Weblate REST API

Az API a /api/ URL-en érhető el, és a Django REST framework alapjaira épül. Közvetlenül vagy a Weblate kliens segítségével használható.

Az API dokumentációja az OpenAPI 3.1 szabvány szerint a /api/schema/ URL-en található, böngészhető formában a /api/docs/ alatt érhető el.

Megjegyzés

Az OpenAPI funkció előzetes verzióban érhető el. A dokumentáció ebben a szakaszban még hiányos lehet és változhat. A részletesebb információkért nézze meg az alábbi dokumentációt.

Hitelesítés és általános paraméterek

The read-only API is available without authentication unless REQUIRE_LOGIN is turned on. Unauthenticated requests are heavily throttled (by default to 100 requests per day), so it is recommended to use authentication.

The authentication uses a token, which you can get in your profile. Use it in the Authorization header:

ANY /

Általános kéréskezelési szabályok az API-hoz: a fejléc, státuszkódok és paraméterek minden végpontra érvényesek.

Lekérdezési paraméterek:

  • format – Response format (overrides Accept). Possible values depends on REST framework setup, by default json, csv and api are supported. The latter provides web browser interface for API.

  • page – Visszaadja az adott oldal eredményeit lapozható formában (a next és previous mezők segítségével automatizálható a navigáció).

  • page_size – Visszaadja a kért számú elemet lekérésenként. Az alapértelmezett érték 50, maximum 1000. Az units végpontoknál az alapértelmezés 100, maximum 10000. Az alapértelmezés módosítható a PAGE_SIZE beállítással.

Kérésfejlécek:

  • Accept – a válasz tartalomtípusa az Accept fejléc alapján kerül meghatározásra

  • Authorization – hitelesítéshez opcionális token: Authorization: Token YOUR-TOKEN

Válaszfejlécek:

  • Content-Type – ez a kérés az Accept fejlécétől függ

  • Allow – az objektumon engedélyezett HTTP-módszerek listája

Válasz JSON-objektum:

  • detail (string) – az eredmény részletes leírása (HTTP státuszkódok esetén, amelyek nem 200 OK)

  • count (int) – objektumlisták teljes elem száma

  • next (string) – objektumlisták következő oldalának URL-je

  • previous (string) – objektumlisták előző oldalának URL-je

  • results (array) – objektumlisták eredményei

  • url (string) – URL az erőforrás eléréséhez API-n keresztül

  • web_url (string) – URL az erőforrás eléréséhez webböngészőn keresztül

Státuszkódok:

Hitelesítési tokenek

A 4.10 verzióban változott: A projektszintű tokenek a 4.10-es kiadásban kerültek bevezetésre.

Minden felhasználónak van személyes hozzáférési tokenje, amely a felhasználói profiljában szerezhető be. Az újonnan generált felhasználói tokenek wlu_ előtaggal rendelkeznek.

Lehetőség van projektszintű tokenek létrehozására, amelyek kizárólag az adott projekthez biztosítanak API-hozzáférést. Ezek a tokenek wlp_ előtaggal azonosíthatók.

Lásd még

Hitelesítési példák

Példa kérés:

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

Példa válasz:

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 példa:

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

Paraméterek átadásának példái

A POST módszer esetén a paraméterek megadhatók űrlapbeküldéssel (application/x-www-form-urlencoded) vagy JSON formátumban (application/json).

Űrlap alapú kérés példa:

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

JSON alapú kérés példa:

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 példa:

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

CURL JSON példa:

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

Összetevők és kategóriák

To access a component which is nested inside a Kategória, 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/.

API lekérdezési korlátozás

Az API kérések korlátozva vannak; az alapértelmezett beállítások szerint anonim felhasználók napi 100 kérést, hitelesített felhasználók óránként 5000 kérést indíthatnak.

A korlátozás beállítható a settings.py fájlban; részletes konfigurációs útmutatóért lásd a Django REST framework dokumentációját a Throttling fejezetben.

Docker-konténer használata esetén a WEBLATE_API_RATELIMIT_ANON és WEBLATE_API_RATELIMIT_USER változókkal szabályozható.

A korlátozási állapotot az alábbi fejlécek jelentik:

X-RateLimit-Limit

Az engedélyezett kérések száma

X-RateLimit-Remaining

A fennmaradó kérések száma

X-RateLimit-Reset

Másodpercek száma a korlátozási ablak visszaállásáig

A 4.1 verzióban változott: Hozzáadva a lekérdezési korlátozás állapotát jelző fejlécek.

Lásd még

Hibaválaszok

A 5.10 verzióban változott: A hibaválaszok korábban végpontspecifikusak voltak.

A Weblate hibaválaszai mostantól a Error Response Format szabvány alapján kerülnek formázásra.

API belépési pont

GET /api/

Az API gyökér belépési pontja.

Példa kérés:

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

Példa válasz:

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/"
}

Felhasználók

Added in version 4.0.

GET /api/users/

A felhasználók listáját adja vissza, ha rendelkezik a felhasználók kezelésére vonatkozó jogosultsággal. Ha nem, akkor csak a saját adatait láthatja.

Lekérdezési paraméterek:

  • username (string) – Keresés felhasználónév alapján

  • id (int) – Keresés felhasználói azonosító (ID) alapján

Lásd még

A felhasználó objektum attribútumai dokumentálva vannak itt: GET /api/users/(str:username)/.

POST /api/users/

Új felhasználó létrehozása.

Paraméterek:

  • username (string) – Felhasználónév

  • full_name (string) – Felhasználó teljes neve

  • email (string) – Felhasználó e-mail címe

  • is_superuser (boolean) – Rendszergazda jogosultságú felhasználó? (opcionális)

  • is_active (boolean) – Aktív felhasználó? (opcionális)

  • is_bot (boolean) – Bot felhasználó? (opcionális) (projektszintű tokenekhez használható)

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

Felhasználók adatainak lekérdezése.

Paraméterek:

  • username (string) – Felhasználó felhasználóneve

Válasz JSON-objektum:

  • username (string) – felhasználóneve egy felhasználónak

  • full_name (string) – felhasználó teljes neve

  • email (string) – felhasználó e-mail címe

  • is_superuser (boolean) – a felhasználó rendszergazda-e

  • is_active (boolean) – a felhasználó aktív-e

  • is_bot (boolean) – a felhasználó bot-e (projektszintű tokenekhez használható)

  • date_joined (string) – a felhasználó létrehozásának dátuma

  • last_login (string) – a felhasználó utolsó bejelentkezésének dátuma

  • groups (array) – kapcsolódó csoportok hivatkozása; lásd: GET /api/groups/(int:id)/

  • languages (array) – hivatkozás a lefordított nyelvekre, lásd: GET /api/languages/(string:language)/

Példa JSON adatok:

