API REST Weblate

Tá an API inrochtana ar an URL /api/ agus tá sé bunaithe ar chreat Django REST. Is féidir leat é a úsáid go díreach nó trí Cliant Gréasáin.

Déantar an API a dhoiciméadú freisin ag baint úsáide as OpenAPI 3.1 ar an URL ''/api/schema/'', is féidir leat brabhsáil ag ''/api/docs/''.

Note

Tá OpenAPI ar fáil mar réamhamharc gné. Is dócha go bhfuil an doiciméadú neamhiomlán ag an bpointe seo agus faoi réir athraithe. Féach ar an doiciméadú thíos le do thoil chun faisnéis níos mionsonraithe a fháil ar an API.

Fíordheimhniú agus paraiméadair chineálacha

Tá API an tionscadail phoiblí ar fáil gan fíordheimhniú, cé go bhfuil iarratais neamhfhíordheimhnithe faoi lánseol (de réir réamhshocraithe go 100 iarratas in aghaidh an lae), mar sin moltar fíordheimhniú a úsáid. Úsáideann an fíordheimhniú comhartha, ar féidir leat a fháil i do phróifíl. Úsáid é sa cheanntásc Údarú:

ANY /

Baineann iompar iarratais cineálach don API, na ceanntásca, na cóid stádais agus na paraiméadair anseo le gach críochphointe freisin.

Paraiméadair Iarratas:

  • format -- Formáid fhreagartha (athraithe Accept). Braitheann luachanna féideartha ar shocrú creat REST, de réir réamhshocraithe tacaítear le json, csv agus api. Soláthraíonn an dara ceann comhéadan brabhsálaí gréasáin do API.

  • page -- Tuairisceáin tugtha leathanach na dtorthaí uimhrithe (úsáid na réimsí seo chugainn agus roimhe mar fhreagra chun an nascleanúint a uathoibriú).

  • page_size -- Tabhair ar ais an líon tugtha míreanna in aghaidh an iarratais. Is é 50 an réamhshocrú agus is é 1000 an t-uasmhéid. I gcás na gcríochphointí aonaid is é 100 an réamhshocrú agus 10000 ar a mhéad. Is féidir an luach réamhshocraithe a chumrú freisin trí úsáid a bhaint as an socrú PAGE_SIZE.

Ceanntásca Iarratas:

  • Accept -- braitheann an cineál ábhar freagar Accept ceannteideal

  • Authorization -- comhartha roghnach a fhíordheimhniú mar Údarú: Comhartha DO-TOKEN

Ceanntásca Freagartha:

  • Content-Type -- braitheann sé seo ar Accept ceannteideal an iarratais

  • Allow -- liosta de na modhanna HTTP ceadaithe ar réad

Freagra JSON Object:

  • detail (string) -- cur síos iomarcach ar an toradh (le haghaidh cóid stádais HTTP seachas 200 OK)

  • count (int) -- líon iomlán na míreanna le haghaidh liostaí oibiachtaí

  • next (string) -- URL an chéad leathanach eile le haghaidh liostaí oibiachtaí

  • previous (string) -- URL an leathanaigh roimhe seo le haghaidh liostaí oibiachtaí

  • results (array) -- torthaí le haghaidh liostaí oibiachtaí

  • url (string) -- URL chun rochtain a fháil ar an acmhainn seo leis an API

  • web_url (string) -- URL chun an acmhainn seo a rochtain trí úsáid a bhaint as brabhsálaí gréasáin

Cóid Stádais:

Comharthaí fíordheimhnithe

Changed in version 4.10: Tugadh isteach comharthaí scóipe tionscadail san eisiúint 4.10.

Tá comhartha rochtana pearsanta ag gach úsáideoir ar féidir a fháil sa phróifíl úsáideora. Tá an réimír wlu_ ag comharthaí úsáideora nuaghinte.

Is féidir comharthaí scóip tionscadail a chruthú le haghaidh rochtain API ar thionscadal ar leith amháin. Is féidir na comharthaí seo a aithint leis an réimír wlp_.

See also

Clárú agus próifíl úsáideora, Comharthaí rochtana in aghaidh an tionscadail, Rialú rochtana tionscadail

Samplaí fíordheimhnithe

Iarratas samplach:

GET /api/ HTTP/1.1
Host: example.com
Accept: application/json, text/javascript
Authorization: Token YOUR-TOKEN

Freagra samplach:

HTTP/1.0 200 OK
Date: Fri, 25 Mar 2016 09:46:12 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, HEAD, OPTIONS

{
    "projects":"http://example.com/api/projects/",
    "components":"http://example.com/api/components/",
    "translations":"http://example.com/api/translations/",
    "languages":"http://example.com/api/languages/"
}

CURL mar shampla:

curl \
    -H "Authorization: Token TOKEN" \
    https://example.com/api/

Paraiméadair a rith Samplaí

Maidir leis an modh POST is féidir na paraiméadair a shonrú mar aighneacht foirme (application/x-www-form-urlencoded) nó mar JSON (application/json).

** Sampla d’iarratas foirme:**

POST /api/projects/hello/repository/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/x-www-form-urlencoded
Authorization: Token TOKEN

operation=pull

** Sampla d'iarratas JSON:**

POST /api/projects/hello/repository/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{"operation":"pull"}

CURL mar shampla:

curl \
    -d operation=pull \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/components/hello/weblate/repository/

CURL JSON mar shampla:

curl \
    --data-binary '{"operation":"pull"}' \
    -H "Content-Type: application/json" \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/components/hello/weblate/repository/

Comhpháirteanna agus catagóirí

To access a component which is nested inside a Catagóir, you need to URL encode the category name into a component name separated with a slash. For example usage placed in a docs category needs to be used as docs%252Fusage.. Full URL in this case would be for example https://example.com/api/components/hello/docs%252Fusage/repository/.

Teorainn ráta API

Tá teorainn ráta leis na hiarratais API; cuireann an chumraíocht réamhshocraithe teorainn le 100 iarratas in aghaidh an lae d'úsáideoirí gan ainm agus 5000 iarratas in aghaidh na huaire d'úsáideoirí fíordheimhnithe.

Is féidir teorannú rátaí a choigeartú sa settings.py; féach Throttling in Django creatdhoiciméadú REST le haghaidh tuilleadh sonraí conas é a chumrú.

Sa choimeádán Docker is féidir é seo a chumrú le WEBLATE_API_RATELIMIT_ANON agus WEBLATE_API_RATELIMIT_USER.

Tuairiscítear stádas teorannú rátaí sna ceannteidil seo a leanas:

X-RateLimit-Limit

Líon iarratas ceadaithe a dhéanamh

X-RateLimit-Remaining

An líon iarratas atá fágtha le déanamh

X-RateLimit-Reset

Líon soicind go dtí go n-athshocraíonn an fhuinneog teorainn ráta

Changed in version 4.1: Cuireadh ceanntásca stádais teorannaithe rátaí leis.

See also

Teorainn rátaí, Teorainn rátaí, WEBLATE_API_RATELIMIT_ANON, WEBLATE_API_RATELIMIT_USER

Freagraí earráide

Changed in version 5.10: Bhí na freagraí earráide sainiúil don chríochphointe roimh an eisiúint seo.

Formáidítear freagraí earráide an tsuímh Ghréasáin bunaithe ar Error Response Format.

Pointe Iontrála API

GET /api/

An pointe iontrála fhréamh API.

Iarratas samplach:

GET /api/ HTTP/1.1
Host: example.com
Accept: application/json, text/javascript
Authorization: Token YOUR-TOKEN

Freagra samplach:

HTTP/1.0 200 OK
Date: Fri, 25 Mar 2016 09:46:12 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, HEAD, OPTIONS

{
    "projects":"http://example.com/api/projects/",
    "components":"http://example.com/api/components/",
    "translations":"http://example.com/api/translations/",
    "languages":"http://example.com/api/languages/"
}

Úsáideoirí

Added in version 4.0.

GET /api/users/

Filleann sé liosta úsáideoirí má tá cead agat úsáideoirí bainistigh a fheiceáil. Mura bhfuil, ní fheiceann tú ach do shonraí féin.

Paraiméadair Iarratas:

  • username (string) -- Ainm úsáideora le cuardach a dhéanamh air

  • id (int) -- Aitheantas úsáideora chun cuardach a dhéanamh air

See also

Déantar tréithe oibiachta úsáideoirí a dhoiciméadú ag GET /api/users/(str:username)/.

POST /api/users/

Cruthaíonn úsáideoir nua.

Paraiméadair:

  • username (string) -- Ainm Úsáideora

  • full_name (string) -- Ainm iomlán úsáideora

  • email (string) -- Ríomhphost úsáideora

  • is_superuser (boolean) -- An sár-úsáideoir é? (roghnach)

  • is_active (boolean) -- An bhfuil an t-úsáideoir gníomhach? (roghnach)

  • is_bot (boolean) -- An bot úsáideoir é? (roghnach) (úsáidte le haghaidh comharthaí scóipe tionscadail)

GET /api/users/(str: username)/

Filleann sé faisnéis faoi úsáideoirí.

Paraiméadair:

  • username (string) -- Ainm úsáideora

Freagra JSON Object:

  • username (string) -- ainm úsáideora de úsáideora

  • full_name (string) -- ainm iomlán úsáideora

  • email (string) -- ríomhphost úsáideora

  • is_superuser (boolean) -- cibé an sár-úsáideoir é an t-úsáideoir

  • is_active (boolean) -- cibé an bhfuil an t-úsáideoir gníomhach

  • is_bot (boolean) -- cibé an bot é an t-úsáideoir (a úsáidtear le haghaidh comharthaí scóipe tionscadail)

  • date_joined (string) -- an dáta a chruthaítear an t-úsáideoir

  • last_login (string) -- an dáta ar shínigh an t-úsáideoir isteach go deireanach

  • groups (array) -- nasc le grúpaí gaolmhara; féach GET /api/groups/(int:id)/

  • languages (array) -- nasc chuig teangacha aistrithe; féach GET /api/languages/(string:language)/

Sonraí samplach JSON:

{
    "email": "user@example.com",
    "full_name": "Example User",
    "username": "exampleusername",
    "groups": [
        "http://example.com/api/groups/2/",
        "http://example.com/api/groups/3/"
    ],
    "languages": [
        "http://example.com/api/languages/cs/",
    ],
    "is_superuser": true,
    "is_active": true,
    "is_bot": false,
    "date_joined": "2020-03-29T18:42:42.617681Z",
    "url": "http://example.com/api/users/exampleusername/",
    "contributions_url": "http://example.com/api/users/exampleusername/contributions/"
    "statistics_url": "http://example.com/api/users/exampleusername/statistics/"
}
PUT /api/users/(str: username)/

Athraíonn na paraiméadair úsáideora.

Paraiméadair:

  • username (string) -- Ainm úsáideora

Freagra JSON Object:

  • username (string) -- ainm úsáideora de úsáideora

  • full_name (string) -- ainm iomlán úsáideora

  • email (string) -- ríomhphost úsáideora

  • is_superuser (boolean) -- cibé an sár-úsáideoir é an t-úsáideoir

  • is_active (boolean) -- cibé an bhfuil an t-úsáideoir gníomhach

  • is_bot (boolean) -- cibé an bot é an t-úsáideoir (a úsáidtear le haghaidh comharthaí scóipe tionscadail)

  • date_joined (string) -- an dáta a chruthaítear an t-úsáideoir