{
    "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)/

Felhasználói paraméterek módosítása.

Paraméterek:

  • username (string) – Felhasználó felhasználóneve

Válasz JSON-objektum:

  • username (string) – felhasználóneve egy felhasználónak

  • full_name (string) – felhasználó teljes neve

  • email (string) – felhasználó e-mail címe

  • is_superuser (boolean) – a felhasználó rendszergazda-e

  • is_active (boolean) – a felhasználó aktív-e

  • is_bot (boolean) – a felhasználó bot-e (projektszintű tokenekhez használható)

  • date_joined (string) – a felhasználó létrehozásának dátuma

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

Felhasználói paraméterek módosítása.

Paraméterek:

  • username (string) – Felhasználó felhasználóneve

Válasz JSON-objektum:

  • username (string) – felhasználóneve egy felhasználónak

  • full_name (string) – felhasználó teljes neve

  • email (string) – felhasználó e-mail címe

  • is_superuser (boolean) – a felhasználó rendszergazda-e

  • is_active (boolean) – a felhasználó aktív-e

  • is_bot (boolean) – a felhasználó bot-e (projektszintű tokenekhez használható)

  • date_joined (string) – a felhasználó létrehozásának dátuma

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

Felhasználói adatok törlése és a felhasználó inaktívvá tétele.

Paraméterek:

  • username (string) – Felhasználó felhasználóneve

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

Felhasználó társítása csoportokhoz.

Paraméterek:

  • username (string) – Felhasználó felhasználóneve

Űrlapparaméterek:

  • string group_id – A csoport egyedi azonosítója

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

Added in version 4.13.1.

Felhasználó eltávolítása egy csoportból.

Paraméterek:

  • username (string) – Felhasználó felhasználóneve

Űrlapparaméterek:

  • string group_id – A csoport egyedi azonosítója

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

Felhasználó statisztikáinak listázása.

Paraméterek:

  • username (string) – Felhasználó felhasználóneve

Válasz JSON-objektum:

  • translated (int) – Felhasználó által végzett fordítások száma

  • suggested (int) – Felhasználó által tett javaslatok száma

  • uploaded (int) – Felhasználó által végzett feltöltések száma

  • commented (int) – Felhasználó által írt megjegyzések száma

  • languages (int) – Felhasználó által fordítható nyelvek száma

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

Fordítások listázása adott felhasználó közreműködéseivel.

Paraméterek:

  • username (string) – Felhasználó felhasználóneve

Válasz JSON-objektum:
GET /api/users/(str: username)/notifications/

Felhasználó előfizetéseinek listázása.

Paraméterek:

  • username (string) – Felhasználó felhasználóneve

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

Felhasználó előfizetéseinek társítása.

Paraméterek:

  • username (string) – Felhasználó felhasználóneve

Kérés JSON-objektum:

  • notification (string) – Regisztrált értesítés neve

  • scope (int) – Értesítés hatóköre a megadott lehetőségek közül

  • frequency (int) – Értesítések gyakorisági beállításai

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

Felhasználóhoz társított előfizetés lekérdezése.

Paraméterek:

  • username (string) – Felhasználó felhasználóneve

  • subscription_id (int) – Regisztrált értesítés azonosítója

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

Felhasználóhoz társított előfizetés szerkesztése.

Paraméterek:

  • username (string) – Felhasználó felhasználóneve

  • subscription_id (int) – Regisztrált értesítés azonosítója

Kérés JSON-objektum:

  • notification (string) – Regisztrált értesítés neve

  • scope (int) – Értesítés hatóköre a megadott lehetőségek közül

  • frequency (int) – Értesítések gyakorisági beállításai

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

Felhasználóhoz társított előfizetés szerkesztése.

Paraméterek:

  • username (string) – Felhasználó felhasználóneve

  • subscription_id (int) – Regisztrált értesítés azonosítója

Kérés JSON-objektum:

  • notification (string) – Regisztrált értesítés neve

  • scope (int) – Értesítés hatóköre a megadott lehetőségek közül

  • frequency (int) – Értesítések gyakorisági beállításai

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

Felhasználóhoz társított előfizetés törlése.

Paraméterek:

  • username (string) – Felhasználó felhasználóneve

  • subscription_id – Regisztrált értesítés neve

  • subscription_id – int

Csoportok

Added in version 4.0.

GET /api/groups/

A csoportok listáját adja vissza, ha rendelkezik a csoportok kezelésére vonatkozó jogosultsággal. Ha nem, akkor csak azokat a csoportokat látja, amelyeknek a felhasználó tagja.

Lásd még

A csoport objektum attribútumai dokumentálva vannak itt: GET /api/groups/(int:id)/.

POST /api/groups/

Új csoport létrehozása.

Paraméterek:
GET /api/groups/(int: id)/

A csoport adatait adja vissza.

Paraméterek:

  • id (int) – Csoport azonosítója

Válasz JSON-objektum:

Példa JSON adatok:

{
    "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/"
    ],
    "admins": [
        "http://example.com/api/users/exampleusername/"
    ]
}
PUT /api/groups/(int: id)/

Csoport paramétereinek módosítása.

Paraméterek:

  • id (int) – Csoport azonosítója

Válasz JSON-objektum:

  • name (string) – csoport neve

  • project_selection (int) – a projektek csoportjához tartozó egész szám

  • language_selection (int) – a nyelvek csoportjához tartozó egész szám

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

Csoport paramétereinek módosítása.

Paraméterek:

  • id (int) – Csoport azonosítója

Válasz JSON-objektum:

  • name (string) – csoport neve

  • project_selection (int) – a projektek csoportjához tartozó egész szám

  • language_selection (int) – a nyelvek csoportjához tartozó egész szám

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

Csoport törlése.

Paraméterek:

  • id (int) – Csoport azonosítója

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

Szerepkörök társítása egy csoporthoz.

Paraméterek:

  • id (int) – Csoport azonosítója

Űrlapparaméterek:

  • string role_id – A szerepkör egyedi azonosítója

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

Szerepkör eltávolítása a csoportból.

Paraméterek:

  • id (int) – Csoport azonosítója

  • role_id (int) – A szerepkör egyedi azonosítója

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

Összetevők társítása egy csoporthoz.

Paraméterek:

  • id (int) – Csoport azonosítója

Űrlapparaméterek:

  • string component_id – Az összetevő egyedi azonosítója

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

Összetevő eltávolítása a csoportból.

Paraméterek:

  • id (int) – Csoport azonosítója

  • component_id (int) – Az összetevő egyedi azonosítója

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

Projektek társítása egy csoporthoz.

Paraméterek:

  • id (int) – Csoport azonosítója

Űrlapparaméterek:

  • string project_id – A projekt egyedi azonosítója

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

Projekt eltávolítása a csoportból.

Paraméterek:

  • id (int) – Csoport azonosítója

  • project_id (int) – A projekt egyedi azonosítója

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

Nyelvek társítása egy csoporthoz.

Paraméterek:

  • id (int) – Csoport azonosítója

Űrlapparaméterek:

  • string language_code – A nyelv egyedi kódja

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

Nyelv eltávolítása a csoportból.

Paraméterek:

  • id (int) – Csoport azonosítója

  • language_code (string) – A nyelv egyedi kódja

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

Összetevőlisták társítása egy csoporthoz.

Paraméterek:

  • id (int) – Csoport azonosítója

Űrlapparaméterek:

  • string component_list_id – Az összetevőlista egyedi azonosítója

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

Összetevőlista eltávolítása a csoportból.

Paraméterek:

  • id (int) – Csoport azonosítója

  • component_list_id (int) – Az összetevőlista egyedi azonosítója

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

Added in version 5.5.

Felhasználó hozzáadása a csapat adminisztrátoraihoz.

Paraméterek:

  • id (int) – Csoport azonosítója

Űrlapparaméterek:

  • string user_id – A felhasználó azonosítója

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

Added in version 5.5.

Felhasználó eltávolítása a csapat adminisztrátorai közül.

Paraméterek:

  • id (int) – Csoport azonosítója

  • user_id (integer) – A felhasználó azonosítója

Szerepkörök

GET /api/roles/

A felhasználóhoz társított összes szerepkör listázása. Ha a felhasználó rendszergazda, akkor az összes létező szerepkör megjelenik.

Lásd még

A szerepkör objektum attribútumai dokumentálva vannak itt: GET /api/roles/(int:id)/.

POST /api/roles/

Új szerepkör létrehozása.

Paraméterek:

  • name (string) – Szerepkör neve

  • permissions (array) – A jogosultságok kódneveinek listája

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

A szerepkör adatainak visszaadása.

Paraméterek:

  • id (int) – A szerepkör azonosítója

Válasz JSON-objektum:

  • name (string) – Szerepkör neve

  • permissions (array) – a jogosultságok kódneveinek listája

Példa JSON adatok:

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

A szerepkör paramétereinek módosítása.

Paraméterek:

  • id (int) – A szerepkör azonosítója

Válasz JSON-objektum:

  • name (string) – Szerepkör neve

  • permissions (array) – a jogosultságok kódneveinek listája

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

A szerepkör paramétereinek módosítása.

Paraméterek:

  • id (int) – A szerepkör azonosítója

Válasz JSON-objektum:

  • name (string) – Szerepkör neve

  • permissions (array) – a jogosultságok kódneveinek listája

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

A szerepkör törlése.

Paraméterek:

  • id (int) – A szerepkör azonosítója

Nyelvek

GET /api/languages/

Az összes nyelv listázása.

Lásd még

A nyelv objektum attribútumai dokumentálva vannak itt: GET /api/languages/(string:language)/.

POST /api/languages/

Új nyelv létrehozása.

Paraméterek:

  • code (string) – Nyelv neve

  • name (string) – Nyelv neve

  • direction (string) – Írásirány

  • population (int) – Beszélők száma

  • plural (object) – Nyelv többes szám képlete és száma

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

A nyelv adatainak visszaadása.

Paraméterek:

  • language (string) – Nyelvi kód

Válasz JSON-objektum:

  • code (string) – Nyelvi kód

  • direction (string) – Írásirány

  • plural (object) – A nyelv többes szám adatait tartalmazó objektum

  • aliases (array) – A nyelvhez tartozó álnevek tömbje

Kérés JSON-objektum:

  • population (int) – Beszélők száma

Példa JSON adatok:

{
    "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)/

A nyelv paramétereinek módosítása.

Paraméterek:

  • language (string) – A nyelv kódja

Kérés JSON-objektum:

  • name (string) – Nyelv neve

  • direction (string) – Írásirány

  • population (int) – Beszélők száma

  • plural (object) – A nyelv többes szám információi

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

A nyelv paramétereinek módosítása.

Paraméterek:

  • language (string) – A nyelv kódja

Kérés JSON-objektum:

  • name (string) – Nyelv neve

  • direction (string) – Írásirány

  • population (int) – Beszélők száma

  • plural (object) – A nyelv többes szám információi

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

A nyelv törlése.

Paraméterek:

  • language (string) – A nyelv kódja

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

A nyelv statisztikáinak visszaadása.

Paraméterek:

  • language (string) – Nyelvi kód

Lásd még

Returned attributes are described in Statisztikák.

Projektek

GET /api/projects/

Az összes projekt listázása.

Lásd még

A projekt objektum attribútumai dokumentálva vannak itt: GET /api/projects/(string:project)/.

POST /api/projects/

Új projekt létrehozása.

Paraméterek:

  • name (string) – Projekt neve

  • slug (string) – Projekt URL-azonosító (slug)

  • web (string) – Projekt webhelye

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

A projekt adatainak visszaadása.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

Válasz JSON-objektum:

Példa JSON adatok:

{
    "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.

Projekt szerkesztése PATCH kérés segítségével.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

  • component (string) – Összetevő URL-azonosítója (slug)

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

Added in version 4.3.

Projekt szerkesztése PUT kérés segítségével.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

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

Projekt törlése.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

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

Projektváltozások listájának visszaadása. Ez lényegében egy projektszintű GET /api/changes/, azonos paraméterekkel.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

Válasz JSON-objektum:
GET /api/projects/(string: project)/file/

Added in version 5.5.

Az összes elérhető fordítás letöltése a projekthez archivált fájlformátumban, a megadott formátumban és nyelven.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

Lekérdezési paraméterek:

  • format (string) – A használandó archívumformátum; ha nincs megadva, az alapértelmezett a zip. Támogatott formátumok: zip és zip:CONVERSION, ahol a CONVERSION az átalakítók közül választható, lásd: Fordítások letöltése.

  • language_code (string) – A letöltendő nyelv kódja; ha nincs megadva, minden nyelv belekerül.

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

A VCS-tároló állapotának visszaadása. Ez a végpont csak általános összefoglalót tartalmaz a projekt minden tárolójára nézve. Részletesebb állapotért használja: GET /api/components/(string:project)/(string:component)/repository/.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

Válasz JSON-objektum:

  • needs_commit (boolean) – vannak-e függőben lévő véglegesítések (commit)

  • needs_merge (boolean) – vannak-e a forrás tárolóból származó egyesítendő változások (merge)

  • needs_push (boolean) – vannak-e helyi módosítások, amelyeket fel kell tölteni (push)

Példa JSON adatok:

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

A megadott művelet végrehajtása a VCS-tárolón.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

Kérés JSON-objektum:

  • operation (string) – Végrehajtandó művelet: lehet push, pull, commit, reset, cleanup, file-sync, file-scan

Válasz JSON-objektum:

  • result (boolean) – a művelet eredménye

CURL példa:

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

JSON alapú kérés példa:

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"}

Példa JSON válasz:

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/

A megadott projekt fordítási összetevőinek listáját adja vissza.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

Válasz JSON-objektum:
POST /api/projects/(string: project)/components/

A 4.3 verzióban változott: A zipfile és docfile paraméterek mostantól VCS nélküli összetevők esetében is használhatók, lásd: Helyi fájlok.

A 4.6 verzióban változott: A klónozott tárolók mostantól automatikusan megosztásra kerülnek a projekten belül a Weblate belső URL-ek használatával. A megosztás kikapcsolásához használja a disable_autoshare beállítást.

Új fordítási összetevők létrehozása a megadott projektben.

Tipp

Több összetevő létrehozása esetén használja a Weblate belső URL-ek funkciót egyetlen VCS tárolóból való létrehozáshoz.

Megjegyzés

Az összetevők többségének létrehozása háttérfolyamatban történik. Az elkészült összetevő task_url attribútumát követve ellenőrizhető a folyamat állapota.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

Űrlapparaméterek:

  • file zipfile – ZIP-fájl feltöltése a Weblate rendszerébe a fordítások inicializálásához

  • file docfile – Lefordítandó dokumentum

  • boolean disable_autoshare – Automatikus tárolómegosztás letiltása a Weblate belső URL-ek használatával.

Kérés JSON-objektum:
Válasz JSON-objektum:

A fájlok feltöltésekor (zipfile és docfile paraméterek használatával) a JSON nem alkalmazható. Az adatokat multipart/form-data formátumban kell feltölteni.

CURL űrlap alapú kérés példa:

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 JSON kérés példa:

curl \
    --data-binary '{
        "branch": "main",
        "file_format": "po",
        "file_format_params": {
            "po_line_wrap": 65535,
            "po_no_location": true
        },
        "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/

JSON kérés új összetevő létrehozására Git tárolóból:

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",
    "file_format_params": {
        "po_line_wrap": 65535,
        "po_no_location": true
    },
    "filemask": "po/*.po",
    "name": "Weblate",
    "slug": "weblate",
    "repo": "https://github.com/WeblateOrg/hello.git",
    "template": "",
    "new_base": "po/hello.pot",
    "vcs": "git"
}

JSON kérés új összetevő létrehozására meglévő összetevőből:

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"
}

Példa JSON válasz:

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",
    "file_format_params": {
        "po_line_wrap": 65535,
        "po_no_location": true
    },
    "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/

Lapozott statisztikák visszaadása a projekt összes nyelvére vonatkozóan.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

Válasz JSON-objektum:

  • results (array) – fordítási statisztika objektumok tömbje

  • language (string) – nyelv neve

  • code (string) – nyelv kódja

  • total (int) – összes szöveg száma

  • translated (int) – lefordított szövegek száma

  • translated_percent (float) – lefordított szövegek aránya

  • total_words (int) – összes szó száma

  • translated_words (int) – lefordított szavak száma

  • words_percent (float) – lefordított szavak aránya

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

Projekt statisztikáinak visszaadása.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

Lásd még

Returned attributes are described in Statisztikák.

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

Added in version 5.0: Projekt kategóriáinak visszaadása. A mezők leírását lásd: GET /api/categories/(int:id)/.

param projekt:

Projekt URL-azonosítója (slug)

típus projekt:

szöveg

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

Added in version 5.3: Projekt címkéinek visszaadása.

param projekt:

Projekt URL-azonosítója (slug)

típus projekt:

szöveg

>json int id:

címke azonosítója

>json string name:

címke neve

>json string color:

címke színe

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

Added in version 5.3: Címke létrehozása egy projekthez.

param projekt:

Projekt URL-azonosítója (slug)

típus projekt:

szöveg

<json string name:

címke neve

<json string color:

címke színe

DELETE /api/projects/(string: project)/labels/(int: label_id)/

Added in version 5.14: Deletes a label from a project.

param projekt:

Projekt URL-azonosítója (slug)

típus projekt:

szöveg

param label_id:

ID of the label to delete

type label_id:

integer

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

Közreműködők elismeréseinek visszaadása egy projekthez.

Added in version 5.7.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

  • start (date) – Alsó (kezdő) időbélyeg-határ ISO 8601 formátumban (kötelező)

  • end (date) – Felső időbélyeg-határ ISO 8601 formátumban (kötelező)

  • lang (source_language) – Nyelvkód keresése

Válasz JSON-objektum:

  • email (string) – Közreműködő e-mail címe

  • full_name (string) – Közreműködő teljes neve

  • change_count (string) – Módosítások száma az adott időszakban

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

Added in version 5.9.

Projekt automatikus javaslataihoz tartozó beállítások visszaadása, amelyek az egyes telepített fordítási szolgáltatások megadott konfigurációiból állnak.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

Válasz JSON-objektum:

  • suggestion_settings (object) – Összes telepített szolgáltatás konfigurációja.

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

Added in version 5.9.

Szolgáltatáskonfiguráció létrehozása vagy frissítése projekt számára.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

Űrlapparaméterek:

  • string service – Szolgáltatás neve

  • string configuration – Szolgáltatás konfigurációja JSON formátumban