PATCH /api/users/(str: username)/

Athraíonn na paraiméadair úsáideora.

Paraiméadair:

  • username (string) -- Ainm úsáideora

Freagra JSON Object:

  • username (string) -- ainm úsáideora de úsáideora

  • full_name (string) -- ainm iomlán úsáideora

  • email (string) -- ríomhphost úsáideora

  • is_superuser (boolean) -- cibé an sár-úsáideoir é an t-úsáideoir

  • is_active (boolean) -- cibé an bhfuil an t-úsáideoir gníomhach

  • is_bot (boolean) -- cibé an bot é an t-úsáideoir (a úsáidtear le haghaidh comharthaí scóipe tionscadail)

  • date_joined (string) -- an dáta a chruthaítear an t-úsáideoir

DELETE /api/users/(str: username)/

Scriosann sé gach faisnéis úsáideora agus marcanna an t-úsáideoir neamhghníomhach.

Paraiméadair:

  • username (string) -- Ainm úsáideora

POST /api/users/(str: username)/groups/

Grúpaí a nascadh le húsáideoir.

Paraiméadair:

  • username (string) -- Ainm úsáideora

Paraiméadair Fhoirm:

  • string group_id -- Aitheantas uathúil an ghrúpa

DELETE /api/users/(str: username)/groups/

Added in version 4.13.1.

Bain an t-úsáideoir as grúpa.

Paraiméadair:

  • username (string) -- Ainm úsáideora

Paraiméadair Fhoirm:

  • string group_id -- Aitheantas uathúil an ghrúpa

GET /api/users/(str: username)/statistics/

Liosta staitisticí úsáideora.

Paraiméadair:

  • username (string) -- Ainm úsáideora

Freagra JSON Object:

  • translated (int) -- Líon na n-aistriúchán de réir úsáideora

  • suggested (int) -- Líon moltaí de réir úsáideora

  • uploaded (int) -- Líon na n-uaslódála de réir úsáideora

  • commented (int) -- Líon tuairimí an úsáideora

  • languages (int) -- Líon na dteangacha is féidir leis an úsáideoir a aistriú

GET /api/users/(str: username)/contributions/

List translations with contributions from a user.

Paraiméadair:

  • username (string) -- Ainm úsáideora

Freagra JSON Object:
GET /api/users/(str: username)/notifications/

Liostaigh síntiúis úsáideora.

Paraiméadair:

  • username (string) -- Ainm úsáideora

POST /api/users/(str: username)/notifications/

Comhcheangail síntiúis le húsáideoir.

Paraiméadair:

  • username (string) -- Ainm úsáideora

Iarr JSON Object:

  • notification (string) -- Ainm an fhógra cláraithe

  • scope (int) -- Scóip an fhógra ó na roghanna atá ar fáil

  • frequency (int) -- Roghanna minicíochta le haghaidh fógraí

GET /api/users/(str: username)/notifications/(int: subscription_id)/

Faigh síntiús a bhaineann le húsáideoir.

Paraiméadair:

  • username (string) -- Ainm úsáideora

  • subscription_id (int) -- Aitheantas an fhógra cláraithe

PUT /api/users/(str: username)/notifications/(int: subscription_id)/

Cuir síntiús a bhaineann le húsáideoir in eagar.

Paraiméadair:

  • username (string) -- Ainm úsáideora

  • subscription_id (int) -- Aitheantas an fhógra cláraithe

Iarr JSON Object:

  • notification (string) -- Ainm an fhógra cláraithe

  • scope (int) -- Scóip an fhógra ó na roghanna atá ar fáil

  • frequency (int) -- Roghanna minicíochta le haghaidh fógraí

PATCH /api/users/(str: username)/notifications/(int: subscription_id)/

Cuir síntiús a bhaineann le húsáideoir in eagar.

Paraiméadair:

  • username (string) -- Ainm úsáideora

  • subscription_id (int) -- Aitheantas an fhógra cláraithe

Iarr JSON Object:

  • notification (string) -- Ainm an fhógra cláraithe

  • scope (int) -- Scóip an fhógra ó na roghanna atá ar fáil

  • frequency (int) -- Roghanna minicíochta le haghaidh fógraí

DELETE /api/users/(str: username)/notifications/(int: subscription_id)/

Scrios síntiús a bhaineann le húsáideoir.

Paraiméadair:

  • username (string) -- Ainm úsáideora

  • subscription_id -- Ainm an fhógra cláraithe

  • subscription_id -- slánuimhir

Grúpaí

Added in version 4.0.

GET /api/groups/

Filleann sé seo liosta grúpaí má tá cead agat féachaint ar bhainistiú grúpaí. Mura bhfuil, ní fheiceann tú ach na grúpaí a bhfuil an t-úsáideoir ina gcuid díobh.

See also

Déantar tréithe oibiachta grúpa a dhoiciméadú ag GET /api/groups/(int:id)/.

POST /api/groups/

Cruthaíonn grúpa nua.

Paraiméadair:
GET /api/groups/(int: id)/

Filleann sé eolas faoin ngrúpa.

Paraiméadair:

  • id (int) -- Aitheantas an Ghrúpa

Freagra JSON Object:

Sonraí samplach JSON:

{
    "name": "Guests",
    "defining_project": null,
    "project_selection": 3,
    "language_selection": 1,
    "url": "http://example.com/api/groups/1/",
    "roles": [
        "http://example.com/api/roles/1/",
        "http://example.com/api/roles/2/"
    ],
    "languages": [
        "http://example.com/api/languages/en/",
        "http://example.com/api/languages/cs/",
    ],
    "projects": [
        "http://example.com/api/projects/demo1/",
        "http://example.com/api/projects/demo/"
    ],
    "componentlist": "http://example.com/api/component-lists/new/",
    "components": [
        "http://example.com/api/components/demo/weblate/"
    ]
}
PUT /api/groups/(int: id)/

Athruithe ar pharaiméadair an ghrúpa.

Paraiméadair:

  • id (int) -- Aitheantas an Ghrúpa

Freagra JSON Object:

  • name (string) -- ainm grúpa

  • project_selection (int) -- slánuimhir a fhreagraíonn do ghrúpa tionscadal

  • language_selection (int) -- slánuimhir a fhreagraíonn do ghrúpa teangacha

PATCH /api/groups/(int: id)/

Athruithe ar pharaiméadair an ghrúpa.

Paraiméadair:

  • id (int) -- Aitheantas an Ghrúpa

Freagra JSON Object:

  • name (string) -- ainm grúpa

  • project_selection (int) -- slánuimhir a fhreagraíonn do ghrúpa tionscadal

  • language_selection (int) -- slánuimhir a fhreagraíonn do ghrúpa teangacha

DELETE /api/groups/(int: id)/

Scrios an grúpa.

Paraiméadair:

  • id (int) -- Aitheantas an Ghrúpa

POST /api/groups/(int: id)/roles/

Róil a chomhlachú le grúpa.

Paraiméadair:

  • id (int) -- Aitheantas an Ghrúpa

Paraiméadair Fhoirm:

  • string role_id -- An ID ról uathúil

DELETE /api/groups/(int: id)/roles/(int: role_id)

Scrios ról ó ghrúpa.

Paraiméadair:

  • id (int) -- Aitheantas an Ghrúpa

  • role_id (int) -- An ID ról uathúil

POST /api/groups/(int: id)/components/

Comhpháirteanna a nascadh le grúpa.

Paraiméadair:

  • id (int) -- Aitheantas an Ghrúpa

Paraiméadair Fhoirm:

  • string component_id -- Aitheantas an chomhpháirt uathúil

DELETE /api/groups/(int: id)/components/(int: component_id)

Scrios comhpháirt ó ghrúpa.

Paraiméadair:

  • id (int) -- Aitheantas an Ghrúpa

  • component_id (int) -- Aitheantas an chomhpháirt uathúil

POST /api/groups/(int: id)/projects/

Comhcheangail tionscadail le grúpa.

Paraiméadair:

  • id (int) -- Aitheantas an Ghrúpa

Paraiméadair Fhoirm:

  • string project_id -- Aitheantas uathúil an tionscadail

DELETE /api/groups/(int: id)/projects/(int: project_id)

Scrios an tionscadal ó ghrúpa.

Paraiméadair:

  • id (int) -- Aitheantas an Ghrúpa

  • project_id (int) -- Aitheantas uathúil an tionscadail

POST /api/groups/(int: id)/languages/

Ceangail teangacha le grúpa.

Paraiméadair:

  • id (int) -- Aitheantas an Ghrúpa

Paraiméadair Fhoirm:

  • string language_code -- An cód teanga uathúil

DELETE /api/groups/(int: id)/languages/(string: language_code)

Scrios teanga ó ghrúpa.

Paraiméadair:

  • id (int) -- Aitheantas an Ghrúpa

  • language_code (string) -- An cód teanga uathúil

POST /api/groups/(int: id)/componentlists/

Comhpháirteoirí a chomhcheangal le grúpa.

Paraiméadair:

  • id (int) -- Aitheantas an Ghrúpa

Paraiméadair Fhoirm:

  • string component_list_id -- An t-aitheantas uathúil comhpháirte

DELETE /api/groups/(int: id)/componentlists/(int: component_list_id)

Scrios liosta na gcomhpháirteanna ó ghrúpa.

Paraiméadair:

  • id (int) -- Aitheantas an Ghrúpa

  • component_list_id (int) -- An t-aitheantas uathúil comhpháirte

POST /api/groups/(int: id)/admins/

Added in version 5.5.

Cuir úsáideoir le riarthóirí foirne.

Paraiméadair:

  • id (int) -- Aitheantas an Ghrúpa

Paraiméadair Fhoirm:

  • string user_id -- Aitheantas an úsáideora

DELETE /api/groups/(int: id)/admins/(int: user_id)

Added in version 5.5.

Scrios an t-úsáideoir ó riarthóirí foirne.

Paraiméadair:

  • id (int) -- Aitheantas an Ghrúpa

  • user_id (integer) -- Aitheantas an úsáideora

Róil

GET /api/roles/

Seoltar ar ais liosta de na róil go léir a bhaineann leis an úsáideoir. Más sár-úsáideoir é an t-úsáideoir, seolfar liosta de na róil reatha ar fad ar ais.

See also

Déantar tréithe réad róil a dhoiciméadú ag GET /api/roles/(int:id)/.

POST /api/roles/

Cruthaíonn sé ról nua.

Paraiméadair:

  • name (string) -- Ainm an róil

  • permissions (array) -- Liosta de chóidainmneacha na gceadanna

GET /api/roles/(int: id)/

Filleann sé eolas faoin ról.

Paraiméadair:

  • id (int) -- Aitheantas an Róil

Freagra JSON Object:

  • name (string) -- Ainm an róil

  • permissions (array) -- liosta de chóidainmneacha na gceadanna

Sonraí samplach JSON:

{
    "name": "Access repository",
    "permissions": [
        "vcs.access",
        "vcs.view"
    ],
    "url": "http://example.com/api/roles/1/",
}
PUT /api/roles/(int: id)/

Athraíonn na paraiméadair ról.

Paraiméadair:

  • id (int) -- Aitheantas an Róil

Freagra JSON Object:

  • name (string) -- Ainm an róil

  • permissions (array) -- liosta de chóidainmneacha na gceadanna

PATCH /api/roles/(int: id)/

Athraíonn na paraiméadair ról.

Paraiméadair:

  • id (int) -- Aitheantas an Róil

Freagra JSON Object:

  • name (string) -- Ainm an róil

  • permissions (array) -- liosta de chóidainmneacha na gceadanna

DELETE /api/roles/(int: id)/

Scrios an ról.

Paraiméadair:

  • id (int) -- Aitheantas an Róil

Teangacha

GET /api/languages/

Seoltar ar ais liosta de na teangacha go léir.

See also

Déantar tréithe oibiachta teanga a dhoiciméadú ag GET /api/languages/(string:language)/.

POST /api/languages/

Cruthaíonn teanga nua.

Paraiméadair:

  • code (string) -- Ainm teanga

  • name (string) -- Ainm teanga

  • direction (string) -- Treo téacs

  • population (int) -- Líon na gcainteoirí

  • plural (object) -- Foirmle iolra teanga agus uimhir

GET /api/languages/(string: language)/

Filleann sé eolas faoin teanga.

Paraiméadair:

  • language (string) -- Cód teanga

Freagra JSON Object:

  • code (string) -- Cód teanga

  • direction (string) -- Treo téacs

  • plural (object) -- Cuspóir an eolais iolra teanga

  • aliases (array) -- Sraith ailiasanna don teanga

Iarr JSON Object:

  • population (int) -- Líon na gcainteoirí

Sonraí samplach JSON:

{
    "code": "en",
    "direction": "ltr",
    "name": "English",
    "population": 159034349015,
    "plural": {
        "id": 75,
        "source": 0,
        "number": 2,
        "formula": "n != 1",
        "type": 1
    },
    "aliases": [
        "english",
        "en_en",
        "base",
        "source",
        "eng"
    ],
    "url": "http://example.com/api/languages/en/",
    "web_url": "http://example.com/languages/en/",
    "statistics_url": "http://example.com/api/languages/en/statistics/"
}
PUT /api/languages/(string: language)/

Athraíonn na paraiméadair teanga.

Paraiméadair:

  • language (string) -- Cóid teangacha

Iarr JSON Object:

  • name (string) -- Ainm teanga

  • direction (string) -- Treo téacs

  • population (int) -- Líon na gcainteoirí

  • plural (object) -- Sonraí iolra teanga

PATCH /api/languages/(string: language)/

Athraíonn na paraiméadair teanga.

Paraiméadair:

  • language (string) -- Cóid teangacha

Iarr JSON Object:

  • name (string) -- Ainm teanga

  • direction (string) -- Treo téacs

  • population (int) -- Líon na gcainteoirí

  • plural (object) -- Sonraí iolra teanga

DELETE /api/languages/(string: language)/

Scriosann an teanga.

Paraiméadair:

  • language (string) -- Cóid teangacha

GET /api/languages/(string: language)/statistics/

Tuairisceáin staitisticí do theanga.

Paraiméadair:

  • language (string) -- Cód teanga

See also

Déantar cur síos ar na tréithe a tugadh ar ais i Staitisticí.

Tionscadail

GET /api/projects/

Seol ar ais liosta de na tionscadail go léir.

See also

Déantar tréithe oibiachta an tionscadail a dhoiciméadú ag GET /api/projects/(string:project)/.

POST /api/projects/

Cruthaíonn tionscadal nua.

Paraiméadair:

  • name (string) -- Ainm tionscadal

  • slug (string) -- Seilide tionscadail

  • web (string) -- Láithreán gréasáin tionscadal

GET /api/projects/(string: project)/

Filleann sé eolas faoin tionscadal.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

Freagra JSON Object:

Sonraí samplach JSON:

{
    "name": "Hello",
    "slug": "hello",
    "url": "http://example.com/api/projects/hello/",
    "web": "https://weblate.org/",
    "web_url": "http://example.com/projects/hello/"
}
PATCH /api/projects/(string: project)/

Added in version 4.3.

Cuir tionscadal in eagar trí iarratas a PATCH.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

  • component (string) -- seilide URL Comhpháirte

PUT /api/projects/(string: project)/

Added in version 4.3.

Cuir tionscadal in eagar trí iarratas a PUT.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

DELETE /api/projects/(string: project)/

Scriosann tionscadal.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

GET /api/projects/(string: project)/changes/

Seoltar liosta athruithe tionscadail ar ais. Go bunúsach, is tionscadal é seo a bhfuil scóip aige GET /api/changes/ ag glacadh leis na paraiméadair chéanna.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

Freagra JSON Object:
GET /api/projects/(string: project)/file/

Added in version 5.5.

Íoslódálann sé gach aistriúchán atá ar fáil a bhaineann leis an tionscadal mar chomhad cartlainne ag baint úsáide as an bhformáid agus an teanga a iarrtar.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

Paraiméadair Iarratas:

  • format (string) -- An fhormáid cartlainne le húsáid; Mura bhfuil sé sonraithe, réamhshocrú go zip; Formáidí tacaithe: `` zip`` agus `` zip: CONVERSION`` áit a bhfuil `` CONVERSION`` ar cheann de na tiontairí liostaithe ag Aistriúcháin a íoslódáil.

  • language_code (string) -- An cód teanga le híoslódáil; Mura sonraítear iad, cuirtear gach teanga san áireamh.

GET /api/projects/(string: project)/repository/

Tuairisceáin faisnéis faoi stádas stór VCS. Níl sa chríochphointe seo ach achoimre iomlán do gach stór don tionscadal. Chun stádas níos mionsonraithe a fháil bain úsáid as GET /api/components/(string:project)/(string:component)/repository/.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

Freagra JSON Object:

  • needs_commit (boolean) -- an bhfuil aon athruithe le déanamh ar feitheamh

  • needs_merge (boolean) -- cibé an bhfuil aon athruithe réamhtheachtacha le cumasc

  • needs_push (boolean) -- an bhfuil aon athruithe áitiúla le brú

Sonraí samplach JSON:

{
    "needs_commit": true,
    "needs_merge": false,
    "needs_push": true
}
POST /api/projects/(string: project)/repository/

Déanann sé oibríocht tugtha ar an stór VCS.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

Iarr JSON Object:

  • operation (string) -- Oibríocht le cur i gcrích: ceann amháin de `` bhrú``, tarraing, `` tiomnaigh``, athshocraigh, glanadh, comhad-shioncronú, `` scanadh comhaid` `

Freagra JSON Object:

  • result (boolean) -- thoradh na hoibríochta

CURL mar shampla:

curl \
    -d operation=pull \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/projects/hello/repository/

** Sampla d'iarratas JSON:**

POST /api/projects/hello/repository/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{"operation":"pull"}

** Sampla freagra JSON:**

HTTP/1.0 200 OK
Date: Tue, 12 Apr 2016 09:32:50 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, POST, HEAD, OPTIONS

{"result":true}
GET /api/projects/(string: project)/components/

Seol ar ais liosta de na comhpháirteanna aistriúcháin sa tionscadal ar leith.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

Freagra JSON Object:
POST /api/projects/(string: project)/components/

Changed in version 4.3: Glactar leis na paraiméadair zipfile agus docfile anois le haghaidh comhpháirteanna nach bhfuil chomh VCS, féach Comhaid áitiúla.

Changed in version 4.6: Déantar na stórais clónaithe a roinnt go huathoibríoch laistigh de thionscadal anois ag baint úsáid URLanna inmheánacha an Ghréasáin. Úsáid disable_autoshare chun é seo a mhúchadh.

Cruthaíonn comhpháirteanna aistriúcháin sa tionscadal tugtha.

Hint

Úsáid URLanna inmheánacha an Ghréasáin agus comhpháirteanna iolracha á chruthú ó stór VCS amháin.

Note

Tarlaíonn an chuid is mó de chruthú comhpháirte sa chúlra. Seiceáil an aitreabúid tasc_url den chomhpháirt chruthaithe agus lean an dul chun cinn ann.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

Paraiméadair Fhoirm:

  • file zipfile -- Comhad ZIP le huaslódáil isteach i Weblate chun aistriúchán a thosú

  • file docfile -- Doiciméad le haistriú

  • boolean disable_autoshare -- Díchumasaíonn sé comhroinnt stórais uathoibríoch trí URLanna inmheánacha an Ghréasáin.

Iarr JSON Object:
Freagra JSON Object:

Ní féidir JSON a úsáid agus na comhaid á uaslódáil ag baint úsáide as na paraiméadair zipfile agus docfile`. Caithfear na sonraí a uaslódáil mar multipart/form-data.

** Sampla den fhoirm iarratais CURL:**

curl \
    --form docfile=@strings.html \
    --form name=Weblate \
    --form slug=weblate \
    --form file_format=html \
    --form new_lang=add \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/projects/hello/components/

CURL sampla iarratas JSON:

curl \
    --data-binary '{
        "branch": "main",
        "file_format": "po",
        "filemask": "po/*.po",
        "name": "Weblate",
        "slug": "weblate",
        "repo": "https://github.com/WeblateOrg/hello.git",
        "template": "",
        "new_base": "po/hello.pot",
        "vcs": "git"
    }' \
    -H "Content-Type: application/json" \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/projects/hello/components/

Iarratas JSON chun comhpháirt nua a chruthú ó Git:

POST /api/projects/hello/components/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{
    "branch": "main",
    "file_format": "po",
    "filemask": "po/*.po",
    "name": "Weblate",
    "slug": "weblate",
    "repo": "https://github.com/WeblateOrg/hello.git",
    "template": "",
    "new_base": "po/hello.pot",
    "vcs": "git"
}

Iarratas JSON chun comhpháirt nua a chruthú ó cheann eile:

POST /api/projects/hello/components/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{
    "file_format": "po",
    "filemask": "po/*.po",
    "name": "Weblate",
    "slug": "weblate",
    "repo": "weblate://weblate/hello",
    "template": "",
    "new_base": "po/hello.pot",
    "vcs": "git"
}

** Sampla freagra JSON:**

HTTP/1.0 200 OK
Date: Tue, 12 Apr 2016 09:32:50 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, POST, HEAD, OPTIONS

{
    "branch": "main",
    "file_format": "po",
    "filemask": "po/*.po",
    "git_export": "",
    "license": "",
    "license_url": "",
    "name": "Weblate",
    "slug": "weblate",
    "project": {
        "name": "Hello",
        "slug": "hello",
        "source_language": {
            "code": "en",
            "direction": "ltr",
             "population": 159034349015,
            "name": "English",
            "url": "http://example.com/api/languages/en/",
            "web_url": "http://example.com/languages/en/"
        },
        "url": "http://example.com/api/projects/hello/",
        "web": "https://weblate.org/",
        "web_url": "http://example.com/projects/hello/"
    },
    "repo": "file:///home/nijel/work/weblate-hello",
    "template": "",
    "new_base": "",
    "url": "http://example.com/api/components/hello/weblate/",
    "vcs": "git",
    "web_url": "http://example.com/projects/hello/weblate/"
}
GET /api/projects/(string: project)/languages/

Tuairisceáin staitisticí leathanach do gach teanga laistigh de thionscadal.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

Freagra JSON Object:

  • results (array) -- raon de réad staitisticí aistriúcháin

  • language (string) -- ainm teanga

  • code (string) -- cód teanga

  • total (int) -- líon iomlán na teaghráin

  • translated (int) -- líon teaghráin aistrithe

  • translated_percent (float) -- céatadán de na teaghráin aistrithe

  • total_words (int) -- líon iomlán na bhfocal

  • translated_words (int) -- líon na bhfocal aistrithe

  • words_percent (float) -- céatadán de na focail aistrithe

GET /api/projects/(string: project)/statistics/

Tuairisceáin staitisticí le haghaidh tionscadail.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

See also

Déantar cur síos ar na tréithe a tugadh ar ais i Staitisticí.

GET /api/projects/(string: project)/categories/

Added in version 5.0: Tuairisceáin catagóirí le haghaidh tionscadail. Féach GET /api/categories/(int:id)/ le haghaidh sainmhínithe réimse.

tionscadal param:

Seilide URL an tionscadail

cineál tionscadal:

teaghrán

GET /api/projects/(string: project)/labels/

Added in version 5.3: Seoltar ar ais lipéid le haghaidh tionscadail.

tionscadal param:

Seilide URL an tionscadail

cineál tionscadal:

teaghrán

>json int id:

ID an lipéid

>json string name:

ainm an lipéid

>json string color:

dath an lipéid

POST /api/projects/(string: project)/labels/

Added in version 5.3: Cruthaíonn lipéad do thionscadal.

tionscadal param:

Seilide URL an tionscadail

cineál tionscadal:

teaghrán

<json string name:

ainm an lipéid

<json string color:

dath an lipéid

GET /api/projects/(string: project)/credits/

Tuairisceáin creidmheasanna ranníocóra le haghaidh tionscadail.

Added in version 5.7.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

  • start (date) -- Stampa ama ISO 8601 le teorainn níos ísle (éigeantach)

  • end (date) -- Stampa ama ISO 8601 ag teorainn uachtarach (éigeantach)

  • lang (source_language) -- Cód teanga chun cuardach a dhéanamh

Freagra JSON Object:

  • email (string) -- Ríomhphost an rannchuiditheora

  • full_name (string) -- Ainm iomlán an rannchuiditheora

  • change_count (string) -- Líon na n-athruithe a rinneadh sa raon ama

GET /api/projects/{string:project}/machinery_settings/

Added in version 5.9.

Filleann sé socruithe moltaí uathoibríocha do thionscadal, ina bhfuil na cumraíochtaí sainithe do gach seirbhís aistriúcháin a suiteáladh.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

Freagra JSON Object:

  • suggestion_settings (object) -- Cumraíocht do gach seirbhís suiteáilte.

POST /api/projects/{string:project}/machinery_settings/

Added in version 5.9.

Cruthaigh nó nuashonraigh an chumraíocht seirbhíse do thionscadal.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

Paraiméadair Fhoirm:

  • string service -- Ainm seirbhíse

  • string configuration -- Cumraíocht seirbhíse i JSON

Comhpháirteanna

Hint

Úsáid POST /api/projects/(string:project)/components/ chun comhpháirteanna nua a chruthú.

GET /api/components/

Seoltar liosta comhpháirteanna aistriúcháin ar ais.

See also

Déantar tréithe comhpháirte oibiachta a dhoiciméadú ag GET /api/components/(string:project)/(string:component)/.

GET /api/components/(string: project)/(string: component)/

Filleann sé faisnéis faoin gcomhpháirt aistriúcháin.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

  • component (string) -- seilide URL Comhpháirte

Freagra JSON Object:

Sonraí samplach JSON:

{
    "branch": "main",
    "file_format": "po",
    "filemask": "po/*.po",
    "git_export": "",
    "license": "",
    "license_url": "",
    "name": "Weblate",
    "slug": "weblate",
    "project": {
        "name": "Hello",
        "slug": "hello",
        "source_language": {
            "code": "en",
            "direction": "ltr",
             "population": 159034349015,
            "name": "English",
            "url": "http://example.com/api/languages/en/",
            "web_url": "http://example.com/languages/en/"
        },
        "url": "http://example.com/api/projects/hello/",
        "web": "https://weblate.org/",
        "web_url": "http://example.com/projects/hello/"
    },
    "source_language": {
        "code": "en",
        "direction": "ltr",
        "population": 159034349015,
        "name": "English",
        "url": "http://example.com/api/languages/en/",
        "web_url": "http://example.com/languages/en/"
    },
    "repo": "file:///home/nijel/work/weblate-hello",
    "template": "",
    "new_base": "",
    "url": "http://example.com/api/components/hello/weblate/",
    "vcs": "git",
    "web_url": "http://example.com/projects/hello/weblate/"
}
PATCH /api/components/(string: project)/(string: component)/

Cuir comhpháirt in eagar trí iarratas a:PATCH.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

  • component (string) -- seilide URL Comhpháirte

  • source_language (string) -- Cód teanga foinse an tionscadail (roghnach)

Iarr JSON Object:

  • name (string) -- ainm na comhpháirte

  • slug (string) -- sluga comhpháirte

  • repo (string) -- URL stór VCS

CURL mar shampla:

curl \
    --data-binary '{"name": "new name"}' \
    -H "Content-Type: application/json" \
    -H "Authorization: Token TOKEN" \
    PATCH http://example.com/api/projects/hello/components/

** Sampla d'iarratas JSON:**

PATCH /api/projects/hello/components/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{
    "name": "new name"
}

** Sampla freagra JSON:**

HTTP/1.0 200 OK
Date: Tue, 12 Apr 2016 09:32:50 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, POST, HEAD, OPTIONS

{
    "branch": "main",
    "file_format": "po",
    "filemask": "po/*.po",
    "git_export": "",
    "license": "",
    "license_url": "",
    "name": "new name",
    "slug": "weblate",
    "project": {
        "name": "Hello",
        "slug": "hello",
        "source_language": {
            "code": "en",
            "direction": "ltr",
            "population": 159034349015,
            "name": "English",
            "url": "http://example.com/api/languages/en/",
            "web_url": "http://example.com/languages/en/"
        },
        "url": "http://example.com/api/projects/hello/",
        "web": "https://weblate.org/",
        "web_url": "http://example.com/projects/hello/"
    },
    "repo": "file:///home/nijel/work/weblate-hello",
    "template": "",
    "new_base": "",
    "url": "http://example.com/api/components/hello/weblate/",
    "vcs": "git",
    "web_url": "http://example.com/projects/hello/weblate/"
}
PUT /api/components/(string: project)/(string: component)/

Cuir comhpháirt in eagar trí iarratas a PUT.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

  • component (string) -- seilide URL Comhpháirte

Iarr JSON Object:

  • branch (string) -- Brainse stór VCS

  • file_format (string) -- formáid comhaid aistriúcháin

  • filemask (string) -- masc de chomhaid aistriúcháin sa stór

  • name (string) -- ainm na comhpháirte

  • slug (string) -- sluga comhpháirte

  • repo (string) -- URL stór VCS

  • template (string) -- bunchomhad le haghaidh aistriúcháin aonteangacha

  • new_base (string) -- bunchomhad chun aistriúcháin nua a chur leis

  • vcs (string) -- córas rialaithe leagan

DELETE /api/components/(string: project)/(string: component)/

Scriosann comhpháirt.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

  • component (string) -- seilide URL Comhpháirte

GET /api/components/(string: project)/(string: component)/changes/

Seoltar ar ais liosta athruithe comhpháirte. Go bunúsach is comhpháirt í seo a bhfuil scóip GET /api/changes/ ag glacadh leis na paraimí céanna.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

  • component (string) -- seilide URL Comhpháirte

Freagra JSON Object:
GET /api/components/(string: project)/(string: component)/file/

Added in version 4.9.

Íoslódálann sé gach aistriúchán atá ar fáil a bhaineann leis an gcomhpháirt mar chomhad cartlainne ag baint úsáide as an bhformáid a iarrtar.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

  • component (string) -- seilide URL Comhpháirte

Paraiméadair Iarratas:

  • format (string) -- An fhormáid cartlainne le húsáid; Mura bhfuil sé sonraithe, réamhshocrú go zip; Formáidí tacaithe: `` zip`` agus `` zip: CONVERSION`` áit a bhfuil `` CONVERSION`` ar cheann de na tiontairí liostaithe ag Aistriúcháin a íoslódáil.

GET /api/components/(string: project)/(string: component)/screenshots/

Seoltar ar ais liosta de screenshots comhpháirteanna.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

  • component (string) -- seilide URL Comhpháirte

Freagra JSON Object:
GET /api/components/(string: project)/(string: component)/lock/

Tuairisceáin stádas glasála comhpháirte.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

  • component (string) -- seilide URL Comhpháirte

Freagra JSON Object:

  • locked (boolean) -- cibé an bhfuil an chomhpháirt faoi ghlas le haghaidh nuashonruithe

Sonraí samplach JSON:

{
    "locked": false
}
POST /api/components/(string: project)/(string: component)/lock/

Socraíonn sé stádas glasála comhpháirte.

Tá an freagra mar an gcéanna le GET /api/components/(string:project)/(string:component)/lock/.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

  • component (string) -- seilide URL Comhpháirte

Iarr JSON Object:

  • lock -- Boolean cibé acu a ghlasáil nó nach bhfuil.

CURL mar shampla:

curl \
    -d lock=true \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/components/hello/weblate/repository/

** Sampla d'iarratas JSON:**

POST /api/components/hello/weblate/repository/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{"lock": true}

** Sampla freagra JSON:**

HTTP/1.0 200 OK
Date: Tue, 12 Apr 2016 09:32:50 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, POST, HEAD, OPTIONS

{"locked":true}
GET /api/components/(string: project)/(string: component)/repository/

Tuairisceáin faisnéis faoi stádas stór VCS.

Is ionann an freagra agus an freagra do GET /api/projects/(string:project)/repository/.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

  • component (string) -- seilide URL Comhpháirte

Freagra JSON Object:

  • needs_commit (boolean) -- an bhfuil aon athruithe le déanamh ar feitheamh

  • needs_merge (boolean) -- cibé an bhfuil aon athruithe réamhtheachtacha le cumasc

  • needs_push (boolean) -- an bhfuil aon athruithe áitiúla le brú

  • remote_commit (string) -- Faisnéis chiantiomanta

  • status (string) -- Stádas stórtha VCS mar a thuairiscigh VCS

  • merge_failure -- Téacs a chuireann síos ar theip ar chumasc nó ar neamhní mura bhfuil aon cheann ann

POST /api/components/(string: project)/(string: component)/repository/

Déanann sé an oibríocht ar leith ar stór VCS.

Féach POST /api/projects/(string:project)/repository/ le haghaidh doiciméadú.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

  • component (string) -- seilide URL Comhpháirte

Iarr JSON Object:

  • operation (string) -- Oibríocht le déanamh: ceann de `` bhrú``, tarraing, `` tiomnaigh``, `` athshocrú``, glanadh

Freagra JSON Object:

  • result (boolean) -- thoradh na hoibríochta

CURL mar shampla:

curl \
    -d operation=pull \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/components/hello/weblate/repository/

** Sampla d'iarratas JSON:**

POST /api/components/hello/weblate/repository/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{"operation":"pull"}

** Sampla freagra JSON:**

HTTP/1.0 200 OK
Date: Tue, 12 Apr 2016 09:32:50 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, POST, HEAD, OPTIONS

{"result":true}
GET /api/components/(string: project)/(string: component)/monolingual_base/

Íoslódáil an bunchomhad le haghaidh aistriúcháin aonteangacha.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

  • component (string) -- seilide URL Comhpháirte

GET /api/components/(string: project)/(string: component)/new_template/

Íosluchtaigh teimpléid le haghaidh aistriúcháin nua.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

  • component (string) -- seilide URL Comhpháirte

GET /api/components/(string: project)/(string: component)/translations/

Seol ar ais liosta de na rudaí aistriúcháin sa chomhpháirt a thugtar.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

  • component (string) -- seilide URL Comhpháirte

Freagra JSON Object:
POST /api/components/(string: project)/(string: component)/translations/

Cruthaíonn aistriúchán nua sa chomhpháirt tugtha.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

  • component (string) -- seilide URL Comhpháirte

Iarr JSON Object:
Freagra JSON Object:

  • result (object) -- réad aistriúcháin nua cruthaithe

CURL mar shampla:

curl \
    -d language_code=cs \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/projects/hello/components/

** Sampla d'iarratas JSON:**

POST /api/projects/hello/components/ HTTP/1.1
Host: example.com
Accept: application/json
Content-Type: application/json
Authorization: Token TOKEN
Content-Length: 20

{"language_code": "cs"}

** Sampla freagra JSON:**

HTTP/1.0 200 OK
Date: Tue, 12 Apr 2016 09:32:50 GMT
Server: WSGIServer/0.1 Python/2.7.11+
Vary: Accept, Accept-Language, Cookie
X-Frame-Options: SAMEORIGIN
Content-Type: application/json
Content-Language: en
Allow: GET, POST, HEAD, OPTIONS

{
    "failing_checks": 0,
    "failing_checks_percent": 0,
    "failing_checks_words": 0,
    "filename": "po/cs.po",
    "fuzzy": 0,
    "fuzzy_percent": 0.0,
    "fuzzy_words": 0,
    "have_comment": 0,
    "have_suggestion": 0,
    "is_template": false,
    "is_source": false,
    "language": {
        "code": "cs",
        "direction": "ltr",
        "population": 1303174280
        "name": "Czech",
        "url": "http://example.com/api/languages/cs/",
        "web_url": "http://example.com/languages/cs/"
    },
    "language_code": "cs",
    "id": 125,
    "last_author": null,
    "last_change": null,
    "share_url": "http://example.com/engage/hello/cs/",
    "total": 4,
    "total_words": 15,
    "translate_url": "http://example.com/translate/hello/weblate/cs/",
    "translated": 0,
    "translated_percent": 0.0,
    "translated_words": 0,
    "url": "http://example.com/api/translations/hello/weblate/cs/",
    "web_url": "http://example.com/projects/hello/weblate/cs/"
}
GET /api/components/(string: project)/(string: component)/statistics/

Tuairisceáin staitisticí leathanach ar gach aistriúchán laistigh den chomhpháirt.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

  • component (string) -- seilide URL Comhpháirte

See also

Déantar cur síos ar na tréithe a tugadh ar ais i Staitisticí.

GET /api/components/(string: project)/(string: component)/links/

Tuairisceáin tionscadail atá nasctha le comhpháirt.

Added in version 4.5.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

  • component (string) -- seilide URL Comhpháirte

Freagra JSON Object:
POST /api/components/(string: project)/(string: component)/links/

Tionscadal a chomhlachú le comhpháirt.

Added in version 4.5.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

  • component (string) -- seilide URL Comhpháirte

Paraiméadair Fhoirm:

  • string project_slug -- Seilide tionscadail

DELETE /api/components/(string: project)/(string: component)/links/(string: project_slug)/

Bain baint tionscadail le comhpháirt.

Added in version 4.5.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

  • component (string) -- seilide URL Comhpháirte

  • project_slug (string) -- Drúchtín an tionscadail a bhaint

GET /api/components/(string: project)/(string: component)/credits/

Tuairisceáin creidmheasanna ranníocóra le haghaidh tionscadail.

Added in version 5.7.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

  • start (date) -- Stampa ama ISO 8601 le teorainn níos ísle (éigeantach)

  • end (date) -- Stampa ama ISO 8601 ag teorainn uachtarach (éigeantach)

  • lang (source_language) -- Cód teanga chun cuardach a dhéanamh

Freagra JSON Object:

  • email (string) -- Ríomhphost an rannchuiditheora

  • full_name (string) -- Ainm iomlán an rannchuiditheora

  • change_count (string) -- Líon na n-athruithe a rinneadh sa raon ama

Aistriúcháin

GET /api/translations/

Seoltar liosta aistriúcháin ar ais.

See also

Déantar tréithe oibiachta aistriúcháin a dhoiciméadú ag GET /api/translations/(string:project)/(string:component)/(string:language)/.

GET /api/translations/(string: project)/(string: component)/(string: language)/

Filleann sé eolas faoin aistriúchán.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

  • component (string) -- seilide URL Comhpháirte

  • language (string) -- Cód teanga aistriúcháin

Freagra JSON Object:

  • component (object) -- réad comhpháirt; féach GET /api/components/(string:project)/(string:component)/

  • failing_checks (int) -- líon na teaghráin a dteipeann seiceálacha

  • failing_checks_percent (float) -- céatadán de theaghráin a dteipeann seiceálacha

  • failing_checks_words (int) -- líon na bhfocal le seiceanna ag teip

  • filename (string) -- ainm comhaid aistriúcháin

  • fuzzy (int) -- líon na teaghrán doiléir (marcáilte le haghaidh eagarthóireacht)

  • fuzzy_percent (float) -- céatadán de na teaghráin doiléir (marcáilte le haghaidh eagarthóireacht)

  • fuzzy_words (int) -- líon na bhfocal i teaghráin doiléir (marcáilte le haghaidh eagarthóireachta)

  • have_comment (int) -- líon teaghrán le trácht

  • have_suggestion (int) -- líon teaghrán le moladh

  • is_template (boolean) -- an bhfuil bunús aonteangach leis an aistriúchán

  • language (object) -- réad teanga foinse; féach GET /api/languages/(string:language)/

  • language_code (string) -- cód teanga a úsáidtear sa stór; is féidir é seo a bheith difriúil ó chód teanga san oibiacht teanga

  • last_author (string) -- ainm an údair dheireanaigh

  • last_change (timestamp) -- stampa ama an athraithe dheireanach

  • revision (string) -- hash athbhreithnithe don chomhad

  • share_url (string) -- URL le haghaidh roinnt as a dtiocfaidh leathanach rannpháirtíochta

  • total (int) -- líon iomlán na teaghráin

  • total_words (int) -- líon iomlán na bhfocal

  • translate_url (string) -- URL le haghaidh aistriúcháin

  • translated (int) -- líon teaghráin aistrithe

  • translated_percent (float) -- céatadán de na teaghráin aistrithe

  • translated_words (int) -- líon na bhfocal aistrithe

  • repository_url (string) -- URL chuig stádas stórais; féach GET /api/translations/(string:project)/(string:component)/(string:language)/repository/

  • file_url (string) -- URL chuig réad comhad; féach GET /api/translations/(string:project)/(string:component)/(string:language)/file/

  • changes_list_url (string) -- URL chuig an liosta athruithe; féach GET /api/translations/(string:project)/(string:component)/(string:language)/changes/

  • units_list_url (string) -- URL chuig liosta teaghráin; féach GET /api/translations/(string:project)/(string:component)/(string:language)/units/

Sonraí samplach JSON:

{
    "component": {
        "branch": "main",
        "file_format": "po",
        "filemask": "po/*.po",
        "git_export": "",
        "license": "",
        "license_url": "",
        "name": "Weblate",
        "new_base": "",
        "project": {
            "name": "Hello",
            "slug": "hello",
            "source_language": {
                "code": "en",
                "direction": "ltr",
                "population": 159034349015,
                "name": "English",
                "url": "http://example.com/api/languages/en/",
                "web_url": "http://example.com/languages/en/"
            },
            "url": "http://example.com/api/projects/hello/",
            "web": "https://weblate.org/",
            "web_url": "http://example.com/projects/hello/"
        },
        "repo": "file:///home/nijel/work/weblate-hello",
        "slug": "weblate",
        "template": "",
        "url": "http://example.com/api/components/hello/weblate/",
        "vcs": "git",
        "web_url": "http://example.com/projects/hello/weblate/"
    },
    "failing_checks": 3,
    "failing_checks_percent": 75.0,
    "failing_checks_words": 11,
    "filename": "po/cs.po",
    "fuzzy": 0,
    "fuzzy_percent": 0.0,
    "fuzzy_words": 0,
    "have_comment": 0,
    "have_suggestion": 0,
    "is_template": false,
    "language": {
        "code": "cs",
        "direction": "ltr",
        "population": 1303174280
        "name": "Czech",
        "url": "http://example.com/api/languages/cs/",
        "web_url": "http://example.com/languages/cs/"
    },
    "language_code": "cs",
    "last_author": "Weblate Admin",
    "last_change": "2016-03-07T10:20:05.499",
    "revision": "7ddfafe6daaf57fc8654cc852ea6be212b015792",
    "share_url": "http://example.com/engage/hello/cs/",
    "total": 4,
    "total_words": 15,
    "translate_url": "http://example.com/translate/hello/weblate/cs/",
    "translated": 4,
    "translated_percent": 100.0,
    "translated_words": 15,
    "url": "http://example.com/api/translations/hello/weblate/cs/",
    "web_url": "http://example.com/projects/hello/weblate/cs/"
}
DELETE /api/translations/(string: project)/(string: component)/(string: language)/

Scrios aistriúchán.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

  • component (string) -- seilide URL Comhpháirte

  • language (string) -- Cód teanga aistriúcháin

GET /api/translations/(string: project)/(string: component)/(string: language)/changes/

Seoltar liosta athruithe aistriúcháin ar ais. Go bunúsach is aistriúchán-scóip é seo GET /api/changes/ a ghlacann leis na paraiméadair chéanna.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

  • component (string) -- seilide URL Comhpháirte

  • language (string) -- Cód teanga aistriúcháin

Freagra JSON Object:
GET /api/translations/(string: project)/(string: component)/(string: language)/units/

Seoltar liosta aonad aistriúcháin ar ais.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

  • component (string) -- seilide URL Comhpháirte

  • language (string) -- Cód teanga aistriúcháin

  • q (string) -- Teaghrán iarratais cuardaigh Cuardach (roghnach)

Freagra JSON Object:
POST /api/translations/(string: project)/(string: component)/(string: language)/units/

Cuir aonad nua leis.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

  • component (string) -- seilide URL Comhpháirte

  • language (string) -- Cód teanga aistriúcháin

Iarr JSON Object:

  • key (string) -- Aistriúcháin aonteangacha: Eochair an aonaid aistriúcháin

  • value (array) -- Aistriúcháin aonteangacha: Teaghráin foinse (úsáid teaghrán aonair mura gcruthaítear an t-iolra)

  • context (string) -- Aistriúcháin dátheangacha: Comhthéacs aonaid aistriúcháin

  • source (array) -- Aistriúcháin dhátheangacha: Teaghráin foinse (úsáid teaghrán aonair mura gcruthaítear an t-iolra)

  • target (array) -- Aistriúcháin dhátheangacha: Teaghráin sprice (úsáid teaghrán aonair mura gcruthaítear an t-iolra)

  • state (int) -- Stát teaghrán; féach GET /api/units/(int:id)/

Freagra JSON Object:

See also

Bainistigh teaghráin, Teaghráin nua á gcur leis

POST /api/translations/(string: project)/(string: component)/(string: language)/autotranslate/

Truicear aistriúchán uathoibríoch.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

  • component (string) -- seilide URL Comhpháirte

  • language (string) -- Cód teanga aistriúcháin

Iarr JSON Object:

  • mode (string) -- Modh aistriúcháin uathoibríoch

  • filter_type (string) -- Cineál scagaire aistriúcháin uathoibríoch

  • auto_source (string) -- Foinse aistriúcháin uathoibríoch - mt nó others

  • component (string) -- Cuir an ranníocaíocht chuig cuimhne aistriúcháin roinnte ar siúl don tionscadal chun rochtain a fháil ar chomhpháirteanna breise.

  • engines (array) -- Innill aistriúcháin meaisín

  • threshold (string) -- Tairseach scóir

GET /api/translations/(string: project)/(string: component)/(string: language)/file/

Íoslódáil an comhad aistriúcháin reatha mar atá sé stóráilte sa VCS (gan an paraiméadar format) nó a thiontú go formáid eile (féach Aistriúcháin a íoslódáil).

Note

Úsáideann an críochphointe API seo loighic éagsúil le haghaidh aschuir ná an chuid eile den API mar go n-oibríonn sé ar chomhad iomlán seachas ar shonraí. Tá difríocht idir an tacar de pharaiméadar formáid a nglactar leis agus gan an paraiméadar sin gheobhaidh tú an comhad aistriúcháin mar atá stóráilte i VCS.

Ceanntásca Freagartha:

  • Last-Modified -- Stampa ama an athraithe dheireanaigh ar an gcomhad seo.

Ceanntásca Iarratas:
Paraiméadair Iarratas:

  • format -- Formáid comhaid le húsáid; mura ndéantar aon chomhshó formáid a shonrú; féach Aistriúcháin a íoslódáil le haghaidh formáidí tacaithe

  • q (string) -- Scagaigh teaghráin íoslódáilte, féach Search Page, is infheidhme ach nuair a bhíonn tiontú i bhfeidhm (sonraítear format).

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

  • component (string) -- seilide URL Comhpháirte

  • language (string) -- Cód teanga aistriúcháin

POST /api/translations/(string: project)/(string: component)/(string: language)/file/

Uaslódáil comhad nua le haistriúcháin.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

  • component (string) -- seilide URL Comhpháirte

  • language (string) -- Cód teanga aistriúcháin

Paraiméadair Fhoirm:

  • string conflicts -- Conas déileáil le coinbhleachtaí (ignore, replace-translated nó replace-approved), féach Coinbhleachtaí a láimhseáil

  • file file -- Comhad uaslódáilte

  • string email -- R-phost an údair

  • string author -- Ainm an údair

  • string method -- Modh uaslódála (translate, approve, suggest, fuzzy, replace, source, add), féach Modhanna allmhairithe

  • string fuzzy -- Próiseáil teaghráin doiléir (marcáilte le haghaidh eagarthóireachta) (folamh, próiseas, faomh)

CURL mar shampla:

curl -X POST \
    -F file=@strings.xml \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/translations/hello/android/cs/file/
GET /api/translations/(string: project)/(string: component)/(string: language)/repository/

Tuairisceáin faisnéis faoi stádas stór VCS.

Tá an freagra mar an gcéanna le haghaidh GET /api/components/(string:project)/(string:component)/repository/.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

  • component (string) -- seilide URL Comhpháirte

  • language (string) -- Cód teanga aistriúcháin

POST /api/translations/(string: project)/(string: component)/(string: language)/repository/

Déanann sé oibríocht tugtha ar an stór VCS.

Féach POST /api/projects/(string:project)/repository/ le haghaidh doiciméadú.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

  • component (string) -- seilide URL Comhpháirte

  • language (string) -- Cód teanga aistriúcháin

Iarr JSON Object:

  • operation (string) -- Oibríocht le déanamh: ceann de `` bhrú``, tarraing, `` tiomnaigh``, `` athshocrú``, glanadh

Freagra JSON Object:

  • result (boolean) -- thoradh na hoibríochta

GET /api/translations/(string: project)/(string: component)/(string: language)/statistics/

Tuairisceáin staitisticí mionsonraithe aistriúcháin.

Paraiméadair:

  • project (string) -- Seilide URL an tionscadail

  • component (string) -- seilide URL Comhpháirte

  • language (string) -- Cód teanga aistriúcháin

See also

Déantar cur síos ar na tréithe a tugadh ar ais i Staitisticí.

Cuimhne

Added in version 4.14.

GET /api/memory/

Seoltar liosta torthaí cuimhne ar ais.

DELETE /api/memory/(int: memory_object_id)/

Scrios réad cuimhne

Paraiméadair:

  • memory_object_id -- Aitheantas Cuspóir Cuimhne

Aonaid

Is éard is unit ann ná píosa aonair d'aistriúchán a phéireálann teaghrán foinse le teaghrán aistrithe comhfhreagrach agus ina bhfuil roinnt meiteashonraí gaolmhara freisin. Díorthaítear an téarma ón translate.storage.base.TranslationUnit in Translate Toolkit agus XLIFF.

GET /api/units/

Seoltar liosta aonad aistriúcháin ar ais.

Paraiméadair:

  • q (string) -- Teaghrán iarratais cuardaigh Cuardach (roghnach)

See also

Déantar tréithe oibiachta aonaid a dhoiciméadú ag GET /api/units/(int:id)/.

GET /api/units/(int: id)/

Changed in version 4.3: Is eagair iad na sprioc agus `` foinse`` anois chun teaghráin iolra a láimhseáil i gceart.

Changed in version 5.6: Tá an tréith last_updated nochta anois.

Filleann sé eolas faoin aonad aistriúcháin.

Paraiméadair:

  • id (int) -- Aitheantas Aonaid

Freagra JSON Object:

  • translation (string) -- URL réad aistriúcháin gaolmhar

  • source (array) -- teaghrán foinse

  • previous_source (string) -- teaghrán foinse roimhe seo a úsáidtear le haghaidh meaitseáil doiléir

  • target (array) -- teaghrán sprice

  • id_hash (string) -- aitheantóir uathúil an aonaid

  • content_hash (string) -- aitheantóir uathúil na teaghrán foinse

  • location (string) -- suíomh an aonaid sa chód foinse

  • context (string) -- comhthéacs aonad aistriúcháin

  • note (string) -- nóta aonad aistriúcháin

  • flags (string) -- bratacha aonad aistriúcháin

  • labels (array) -- lipéid aonad aistriúcháin, ar fáil ar aonaid foinse

  • state (int) -- staid aonaid, 0 - neamhaistrithe, 10 - le heagarthóireacht, 20 - aistrithe, 30 - ceadaithe, 100 - inléite amháin

  • fuzzy (boolean) -- cibé an bhfuil an t-aonad doiléir nó marcáilte le haghaidh athbhreithnithe

  • translated (boolean) -- cibé an aistrítear an t-aonad

  • approved (boolean) -- cibé an bhfuil an t-aistriúchán ceadaithe

  • position (int) -- suíomh aonaid sa chomhad aistriúcháin

  • has_suggestion (boolean) -- an bhfuil moltaí ag an aonad

  • has_comment (boolean) -- cibé an bhfuil tuairimí ag an aonad

  • has_failing_check (boolean) -- cibé an bhfuil seiceálacha teipthe ar an aonad

  • num_words (int) -- líon na bhfocal foinseach

  • priority (int) -- tosaíocht aistriúcháin; Tá 100 réamhshocraithe

  • id (int) -- aitheantóir aonaid

  • explanation (string) -- Míniú teaghrán, ar fáil ar aonaid foinse, féach Eolas breise ar na teaghráin foinse

  • extra_flags (string) -- Bratacha sreangán breise, atá ar fáil ar aonaid foinse, féach Saincheapadh iompar ag baint úsáide as bratacha

  • web_url (string) -- URL inar féidir an t-aonad a chur in eagar

  • source_unit (string) -- Nasc aonaid foinse; féach GET /api/units/(int:id)/

  • pending (boolean) -- cibé an bhfuil an t-aonad ar feitheamh le haghaidh scríobh

  • timestamp (timestamp) -- aois teaghrán

  • last_updated (timestamp) -- nuashonrú teaghrán deiridh

PATCH /api/units/(int: id)/

Added in version 4.3.

Déanann sé nuashonrú páirteach ar aonad aistriúcháin.

Paraiméadair:

  • id (int) -- Aitheantas Aonaid

Iarr JSON Object:
PUT /api/units/(int: id)/

Added in version 4.3.

Nuashonrú iomlán ar aonad aistriúcháin.

Paraiméadair:

  • id (int) -- Aitheantas Aonaid

Iarr JSON Object:
DELETE /api/units/(int: id)/

Added in version 4.3.

Scrios aonad aistriúcháin.

Paraiméadair:

  • id (int) -- Aitheantas Aonaid

GET /api/units/(int: id)/translations/

Added in version 5.11.

Filleann sé liosta de na spriocaonaid aistriúcháin go léir don aonad aistriúcháin foinse a thugtar air.

POST /api/units/(int: id)/comments/

Added in version 5.12.

Cruthaigh trácht nua ar an aonad aistriúcháin tugtha.

Paraiméadair:

  • id (int) -- Aitheantas Aonaid

Iarr JSON Object:

  • scope (string) -- raon feidhme tráchta - domhanda, aistriúchán (ar fáil ar gach aonad neamhfhoinseach), tuarascáil (ní mór sreabhadh oibre athbhreithnithe a chumasú, féach Athbhreithneoirí tiomnaithe)

  • comment (string) -- ábhar an tráchta nua, is féidir leat Markdown a úsáid agus úsáideoirí a lua de réir @ainm úsáideora.

  • user_email (string) -- ríomhphost an tráchtaire, ní féidir ach le riarthóirí tionscadail é seo a shocrú agus is é an t-úsáideoir fíordheimhnithe an réamhshocrú.

  • timestamp (string) -- stampa ama cruthaithe an tráchta, ní féidir ach le riarthóirí tionscadail é seo a shocrú agus is é seo an réamhshocrú.

Freagra JSON Object:

  • id (int) -- aitheantóir tráchta

  • comment (string) -- ábhar an tráchta nua

  • user (string) -- URL réada an tráchtaire

  • timestamp (string) -- stampa ama cruthaithe an tráchta

Athruithe

GET /api/changes/

Changed in version 4.1: Tugadh isteach scagadh athruithe san eisiúint 4.1.

Seoltar liosta athruithe aistriúcháin ar ais.

See also

Déantar tréithe athraithe oibiachta a dhoiciméadú ag GET /api/changes/(int:id)/.

Paraiméadair Iarratas:

  • user (string) -- Ainm úsáideora an úsáideora le scagairí

  • action (int) -- Gníomh a scagadh is féidir, a úsáid arís agus arís eile

  • timestamp_after (timestamp) -- Stampa ama formáidithe ISO 8601 chun athruithe ina dhiaidh sin a liostú

  • timestamp_before (timestamp) -- Stampa ama formáidithe ISO 8601 chun athruithe a liostú roimhe seo

GET /api/changes/(int: id)/

Filleann sé eolas faoin athrú aistriúcháin.

Paraiméadair:

  • id (int) -- Athraigh ID

Freagra JSON Object:

  • unit (string) -- URL réad aonaid gaolmhar

  • translation (string) -- URL réad aistriúcháin gaolmhar

  • component (string) -- URL réad comhpháirte gaolmhar

  • user (string) -- URL réad úsáideora gaolmhar

  • author (string) -- URL oibiachta údair ghaolmhair

  • timestamp (timestamp) -- stampa ama imeachta

  • action (int) -- sainaithint uimhriúil na gníomhaíochta

  • action_name (string) -- cur síos téacs ar an ngníomh

  • target (string) -- imeacht athraithe téacs

  • old (string) -- téacs roimhe seo

  • details (object) -- sonraí breise faoin athrú

  • id (int) -- aitheantóir a athrú

Gabhálacha scáileáin

GET /api/screenshots/

Seoltar ar ais liosta faisnéise teaghrán scáileáin.

See also

Déantar tréithe réad scáileáin a dhoiciméadú ag GET /api/screenshots/(int:id)/.

GET /api/screenshots/(int: id)/

Filleann sé eolas faoin screenshot.

Paraiméadair:

  • id (int) -- ID scáileáin

Freagra JSON Object:
GET /api/screenshots/(int: id)/file/

Íoslódáil an pictiúr ar an scáileán.

Paraiméadair:

  • id (int) -- ID scáileáin

POST /api/screenshots/(int: id)/file/

Ionadaigh íomhá scáileáin.

Paraiméadair:

  • id (int) -- ID scáileáin

Paraiméadair Fhoirm:

  • file image -- Comhad uaslódáilte

CURL mar shampla:

curl -X POST \
    -F image=@image.png \
    -H "Authorization: Token TOKEN" \
    http://example.com/api/screenshots/1/file/
POST /api/screenshots/(int: id)/units/

Comhcheangail teaghrán foinse le seat scáileáin.

Paraiméadair:

  • id (int) -- ID scáileáin

Paraiméadair Fhoirm:

  • string unit_id -- Aitheantas Aonaid

Freagra JSON Object:
DELETE /api/screenshots/(int: id)/units/(int: unit_id)

Bain comhlachas teaghrán foinse leis an ngabháil scáileáin.

Paraiméadair:

  • id (int) -- ID scáileáin

  • unit_id -- Aitheantas aonaid teaghrán foinse

POST /api/screenshots/

Cruthaíonn sé seat nua.

Paraiméadair Fhoirm:

  • file image -- Comhad uaslódáilte

  • string name -- Ainm an scáileáin

  • string project_slug -- Seilide tionscadail

  • string component_slug -- Seilide comhpháirte

  • string language_code -- Cód teanga

Freagra JSON Object:
PATCH /api/screenshots/(int: id)/

Cuir faisnéis pháirteach faoi scáileáin in eagar.

Paraiméadair:

  • id (int) -- ID scáileáin

Freagra JSON Object:
PUT /api/screenshots/(int: id)/

Cuir eolas iomlán faoi scáileáin in eagar.

Paraiméadair:

  • id (int) -- ID scáileáin

Freagra JSON Object:
DELETE /api/screenshots/(int: id)/

Scrios scáileáin.

Paraiméadair:

  • id (int) -- ID scáileáin

Breiseáin

Added in version 4.4.1.

GET /api/addons/

Seoltar liosta breiseán ar ais.

See also

Déantar tréithe oibiachta an bhreiseáin a dhoiciméadú ag GET /api/addons/(int:id)/.

GET /api/addons/(int: id)/

Tuairisceáin faisnéis faoi fhaisnéis bhreiseáin.

Paraiméadair:

  • id (int) -- Aitheantas an bhreiseáin

Freagra JSON Object:

  • name (string) -- ainm an bhreiseáin

  • component (string) -- URL réad comhpháirte gaolmhar

  • configuration (object) -- Cumraíocht an bhreiseáin roghnach

See also

Breiseáin

POST /api/components/(string: project)/(string: component)/addons/

Cruthaíonn sé breiseán nua.

Paraiméadair:

  • project_slug (string) -- Seilide tionscadail

  • component_slug (string) -- Seilide comhpháirte

Iarr JSON Object:

  • name (string) -- ainm an bhreiseáin

  • configuration (object) -- Cumraíocht an bhreiseáin roghnach

PATCH /api/addons/(int: id)/

Cuir faisnéis pháirteach faoi bhreiseán in eagar.

Paraiméadair:

  • id (int) -- Aitheantas an bhreiseáin

Freagra JSON Object:

  • configuration (object) -- Cumraíocht an bhreiseáin roghnach

PUT /api/addons/(int: id)/

Cuir eolas iomlán faoin mbreiseán in eagar.

Paraiméadair:

  • id (int) -- Aitheantas an bhreiseáin

Freagra JSON Object:

  • configuration (object) -- Cumraíocht an bhreiseáin roghnach

DELETE /api/addons/(int: id)/

Scrios an breiseán.

Paraiméadair:

  • id (int) -- Aitheantas an bhreiseáin

Liosta míre

Added in version 4.0.

GET /api/component-lists/

Seoltar liosta liostaí comhpháirteanna ar ais.

See also

Déantar tréithe oibiachta liosta comhpháirte a dhoiciméadú ag GET /api/component-lists/(str:slug)/.

GET /api/component-lists/(str: slug)/

Tuairisceáin faisnéis faoi liosta comhpháirteanna.

Paraiméadair:

  • slug (string) -- Seilide liosta comhpháirte

Freagra JSON Object:

  • name (string) -- ainm liosta comhpháirteanna

  • slug (string) -- slug de liosta comhpháirteanna

  • show_dashboard (boolean) -- cibé acu é a thaispeáint ar an deais

  • components (array) -- nasc le comhpháirteanna gaolmhara; féach GET /api/components/(string:project)/(string:component)/

  • auto_assign (array) -- rialacha sannadh uathoibríoch

PUT /api/component-lists/(str: slug)/

Athruithe ar pharaiméadair liosta na gcomhpháirteanna.

Paraiméadair:

  • slug (string) -- Seilide liosta comhpháirte

Iarr JSON Object:

  • name (string) -- ainm liosta comhpháirteanna

  • slug (string) -- slug de liosta comhpháirteanna

  • show_dashboard (boolean) -- cibé acu é a thaispeáint ar an deais

PATCH /api/component-lists/(str: slug)/

Athruithe ar pharaiméadair liosta na gcomhpháirteanna.

Paraiméadair:

  • slug (string) -- Seilide liosta comhpháirte

Iarr JSON Object:

  • name (string) -- ainm liosta comhpháirteanna

  • slug (string) -- slug de liosta comhpháirteanna

  • show_dashboard (boolean) -- cibé acu é a thaispeáint ar an deais

DELETE /api/component-lists/(str: slug)/

Scrios an liosta comhpháirteanna.

Paraiméadair:

  • slug (string) -- Seilide liosta comhpháirte

GET /api/component-lists/(str: slug)/components/

Added in version 5.0.1: Déan liosta de na comhpháirteanna i liosta comhpháirteanna.

seilide param:

Seilide liosta comhpháirte

cineál seilide:

teaghrán

foirm teaghrán component_id:

Aitheantas na Comhpháirte

>json array results:

sraith rudaí comhpháirteanna; féach GET /api/components/(string:project)/(string:component)/

POST /api/component-lists/(str: slug)/components/

Comhpháirt a chomhcheangal le liosta comhpháirteanna.

Paraiméadair:

  • slug (string) -- Seilide liosta comhpháirte

Paraiméadair Fhoirm:

  • string component_id -- Aitheantas na Comhpháirte

DELETE /api/component-lists/(str: slug)/components/(str: component_slug)

Dícheangail comhpháirt ón liosta comhpháirteanna.

Paraiméadair:

  • slug (string) -- Seilide liosta comhpháirte

  • component_slug (string) -- Seilide comhpháirte

Gluais

Changed in version 4.5: Stóráiltear gluaiseanna anois mar chomhpháirteanna, aistriúcháin agus teaghráin rialta, bain úsáid as an API faoi seach ina ionad sin.

Tascanna

Added in version 4.4.

GET /api/tasks/

Níl liosta de na tascanna ar fáil faoi láthair.

GET /api/tasks/(str: uuid)/

Filleann sé eolas faoi thasc.

Paraiméadair:

  • uuid (string) -- Tasc UUID

Freagra JSON Object:

  • completed (boolean) -- Cibé an bhfuil an tasc críochnaithe

  • progress (int) -- Dul chun cinn tasc i faoin gcéad

  • result (object) -- Toradh an taisc nó sonraí dul chun cinn

  • log (string) -- Logchomhad tascanna

Staitisticí

GET /api/(str: object)/statistics/

Tá roinnt críochphointí staitisticí ann do réada agus tá an struchtúr céanna iontu ar fad.

Paraiméadair:

  • object (string) -- Conair URL

Freagra JSON Object:

  • total (int) -- líon iomlán na teaghráin

  • total_words (int) -- líon iomlán na bhfocal

  • total_chars (int) -- líon iomlán na gcarachtar

  • last_change (timestamp) -- dáta an athraithe dheireanaigh

  • translated (int) -- líon teaghráin aistrithe

  • translated_percent (float) -- céatadán de na teaghráin aistrithe

  • translated_words (int) -- líon na bhfocal aistrithe

  • translated_words_percent (float) -- céatadán de na focail aistrithe

  • translated_chars (int) -- líon na gcarachtar aistrithe

  • translated_chars_percent (float) -- céatadán de charachtair aistrithe

  • fuzzy (int) -- líon na teaghrán doiléir (marcáilte le haghaidh eagarthóireacht)

  • fuzzy_words (int) -- líon na bhfocal doiléir (marcáilte le cur in eagar)

  • fuzzy_chars (int) -- líon na gcarachtar doiléir (marcáilte le cur in eagar)

  • fuzzy_percent (float) -- céatadán de na teaghráin doiléir (marcáilte le haghaidh eagarthóireacht)

  • fuzzy_words_percent (float) -- céatadán na bhfocal doiléir (marcáilte le cur in eagar)

  • fuzzy_chars_percent (float) -- céatadán de charachtair doiléir (marcáilte le haghaidh eagarthóireachta)

  • failing (int) -- líon na seiceálacha a dteipeann orthu

  • failing_percent (float) -- céatadán de sheiceanna a dteipeann orthu

  • approved (int) -- líon teaghráin cheadaithe

  • approved_words (int) -- líon na bhfocal ceadaithe

  • approved_chars (int) -- líon na gcarachtar ceadaithe

  • approved_percent (float) -- céatadán de na teaghráin cheadaithe

  • approved_words_percent (float) -- céatadán na bhfocal ceadaithe

  • approved_chars_percent (float) -- céatadán de charachtair ceadaithe

  • readonly (int) -- líon teaghráin inléite amháin

  • readonly_words (int) -- líon na bhfocal inléite amháin

  • readonly -- líon na gcarachtar inléite amháin

  • readonly_percent (float) -- céatadán de na teaghráin inléite amháin

  • readonly_words_percent (float) -- céatadán na bhfocal inléite amháin

  • readonly_char_percent (float) -- céatadán de charachtair inléite amháin

  • suggestions (int) -- líon teaghráin le moltaí

  • comments (int) -- líon teaghráin le tuairimí

  • name (string) -- ainm réad

  • url (string) -- URL chun an réad a rochtain (má bhaineann)

  • url_translate (string) -- URL chun rochtain a fháil ar an aistriúchán (má bhaineann)

  • code (string) -- cód teanga (má bhaineann)

See also

GET /api/languages/(string:language)/statistics/, GET /api/projects/(string:project)/statistics/, GET /api/categories/(int:id)/statistics/, GET /api/components/(string:project)/(string:component)/statistics/, GET /api/translations/(string:project)/(string:component)/(string:language)/statistics/

Méadracht

GET /api/metrics/

Tuairisceáin méadracht freastalaí.

Changed in version 5.6.1: Is féidir méadracht a nochtadh anois i bhformáid atá comhoiriúnach le OpenMetrics le ?format=openmetrics.

Freagra JSON Object:

  • units (int) -- Líon na n-aonad

  • units_translated (int) -- Líon na n-aonad aistrithe

  • users (int) -- Líon na n-úsáideoirí

  • changes (int) -- Uimhir na n-athruithe

  • projects (int) -- Líon na dtionscadal

  • components (int) -- Líon na gcomhpháirteanna

  • translations (int) -- Líon na n-aistriúchán

  • languages (int) -- Líon na dteangacha a úsáidtear

  • checks (int) -- Líon na seiceálacha cáilíochta spreagtha

  • configuration_errors (int) -- Líon na n-earráidí cumraíochta

  • suggestions (int) -- Líon moltaí ar feitheamh

  • celery_queues (object) -- Fad na scuainí Soilire, féach Tascanna cúlra ag baint úsáide as Soilire

  • name (string) -- Ainm freastalaí cumraithe

Catagóirí

GET /api/categories/

Added in version 5.0.

Liostaíonn na catagóirí atá ar fáil. Féach GET /api/categories/(int:id)/ le haghaidh sainmhínithe réimse.

POST /api/categories/

Added in version 5.0.

Cruthaíonn catagóir nua. Féach GET /api/categories/(int:id)/ le haghaidh sainmhínithe réimse.

GET /api/categories/(int: id)/

Added in version 5.0.

Paraiméadair:

  • id (int) -- Aitheantas na catagóire

Freagra JSON Object:

  • name (str) -- Ainm na catagóire.

  • slug (str) -- Drúchtín na catagóire.

  • project (str) -- Nasc le tionscadal.

  • category (str) -- Nasc le catagóir tuismitheora.

PATCH /api/categories/(int: id)/

Added in version 5.0: Cuir faisnéis pháirteach faoin gcatagóir in eagar.

param id:

Aitheantas na catagóire

cineál aitheantais:

slánuimhir

>json object configuration:

Cumraíocht chatagóir roghnach

PUT /api/categories/(int: id)/

Added in version 5.0: Cuir eolas iomlán faoin gcatagóir in eagar.

param id:

Aitheantas na catagóire

cineál aitheantais:

slánuimhir

>json object configuration:

Cumraíocht chatagóir roghnach

DELETE /api/categories/(int: id)/

Added in version 5.0: Scrios catagóir.

param id:

Aitheantas na catagóire

cineál aitheantais:

slánuimhir

GET /api/categories/(int: id)/statistics/

Added in version 5.5.

Tuairisceáin staitisticí do chatagóir.

Paraiméadair:

  • project (int) -- Aitheantas na catagóire

See also

Déantar cur síos ar na tréithe a tugadh ar ais i Staitisticí.

Crúcaí fógra

Ligeann crúcaí fógra d’fheidhmchláir sheachtracha a chur in iúl do Weblate go bhfuil an stór VCS nuashonraithe.

Is féidir leat críochphointí stórtha a úsáid le haghaidh tionscadal, comhpháirteanna agus aistriúcháin chun stórtha aonair a nuashonrú; féach POST /api/projects/(string:project)/repository/ le haghaidh doiciméadú.

GET /hooks/update/(string: project)/(string: component)/

Deprecated since version 2.6: Bain úsáid as POST /api/components/(string:project)/(string:component)/repository/ ina ionad sin a oibríonn i gceart le fíordheimhniú do thionscadail teoranta ACL.

Spreagann sé comhpháirt a nuashonrú (ag tarraingt ó VCS agus ag scanadh le haghaidh athruithe aistriúcháin).

GET /hooks/update/(string: project)/

Deprecated since version 2.6: Úsáid POST /api/projects/(string:project)/repository/ ina ionad sin a oibríonn i gceart le fíordheimhniú do thionscadail teoranta ACL.

Spreagann sé nuashonrú ar gach comhpháirt i dtionscadal (ag tarraingt ó VCS agus scanadh le haghaidh athruithe aistriúcháin).

POST /hooks/github/

Hook speisialta chun fógraí GitHub a láimhseáil agus chun comhpháirteanna meaitseála a nuashonrú go huathoibríoch.

Note

Cuimsíonn GitHub tacaíocht dhíreach chun Weblate a chur ar an eolas: cumasaigh hook seirbhíse Weblate i socruithe stórtha agus socraigh an URL chuig URL do shuiteáil Weblate.

See also

Ag fáil athruithe go huathoibríoch ó GitHub

Le haghaidh treoir maidir le comhtháthú GitHub a bhunú

https://docs.github.com/en/get-started/customizing-your-github-workflow/exploring-integrations/about-webhooks

Eolas cineálach faoi GitHub Webhooks

ENABLE_HOOKS

Chun crúcaí a chumasú le haghaidh Weblate iomlán

POST /hooks/gitlab/

Hook speisialta chun fógraí GitLab a láimhseáil agus chun comhpháirteanna meaitseála a nuashonrú go huathoibríoch.

See also

Ag fáil athruithe go huathoibríoch ó GitLab

Chun treoir a fháil maidir le comhtháthú GitLab a bhunú

https://docs.gitlab.com/user/project/integrations/webhooks/

Eolas cineálach faoi GitLab Webhooks

ENABLE_HOOKS

Chun crúcaí a chumasú le haghaidh Weblate iomlán

POST /hooks/bitbucket/

Hook speisialta chun fógraí Bitbucket a láimhseáil agus chun comhpháirteanna meaitseála a nuashonrú go huathoibríoch.

See also

Athruithe a fháil go huathoibríoch ó Bitbucket

Chun treoir a fháil maidir le comhtháthú Bitbucket a bhunú

https://support.atlassian.com/bitbucket-cloud/docs/manage-webhooks/

Eolas cineálach faoi Bitbucket Webhooks

ENABLE_HOOKS

Chun crúcaí a chumasú le haghaidh Weblate iomlán

POST /hooks/pagure/

Hook speisialta chun fógraí Pagure a láimhseáil agus chun comhpháirteanna meaitseála a nuashonrú go huathoibríoch.

See also

Athruithe a fháil go huathoibríoch ó Pagure

Chun treoir a fháil maidir le comhtháthú Pagure a bhunú

https://docs.pagure.org/pagure/usage/using_webhooks.html

Eolas cineálach faoi Pagure Webhooks

ENABLE_HOOKS

Chun crúcaí a chumasú le haghaidh Weblate iomlán

POST /hooks/azure/

Hook speisialta chun fógraí Azure DevOps a láimhseáil agus chun comhpháirteanna meaitseála a nuashonrú go huathoibríoch.

Note

Déan cinnte le do thoil go bhfuil Resource details to send socraithe uir All, ar shlí eile ní bheidh Weblate in ann do stór Azure a mheaitseáil.

See also

Athruithe a fháil go huathoibríoch ó Azure Repos

Le haghaidh treorach maidir le comhtháthú Azure a bhunú

https://learn.microsoft.com/en-us/azure/devops/service-hooks/services/webhooks?view=azure-devops

Eolas cineálach faoi Azure DevOps Web Hooks

ENABLE_HOOKS

Chun crúcaí a chumasú le haghaidh Weblate iomlán

POST /hooks/gitea/

Hook speisialta chun fógraí Gitea Webhook a láimhseáil agus chun comhpháirteanna meaitseála a nuashonrú go huathoibríoch.

See also

Athruithe a fháil go huathoibríoch ó Gitea Repos

Chun treoir a fháil maidir le comhtháthú Gitea a bhunú

https://docs.gitea.io/en-us/webhooks/

Eolas cineálach faoi Gitea Webhooks

ENABLE_HOOKS

Chun crúcaí a chumasú le haghaidh Weblate iomlán

POST /hooks/gitee/

Hook speisialta chun fógraí Gitee Webhook a láimhseáil agus chun comhpháirteanna meaitseála a nuashonrú go huathoibríoch.

See also

Athruithe a fháil go huathoibríoch ó Gitee Repos

Chun treoir a fháil maidir le comhtháthú Gitee a bhunú

https://gitee.com/help/categories/40

Eolas cineálach faoi Gitee Webhooks

ENABLE_HOOKS

Chun crúcaí a chumasú le haghaidh Weblate iomlán

Fothaí RSS

Easpórtáiltear athruithe ar aistriúcháin i bhfothaí RSS.

GET /exports/rss/(string: project)/(string: component)/(string: language)/

Aisghabhann fotha RSS le hathruithe le déanaí le haghaidh aistriúcháin.

GET /exports/rss/(string: project)/(string: component)/

Aisghabhann fotha RSS le hathruithe le déanaí do chomhpháirt.

GET /exports/rss/(string: project)/

Aisghabhann fotha RSS le hathruithe le déanaí do thionscadal.

GET /exports/rss/language/(string: language)/

Aisghabhann fotha RSS le hathruithe le déanaí do theanga.

GET /exports/rss/

Aisghabhann fotha RSS le hathruithe le déanaí do shampla Weblate.

See also

RSS ar Vicipéid