GET /api/projects/(string: project)/languages/(string: language_code)/file/

A 5.15.1 verzióban változott: Added ability to download ZIP file of all components translations in a project for 1 specific language.

Download a ZIP file of all translation files for a specified language_code across all components for a given project rather than downloading individual translated files and manually zipping them, with the archive named {project-slug}-{language-code}.zip and organized by component paths (e.g., component-slug/po/lang.po).

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

  • language_code (string) – Nyelvi kód

Lekérdezési paraméterek:

  • filter (string) – Optional case-insensitive substring to filter components by slug (e.g., ?filter=core will match components with «core» anywhere in their slug); only components whose slugs contain the substring will be included in the download.

  • format (string) – A használandó archívumformátum; ha nincs megadva, az alapértelmezett a zip. Támogatott formátumok: zip és zip:CONVERSION, ahol a CONVERSION az átalakítók közül választható, lásd: Fordítások letöltése.

Megjegyzés

Possible responses:

  • 200 OK with the ZIP file of translations for the specified language across all components in the project. If no components have translations for the specified language, an empty ZIP file will be returned.

  • 403 Forbidden if the user does not have permission to the project.

  • 404 Not Found if the project slug does not exist.

Összetevők

Tipp

Új összetevő létrehozása a POST /api/projects/(string:project)/components/ végpont használatával.

GET /api/components/

Fordítási összetevők listájának visszaadása.

Lásd még

Összetevő objektum attribútumainak dokumentációja: GET /api/components/(string:project)/(string:component)/.

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

Fordítási összetevő adatainak visszaadása.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

  • component (string) – Összetevő URL-azonosítója (slug)

Válasz JSON-objektum:

Példa JSON adatok:

{
    "branch": "main",
    "file_format": "po",
    "file_format_params": {
        "po_line_wrap": 65535,
        "po_no_location": true
    },
    "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)/

Összetevő szerkesztése PATCH kérés segítségével.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

  • component (string) – Összetevő URL-azonosítója (slug)

  • source_language (string) – Projekt forrásnyelvének kódja (nem kötelező)

Kérés JSON-objektum:

  • name (string) – összetevő neve

  • slug (string) – összetevő URL-azonosítója (slug)

  • repo (string) – VCS tároló URL

CURL példa:

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

JSON alapú kérés példa:

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"
}

Példa JSON válasz:

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",
    "file_format_params": {
        "po_line_wrap": 65535,
        "po_no_location": true
    },
    "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)/

Összetevő szerkesztése PUT kérés segítségével.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

  • component (string) – Összetevő URL-azonosítója (slug)

Kérés JSON-objektum:

  • branch (string) – VCS tároló ága

  • file_format (string) – fordítások fájlformátuma

  • file_format_params (object) – parameters related to the file

  • filemask (string) – fordítási fájlok maszkja a tárolóban

  • name (string) – összetevő neve

  • slug (string) – összetevő URL-azonosítója (slug)

  • repo (string) – VCS tároló URL

  • template (string) – egynyelvű fordítások alapfájlja

  • new_base (string) – új fordítások hozzáadásához használt alapfájl

  • vcs (string) – verziókezelő rendszer megnevezése

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

Összetevő törlése.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

  • component (string) – Összetevő URL-azonosítója (slug)

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

Összetevő módosításainak listázása; lényegében összetevőre szűkített GET /api/changes/ ugyanazon paraméterekkel.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

  • component (string) – Összetevő URL-azonosítója (slug)

Válasz JSON-objektum:
GET /api/components/(string: project)/(string: component)/file/

Added in version 4.9.

Összes elérhető fordítás letöltése tömörített állományként a megadott formátumban.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

  • component (string) – Összetevő URL-azonosítója (slug)

Lekérdezési paraméterek:

  • format (string) – A használandó archívumformátum; ha nincs megadva, az alapértelmezett a zip. Támogatott formátumok: zip és zip:CONVERSION, ahol a CONVERSION az átalakítók közül választható, lásd: Fordítások letöltése.

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

Összetevő képernyőképeinek listázása.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

  • component (string) – Összetevő URL-azonosítója (slug)

Válasz JSON-objektum:
GET /api/components/(string: project)/(string: component)/lock/

Összetevő zárolási állapotának lekérdezése.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

  • component (string) – Összetevő URL-azonosítója (slug)

Válasz JSON-objektum:

  • locked (boolean) – összetevő frissítésre történő zároltságának ellenőrzése

Példa JSON adatok:

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

Összetevő zárolási állapotának beállítása.

Válasz megegyezik a GET /api/components/(string:project)/(string:component)/lock/ válaszával.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

  • component (string) – Összetevő URL-azonosítója (slug)

Kérés JSON-objektum:

  • lock – Logikai érték, amely jelzi a zárolás beállítását.

CURL példa:

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

JSON alapú kérés példa:

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}

Példa JSON válasz:

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/

VCS (verziókezelő) tároló állapotának lekérdezése.

A válasz megegyezik a GET /api/projects/(string:project)/repository/ válaszával.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

  • component (string) – Összetevő URL-azonosítója (slug)

Válasz JSON-objektum:

  • needs_commit (boolean) – vannak-e függőben lévő véglegesítések (commit)

  • needs_merge (boolean) – vannak-e a forrás tárolóból származó egyesítendő változások (merge)

  • needs_push (boolean) – vannak-e helyi módosítások, amelyeket fel kell tölteni (push)

  • remote_commit (string) – Távoli véglegesítési információk

  • status (string) – VCS (verziókezelő rendszer) által jelentett tárolóállapot

  • merge_failure – Egyesítési (merge) hiba leírása vagy null, ha nincs hiba

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

Egy adott művelet végrehajtása VCS tárolón.

Dokumentáció: POST /api/projects/(string:project)/repository/.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

  • component (string) – Összetevő URL-azonosítója (slug)

Kérés JSON-objektum:

  • operation (string) – Végrehajtandó művelet, az alábbiak egyike: push, pull, commit, reset, cleanup

Válasz JSON-objektum:

  • result (boolean) – a művelet eredménye

CURL példa:

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

JSON alapú kérés példa:

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"}

Példa JSON válasz:

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/

Egynyelvű fordítások alapfájljának letöltése.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

  • component (string) – Összetevő URL-azonosítója (slug)

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

Új fordítások sablonfájljának letöltése.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

  • component (string) – Összetevő URL-azonosítója (slug)

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

Fordítási objektumok listázása az adott összetevőben.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

  • component (string) – Összetevő URL-azonosítója (slug)

Válasz JSON-objektum:
POST /api/components/(string: project)/(string: component)/translations/

Új fordítást hoz létre a megadott összetevőben.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

  • component (string) – Összetevő URL-azonosítója (slug)

Kérés JSON-objektum:
Válasz JSON-objektum:

  • result (object) – az újonnan létrehozott fordítási objektum

CURL példa:

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

JSON alapú kérés példa:

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"}

Példa JSON válasz:

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/

Lapozható statisztikákat ad vissza az összetevőn belüli összes fordításhoz.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

  • component (string) – Összetevő URL-azonosítója (slug)

Lásd még

Returned attributes are described in Statisztikák.

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

Az összetevőhöz kapcsolódó projektek listája.

Added in version 4.5.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

  • component (string) – Összetevő URL-azonosítója (slug)

Válasz JSON-objektum:
POST /api/components/(string: project)/(string: component)/links/

Projekt társítása egy összetevőhöz.

Added in version 4.5.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

  • component (string) – Összetevő URL-azonosítója (slug)

Űrlapparaméterek:

  • string project_slug – Projekt URL-azonosító (slug)

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

Projekt társításának eltávolítása egy összetevőről.

Added in version 4.5.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

  • component (string) – Összetevő URL-azonosítója (slug)

  • project_slug (string) – Eltávolítandó projekt URL-azonosítója (slug)

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

Közreműködők elismeréseinek visszaadása egy projekthez.

Added in version 5.7.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

  • start (date) – Alsó (kezdő) időbélyeg-határ ISO 8601 formátumban (kötelező)

  • end (date) – Felső időbélyeg-határ ISO 8601 formátumban (kötelező)

  • lang (source_language) – Nyelvkód keresése

Válasz JSON-objektum:

  • email (string) – Közreműködő e-mail címe

  • full_name (string) – Közreműködő teljes neve

  • change_count (string) – Módosítások száma az adott időszakban

Fordítások

GET /api/translations/

Fordítások listájának lekérése.

Lásd még

A fordítási objektum attribútumai dokumentálva itt: GET /api/translations/(string:project)/(string:component)/(string:language)/.

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

Fordításhoz tartozó információk lekérése.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

  • component (string) – Összetevő URL-azonosítója (slug)

  • language (string) – Fordítás nyelvkódja

Válasz JSON-objektum:

  • component (object) – összetevő objektum; lásd: GET /api/components/(string:project)/(string:component)/

  • failing_checks (int) – ellenőrzésen megbukott szövegek száma

  • failing_checks_percent (float) – ellenőrzésen megbukott szövegek aránya százalékban

  • failing_checks_words (int) – ellenőrzésen megbukott szavak száma

  • filename (string) – fordítás fájlneve

  • fuzzy (int) – szerkesztést igénylő szövegek száma

  • fuzzy_percent (float) – szerkesztést igénylő szövegek aránya

  • fuzzy_words (int) – szerkesztést igénylő szövegekben található szavak száma

  • have_comment (int) – azon szövegek száma, amelyekhez megjegyzés tartozik

  • have_suggestion (int) – azon szövegek száma, amelyekhez javaslat tartozik

  • is_template (boolean) – megadja, hogy a fordítás egynyelvű alapon készült-e

  • language (object) – forrásnyelv objektum; lásd: GET /api/languages/(string:language)/

  • language_code (string) – a tárolóban használt nyelvkód; eltérhet a nyelvi objektumban megadott nyelvkódtól

  • last_author (string) – az utolsó szerző neve

  • last_change (timestamp) – utolsó módosítás időbélyege

  • revision (string) – a fájl revíziós azonosítója (hash)

  • share_url (string) – megosztási URL, amely az elköteleződési oldalra vezet

  • total (int) – összes szöveg száma

  • total_words (int) – összes szó száma

  • translate_url (string) – fordítási URL

  • translated (int) – lefordított szövegek száma

  • translated_percent (float) – lefordított szövegek aránya

  • translated_words (int) – lefordított szavak száma

  • repository_url (string) – URL a tároló állapotához; lásd: GET /api/translations/(string:project)/(string:component)/(string:language)/repository/

  • file_url (string) – URL a fájl objektumhoz; lásd: GET /api/translations/(string:project)/(string:component)/(string:language)/file/

  • changes_list_url (string) – URL a változások listájához; lásd: GET /api/translations/(string:project)/(string:component)/(string:language)/changes/

  • units_list_url (string) – URL a szövegek listájához; lásd: GET /api/translations/(string:project)/(string:component)/(string:language)/units/

Példa JSON adatok:

{
    "component": {
        "branch": "main",
        "file_format": "po",
        "file_format_params": {
            "po_line_wrap": 65535,
            "po_no_location": true
        },
        "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)/

Egy fordítás törlését végzi el.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

  • component (string) – Összetevő URL-azonosítója (slug)

  • language (string) – Fordítás nyelvkódja

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

A fordítási változások listájának lekérése. Ez lényegében egy fordításokra szűkített GET /api/changes/, amely ugyanazokat a paramétereket fogadja el.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

  • component (string) – Összetevő URL-azonosítója (slug)

  • language (string) – Fordítás nyelvkódja

Válasz JSON-objektum:
GET /api/translations/(string: project)/(string: component)/(string: language)/units/

A fordítási egységek listájának lekérése.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

  • component (string) – Összetevő URL-azonosítója (slug)

  • language (string) – Fordítás nyelvkódja

  • q (string) – Keresési lekérdezési sztring Keresés (nem kötelező)

Válasz JSON-objektum:
POST /api/translations/(string: project)/(string: component)/(string: language)/units/

Új fordítási egység hozzáadása.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

  • component (string) – Összetevő URL-azonosítója (slug)

  • language (string) – Fordítás nyelvkódja

Kérés JSON-objektum:

  • key (string) – Egynyelvű fordítások esetén: a fordítási egység kulcsa

  • value (array) – Egynyelvű fordítások esetén: forrásszövegek (többes szám létrehozása esetén több szöveget használjon, egyébként egyet)

  • context (string) – Kétnyelvű fordítások esetén: a fordítási egység kontextusa

  • source (array) – Kétnyelvű fordítások esetén: forrásszövegek (többes szám létrehozása esetén több szöveget használjon, egyébként egyet)

  • target (array) – Kétnyelvű fordítások esetén: célnyelvi szövegek (többes szám létrehozása esetén több szöveget használjon, egyébként egyet)

  • state (int) – A szöveg állapota; lásd: GET /api/units/(int:id)/

Válasz JSON-objektum:

Lásd még

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

A 5.13 verzióban változott: The filter_type parameter is no longer supported and filtering is done by the q parameter.

Automatikus fordítás indítása.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

  • component (string) – Összetevő URL-azonosítója (slug)

  • language (string) – Fordítás nyelvkódja

Kérés JSON-objektum:

  • mode (string) – Automatikus fordítás módja

  • q (string) – Automatic translation search string, see Szövegek keresése.

  • auto_source (string) – Automatikus fordítás forrása – mt vagy others

  • component (string) – Hozzájárulás bekapcsolása a megosztott fordítási memóriához a projekt számára, hogy hozzáférhessen további összetevőkhöz.

  • engines (array) – Gépi fordítómotorok

  • threshold (string) – Pontszámküszöb

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

A jelenlegi fordítási fájl letöltése az eredeti VCS tárolóból (format paraméter nélkül) vagy más formátumba konvertálva (lásd: Fordítások letöltése).

Megjegyzés

Ez az API-végpont eltérő logikát használ, mivel teljes fájlokon működik. Az elfogadott format paraméterek köre is eltér; formátum megadása nélkül a VCS-ben tárolt fájl kerül letöltésre.

Válaszfejlécek:

  • Last-Modified – A fájl utolsó módosításának időbélyege.

Kérésfejlécek:

  • If-Modified-Since – A válasz kihagyása, ha a fájl az adott időpont óta nem módosult.

Lekérdezési paraméterek:

  • format – Használandó fájlformátum megadása; ha nincs megadva, formátumkonverzió nem történik; lásd: Fordítások letöltése

  • q (string) – Letöltött szövegek szűrése, lásd: Keresés, csak akkor alkalmazható, ha átalakítás van megadva (format meg van adva).

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

  • component (string) – Összetevő URL-azonosítója (slug)

  • language (string) – Fordítás nyelvkódja

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

Új fordítási fájl feltöltése.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

  • component (string) – Összetevő URL-azonosítója (slug)

  • language (string) – Fordítás nyelvkódja

Űrlapparaméterek:

  • string conflicts – Konfliktusok kezelése (ignore, replace-translated vagy replace-approved), lásd: Ütközések kezelése

  • file file – Feltöltött fájl

  • string email – Szerző e-mail-címe

  • string author – Szerző neve

  • string method – Feltöltési mód (translate, approve, suggest, fuzzy, replace, source, add), lásd: Importálási módok

  • string fuzzy – Szerkesztést igénylő (zavaros) szövegek feldolgozása (üres, process, approve)

CURL példa:

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/

VCS (verziókezelő) tároló állapotának lekérdezése.

A válasz megegyezik a következővel: GET /api/components/(string:project)/(string:component)/repository/.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

  • component (string) – Összetevő URL-azonosítója (slug)

  • language (string) – Fordítás nyelvkódja

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

A megadott művelet végrehajtása a VCS-tárolón.

Dokumentáció: POST /api/projects/(string:project)/repository/.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

  • component (string) – Összetevő URL-azonosítója (slug)

  • language (string) – Fordítás nyelvkódja

Kérés JSON-objektum:

  • operation (string) – Végrehajtandó művelet, az alábbiak egyike: push, pull, commit, reset, cleanup

Válasz JSON-objektum:

  • result (boolean) – a művelet eredménye

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

Részletes fordítási statisztikákat ad vissza.

Paraméterek:

  • project (string) – Projekt URL-azonosítója (slug)

  • component (string) – Összetevő URL-azonosítója (slug)

  • language (string) – Fordítás nyelvkódja

Lásd még

Returned attributes are described in Statisztikák.

Memória

Added in version 4.14.

GET /api/memory/

Memóriaeredmények listáját adja vissza.

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

Memóriaobjektum törlése

Paraméterek:

  • memory_object_id – Memóriaobjektum azonosítója

Egységek

Az egység egyetlen fordítási elem, amely egy forrásszöveget egy hozzá tartozó fordított szöveggel párosít, valamint kapcsolódó metaadatokat is tartalmaz. A kifejezés a Translate Toolkit translate.storage.base.TranslationUnit osztályából és az XLIFF szabványból származik.

GET /api/units/

A fordítási egységek listájának lekérése.

Paraméterek:

  • q (string) – Keresési lekérdezési sztring Keresés (nem kötelező)

Lásd még

Az egység objektum attribútumai a következő dokumentációban találhatók: GET /api/units/(int:id)/.

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

A 4.3 verzióban változott: A target és source mezők mostantól tömbök, hogy megfelelően kezeljék a többes számú szövegeket.

A 5.6 verzióban változott: A last_updated attribútum mostantól elérhető.

Az egység fordítási információit adja vissza.

Paraméterek:

  • id (int) – Egység azonosító

Válasz JSON-objektum:

  • translation (string) – Kapcsolódó fordítási objektum URL-je

  • source (array) – forrásszöveg

  • previous_source (string) – korábbi forrásszöveg szerkesztést igénylő (zavaros) egyezéshez

  • target (array) – célszöveg

  • id_hash (string) – az egység egyedi azonosítója

  • content_hash (string) – forrásszöveg egyedi azonosítója

  • location (string) – egység helye a forráskódban

  • context (string) – fordítási egység kontextusa

  • note (string) – fordítási egység megjegyzése

  • flags (string) – fordítási egység jelzői

  • labels (array) – fordítási egység címkéi, csak forrásegységeknél érhetők el

  • state (int) – egység állapota: 0 - nincs lefordítva, 10 - szerkesztést igényel, 20 - lefordítva, 30 - jóváhagyva, 100 - csak olvasható

  • fuzzy (boolean) – hogy a szöveg szerkesztést igényel-e vagy ellenőrzésre van-e megjelölve

  • translated (boolean) – hogy a szöveg le van-e fordítva

  • approved (boolean) – hogy a fordítás jóvá van-e hagyva

  • position (int) – szöveg pozíciója a fordítási fájlban

  • has_suggestion (boolean) – hogy a szöveghez vannak-e javaslatok

  • has_comment (boolean) – hogy a szöveghez vannak-e megjegyzések

  • has_failing_check (boolean) – hogy a szöveg ellenőrzései hibát jeleznek-e

  • num_words (int) – forrás szavak száma

  • priority (int) – fordítás prioritása; alapértelmezett érték: 100

  • id (int) – szöveg azonosítója

  • explanation (string) – A szöveg magyarázata, amely a forrásszövegeknél érhető el, lásd: További információk a forrásszövegekről

  • extra_flags (string) – További szövegjelzők, amelyek a forrásszövegeknél érhetők el, lásd: Viselkedés testreszabása jelzők használatával

  • web_url (string) – URL, ahol a szöveg szerkeszthető

  • source_unit (string) – Forrásszöveg hivatkozása; lásd: GET /api/units/(int:id)/

  • pending (boolean) – hogy a szöveg még írás alatt áll-e

  • timestamp (timestamp) – szöveg kora

  • last_updated (timestamp) – utolsó szövegfrissítés

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

Added in version 4.3.

Részleges frissítést hajt végre a fordítási egységen.

Paraméterek:

  • id (int) – Egység azonosító

Kérés JSON-objektum:

  • state (int) – szöveg állapota, 0 - lefordítatlan, 10 - szerkesztést igényel, 20 - lefordítva, 30 - jóváhagyva (szükséges az ellenőrzési munkafolyamat engedélyezése, lásd: Kijelölt felülvizsgálók)

  • target (array) – célszöveg

  • explanation (string) – A szöveg magyarázata, amely a forrásszövegeknél érhető el, lásd: További információk a forrásszövegekről

  • extra_flags (string) – További szövegjelzők, amelyek a forrásszövegeknél érhetők el, lásd: Viselkedés testreszabása jelzők használatával

  • labels (array) – címkék, amelyek a forrásszövegeknél érhetők el

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

Added in version 4.3.

Teljes frissítést hajt végre a fordítási egységen.

Paraméterek:

  • id (int) – Egység azonosító

Kérés JSON-objektum:

  • state (int) – szöveg állapota, 0 - lefordítatlan, 10 - szerkesztést igényel, 20 - lefordítva, 30 - jóváhagyva (szükséges az ellenőrzési munkafolyamat engedélyezése, lásd: Kijelölt felülvizsgálók)

  • target (array) – célszöveg

  • explanation (string) – A szöveg magyarázata, amely a forrásszövegeknél érhető el, lásd: További információk a forrásszövegekről

  • extra_flags (string) – További szövegjelzők, amelyek a forrásszövegeknél érhetők el, lásd: Viselkedés testreszabása jelzők használatával

  • labels (array) – címkék, amelyek a forrásszövegeknél érhetők el

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

Added in version 4.3.

Törli a fordítási egységet.

Paraméterek:

  • id (int) – Egység azonosító

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

Added in version 5.11.

Visszaadja az adott forrásszöveghez tartozó összes célnyelvi fordítási egység listáját.

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

Added in version 5.12.

Új megjegyzés létrehozása az adott fordítási egységhez.

Paraméterek:

  • id (int) – Egység azonosító

Kérés JSON-objektum:

  • scope (string) – a megjegyzés hatóköre – globális, fordítás (minden nem forrás egységnél elérhető), jelentés (felülvizsgálati munkafolyamat szükséges, lásd: Kijelölt felülvizsgálók)

  • comment (string) – content of the new comment, you can use Markdown and mention users by @username.

  • user_email (string) – a megjegyzést író e-mail-címe, csak a projekt adminisztrátorai állíthatják be, alapértelmezés szerint a bejelentkezett felhasználóé.

  • timestamp (string) – a megjegyzés létrehozásának időbélyege, csak a projekt adminisztrátorai állíthatják be, alapértelmezés szerint az aktuális időpont.

Válasz JSON-objektum:

  • id (int) – a megjegyzés azonosítója

  • comment (string) – az új megjegyzés tartalma

  • user (string) – a megjegyzést író felhasználó objektumának URL-címe

  • timestamp (string) – a megjegyzés létrehozásának időbélyege

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

Added in version 5.15.

Returns a list of comments on a given translation unit

Paraméterek:

  • id (int) – Egység azonosító

Válasz JSON-objektum:

  • id (int) – a megjegyzés azonosítója

  • comment (string) – content of the comment

  • timestamp (string) – a megjegyzés létrehozásának időbélyege

  • user (string) – a megjegyzést író felhasználó objektumának URL-címe

Változások

GET /api/changes/

A 4.1 verzióban változott: A változások szűrésének lehetősége a 4.1 verzióban került bevezetésre.

Visszaadja a fordítási változások listáját.

Lásd még

A változás objektum attribútumai dokumentálva vannak itt: GET /api/changes/(int:id)/.

Lekérdezési paraméterek:

  • user (string) – felhasználónév szűréshez

  • action (int) – Szűrendő művelet, többször is megadható

  • timestamp_after (timestamp) – ISO 8601 formátumú időbélyeg, amely utáni változásokat listázza

  • timestamp_before (timestamp) – ISO 8601 formátumú időbélyeg, amely előtti változásokat listázza

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

Lekéri a fordítási változások listáját.

Paraméterek:

  • id (int) – Változás azonosítója

Válasz JSON-objektum:

  • unit (string) – Kapcsolódó egység objektum URL-je

  • translation (string) – Kapcsolódó fordítási objektum URL-je

  • component (string) – Kapcsolódó összetevő objektum URL-je

  • user (string) – Kapcsolódó felhasználó objektum URL-je

  • author (string) – Kapcsolódó szerző objektum URL-je

  • timestamp (timestamp) – esemény időbélyege

  • action (int) – művelet numerikus azonosítója

  • action_name (string) – művelet szöveges leírása

  • target (string) – esemény során módosított szöveg

  • old (string) – előző szöveg

  • details (object) – további részletek a változásról

  • id (int) – változásazonosító

Képernyőképek

GET /api/screenshots/

lekéri a képernyőkép szöveginformációinak listáját.

Lásd még

A képernyőkép objektum attribútumai dokumentálva vannak itt: GET /api/screenshots/(int:id)/.

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

információt ad a képernyőképről.

Paraméterek:

  • id (int) – Képernyőkép azonosító

Válasz JSON-objektum:

  • name (string) – képernyőkép neve

  • component (string) – Kapcsolódó összetevő objektum URL-je

  • file_url (string) – Fájl letöltéséhez használt URL; lásd: GET /api/screenshots/(int:id)/file/

  • units (array) – kapcsolódó forrásszöveg információk linkje; lásd: GET /api/units/(int:id)/

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

Képernyőkép letöltése.

Paraméterek:

  • id (int) – Képernyőkép azonosító

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

Képernyőkép cseréje.

Paraméterek:

  • id (int) – Képernyőkép azonosító

Űrlapparaméterek:

  • file image – Feltöltött fájl

CURL példa:

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

Forrásszöveg társítása a képernyőképpel.

Paraméterek:

  • id (int) – Képernyőkép azonosító

Űrlapparaméterek:

  • string unit_id – Egység azonosító

Válasz JSON-objektum:

  • name (string) – képernyőkép neve

  • translation (string) – Kapcsolódó fordítási objektum URL-je

  • file_url (string) – Fájl letöltéséhez használt URL; lásd: GET /api/screenshots/(int:id)/file/

  • units (array) – kapcsolódó forrásszöveg információk linkje; lásd: GET /api/units/(int:id)/

DELETE /api/screenshots/(int: id)/units/(int: unit_id)

Forrásszöveg társításának eltávolítása a képernyőképről.

Paraméterek:

  • id (int) – Képernyőkép azonosító

  • unit_id – Forrásszöveg egységazonosító

POST /api/screenshots/

Új képernyőkép létrehozása.

Űrlapparaméterek:

  • file image – Feltöltött fájl

  • string name – Képernyőkép neve

  • string project_slug – Projekt URL-azonosító (slug)

  • string component_slug – Összetevő URL-azonosítója (slug)

  • string language_code – Nyelvi kód

Válasz JSON-objektum:

  • name (string) – képernyőkép neve

  • component (string) – Kapcsolódó összetevő objektum URL-je

  • file_url (string) – Fájl letöltéséhez használt URL; lásd: GET /api/screenshots/(int:id)/file/

  • units (array) – kapcsolódó forrásszöveg információk linkje; lásd: GET /api/units/(int:id)/

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

Képernyőkép részleges adatainak módosítása.

Paraméterek:

  • id (int) – Képernyőkép azonosító

Válasz JSON-objektum:

  • name (string) – képernyőkép neve

  • component (string) – Kapcsolódó összetevő objektum URL-je

  • file_url (string) – Fájl letöltéséhez használt URL; lásd: GET /api/screenshots/(int:id)/file/

  • units (array) – kapcsolódó forrásszöveg információk linkje; lásd: GET /api/units/(int:id)/

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

Képernyőkép teljes adatainak módosítása.

Paraméterek:

  • id (int) – Képernyőkép azonosító

Válasz JSON-objektum:

  • name (string) – képernyőkép neve

  • component (string) – Kapcsolódó összetevő objektum URL-je

  • file_url (string) – Fájl letöltéséhez használt URL; lásd: GET /api/screenshots/(int:id)/file/

  • units (array) – kapcsolódó forrásszöveg információk linkje; lásd: GET /api/units/(int:id)/

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

Képernyőkép törlése.

Paraméterek:

  • id (int) – Képernyőkép azonosító

Kiegészítők

Added in version 4.4.1.

GET /api/addons/

Lekéri a kiegészítők listáját.

Lásd még

A kiegészítő objektum attribútumai dokumentálva vannak itt: GET /api/addons/(int:id)/.

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

Információt ad a kiegészítő adatairól.

Paraméterek:

  • id (int) – Kiegészítő azonosítója

Válasz JSON-objektum:

  • name (string) – kiegészítő neve

  • component (string) – Kapcsolódó összetevő objektum URL-je

  • configuration (object) – Kiegészítő választható beállításai

Lásd még

Kiegészítők

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

Új kiegészítő létrehozása.

Paraméterek:

  • project_slug (string) – Projekt URL-azonosító (slug)

  • component_slug (string) – Összetevő URL-azonosítója (slug)

Kérés JSON-objektum:

  • name (string) – kiegészítő neve

  • configuration (object) – Kiegészítő választható beállításai

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

Kiegészítő adatainak részleges módosítása.

Paraméterek:

  • id (int) – Kiegészítő azonosítója

Válasz JSON-objektum:

  • configuration (object) – Kiegészítő választható beállításai

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

Kiegészítő adatainak teljes módosítása.

Paraméterek:

  • id (int) – Kiegészítő azonosítója

Válasz JSON-objektum:

  • configuration (object) – Kiegészítő választható beállításai

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

Kiegészítő törlése.

Paraméterek:

  • id (int) – Kiegészítő azonosítója

Összetevőlisták

Added in version 4.0.

GET /api/component-lists/

Lekéri az összetevőlisták listáját.

Lásd még

Az összetevőlista objektum attribútumai dokumentálva vannak itt: GET /api/component-lists/(str:slug)/.

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

Információt ad az összetevőlistáról.

Paraméterek:

  • slug (string) – Összetevőlista URL-azonosító (slug)

Válasz JSON-objektum:

  • name (string) – összetevőlista neve

  • slug (string) – összetevőlista URL-azonosítója

  • show_dashboard (boolean) – megjelenjen-e az vezérlőpulton

  • components (array) – kapcsolódó összetevőkre mutató hivatkozás; lásd: GET /api/components/(string:project)/(string:component)/

  • auto_assign (array) – automatikus hozzárendelési szabályok

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

Módosítja az összetevőlista paramétereit.

Paraméterek:

  • slug (string) – Összetevőlista URL-azonosító (slug)

Kérés JSON-objektum:

  • name (string) – összetevőlista neve

  • slug (string) – összetevőlista URL-azonosítója

  • show_dashboard (boolean) – megjelenjen-e az vezérlőpulton

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

Módosítja az összetevőlista paramétereit.

Paraméterek:

  • slug (string) – Összetevőlista URL-azonosító (slug)

Kérés JSON-objektum:

  • name (string) – összetevőlista neve

  • slug (string) – összetevőlista URL-azonosítója

  • show_dashboard (boolean) – megjelenjen-e az vezérlőpulton

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

Összetevőlista törlése.

Paraméterek:

  • slug (string) – Összetevőlista URL-azonosító (slug)

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

Added in version 5.0.1: Összetevők listázása egy összetevőlistában.

slug paraméter:

Összetevőlista URL-azonosító (slug)

slug típusa:

szöveg

űrlapmező (szöveg): component_id:

Összetevő azonosító

>json array results:

összetevő objektumok tömbje; lásd: GET /api/components/(string:project)/(string:component)/

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

Összetevő társítása egy összetevőlistához.

Paraméterek:

  • slug (string) – Összetevőlista URL-azonosító (slug)

Űrlapparaméterek:

  • string component_id – Összetevő azonosító

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

Összetevő leválasztása az összetevőlistáról.

Paraméterek:

  • slug (string) – Összetevőlista URL-azonosító (slug)

  • component_slug (string) – Összetevő URL-azonosítója (slug)

Szójegyzék

A 4.5 verzióban változott: A szójegyzékek mostantól szokásos összetevőként, fordításokként és szövegekként vannak tárolva, használja a megfelelő API-t helyette.

Feladatok

Added in version 4.4.

GET /api/tasks/

A feladatok listázása jelenleg nem érhető el.

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

Információt ad egy feladatról.

Paraméterek:

  • uuid (string) – Feladat UUID

Válasz JSON-objektum:

  • completed (boolean) – A feladat befejeződött-e

  • progress (int) – Feladat előrehaladása százalékban

  • result (object) – Feladat eredménye vagy részletes állapota

  • log (string) – Feladat naplója

Statisztikák

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

Több statisztikai végpont is elérhető objektumokhoz, mindegyik azonos struktúrát használ.

Paraméterek:

  • object (string) – URL-útvonal

Válasz JSON-objektum:

  • total (int) – összes szöveg száma

  • total_words (int) – összes szó száma

  • total_chars (int) – karakterek teljes száma

  • last_change (timestamp) – utolsó változtatás dátuma

  • translated (int) – lefordított szövegek száma

  • translated_percent (float) – lefordított szövegek aránya

  • translated_words (int) – lefordított szavak száma

  • translated_words_percent (float) – lefordított szavak aránya

  • translated_chars (int) – lefordított karakterek száma

  • translated_chars_percent (float) – lefordított karakterek aránya

  • fuzzy (int) – szerkesztést igénylő szövegek száma

  • fuzzy_words (int) – szerkesztést igénylő (zavaros) szavak száma

  • fuzzy_chars (int) – szerkesztést igénylő (zavaros) karakterek száma

  • fuzzy_percent (float) – szerkesztést igénylő szövegek aránya

  • fuzzy_words_percent (float) – szerkesztést igénylő (zavaros) szavak aránya

  • fuzzy_chars_percent (float) – szerkesztést igénylő (zavaros) karakterek aránya

  • failing (int) – hibás ellenőrzések száma

  • failing_percent (float) – hibás ellenőrzések aránya

  • approved (int) – jóváhagyott szövegek száma

  • approved_words (int) – jóváhagyott szavak száma

  • approved_chars (int) – a jóváhagyott karakterek száma

  • approved_percent (float) – jóváhagyott szövegek aránya

  • approved_words_percent (float) – jóváhagyott szavak aránya

  • approved_chars_percent (float) – jóváhagyott karakterek aránya

  • readonly (int) – csak olvasható szövegek száma

  • readonly_words (int) – csak olvasható szavak száma

  • readonly – csak olvasható karakterek száma

  • readonly_percent (float) – csak olvasható szövegek aránya

  • readonly_words_percent (float) – csak olvasható szavak aránya

  • readonly_char_percent (float) – csak olvasható karakterek aránya

  • suggestions (int) – javaslattal rendelkező szövegek száma

  • comments (int) – megjegyzéssel rendelkező szövegek száma

  • name (string) – objektum neve

  • url (string) – objektum elérési URL-je (ha alkalmazható)

  • url_translate (string) – fordítás elérési URL-je (ha alkalmazható)

  • code (string) – nyelvkód (ha alkalmazható)

Lásd még

Metrikák

GET /api/metrics/

Információt ad a kiszolgáló metrikáiról.

A 5.6.1 verzióban változott: A metrikák mostantól OpenMetrics-kompatibilis formátumban is elérhetők a ?format=openmetrics használatával.

Válasz JSON-objektum:

  • units (int) – Egységek száma

  • units_translated (int) – Fordított egységek száma

  • users (int) – Felhasználók száma

  • changes (int) – Változtatások száma

  • projects (int) – Projektek száma

  • components (int) – Összetevők száma

  • translations (int) – Fordítások száma

  • languages (int) – Használt nyelvek száma

  • checks (int) – Kiváltott minőség-ellenőrzések száma

  • configuration_errors (int) – Konfigurációs hibák száma

  • suggestions (int) – Függőben lévő javaslatok száma

  • celery_queues (object) – Celery várólisták hossza, lásd: Háttérfeladatok Celery használatával

  • name (string) – Konfigurált kiszolgálónév

Kategóriák

GET /api/categories/

Added in version 5.0.

Az elérhető kategóriákat listázza. A mezők meghatározásához lásd: GET /api/categories/(int:id)/.

POST /api/categories/

Added in version 5.0.

Új kategória létrehozása. A mezők meghatározásához lásd: GET /api/categories/(int:id)/.

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

Added in version 5.0.

Paraméterek:

  • id (int) – Kategóriaazonosító

Válasz JSON-objektum:

  • name (str) – Kategória neve.

  • slug (str) – Kategória URL-azonosítója (slug).

  • project (str) – Hivatkozás egy projektre.

  • category (str) – Hivatkozás egy szülőkategóriára.

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

Added in version 5.0: Kategória részleges adatainak szerkesztése.

paraméter azonosító:

Kategóriaazonosító

típus azonosító:

int

>json object configuration:

Opcionális kategóriabeállítás

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

Added in version 5.0: Kategória teljes adatainak szerkesztése.

paraméter azonosító:

Kategóriaazonosító

típus azonosító:

int

>json object configuration:

Opcionális kategóriabeállítás

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

Added in version 5.0: Kategória törlése.

paraméter azonosító:

Kategóriaazonosító

típus azonosító:

int

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

Added in version 5.5.

Kategóriastatisztikák visszaadása.

Paraméterek:

  • project (int) – Kategóriaazonosító

Lásd még

Returned attributes are described in Statisztikák.

Értesítési hookok

Az értesítési hookok lehetővé teszik külső alkalmazások számára, hogy értesítsék a Weblate rendszert a VCS tároló frissítéséről.

Használhatja a projektek, összetevők és fordítások tárolóvégpontjait az egyes tárolók frissítéséhez; lásd: POST /api/projects/(string:project)/repository/ dokumentációját.

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

Elavult a(z) 2.6 verzió óta: Inkább a POST /api/components/(string:project)/(string:component)/repository/ végpontot használja, amely megfelelően működik hitelesítéssel ACL-korlátozott projektek esetén.

Removed in version 5.14.

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

Elavult a(z) 2.6 verzió óta: Inkább a POST /api/projects/(string:project)/repository/ végpontot használja, amely megfelelően működik hitelesítéssel ACL-korlátozott projektek esetén.

Removed in version 5.14.

POST /hooks/github/

Speciális hook GitHub értesítések kezelésére és a megfelelő összetevők automatikus frissítésére.

Megjegyzés

A GitHub közvetlen támogatást nyújt a Weblate értesítéséhez: engedélyezze a Weblate szolgáltatás hookot a tároló beállításaiban, és állítsa be az URL-t a Weblate telepítésének URL-jére.

Lásd még

Változások automatikus fogadása a GitHubról

Útmutató a GitHub integráció beállításához

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

Általános információk a GitHub Webhookokról

ENABLE_HOOKS

Hookok engedélyezése a teljes Weblate-re

POST /hooks/gitlab/

Speciális hook a GitLab értesítések kezelésére és az egyező összetevők automatikus frissítésére.

Lásd még

Változások automatikus fogadása GitLab-ról

Útmutató a GitLab integráció beállításához

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

Általános információk a GitLab Webhookokról

ENABLE_HOOKS

Hookok engedélyezése a teljes Weblate-re

POST /hooks/bitbucket/

Speciális hook a Bitbucket értesítések kezelésére és az egyező összetevők automatikus frissítésére.

Lásd még

Változások automatikus fogadása Bitbucket-ről

Útmutató a Bitbucket integráció beállításához

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

Általános információk a Bitbucket Webhookokról

ENABLE_HOOKS

Hookok engedélyezése a teljes Weblate-re

POST /hooks/pagure/

Speciális hook a Pagure értesítések kezelésére és az egyező összetevők automatikus frissítésére.

Lásd még

Változások automatikus fogadása Pagure-ról

Útmutató a Pagure integráció beállításához

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

Általános információk a Pagure Webhookokról

ENABLE_HOOKS

Hookok engedélyezése a teljes Weblate-re

POST /hooks/azure/

Speciális hook az Azure DevOps értesítések kezelésére és az egyező összetevők automatikus frissítésére.

Megjegyzés

Győződjön meg arról, hogy a Resource details to send (Küldendő erőforrás részletei) értéke All legyen, különben a Weblate nem tudja az Azure tárolót párosítani.

Lásd még

Azure Repos: automatikus változásfogadás

Útmutató az Azure integráció beállításához

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

Általános információk az Azure DevOps Web Hookokról

ENABLE_HOOKS

Hookok engedélyezése a teljes Weblate-re

POST /hooks/gitea/

Speciális hook a Gitea Webhook értesítések kezelésére és az egyező összetevők automatikus frissítésére.

Lásd még

Változások automatikus fogadása Gitea Repos-ról

Útmutató a Gitea integráció beállításához

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

Általános információk a Gitea Webhookokról

ENABLE_HOOKS

Hookok engedélyezése a teljes Weblate-re

POST /hooks/gitee/

Speciális hook a Gitee Webhook értesítések kezelésére és az egyező összetevők automatikus frissítésére.

Lásd még

Változások automatikus fogadása Gitee Repos-ról

Útmutató a Gitee integráció beállításához

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

Általános információk a Gitee Webhookokról

ENABLE_HOOKS

Hookok engedélyezése a teljes Weblate-re

RSS-csatornák

A fordításokban történt változások RSS-csatornákban kerülnek exportálásra.

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

RSS-csatorna lekérése egy fordítás legutóbbi változásaival.

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

RSS-csatorna lekérése egy összetevő legutóbbi változásaival.

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

RSS-csatorna lekérése egy projekt legutóbbi változásaival.

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

RSS-csatorna lekérése egy nyelv legutóbbi változásaival.

GET /exports/rss/

RSS-csatorna lekérése a Weblate példány legutóbbi változásaival.

Lásd még

RSS a Wikipédián