WeblateOrg / weblate
6,011 PythonWeb based localization tool with tight version control integration.
weblate Specification
Located in docs/specs/openapi.yaml on branch HEAD
3.x (YAML)
YAML
1281.3 KB
Raw YAML Specification
openapi: 3.1.1
info:
title: Weblate's REST API
version: ''
x-logo:
url: /static/weblate.svg
description: "\nThe API is accessible on the ``/api/`` URL and it is based on [Django
REST framework](https://www.django-rest-framework.org/).\n\nThe OpenAPI specification
is available as feature preview, feedback welcome!\n\n## Authorization\n\n<!--
Redoc-Inject: <security-definitions> -->\n\n\n "
license:
name: GNU General Public License v3 or later
url: https://docs.weblate.org/en/latest/contributing/license.html
paths:
/api/addons/:
get:
operationId: api_addons_list
description: Return a list of add-ons.
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- addons
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedAddonList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/addons/{id}/:
get:
operationId: api_addons_retrieve
description: Returns information about add-on information.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this add-on.
required: true
tags:
- addons
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Addon'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
put:
operationId: api_addons_update
description: Edit full information about add-on.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this add-on.
required: true
tags:
- addons
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Addon'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Addon'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
patch:
operationId: api_addons_partial_update
description: Edit partial information about add-on.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this add-on.
required: true
tags:
- addons
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedAddon'
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Addon'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
delete:
operationId: api_addons_destroy
description: Delete add-on.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this add-on.
required: true
tags:
- addons
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'204':
description: No response body
/api/addons/{id}/trigger/:
post:
operationId: api_addons_trigger_create
description: Trigger manual execution of an add-on that supports manual triggering.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this add-on.
required: true
tags:
- addons
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/AddonTriggerResponse'
description: The request was accepted for asynchronous processing.
/api/categories/:
get:
operationId: api_categories_list
description: List available categories.
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- categories
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedCategoryList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_categories_create
description: Category API.
tags:
- categories
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Category'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Category'
description: The resource was created.
/api/categories/{id}/:
get:
operationId: api_categories_retrieve
description: Category API.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Category.
required: true
tags:
- categories
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Category'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
put:
operationId: api_categories_update
description: Edit full information about category.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Category.
required: true
tags:
- categories
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Category'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Category'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
patch:
operationId: api_categories_partial_update
description: Category API.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Category.
required: true
tags:
- categories
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedCategory'
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Category'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
delete:
operationId: api_categories_destroy
description: Delete a category.
parameters:
- in: query
name: delete_memory
schema:
type: boolean
description: Also delete project, workspace, and shared translation memory
created from components in the category.
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Category.
required: true
tags:
- categories
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'204':
description: No response body
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CategoryDeleteRequest'
/api/categories/{id}/announcements/:
get:
operationId: api_categories_announcements_list
description: Return announcements.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Category.
required: true
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- categories
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedAnnouncementList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_categories_announcements_create
description: Create an announcement.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Category.
required: true
tags:
- categories
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Announcement'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Announcement'
description: The resource was created.
/api/categories/{id}/announcements/{announcement_id}/:
delete:
operationId: api_categories_announcements_destroy
description: Delete an announcement.
parameters:
- in: path
name: announcement_id
schema:
type: integer
required: true
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Category.
required: true
tags:
- categories
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'204':
description: No response body
/api/categories/{id}/reports/:
get:
operationId: api_categories_reports_list
description: List accessible reports generated directly for this scope.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Category.
required: true
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- categories
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedReportListList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_categories_reports_create
description: Schedule report generation using the endpoint object as scope.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Category.
required: true
tags:
- categories
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ScopedReportCreate'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/ReportTaskResponse'
description: The request was accepted for asynchronous processing.
/api/categories/{id}/statistics/:
get:
operationId: api_categories_statistics_retrieve
description: Return statistics for a category.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Category.
required: true
tags:
- categories
- statistics
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Statistics'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/changes/:
get:
operationId: api_changes_list
description: Return a list of translation changes.
parameters:
- in: query
name: action
schema:
type: array
items:
$ref: '#/components/schemas/ActionEnum'
description: Filter by change action. Repeat this parameter to filter by multiple
actions.
explode: true
style: form
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: timestamp_after
schema:
type: string
format: date-time
- in: query
name: timestamp_before
schema:
type: string
format: date-time
- in: query
name: user
schema:
type: string
tags:
- changes
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedChangeList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/changes/{id}/:
get:
operationId: api_changes_retrieve
description: Return information about a translation change.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this history event.
required: true
tags:
- changes
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Change'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/component-lists/:
get:
operationId: api_component_lists_list
description: Return a list of component lists.
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- component-lists
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedComponentListList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_component_lists_create
description: Create a new component list.
tags:
- component-lists
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ComponentList'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ComponentList'
description: The resource was created.
/api/component-lists/{slug}/:
get:
operationId: api_component_lists_retrieve
description: Return information about component list.
parameters:
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- component-lists
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ComponentList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
put:
operationId: api_component_lists_update
description: Change the component list parameters.
parameters:
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- component-lists
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ComponentList'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ComponentList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
patch:
operationId: api_component_lists_partial_update
description: Change the component list parameters.
parameters:
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- component-lists
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedComponentList'
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ComponentList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
delete:
operationId: api_component_lists_destroy
description: Delete the component list.
parameters:
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- component-lists
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'204':
description: No response body
/api/component-lists/{slug}/components/:
get:
operationId: api_component_lists_components_retrieve
description: Component lists API.
parameters:
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- component-lists
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ComponentList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_component_lists_components_create
description: Associate component with a component list.
parameters:
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- component-lists
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ComponentList'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ComponentList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/component-lists/{slug}/components/{component_slug}/:
delete:
operationId: api_component_lists_components_destroy
description: Disassociate a component from the component list.
parameters:
- in: path
name: component_slug
schema:
type: string
required: true
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- component-lists
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'204':
description: No response body
/api/components/:
get:
operationId: api_components_list
description: Return a list of translation components.
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- components
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedComponentList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/components/{project__slug}/{slug}/:
get:
operationId: api_components_retrieve
description: Return information about translation component.
parameters:
- in: path
name: project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- components
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Component'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
put:
operationId: api_components_update
description: Edit a component by a PUT or PATCH request.
parameters:
- in: path
name: project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- components
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Component'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Component'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
patch:
operationId: api_components_partial_update
description: Edit a component by a PATCH request.
parameters:
- in: path
name: project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- components
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedComponent'
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Component'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
delete:
operationId: api_components_destroy
description: Delete a component.
parameters:
- in: query
name: delete_memory
schema:
type: boolean
description: Also delete project, workspace, and shared translation memory
created from the component.
- in: path
name: project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- components
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'204':
description: No response body
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ComponentDeleteRequest'
/api/components/{project__slug}/{slug}/addons/:
post:
operationId: api_components_addons_create
description: Translation components API.
parameters:
- in: path
name: project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- components
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Component'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Component'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/components/{project__slug}/{slug}/announcements/:
get:
operationId: api_components_announcements_list
description: Return announcements.
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: path
name: project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- components
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedAnnouncementList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_components_announcements_create
description: Create an announcement.
parameters:
- in: path
name: project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- components
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Announcement'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Announcement'
description: The resource was created.
/api/components/{project__slug}/{slug}/announcements/{announcement_id}/:
delete:
operationId: api_components_announcements_destroy
description: Delete an announcement.
parameters:
- in: path
name: announcement_id
schema:
type: integer
required: true
- in: path
name: project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- components
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'204':
description: No response body
/api/components/{project__slug}/{slug}/changes/:
get:
operationId: api_components_changes_list
description: Return a list of component changes.
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: path
name: project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- components
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedChangeList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/components/{project__slug}/{slug}/file/:
get:
operationId: api_components_file_retrieve
description: Download all translation files in the component.
parameters:
- in: path
name: project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- components
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/octet-stream:
schema:
type: string
format: binary
description: Component translation download.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/components/{project__slug}/{slug}/links/:
get:
operationId: api_components_links_list
description: Return projects linked with a component.
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: path
name: project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- components
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedProjectList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_components_links_create
description: Associate project with a component.
parameters:
- in: path
name: project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- components
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ComponentLinkRequest'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ComponentLinkResponse'
description: The resource was created.
/api/components/{project__slug}/{slug}/links/{project_slug}/:
delete:
operationId: api_components_links_destroy
description: Remove association of a project with a component.
parameters:
- in: path
name: project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: project_slug
schema:
type: string
required: true
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- components
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'204':
description: No response body
/api/components/{project__slug}/{slug}/lock/:
get:
operationId: api_components_lock_retrieve
description: Return component lock status.
parameters:
- in: path
name: project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- components
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Lock'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_components_lock_create
description: Sets component lock status.
parameters:
- in: path
name: project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- components
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LockRequest'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Lock'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/components/{project__slug}/{slug}/monolingual_base/:
get:
operationId: api_components_monolingual_base_retrieve
description: Download base file for monolingual translations.
parameters:
- in: path
name: project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- components
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/octet-stream:
schema:
type: string
format: binary
description: Monolingual base file download.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/components/{project__slug}/{slug}/new_template/:
get:
operationId: api_components_new_template_retrieve
description: Download template file for new translations.
parameters:
- in: path
name: project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- components
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/octet-stream:
schema:
type: string
format: binary
description: Template download for new translations.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/components/{project__slug}/{slug}/reports/:
get:
operationId: api_components_reports_list
description: List accessible reports generated directly for this scope.
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: path
name: project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- components
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedReportListList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_components_reports_create
description: Schedule report generation using the endpoint object as scope.
parameters:
- in: path
name: project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- components
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ScopedReportCreate'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/ReportTaskResponse'
description: The request was accepted for asynchronous processing.
/api/components/{project__slug}/{slug}/repository/:
get:
operationId: api_components_repository_retrieve
description: Return information about VCS repository status.
parameters:
- in: path
name: project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- components
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Repository'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_components_repository_create
description: Perform given operation on the VCS repository.
parameters:
- in: path
name: project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- components
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RepoRequest'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RepositoryOperation'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/components/{project__slug}/{slug}/screenshots/:
get:
operationId: api_components_screenshots_list
description: Return a list of component screenshots.
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: path
name: project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- components
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedScreenshotList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/components/{project__slug}/{slug}/statistics/:
get:
operationId: api_components_statistics_list
description: Return paginated statistics for all translations within component.
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: path
name: project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- components
- statistics
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedStatisticsList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/components/{project__slug}/{slug}/translations/:
get:
operationId: api_components_translations_list
description: Return a list of translation objects in the given component.
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: path
name: project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- components
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedComponentTranslationList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_components_translations_create
description: Create a new translation in the given component.
parameters:
- in: path
name: project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- components
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TranslationCreate'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ComponentTranslationResponse'
description: The resource was created.
/api/groups/:
get:
operationId: api_groups_list
description: Groups API.
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- groups
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedGroupList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_groups_create
description: Create a new group.
tags:
- groups
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
description: The resource was created.
/api/groups/{id}/:
get:
operationId: api_groups_retrieve
description: Return information about a group.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Group.
required: true
tags:
- groups
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
put:
operationId: api_groups_update
description: Change the group parameters.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Group.
required: true
tags:
- groups
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
patch:
operationId: api_groups_partial_update
description: Change the group parameters.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Group.
required: true
tags:
- groups
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedGroup'
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
delete:
operationId: api_groups_destroy
description: Delete the group.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Group.
required: true
tags:
- groups
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'204':
description: No response body
/api/groups/{id}/admins/:
post:
operationId: api_groups_admins_create
description: Make user a group admin.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Group.
required: true
tags:
- groups
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/groups/{id}/admins/{user_pk}/:
delete:
operationId: api_groups_admins_destroy
description: Delete a user from group admins.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Group.
required: true
- in: path
name: user_pk
schema:
type: integer
required: true
tags:
- groups
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'204':
description: No response body
/api/groups/{id}/componentlists/:
post:
operationId: api_groups_componentlists_create
description: Associate componentlists with a group.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Group.
required: true
tags:
- groups
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/groups/{id}/componentlists/{component_list_id}/:
delete:
operationId: api_groups_componentlists_destroy
description: Delete a componentlist from a group.
parameters:
- in: path
name: component_list_id
schema:
type: integer
required: true
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Group.
required: true
tags:
- groups
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'204':
description: No response body
/api/groups/{id}/components/:
post:
operationId: api_groups_components_create
description: Associate components with a group.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Group.
required: true
tags:
- groups
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/groups/{id}/components/{component_id}/:
delete:
operationId: api_groups_components_destroy
description: Delete a component from a group.
parameters:
- in: path
name: component_id
schema:
type: integer
required: true
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Group.
required: true
tags:
- groups
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'204':
description: No response body
/api/groups/{id}/languages/:
post:
operationId: api_groups_languages_create
description: Associate languages with a group.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Group.
required: true
tags:
- groups
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/groups/{id}/languages/{language_code}/:
delete:
operationId: api_groups_languages_destroy
description: Delete a language from a group.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Group.
required: true
- in: path
name: language_code
schema:
type: string
required: true
tags:
- groups
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'204':
description: No response body
/api/groups/{id}/projects/:
post:
operationId: api_groups_projects_create
description: Associate projects with a group.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Group.
required: true
tags:
- groups
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/groups/{id}/projects/{project_id}/:
delete:
operationId: api_groups_projects_destroy
description: Delete a project from a group.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Group.
required: true
- in: path
name: project_id
schema:
type: integer
required: true
tags:
- groups
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'204':
description: No response body
/api/groups/{id}/roles/:
post:
operationId: api_groups_roles_create
description: Associate roles with a group.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Group.
required: true
tags:
- groups
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Group'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/groups/{id}/roles/{role_id}/:
delete:
operationId: api_groups_roles_destroy
description: Delete a role from a group.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Group.
required: true
- in: path
name: role_id
schema:
type: integer
required: true
tags:
- groups
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'204':
description: No response body
/api/languages/:
get:
operationId: api_languages_list
description: Return a list of all languages the user has access to.
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- languages
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedLanguageList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_languages_create
description: Create a new language.
tags:
- languages
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Language'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Language'
description: The resource was created.
/api/languages/{code}/:
get:
operationId: api_languages_retrieve
description: Return information about a language.
parameters:
- in: path
name: code
schema:
type: string
title: Language code
required: true
tags:
- languages
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Language'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
put:
operationId: api_languages_update
description: Change the language parameters.
parameters:
- in: path
name: code
schema:
type: string
title: Language code
required: true
tags:
- languages
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Language'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Language'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
patch:
operationId: api_languages_partial_update
description: Change the language parameters.
parameters:
- in: path
name: code
schema:
type: string
title: Language code
required: true
tags:
- languages
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedLanguage'
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Language'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
delete:
operationId: api_languages_destroy
description: Delete the language.
parameters:
- in: path
name: code
schema:
type: string
title: Language code
required: true
tags:
- languages
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'204':
description: No response body
/api/languages/{code}/statistics/:
get:
operationId: api_languages_statistics_retrieve
description: Return statistics for a language.
parameters:
- in: path
name: code
schema:
type: string
title: Language code
required: true
tags:
- languages
- statistics
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Statistics'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/memory/:
get:
operationId: api_memory_list
description: Return a list of memory results.
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: project
schema:
type: string
- in: query
name: source
schema:
type: string
- in: query
name: source_language
schema:
type: string
- in: query
name: target_language
schema:
type: string
tags:
- memory
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedMemoryList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/memory/{id}/:
get:
operationId: api_memory_retrieve
description: Memory API.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Translation memory entry.
required: true
tags:
- memory
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Memory'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
delete:
operationId: api_memory_destroy
description: Delete a memory object.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Translation memory entry.
required: true
tags:
- memory
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'204':
description: No response body
/api/memory/lookup/:
post:
operationId: api_memory_lookup_create
description: Look up translation memory matches for the provided source strings.
parameters:
- in: query
name: exact
schema:
type: boolean
description: Return exact matches only and skip fuzzy matching.
- in: query
name: project
schema:
type: string
description: Project slug filter.
- in: query
name: source_language
schema:
type: string
description: Source language code.
required: true
- in: query
name: target_language
schema:
type: string
description: Target language code.
required: true
tags:
- memory
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MemoryLookupRequest'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/MemoryLookupResult'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/metrics/:
get:
operationId: api_metrics_retrieve
description: Return server metrics.
parameters:
- in: query
name: format
schema:
type: string
enum:
- csv
- json
- openmetrics
tags:
- metrics
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Metrics'
text/csv:
schema:
type: string
application/openmetrics-text:
schema:
type: string
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/projects/:
get:
operationId: api_projects_list
description: Return a list of all projects.
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- projects
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedProjectList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_projects_create
description: Create a new project.
tags:
- projects
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Project'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Project'
description: The resource was created.
/api/projects/{slug}/:
get:
operationId: api_projects_retrieve
description: Return information about a project.
parameters:
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Project'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
put:
operationId: api_projects_update
description: Edit a project by a PUT request.
parameters:
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Project'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Project'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
patch:
operationId: api_projects_partial_update
description: Edit a project by a PATCH request.
parameters:
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedProject'
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Project'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
delete:
operationId: api_projects_destroy
description: Delete a project.
parameters:
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'204':
description: No response body
/api/projects/{slug}/addons/:
post:
operationId: api_projects_addons_create
description: Translation projects API.
parameters:
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Project'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Project'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/projects/{slug}/announcements/:
get:
operationId: api_projects_announcements_list
description: Return announcements.
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedAnnouncementList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_projects_announcements_create
description: Create an announcement.
parameters:
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Announcement'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Announcement'
description: The resource was created.
/api/projects/{slug}/announcements/{announcement_id}/:
delete:
operationId: api_projects_announcements_destroy
description: Delete an announcement.
parameters:
- in: path
name: announcement_id
schema:
type: integer
required: true
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'204':
description: No response body
/api/projects/{slug}/backups/:
get:
operationId: api_projects_backups_list
description: Return a list of project backups.
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedBackupList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_projects_backups_create
description: Create a new project backup.
parameters:
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Project'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/CreateBackupResponse'
description: The request was accepted for asynchronous processing.
/api/projects/{slug}/backups/{backup}/:
get:
operationId: api_projects_backups_download_retrieve
description: Download a project backup.
parameters:
- in: path
name: backup
schema:
type: string
required: true
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/octet-stream:
schema:
type: string
format: binary
description: Project backup download.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/projects/{slug}/categories/:
get:
operationId: api_projects_categories_list
description: Return categories for a project.
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedCategoryList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/projects/{slug}/changes/:
get:
operationId: api_projects_changes_list
description: Return a list of project changes.
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedChangeList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/projects/{slug}/components/:
get:
operationId: api_projects_components_list
description: Return a list of translation components in the given project.
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedProjectComponentList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_projects_components_create
description: Create translation components in the given project.
parameters:
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Component'
multipart/form-data:
schema:
$ref: '#/components/schemas/Component'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Component'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/projects/{slug}/file/:
get:
operationId: api_projects_file_retrieve
description: Download all translation files in the project.
parameters:
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/octet-stream:
schema:
type: string
format: binary
description: Project translation download.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/projects/{slug}/labels/:
get:
operationId: api_projects_labels_list
description: Return labels for a project.
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedLabelList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_projects_labels_create
description: Create a label for a project.
parameters:
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Label'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Label'
description: The resource was created.
/api/projects/{slug}/labels/{label_id}/:
delete:
operationId: api_projects_labels_destroy
description: Delete a label from a project.
parameters:
- in: path
name: label_id
schema:
type: integer
required: true
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'204':
description: No response body
/api/projects/{slug}/languages/:
get:
operationId: api_projects_languages_list
description: Return statistics for all languages within a project.
parameters:
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
- statistics
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Statistics'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/projects/{slug}/languages/{language_code}/announcements/:
get:
operationId: api_projects_languages_announcements_list
description: Return project language announcements.
parameters:
- in: path
name: language_code
schema:
type: string
required: true
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedAnnouncementList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_projects_languages_announcements_create
description: Create a project language announcement.
parameters:
- in: path
name: language_code
schema:
type: string
required: true
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Announcement'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Announcement'
description: The resource was created.
/api/projects/{slug}/languages/{language_code}/announcements/{announcement_id}/:
delete:
operationId: api_projects_languages_announcements_destroy
description: Delete a project language announcement.
parameters:
- in: path
name: announcement_id
schema:
type: integer
required: true
- in: path
name: language_code
schema:
type: string
required: true
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'204':
description: No response body
/api/projects/{slug}/languages/{language_code}/file/:
get:
operationId: api_projects_languages_file_retrieve
description: Download all component translation files in the project for a specific
language.
parameters:
- in: path
name: language_code
schema:
type: string
description: Language code for the requested translations.
required: true
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/octet-stream:
schema:
type: string
format: binary
description: Project translation download for a specific language.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/projects/{slug}/lock/:
get:
operationId: api_projects_lock_retrieve
description: Return project lock status.
parameters:
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectLock'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_projects_lock_create
description: Sets project lock status.
parameters:
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LockRequest'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectLock'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/projects/{slug}/machinery_settings/:
get:
operationId: api_projects_machinery_settings_retrieve
description: List machinery settings for a project.
parameters:
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectMachinerySettings'
examples:
ServiceSettingsExample:
value:
service1:
key: XXXXXXX
url: https://api.service.com/
service2:
secret: SECRET_KEY
credentials: XXXXXXX
summary: Service settings example
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_projects_machinery_settings_create
description: Install a new machinery service.
parameters:
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SingleServiceConfig'
examples:
ServiceSettingsExample:
value:
service: service_name
configuration:
key: xxxxx
url: https://api.service.com/
summary: Service settings example
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
description: The resource was created.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
put:
operationId: api_projects_machinery_settings_update
description: Replace configuration for all services.
parameters:
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectMachinerySettings'
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
patch:
operationId: api_projects_machinery_settings_partial_update
description: Partially update a single service. Leave configuration blank to
remove the service.
parameters:
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedSingleServiceConfig'
examples:
ServiceSettingsExample:
value:
service: service_name
configuration:
key: xxxxx
url: https://api.service.com/
summary: Service settings example
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
/api/projects/{slug}/metrics/:
get:
operationId: api_projects_metrics_retrieve
description: Return translation metrics for a project.
parameters:
- in: query
name: format
schema:
type: string
enum:
- csv
- json
- openmetrics
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
- metrics
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
type: object
additionalProperties:
type: object
additionalProperties:
type: object
properties:
name:
type: string
translated:
type: integer
translated_words:
type: integer
translated_chars:
type: integer
total:
type: integer
total_words:
type: integer
total_chars:
type: integer
fuzzy:
type: integer
fuzzy_words:
type: integer
fuzzy_chars:
type: integer
failing:
type: integer
failing_words:
type: integer
failing_chars:
type: integer
approved:
type: integer
approved_words:
type: integer
approved_chars:
type: integer
suggestions:
type: integer
comments:
type: integer
translated_percent:
type: number
translated_words_percent:
type: number
translated_chars_percent:
type: number
approved_percent:
type: number
approved_words_percent:
type: number
approved_chars_percent:
type: number
required:
- name
- translated
- translated_words
- translated_chars
- total
- total_words
- total_chars
- fuzzy
- fuzzy_words
- fuzzy_chars
- failing
- failing_words
- failing_chars
- approved
- approved_words
- approved_chars
- suggestions
- comments
- translated_percent
- translated_words_percent
- translated_chars_percent
- approved_percent
- approved_words_percent
- approved_chars_percent
text/csv:
schema:
type: string
application/openmetrics-text:
schema:
type: string
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/projects/{slug}/reports/:
get:
operationId: api_projects_reports_list
description: List or create reports scoped to a project.
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedReportListList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_projects_reports_create
description: List or create reports scoped to a project.
parameters:
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ScopedReportCreate'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/ReportTaskResponse'
description: The request was accepted for asynchronous processing.
/api/projects/{slug}/repository/:
get:
operationId: api_projects_repository_retrieve
description: Return information about VCS repository status.
parameters:
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Repository'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_projects_repository_create
description: Perform given operation on the VCS repository.
parameters:
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RepoRequest'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RepositoryOperation'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/projects/{slug}/statistics/:
get:
operationId: api_projects_statistics_retrieve
description: Return statistics for a project.
parameters:
- in: path
name: slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
tags:
- projects
- statistics
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Statistics'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/reports/:
get:
operationId: api_reports_list
description: List stored reports accessible to the authenticated user.
parameters:
- in: query
name: category
schema:
type: integer
description: Limit results to a category ID.
- in: query
name: component
schema:
type: string
description: Limit results to a project/component path.
- in: query
name: kind
schema:
type: string
enum:
- contributor_stats
- cost_estimate
- credits
- translator_work
description: Limit results to one report kind.
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: project
schema:
type: string
description: Limit results to a project slug.
- in: query
name: workspace
schema:
type: string
format: uuid
description: Limit results to a workspace ID.
tags:
- reports
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedReportListList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_reports_create
description: Schedule generation of a stored report.
tags:
- reports
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReportCreate'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/ReportTaskResponse'
description: The request was accepted for asynchronous processing.
/api/reports/{id}/:
get:
operationId: api_reports_retrieve
description: Return report metadata, stored data, and rendered format links.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this report.
required: true
tags:
- reports
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Report'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/reports/{id}/html/:
get:
operationId: api_reports_html_retrieve
description: Download the report rendered as HTML.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this report.
required: true
tags:
- reports
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
text/html:
schema:
type: string
description: Rendered HTML report.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/reports/{id}/json/:
get:
operationId: api_reports_json_retrieve
description: Download stored report data without report metadata.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this report.
required: true
tags:
- reports
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
oneOf:
- type: object
additionalProperties: true
- type: array
items: {}
description: Stored report data without report metadata.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/reports/{id}/rst/:
get:
operationId: api_reports_rst_retrieve
description: Download the report rendered as reStructuredText.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this report.
required: true
tags:
- reports
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
text/plain:
schema:
type: string
description: Rendered reStructuredText report.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/roles/:
get:
operationId: api_roles_list
description: Return a list of all roles associated with the user.
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- roles
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedRoleList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_roles_create
description: Create a new role.
tags:
- roles
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Role'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Role'
description: The resource was created.
/api/roles/{id}/:
get:
operationId: api_roles_retrieve
description: Return information about a role.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Role.
required: true
tags:
- roles
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Role'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
put:
operationId: api_roles_update
description: Change the role parameters.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Role.
required: true
tags:
- roles
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Role'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Role'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
patch:
operationId: api_roles_partial_update
description: Change the role parameters.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Role.
required: true
tags:
- roles
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedRole'
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Role'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
delete:
operationId: api_roles_destroy
description: Delete a role.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Role.
required: true
tags:
- roles
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'204':
description: No response body
/api/schema/:
get:
operationId: api_schema_retrieve
description: |-
OpenApi3 schema for this API. Format can be selected via content negotiation.
- YAML: application/vnd.oai.openapi
- JSON: application/vnd.oai.openapi+json
parameters:
- in: query
name: lang
schema:
type: string
enum:
- ar
- az
- ba
- be
- be-latn
- bg
- br
- ca
- cs
- cy
- da
- de
- el
- en
- en-gb
- es
- fi
- fr
- ga
- gl
- he
- hr
- hu
- id
- is
- it
- ja
- kab
- kk
- ko
- lo
- nb
- nl
- pl
- pt
- pt-br
- ro
- ru
- sk
- sl
- sq
- sr
- sr-latn
- sv
- ta
- th
- tr
- uk
- vi
- zh-hans
- zh-hant
tags:
- schema
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/vnd.oai.openapi:
schema:
$ref: '#/components/schemas/ErrorResponse400'
application/yaml:
schema:
$ref: '#/components/schemas/ErrorResponse400'
application/vnd.oai.openapi+json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/vnd.oai.openapi:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
application/yaml:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
application/vnd.oai.openapi+json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'404':
content:
application/vnd.oai.openapi:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
application/yaml:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
application/vnd.oai.openapi+json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/vnd.oai.openapi:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
application/yaml:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
application/vnd.oai.openapi+json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/vnd.oai.openapi:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
application/yaml:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
application/vnd.oai.openapi+json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/vnd.oai.openapi:
schema:
$ref: '#/components/schemas/ErrorResponse423'
application/yaml:
schema:
$ref: '#/components/schemas/ErrorResponse423'
application/vnd.oai.openapi+json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/vnd.oai.openapi:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
application/yaml:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
application/vnd.oai.openapi+json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/vnd.oai.openapi:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
application/yaml:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
application/vnd.oai.openapi+json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/vnd.oai.openapi:
schema:
type: object
additionalProperties: {}
application/yaml:
schema:
type: object
additionalProperties: {}
application/vnd.oai.openapi+json:
schema:
type: object
additionalProperties: {}
application/json:
schema:
type: object
additionalProperties: {}
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/screenshots/:
get:
operationId: api_screenshots_list
description: Return a list of screenshot string information.
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- screenshots
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedScreenshotList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_screenshots_create
description: Create a new screenshot.
tags:
- screenshots
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/Screenshot'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Screenshot'
description: The resource was created.
/api/screenshots/{id}/:
get:
operationId: api_screenshots_retrieve
description: Return information about screenshot information.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Screenshot.
required: true
tags:
- screenshots
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Screenshot'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
put:
operationId: api_screenshots_update
description: Edit full information about screenshot.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Screenshot.
required: true
tags:
- screenshots
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Screenshot'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Screenshot'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
patch:
operationId: api_screenshots_partial_update
description: Edit partial information about screenshot.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Screenshot.
required: true
tags:
- screenshots
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedScreenshot'
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Screenshot'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
delete:
operationId: api_screenshots_destroy
description: Delete screenshot.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Screenshot.
required: true
tags:
- screenshots
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'204':
description: No response body
/api/screenshots/{id}/file/:
get:
operationId: api_screenshots_file_retrieve
description: Download the screenshot image.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Screenshot.
required: true
tags:
- screenshots
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/octet-stream:
schema:
type: string
format: binary
description: Screenshot image download.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_screenshots_file_create
description: Replace screenshot image.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Screenshot.
required: true
tags:
- screenshots
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/ScreenshotFile'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BooleanResult'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
put:
operationId: api_screenshots_file_update
description: Replace screenshot image.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Screenshot.
required: true
tags:
- screenshots
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/ScreenshotFile'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BooleanResult'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/screenshots/{id}/units/:
post:
operationId: api_screenshots_units_create
description: Associate source string with screenshot.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Screenshot.
required: true
tags:
- screenshots
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Screenshot'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Screenshot'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/screenshots/{id}/units/{unit_id}/:
delete:
operationId: api_screenshots_units_destroy
description: Remove source string association with screenshot.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Screenshot.
required: true
- in: path
name: unit_id
schema:
type: integer
required: true
tags:
- screenshots
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'204':
description: No response body
/api/search/:
get:
operationId: api_search_retrieve
description: Return site-wide search results as a list.
parameters:
- in: query
name: q
schema:
type: string
description: Search query.
tags:
- search
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SearchResult'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/suggestions/:
get:
operationId: api_suggestions_list
description: Return a list of suggestions.
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- suggestions
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedSuggestionList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/suggestions/{id}/:
get:
operationId: api_suggestions_retrieve
description: Return information about a suggestion.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this string suggestion.
required: true
tags:
- suggestions
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Suggestion'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
delete:
operationId: api_suggestions_destroy
description: Delete a suggestion.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this string suggestion.
required: true
tags:
- suggestions
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'204':
description: No response body
/api/suggestions/{id}/accept/:
post:
operationId: api_suggestions_accept_create
description: Accept a suggestion.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this string suggestion.
required: true
tags:
- suggestions
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SuggestionAcceptRequest'
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SuggestionActionResult'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/suggestions/{id}/vote/:
post:
operationId: api_suggestions_vote_create
description: Vote on a suggestion.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this string suggestion.
required: true
tags:
- suggestions
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SuggestionVoteRequest'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SuggestionVoteResult'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/tasks/{id}/:
get:
operationId: api_tasks_retrieve
description: Return information about a task
parameters:
- in: path
name: id
schema:
type: string
pattern: ^[^/]+$
required: true
tags:
- tasks
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
delete:
operationId: api_tasks_destroy
description: Cancel a running task.
parameters:
- in: path
name: id
schema:
type: string
pattern: ^[^/]+$
required: true
tags:
- tasks
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'204':
description: No response body
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
/api/translations/:
get:
operationId: api_translations_list
description: Return a list of translations.
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- translations
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedTranslationList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/translations/{component__project__slug}/{component__slug}/{language__code}/:
get:
operationId: api_translations_retrieve
description: Return information about a translation.
parameters:
- in: path
name: component__project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: component__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: language__code
schema:
type: string
title: Language code
required: true
tags:
- translations
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Translation'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
delete:
operationId: api_translations_destroy
description: Delete a translation.
parameters:
- in: path
name: component__project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: component__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: language__code
schema:
type: string
title: Language code
required: true
tags:
- translations
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'204':
description: No response body
/api/translations/{component__project__slug}/{component__slug}/{language__code}/announcements/:
get:
operationId: api_translations_announcements_list
description: Return announcements.
parameters:
- in: path
name: component__project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: component__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: language__code
schema:
type: string
title: Language code
required: true
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- translations
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedAnnouncementList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_translations_announcements_create
description: Create an announcement.
parameters:
- in: path
name: component__project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: component__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: language__code
schema:
type: string
title: Language code
required: true
tags:
- translations
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Announcement'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Announcement'
description: The resource was created.
/api/translations/{component__project__slug}/{component__slug}/{language__code}/announcements/{announcement_id}/:
delete:
operationId: api_translations_announcements_destroy
description: Delete an announcement.
parameters:
- in: path
name: announcement_id
schema:
type: integer
required: true
- in: path
name: component__project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: component__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: language__code
schema:
type: string
title: Language code
required: true
tags:
- translations
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'204':
description: No response body
/api/translations/{component__project__slug}/{component__slug}/{language__code}/autotranslate/:
post:
operationId: api_translations_autotranslate_create
description: Trigger automatic translation.
parameters:
- in: path
name: component__project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: component__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: language__code
schema:
type: string
title: Language code
required: true
tags:
- translations
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Translation'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Translation'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/translations/{component__project__slug}/{component__slug}/{language__code}/changes/:
get:
operationId: api_translations_changes_list
description: Return a list of translation changes.
parameters:
- in: path
name: component__project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: component__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: language__code
schema:
type: string
title: Language code
required: true
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- translations
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedChangeList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/translations/{component__project__slug}/{component__slug}/{language__code}/file/:
get:
operationId: api_translations_file_retrieve
description: Download translation file.
parameters:
- in: path
name: component__project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: component__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: language__code
schema:
type: string
title: Language code
required: true
tags:
- translations
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/octet-stream:
schema:
type: string
format: binary
description: Translation file download.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_translations_file_create
description: Upload new file with translations.
parameters:
- in: path
name: component__project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: component__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: language__code
schema:
type: string
title: Language code
required: true
tags:
- translations
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/UploadRequest'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UploadResult'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
put:
operationId: api_translations_file_update
description: Upload new file with translations.
parameters:
- in: path
name: component__project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: component__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: language__code
schema:
type: string
title: Language code
required: true
tags:
- translations
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/UploadRequest'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UploadResult'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/translations/{component__project__slug}/{component__slug}/{language__code}/repository/:
get:
operationId: api_translations_repository_retrieve
description: Return information about VCS repository status.
parameters:
- in: path
name: component__project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: component__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: language__code
schema:
type: string
title: Language code
required: true
tags:
- translations
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Repository'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_translations_repository_create
description: Perform given operation on the VCS repository.
parameters:
- in: path
name: component__project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: component__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: language__code
schema:
type: string
title: Language code
required: true
tags:
- translations
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RepoRequest'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RepositoryOperation'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/translations/{component__project__slug}/{component__slug}/{language__code}/statistics/:
get:
operationId: api_translations_statistics_retrieve
description: Return detailed translation statistics.
parameters:
- in: path
name: component__project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: component__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: language__code
schema:
type: string
title: Language code
required: true
tags:
- translations
- statistics
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Statistics'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/translations/{component__project__slug}/{component__slug}/{language__code}/units/:
get:
operationId: api_translations_units_list
description: Return a list of translation units.
parameters:
- in: path
name: component__project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: component__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: language__code
schema:
type: string
title: Language code
required: true
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- translations
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedUnitList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_translations_units_create
description: Add a new unit.
parameters:
- in: path
name: component__project__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: component__slug
schema:
type: string
title: URL slug
description: Name used in URLs and filenames.
required: true
- in: path
name: language__code
schema:
type: string
title: Language code
required: true
tags:
- translations
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NewUnitRequest'
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Unit'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/units/:
get:
operationId: api_units_list
description: Return a list of translation units.
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- units
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedUnitList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/units/{id}/:
get:
operationId: api_units_retrieve
description: Return information about translation unit.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this string.
required: true
tags:
- units
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Unit'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
put:
operationId: api_units_update
description: Perform full update on translation unit.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this string.
required: true
tags:
- units
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UnitWrite'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UnitWrite'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
patch:
operationId: api_units_partial_update
description: Perform partial update on translation unit.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this string.
required: true
tags:
- units
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedUnitWrite'
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UnitWrite'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
delete:
operationId: api_units_destroy
description: Delete a translation unit.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this string.
required: true
tags:
- units
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'204':
description: No response body
/api/units/{id}/comments/:
get:
operationId: api_units_comments_list
description: Return a list of comments on the unit.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this string.
required: true
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- units
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedCommentList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_units_comments_create
description: Add a comment to the unit.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this string.
required: true
tags:
- units
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Comment'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UnitWrite'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/units/{id}/suggestions/:
get:
operationId: api_units_suggestions_list
description: Return a list of suggestions on the unit.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this string.
required: true
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
tags:
- units
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedSuggestionList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_units_suggestions_create
description: Add a suggestion to the unit.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this string.
required: true
tags:
- units
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Suggestion'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Suggestion'
description: The resource was created.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SuggestionVoteResult'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/units/{id}/translations/:
get:
operationId: api_units_translations_retrieve
description: Units API.
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this string.
required: true
tags:
- units
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UnitWrite'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/users/:
get:
operationId: api_users_list
description: |-
List of users if you have permissions to see manage users.
Without a permission you get to see only your own details.
parameters:
- in: query
name: id
schema:
type: integer
- in: query
name: is_active
schema:
type: boolean
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: username
schema:
type: string
tags:
- users
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedFullUserList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_users_create
description: Create a new user.
tags:
- users
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FullUser'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/FullUser'
description: The resource was created.
/api/users/{username}/:
get:
operationId: api_users_retrieve
description: Return information about users.
parameters:
- in: path
name: username
schema:
type: string
description: 'Username may only contain letters, numbers or the following
characters: @ . + - _'
required: true
tags:
- users
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UserResponse'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
put:
operationId: api_users_update
description: Change the user parameters.
parameters:
- in: path
name: username
schema:
type: string
description: 'Username may only contain letters, numbers or the following
characters: @ . + - _'
required: true
tags:
- users
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserUpdateRequest'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FullUser'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
patch:
operationId: api_users_partial_update
description: Change the user parameters.
parameters:
- in: path
name: username
schema:
type: string
description: 'Username may only contain letters, numbers or the following
characters: @ . + - _'
required: true
tags:
- users
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedUserUpdateRequest'
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FullUser'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
delete:
operationId: api_users_destroy
description: Delete all user information and mark the user inactive.
parameters:
- in: path
name: username
schema:
type: string
description: 'Username may only contain letters, numbers or the following
characters: @ . + - _'
required: true
tags:
- users
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'204':
description: No response body
/api/users/{username}/contributions/:
get:
operationId: api_users_contributions_list
description: List translation contributions of a user.
parameters:
- in: query
name: id
schema:
type: integer
- in: query
name: is_active
schema:
type: boolean
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: path
name: username
schema:
type: string
description: 'Username may only contain letters, numbers or the following
characters: @ . + - _'
required: true
- in: query
name: username
schema:
type: string
tags:
- users
- contributions
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedTranslationList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/users/{username}/groups/:
post:
operationId: api_users_groups_create
description: Associate groups with a user.
parameters:
- in: path
name: username
schema:
type: string
description: 'Username may only contain letters, numbers or the following
characters: @ . + - _'
required: true
tags:
- users
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserGroupRequest'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FullUser'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
delete:
operationId: api_users_groups_destroy
description: Remove a user from a group.
parameters:
- in: path
name: username
schema:
type: string
description: 'Username may only contain letters, numbers or the following
characters: @ . + - _'
required: true
tags:
- users
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'204':
description: No response body
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserGroupDeleteRequest'
required: true
/api/users/{username}/notifications/:
get:
operationId: api_users_notifications_list
description: List subscriptions of a user.
parameters:
- in: query
name: id
schema:
type: integer
- in: query
name: is_active
schema:
type: boolean
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: path
name: username
schema:
type: string
description: 'Username may only contain letters, numbers or the following
characters: @ . + - _'
required: true
- in: query
name: username
schema:
type: string
tags:
- users
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedNotificationList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
post:
operationId: api_users_notifications_create
description: Associate subscriptions with a user.
parameters:
- in: query
name: id
schema:
type: integer
- in: query
name: is_active
schema:
type: boolean
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: path
name: username
schema:
type: string
description: 'Username may only contain letters, numbers or the following
characters: @ . + - _'
required: true
- in: query
name: username
schema:
type: string
tags:
- users
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Notification'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedNotificationList'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/api/users/{username}/notifications/{subscription_id}/:
get:
operationId: api_users_notifications_retrieve
description: Get a subscription associated with a user.
parameters:
- in: path
name: subscription_id
schema:
type: integer
required: true
- in: path
name: username
schema:
type: string
description: 'Username may only contain letters, numbers or the following
characters: @ . + - _'
required: true
tags:
- users
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Notification'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
put:
operationId: api_users_notifications_update
description: Edit a subscription associated with a user.
parameters:
- in: path
name: subscription_id
schema:
type: integer
required: true
- in: path
name: username
schema:
type: string
description: 'Username may only contain letters, numbers or the following
characters: @ . + - _'
required: true
tags:
- users
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Notification'
required: true
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Notification'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
patch:
operationId: api_users_notifications_partial_update
description: Edit a subscription associated with a user.
parameters:
- in: path
name: subscription_id
schema:
type: integer
required: true
- in: path
name: username
schema:
type: string
description: 'Username may only contain letters, numbers or the following
characters: @ . + - _'
required: true
tags:
- users
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedNotification'
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'415':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse415'
examples:
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
description: The request media type is not supported.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Notification'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
delete:
operationId: api_users_notifications_destroy
description: Delete a subscription associated with a user.
parameters:
- in: path
name: subscription_id
schema:
type: integer
required: true
- in: path
name: username
schema:
type: string
description: 'Username may only contain letters, numbers or the following
characters: @ . + - _'
required: true
tags:
- users
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'204':
description: No response body
/api/users/{username}/statistics/:
get:
operationId: api_users_statistics_retrieve
description: List statistics of a user.
parameters:
- in: path
name: username
schema:
type: string
description: 'Username may only contain letters, numbers or the following
characters: @ . + - _'
required: true
tags:
- users
- statistics
security:
- tokenAuth: []
- bearerAuth: []
- cookieAuth: []
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse401'
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
description: Authentication credentials were missing or invalid.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse403'
examples:
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
description: The authenticated user does not have permission for this operation.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse429'
examples:
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
description: The API request rate limit was exceeded.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UserStatistics'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
/hooks/{service}/:
post:
operationId: hooks_incoming
description: Process incoming webhook from a code-hosting site.
parameters:
- in: path
name: service
schema:
type: string
enum:
- azure
- bitbucket
- forgejo
- gitea
- gitee
- github
- gitlab
- pagure
required: true
tags:
- hooks
security:
- {}
responses:
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse400'
description: The request was invalid or could not be parsed.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse404'
examples:
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
description: The requested resource was not found or is not accessible.
'405':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse405'
examples:
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
description: The HTTP method is not allowed for this resource.
'406':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse406'
examples:
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
description: The requested response media type is not available.
'423':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse423'
description: The resource is locked.
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse500'
examples:
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
description: An unexpected server error occurred.
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/HookResponse'
description: Successful response.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
components:
headers:
X-RateLimit-Limit:
schema:
type: integer
description: Allowed number of requests to perform
required: true
X-RateLimit-Remaining:
schema:
type: integer
description: Remaining number of requests to perform
required: true
X-RateLimit-Reset:
schema:
type: integer
description: Number of seconds until the rate-limit window resets
required: true
schemas:
AccessControlEnum:
enum:
- 0
- 1
- 100
- 200
type: integer
description: |-
* `0` - Public
* `1` - Protected
* `100` - Private
* `200` - Custom
ActionEnum:
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 13
- 14
- 15
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 41
- 42
- 43
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
type: integer
description: |-
* `0` - **Resource updated:** A translation file was synchronized with its repository.
* `1` - **Translation completed:** A language translation became fully translated after an individual edit. Automatic translation, uploads, and bulk edits do not emit this event.
* `2` - **Translation changed:** An existing translation was edited by a user.
* `3` - **Comment added:** A comment was added to a string.
* `4` - **Suggestion added:** A translation suggestion was added.
* `5` - **Translation added:** A previously untranslated string was translated by a user.
* `6` - **Automatically translated:** A translation was added or changed by automatic translation. This is emitted instead of Translation added or Translation changed.
* `7` - **Suggestion accepted:** A translation suggestion was accepted as the translation.
* `8` - **Translation reverted:** A translation was restored to an earlier value.
* `9` - **Translation uploaded:** A translation was added or changed by a translation file upload. This is emitted instead of Translation added or Translation changed.
* `13` - **Source string added:** A source string was added outside repository or upload updates.
* `14` - **Component locked:** A component was locked for translation.
* `15` - **Component unlocked:** A component was unlocked for translation.
* `17` - **Changes committed:** Pending component changes were committed.
* `18` - **Changes pushed:** Repository changes were pushed upstream.
* `19` - **Repository reset:** A repository was reset to its upstream state.
* `20` - **Repository merged:** Upstream repository changes were merged.
* `21` - **Repository rebased:** Repository changes were rebased on upstream.
* `22` - **Repository merge failed:** Merging upstream repository changes failed.
* `23` - **Repository rebase failed:** Rebasing repository changes failed.
* `24` - **Parsing failed:** Weblate could not parse a translation file.
* `25` - **Translation removed:** A language translation was removed.
* `26` - **Suggestion removed:** A translation suggestion was removed.
* `27` - **Translation replaced:** A translation was changed by a search-and-replace operation. This is emitted instead of Translation changed.
* `28` - **Repository push failed:** Pushing repository changes upstream failed.
* `29` - **Suggestion removed during cleanup:** An obsolete translation suggestion was removed during cleanup.
* `30` - **Source string changed:** A source string was edited in Weblate.
* `31` - **String added:** A new string was added in Weblate.
* `32` - **Bulk status changed:** The translation state of one or more strings was changed in bulk.
* `33` - **Visibility changed:** Project or component visibility was changed.
* `34` - **User added:** A user was granted access.
* `35` - **User removed:** A user's access was removed.
* `36` - **Translation approved:** A translation was approved during review.
* `37` - **Marked for edit:** A translation was marked as needing editing.
* `38` - **Component removed:** A translation component was removed.
* `39` - **Project removed:** A translation project was removed.
* `41` - **Project renamed:** A translation project was renamed.
* `42` - **Component renamed:** A translation component was renamed.
* `43` - **Moved component:** A component was moved within a project.
* `45` - **Contributor joined:** A user made their first contribution to a translation.
* `46` - **Announcement posted:** An announcement was posted.
* `47` - **Alert triggered:** A component alert was triggered.
* `48` - **Language added:** A language translation was added.
* `49` - **Language requested:** A user requested a new language.
* `50` - **Project created:** A translation project was created.
* `51` - **Component created:** A translation component was created.
* `52` - **User invited:** A user was invited to a project.
* `53` - **Repository notification received:** Weblate received a repository notification from a code host.
* `54` - **Translation replaced file by upload:** A translation file was replaced by an uploaded file.
* `55` - **License changed:** Project or component license information changed.
* `56` - **Contributor license agreement changed:** The contributor license agreement was changed.
* `57` - **Screenshot added:** A screenshot was associated with a string.
* `58` - **Screenshot uploaded:** A screenshot image was uploaded.
* `59` - **String updated in the repository:** A string was changed while synchronizing from the repository.
* `60` - **Add-on installed:** An add-on was installed.
* `61` - **Add-on configuration changed:** An add-on's configuration was changed.
* `62` - **Add-on uninstalled:** An add-on was uninstalled.
* `63` - **String removed:** A string was removed from a translation.
* `64` - **Comment removed:** A string comment was removed.
* `65` - **Comment resolved:** A string comment was marked as resolved.
* `66` - **Explanation updated:** The explanation for a source string was updated.
* `67` - **Category removed:** A component category was removed.
* `68` - **Category renamed:** A component category was renamed.
* `69` - **Category moved:** A component category was moved.
* `70` - **Saving string failed:** Weblate could not save a changed string.
* `71` - **String added in the repository:** A new string was found while synchronizing from the repository.
* `72` - **String updated in the upload:** A string was changed while processing an uploaded file.
* `73` - **String added in the upload:** A new string was found while processing an uploaded file.
* `74` - **Translation updated by source upload:** A translation was synchronized after uploading a source file.
* `75` - **Component translation completed:** All language translations in a component became fully translated after an individual edit. Automatic translation, uploads, and bulk edits do not emit this event.
* `76` - **Applied enforced check:** A translation was marked as needing editing by an enforced check.
* `77` - **Propagated change:** A translation edit was propagated to another matching string.
* `78` - **File uploaded:** A file was uploaded to a translation.
* `79` - **Extra flags updated:** Additional source-string flags were updated.
* `80` - **Font uploaded:** A font was uploaded.
* `81` - **Font changed:** An uploaded font was changed.
* `82` - **Font removed:** An uploaded font was removed.
* `83` - **Forced synchronization of translations:** Translation files were forcibly synchronized with the repository.
* `84` - **Forced rescan of translations:** Translation files were forcibly rescanned for changes.
* `85` - **Screenshot removed:** A screenshot was removed.
* `86` - **Label added:** A label was added to a string.
* `87` - **Label removed:** A label was removed from a string.
* `88` - **Repository cleanup:** The repository working tree was cleaned up.
* `89` - **Source string added in the upload:** A source string was added while processing an uploaded file.
* `90` - **Source string added in the repository:** A source string was added while synchronizing from the repository.
* `91` - **Project backed up:** A project backup was created.
* `92` - **Project restored:** A project was restored from a backup.
* `93` - **Component restored:** A component was restored from a backup.
* `94` - **User edit reverted:** All selected edits by a user were reverted.
* `95` - **Project setting changed:** A project setting was changed.
* `96` - **Component setting changed:** A component setting was changed.
* `97` - **User access changed:** A user's access permissions were changed.
* `98` - **Workspace created:** A workspace was created.
* `99` - **Workspace setting changed:** A workspace setting was changed.
* `100` - **Project moved:** A project was moved into or out of a workspace.
* `101` - **Remote repository updated:** A remote repository update was completed.
* `102` - **Remote repository update failed:** Updating a remote repository failed.
* `103` - **Alert dismissed:** A component alert was dismissed.
* `104` - **Alert reopened:** A component alert was reopened after its context changed.
Addon:
type: object
properties:
component:
type: string
format: uri
readOnly: true
project:
type: string
format: uri
readOnly: true
name:
type: string
maxLength: 100
id:
type: integer
readOnly: true
configuration: {}
url:
type: string
format: uri
readOnly: true
required:
- component
- id
- name
- project
- url
AddonTriggerResponse:
type: object
properties:
detail:
type: string
url:
type: string
format: uri
logs_url:
type: string
format: uri
required:
- detail
- logs_url
- url
Alert:
type: object
properties:
name:
type: string
readOnly: true
timestamp:
type: string
format: date-time
readOnly: true
updated:
type: string
format: date-time
readOnly: true
severity:
allOf:
- $ref: '#/components/schemas/AlertSeverityEnum'
readOnly: true
details:
readOnly: true
category:
allOf:
- $ref: '#/components/schemas/CategoryEnum'
readOnly: true
dismissed_at:
type:
- string
- 'null'
format: date-time
readOnly: true
dismissed_by:
type:
- string
- 'null'
format: uri
readOnly: true
dismissal_reason:
type: string
readOnly: true
required:
- category
- details
- dismissal_reason
- dismissed_at
- dismissed_by
- name
- severity
- timestamp
- updated
AlertSeverityEnum:
enum:
- 10
- 50
- 100
type: integer
description: |-
* `10` - Information
* `50` - Warning
* `100` - Error
Announcement:
type: object
properties:
id:
type: integer
readOnly: true
message:
type: string
description: You can use Markdown and mention users by @username.
severity:
allOf:
- $ref: '#/components/schemas/SeverityEnum'
description: Severity defines color used for the message.
expiry:
type:
- string
- 'null'
format: date
title: Expiry date
description: The message will be not shown after this date. Use it to announce
string freeze and translation deadline for next release.
notify:
type: boolean
title: Notify users
description: Send notification to subscribed users.
required:
- id
- message
AutoComponentList:
type: object
properties:
project_match:
type: string
title: Project regular expression
description: Regular expression which is used to match project slug.
maxLength: 200
component_match:
type: string
title: Component regular expression
description: Regular expression which is used to match component slug.
maxLength: 200
Backup:
type: object
properties:
name:
type: string
timestamp:
type: string
format: date-time
size:
type: integer
required:
- name
- size
- timestamp
BasicUser:
type: object
properties:
id:
type: integer
readOnly: true
full_name:
type: string
maxLength: 150
username:
type: string
description: 'Username may only contain letters, numbers or the following
characters: @ . + - _'
maxLength: 150
required:
- full_name
- id
- username
BilingualSourceUnit:
type: object
properties:
state:
$ref: '#/components/schemas/NewUnitStateEnum'
context:
type: string
source:
type: array
items:
type: string
target:
type: array
items:
type: string
required:
- source
BilingualUnit:
type: object
properties:
state:
$ref: '#/components/schemas/NewUnitStateEnum'
context:
type: string
source:
type: array
items:
type: string
target:
type: array
items:
type: string
required:
- source
- target
BlankEnum:
enum:
- ''
BooleanResult:
type: object
properties:
result:
type: boolean
required:
- result
Category:
type: object
properties:
id:
type: integer
readOnly: true
name:
type: string
title: Category name
description: Display name
maxLength: 100
slug:
type: string
title: URL slug
description: Name used in URLs and filenames.
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
project:
type: string
format: uri
category:
type:
- string
- 'null'
format: uri
url:
type: string
format: uri
readOnly: true
statistics_url:
type: string
format: uri
readOnly: true
announcements_url:
type: string
format: uri
readOnly: true
reports_url:
type: string
format: uri
readOnly: true
check_flags:
type: string
title: Translation flags
description: Additional comma-separated flags to influence Weblate behavior.
effective_check_flags:
type: string
readOnly: true
license:
title: Translation license
type: string
maxLength: 150
examples:
- MIT
- GPL-3.0-or-later
- Apache-2.0
- BSD-3-Clause
- proprietary
inherit_license:
type: boolean
title: Inherit translation license
description: Use the translation license configured in the parent category
or project.
effective_license:
type: string
readOnly: true
agreement:
type: string
title: Contributor license agreement
description: Contributor license agreement which needs to be approved before
a user can translate components in this category.
inherit_agreement:
type: boolean
title: Inherit contributor license agreement
description: Use the contributor license agreement configured in the parent
category or project.
effective_agreement:
type: string
readOnly: true
new_lang:
allOf:
- $ref: '#/components/schemas/NewLangEnum'
title: Adding new translation
description: How to handle requests for creating new translations.
inherit_new_lang:
type: boolean
title: Inherit adding new translations
description: Use the adding new translations setting configured in the parent
category or project.
effective_new_lang:
type: string
readOnly: true
language_code_style:
description: Customize language code used to generate the filename for translations
created by Weblate.
oneOf:
- $ref: '#/components/schemas/LanguageCodeStyleEnum'
- $ref: '#/components/schemas/BlankEnum'
inherit_language_code_style:
type: boolean
description: Use the language code style configured in the parent category
or project.
effective_language_code_style:
type: string
readOnly: true
secondary_language:
type:
- integer
- 'null'
description: Additional language to show together with the source language
while translating.
inherit_secondary_language:
type: boolean
description: Use the secondary language configured in the parent category
or project.
effective_secondary_language:
type:
- integer
- 'null'
readOnly: true
commit_message:
type: string
title: Commit message when translating
description: You can use template language for various info, please consult
the documentation for more details.
inherit_commit_message:
type: boolean
title: Inherit commit message when translating
description: Use the commit message when translating configured in the parent
category or project.
effective_commit_message:
type: string
readOnly: true
add_message:
type: string
title: Commit message when adding translation
description: You can use template language for various info, please consult
the documentation for more details.
inherit_add_message:
type: boolean
title: Inherit commit message when adding translation
description: Use the commit message when adding translation configured in
the parent category or project.
effective_add_message:
type: string
readOnly: true
delete_message:
type: string
title: Commit message when removing translation
description: You can use template language for various info, please consult
the documentation for more details.
inherit_delete_message:
type: boolean
title: Inherit commit message when removing translation
description: Use the commit message when removing translation configured
in the parent category or project.
effective_delete_message:
type: string
readOnly: true
merge_message:
type: string
title: Commit message when merging translation
description: You can use template language for various info, please consult
the documentation for more details.
inherit_merge_message:
type: boolean
title: Inherit commit message when merging translation
description: Use the commit message when merging translation configured
in the parent category or project.
effective_merge_message:
type: string
readOnly: true
addon_message:
type: string
title: Commit message when add-on makes a change
description: You can use template language for various info, please consult
the documentation for more details.
inherit_addon_message:
type: boolean
title: Inherit commit message when add-on makes a change
description: Use the commit message when add-on makes a change configured
in the parent category or project.
effective_addon_message:
type: string
readOnly: true
pull_message:
type: string
title: Merge request message
description: You can use template language for various info, please consult
the documentation for more details.
inherit_pull_message:
type: boolean
title: Inherit merge request message
description: Use the merge request message configured in the parent category
or project.
effective_pull_message:
type: string
readOnly: true
required:
- announcements_url
- effective_add_message
- effective_addon_message
- effective_agreement
- effective_check_flags
- effective_commit_message
- effective_delete_message
- effective_language_code_style
- effective_license
- effective_merge_message
- effective_new_lang
- effective_pull_message
- effective_secondary_language
- id
- name
- project
- reports_url
- slug
- statistics_url
- url
CategoryEnum:
enum:
- addons
- community
- configuration
- files
- vcs
type: string
description: |-
* `addons` - addons
* `community` - community
* `configuration` - configuration
* `files` - files
* `vcs` - vcs
Change:
type: object
properties:
unit:
type: string
format: uri
readOnly: true
component:
type: string
format: uri
readOnly: true
translation:
type: string
format: uri
readOnly: true
user:
type: string
format: uri
readOnly: true
author:
type: string
format: uri
readOnly: true
alert:
oneOf:
- $ref: '#/components/schemas/Alert'
- type: 'null'
readOnly: true
timestamp:
type: string
format: date-time
readOnly: true
action:
allOf:
- $ref: '#/components/schemas/ActionEnum'
minimum: -2147483648
maximum: 2147483647
target:
type: string
old:
type: string
details: {}
id:
type: integer
readOnly: true
action_name:
type: string
readOnly: true
url:
type: string
format: uri
readOnly: true
required:
- action_name
- alert
- author
- component
- id
- timestamp
- translation
- unit
- url
- user
ClientErrorEnum:
enum:
- client_error
type: string
description: '* `client_error` - Client Error'
ColorEnum:
enum:
- navy
- blue
- aqua
- teal
- olive
- green
- lime
- yellow
- orange
- red
- maroon
- fuchsia
- purple
- black
- gray
- silver
type: string
description: |-
* `navy` - Navy
* `blue` - Blue
* `aqua` - Aqua
* `teal` - Teal
* `olive` - Olive
* `green` - Green
* `lime` - Lime
* `yellow` - Yellow
* `orange` - Orange
* `red` - Red
* `maroon` - Maroon
* `fuchsia` - Fuchsia
* `purple` - Purple
* `black` - Black
* `gray` - Gray
* `silver` - Silver
Comment:
type: object
properties:
scope:
allOf:
- $ref: '#/components/schemas/CommentScopeEnum'
writeOnly: true
description: Is your comment specific to this translation, or generic for
all of them?
comment:
type: string
title: Comment text
description: You can use Markdown and mention users by @username.
maxLength: 1000
timestamp:
type: string
format: date-time
title: Creation timestamp
description: If you’re an admin, you can set the explicit timestamp at which
the comment was created.
user_email:
type: string
format: email
writeOnly: true
title: Commenter’s email
description: If you’re an admin, you can attribute this comment to another
user by their email.
id:
type: integer
readOnly: true
user:
type: string
format: uri
readOnly: true
required:
- comment
- id
- scope
- user
CommentScopeEnum:
enum:
- report
- global
- translation
type: string
description: |-
* `report` - report
* `global` - global
* `translation` - translation
CommitInfo:
type: object
description: Detailed information about a Git commit.
properties:
revision:
type:
- string
- 'null'
description: Full commit hash.
shortrevision:
type:
- string
- 'null'
description: Abbreviated commit hash.
author:
type:
- string
- 'null'
description: Commit author with email (e.g., 'Name <[email protected]>').
author_name:
type:
- string
- 'null'
description: Author name.
author_email:
type:
- string
- 'null'
description: Author email address.
authordate:
type:
- string
- 'null'
format: date-time
description: Date when the commit was authored.
commit:
type:
- string
- 'null'
description: Committer with email (e.g., 'Name <[email protected]>').
commit_name:
type:
- string
- 'null'
description: Committer name.
commit_email:
type:
- string
- 'null'
description: Committer email address.
commitdate:
type:
- string
- 'null'
format: date-time
description: Date when the commit was committed.
message:
type:
- string
- 'null'
description: Full commit message.
summary:
type:
- string
- 'null'
description: First line of the commit message.
CommitNameEnum:
enum:
- 0
- 1
- 2
type: integer
description: |-
* `0` - Use global default
* `1` - Public
* `2` - Private
CommitPolicyEnum:
enum:
- 0
- 20
- 30
type: integer
description: |-
* `0` - Commit all translations regardless of quality
* `20` - Skip translations marked as needing editing
* `30` - Only include approved translations
Component:
type: object
properties:
name:
type: string
title: Component name
description: Display name
maxLength: 100
slug:
type: string
title: URL slug
description: Name used in URLs and filenames.
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
id:
type: integer
readOnly: true
source_language:
$ref: '#/components/schemas/Language'
project:
allOf:
- $ref: '#/components/schemas/Project'
readOnly: true
vcs:
allOf:
- $ref: '#/components/schemas/VcsEnum'
title: Version control system
description: Version control system to use to access your repository containing
translations. You can also choose additional integration with third party
providers to submit pull/merge requests.
repo:
type: string
maxLength: 300
git_export:
type: string
title: Exported repository URL
description: URL of repository where users can fetch changes from Weblate
maxLength: 220
branch:
type: string
maxLength: 200
push_branch:
type: string
maxLength: 200
filemask:
type: string
title: File mask
description: 'Path of files to translate relative to repository root, use
* instead of language code, for example: po/*.po or locale/*/LC_MESSAGES/django.po.'
maxLength: 400
screenshot_filemask:
type: string
title: Screenshot file mask
description: 'Path of screenshots relative to repository root, for example:
docs/screenshots/*.png.'
maxLength: 400
template:
type: string
title: Monolingual base language file
description: Filename of translation base file, containing all strings and
their source for monolingual translations.
maxLength: 400
edit_template:
type: boolean
title: Edit base file
description: Whether users will be able to edit the base file for monolingual
translations.
intermediate:
type: string
title: Intermediate language file
description: Filename of intermediate translation file. In most cases this
is a translation file provided by developers and is used when creating
actual source strings.
maxLength: 400
new_base:
type: string
title: Template for new translations
description: Filename of file used for creating new translations. For gettext
choose .pot file.
maxLength: 400
file_format:
$ref: '#/components/schemas/FileFormatEnum'
file_format_params:
title: File format parameters
license:
title: Translation license
type: string
maxLength: 150
examples:
- MIT
- GPL-3.0-or-later
- Apache-2.0
- BSD-3-Clause
- proprietary
inherit_license:
type: boolean
title: Inherit translation license
description: Use the translation license configured in the category or project.
effective_license:
type: string
readOnly: true
license_url:
type: string
readOnly: true
announcements_url:
type: string
format: uri
readOnly: true
agreement:
type: string
title: Contributor license agreement
description: Contributor license agreement which needs to be approved before
a user can translate this component.
inherit_agreement:
type: boolean
title: Inherit contributor license agreement
description: Use the contributor license agreement configured in the category
or project.
effective_agreement:
type: string
readOnly: true
web_url:
type: string
readOnly: true
url:
type: string
format: uri
readOnly: true
repository_url:
type: string
format: uri
readOnly: true
translations_url:
type: string
format: uri
readOnly: true
statistics_url:
type: string
format: uri
readOnly: true
lock_url:
type: string
format: uri
readOnly: true
links_url:
type: string
format: uri
readOnly: true
changes_list_url:
type: string
format: uri
readOnly: true
task_url:
type:
- string
- 'null'
format: uri
readOnly: true
reports_url:
type: string
format: uri
readOnly: true
new_lang:
allOf:
- $ref: '#/components/schemas/NewLangEnum'
title: Adding new translation
description: How to handle requests for creating new translations.
inherit_new_lang:
type: boolean
title: Inherit adding new translations
description: Use the adding new translations setting configured in the category
or project.
effective_new_lang:
type: string
readOnly: true
language_code_style:
description: Customize language code used to generate the filename for translations
created by Weblate.
oneOf:
- $ref: '#/components/schemas/LanguageCodeStyleEnum'
- $ref: '#/components/schemas/BlankEnum'
inherit_language_code_style:
type: boolean
description: Use the language code style configured in the category or project.
effective_language_code_style:
type: string
readOnly: true
push:
type: string
maxLength: 300
check_flags:
type: string
title: Translation flags
description: Additional comma-separated flags to influence Weblate behavior.
effective_check_flags:
type: string
readOnly: true
priority:
allOf:
- $ref: '#/components/schemas/PriorityEnum'
description: Components with higher priority are offered first to translators.
minimum: -2147483648
maximum: 2147483647
enforced_checks: {}
restricted:
type: boolean
title: Restricted component
description: Restrict access to the component to only those explicitly given
permission.
repoweb:
type: string
title: Repository browser
description: Link to repository browser, use {{branch}} for branch, {{filename}}
and {{line}} as filename and line placeholders. You might want to strip
leading directory by using {{filename|parentdir}}.
maxLength: 200
report_source_bugs:
title: Source string bug reporting address
description: E-mail address for reports on errors in source strings. Leave
empty for no e-mails.
oneOf:
- type: string
format: email
maxLength: 190
- type: string
maxLength: 0
merge_style:
allOf:
- $ref: '#/components/schemas/MergeStyleEnum'
description: Define whether Weblate should merge the upstream repository
or rebase changes onto it.
commit_message:
type: string
title: Commit message when translating
description: You can use template language for various info, please consult
the documentation for more details.
inherit_commit_message:
type: boolean
title: Inherit commit message when translating
description: Use the commit message when translating configured in the category
or project.
effective_commit_message:
type: string
readOnly: true
add_message:
type: string
title: Commit message when adding translation
description: You can use template language for various info, please consult
the documentation for more details.
inherit_add_message:
type: boolean
title: Inherit commit message when adding translation
description: Use the commit message when adding translation configured in
the category or project.
effective_add_message:
type: string
readOnly: true
delete_message:
type: string
title: Commit message when removing translation
description: You can use template language for various info, please consult
the documentation for more details.
inherit_delete_message:
type: boolean
title: Inherit commit message when removing translation
description: Use the commit message when removing translation configured
in the category or project.
effective_delete_message:
type: string
readOnly: true
merge_message:
type: string
title: Commit message when merging translation
description: You can use template language for various info, please consult
the documentation for more details.
inherit_merge_message:
type: boolean
title: Inherit commit message when merging translation
description: Use the commit message when merging translation configured
in the category or project.
effective_merge_message:
type: string
readOnly: true
addon_message:
type: string
title: Commit message when add-on makes a change
description: You can use template language for various info, please consult
the documentation for more details.
inherit_addon_message:
type: boolean
title: Inherit commit message when add-on makes a change
description: Use the commit message when add-on makes a change configured
in the category or project.
effective_addon_message:
type: string
readOnly: true
pull_message:
type: string
title: Merge request message
description: You can use template language for various info, please consult
the documentation for more details.
inherit_pull_message:
type: boolean
title: Inherit merge request message
description: Use the merge request message configured in the category or
project.
effective_pull_message:
type: string
readOnly: true
allow_translation_propagation:
type: boolean
description: Whether translation updates in other components will cause
automatic translation in this one
hide_glossary_matches:
type: boolean
title: Do not show glossary matches
description: Hides the glossary panel in the translation editor.
contribute_project_tm:
type: boolean
title: Contribute to project translation memory
description: Allow this component's translations to be added to the project-level
translation memory.
manage_units:
type: boolean
title: Manage strings
description: Enables adding and removing strings straight from Weblate.
If your strings are extracted from the source code or managed externally
you probably want to keep it disabled.
enable_suggestions:
type: boolean
title: Turn on suggestions
description: Whether to allow translation suggestions at all.
suggestion_voting:
type: boolean
description: Allows users to vote on suggestions.
suggestion_autoaccept:
type: integer
maximum: 32767
minimum: 0
title: Automatically accept suggestions
description: Automatically accept suggestions with this number of votes,
use 0 to turn it off.
push_on_commit:
type: boolean
description: Whether the repository should be pushed upstream on every commit.
commit_pending_age:
type: integer
maximum: 2160
minimum: -32768
title: Age of changes to commit
description: Time in hours after which any pending changes will be committed
to the VCS.
auto_lock_error:
type: boolean
title: Lock on error
description: Whether the component should be locked on repository errors.
language_regex:
type: string
title: Language filter
description: Regular expression used to filter translation files when scanning
for file mask.
maxLength: 500
key_filter:
type: string
description: Regular expression used to filter keys. This is only available
for monolingual formats.
maxLength: 500
secondary_language:
type:
- integer
- 'null'
description: Additional language to show together with the source language
while translating. This setting is inherited from the project if left
empty.
inherit_secondary_language:
type: boolean
description: Use the secondary language configured in the category or project.
effective_secondary_language:
type:
- integer
- 'null'
readOnly: true
variant_regex:
type: string
title: Variants regular expression
description: Regular expression used to determine variants of a string.
maxLength: 190
zipfile:
type:
- string
- 'null'
format: uri
docfile:
type:
- string
- 'null'
format: uri
from_component:
oneOf:
- type: integer
- type: string
writeOnly: true
addons:
type: array
items:
type: string
format: uri
readOnly: true
is_glossary:
type: boolean
title: Use as a glossary
description: Glossaries are different from regular translations but help
keep track of and share consistent terminology.
glossary_color:
$ref: '#/components/schemas/ColorEnum'
disable_autoshare:
type: boolean
category:
type:
- string
- 'null'
format: uri
linked_component:
type: string
format: uri
readOnly: true
locked:
type: boolean
readOnly: true
required:
- addons
- announcements_url
- changes_list_url
- effective_add_message
- effective_addon_message
- effective_agreement
- effective_check_flags
- effective_commit_message
- effective_delete_message
- effective_language_code_style
- effective_license
- effective_merge_message
- effective_new_lang
- effective_pull_message
- effective_secondary_language
- file_format
- filemask
- id
- license_url
- linked_component
- links_url
- lock_url
- locked
- name
- project
- repo
- reports_url
- repository_url
- slug
- statistics_url
- task_url
- translations_url
- url
- web_url
ComponentLinkRequest:
type: object
properties:
project_slug:
type: string
pattern: ^[-a-zA-Z0-9_]+$
category_id:
type:
- integer
- 'null'
required:
- project_slug
ComponentLinkResponse:
type: object
properties:
data:
$ref: '#/components/schemas/Component'
required:
- data
ComponentList:
type: object
properties:
name:
type: string
title: Component list name
description: Display name
maxLength: 100
slug:
type: string
title: URL slug
description: Name used in URLs and filenames.
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
id:
type: integer
readOnly: true
show_dashboard:
type: boolean
title: Show on dashboard
description: When enabled this component list will be shown as a tab on
the dashboard
components:
type: array
items:
type: string
format: uri
readOnly: true
auto_assign:
type: array
items:
$ref: '#/components/schemas/AutoComponentList'
readOnly: true
url:
type: string
format: uri
readOnly: true
required:
- auto_assign
- components
- id
- name
- slug
- url
ComponentTranslation:
type: object
properties:
language:
allOf:
- $ref: '#/components/schemas/Language'
readOnly: true
language_code:
type: string
maxLength: 50
id:
type: integer
readOnly: true
filename:
type: string
maxLength: 400
revision:
type: string
maxLength: 200
web_url:
type: string
readOnly: true
share_url:
type: string
readOnly: true
translate_url:
type: string
readOnly: true
url:
type: string
format: uri
readOnly: true
is_template:
type: boolean
readOnly: true
is_source:
type: boolean
readOnly: true
total:
type: integer
readOnly: true
total_words:
type: integer
readOnly: true
translated:
type: integer
readOnly: true
translated_words:
type: integer
readOnly: true
translated_percent:
type: number
format: double
readOnly: true
fuzzy:
type: integer
readOnly: true
fuzzy_words:
type: integer
readOnly: true
fuzzy_percent:
type: number
format: double
readOnly: true
failing_checks:
type: integer
readOnly: true
failing_checks_words:
type: integer
readOnly: true
failing_checks_percent:
type: number
format: double
readOnly: true
have_suggestion:
type: integer
readOnly: true
have_comment:
type: integer
readOnly: true
last_change:
type: string
format: date-time
readOnly: true
last_author:
type: string
readOnly: true
repository_url:
type: string
format: uri
readOnly: true
file_url:
type: string
format: uri
readOnly: true
statistics_url:
type: string
format: uri
readOnly: true
changes_list_url:
type: string
format: uri
readOnly: true
units_list_url:
type: string
format: uri
readOnly: true
announcements_url:
type: string
format: uri
readOnly: true
required:
- announcements_url
- changes_list_url
- failing_checks
- failing_checks_percent
- failing_checks_words
- file_url
- filename
- fuzzy
- fuzzy_percent
- fuzzy_words
- have_comment
- have_suggestion
- id
- is_source
- is_template
- language
- last_author
- last_change
- repository_url
- share_url
- statistics_url
- total
- total_words
- translate_url
- translated
- translated_percent
- translated_words
- units_list_url
- url
- web_url
ComponentTranslationResponse:
type: object
properties:
data:
$ref: '#/components/schemas/ComponentTranslation'
required:
- data
ConflictsEnum:
enum:
- ignore
- replace-translated
- replace-approved
type: string
description: "* `` - \n* `ignore` - ignore\n* `replace-translated` - replace-translated\n*
`replace-approved` - replace-approved"
CountingModeEnum:
enum:
- unique
- all
type: string
description: |-
* `unique` - unique
* `all` - all
CreateBackupResponse:
type: object
properties:
detail:
type: string
task_url:
type: string
format: uri
required:
- detail
- task_url
DashboardViewEnum:
enum:
- 1
- 6
- 4
- 5
- 7
type: integer
description: |-
* `1` - Watched translations
* `6` - All component lists
* `4` - Component list
* `5` - Suggested translations
* `7` - Managed projects
DirectionEnum:
enum:
- ltr
- rtl
type: string
description: |-
* `` - Automatically detect text direction
* `ltr` - Left to right
* `rtl` - Right to left
Error400:
type: object
properties:
code:
type: string
description: Error code. The examples list common validation and parse error
codes.
examples:
- blank
- date
- datetime
- does_not_exist
- empty
- incorrect_match
- incorrect_type
- invalid
- invalid_choice
- invalid_image
- invalid_list
- make_aware
- max_length
- max_string_length
- max_value
- min_value
- no_match
- no_name
- not_a_list
- 'null'
- null_characters_not_allowed
- overflow
- parse_error
- required
- surrogate_characters_not_allowed
- unique
detail:
type: string
attr:
type:
- string
- 'null'
required:
- attr
- code
- detail
Error401:
type: object
properties:
code:
$ref: '#/components/schemas/ErrorCode401Enum'
detail:
type: string
attr:
type:
- string
- 'null'
required:
- attr
- code
- detail
Error403:
type: object
properties:
code:
$ref: '#/components/schemas/ErrorCode403Enum'
detail:
type: string
attr:
type:
- string
- 'null'
required:
- attr
- code
- detail
Error404:
type: object
properties:
code:
$ref: '#/components/schemas/ErrorCode404Enum'
detail:
type: string
attr:
type:
- string
- 'null'
required:
- attr
- code
- detail
Error405:
type: object
properties:
code:
$ref: '#/components/schemas/ErrorCode405Enum'
detail:
type: string
attr:
type:
- string
- 'null'
required:
- attr
- code
- detail
Error406:
type: object
properties:
code:
$ref: '#/components/schemas/ErrorCode406Enum'
detail:
type: string
attr:
type:
- string
- 'null'
required:
- attr
- code
- detail
Error415:
type: object
properties:
code:
$ref: '#/components/schemas/ErrorCode415Enum'
detail:
type: string
attr:
type:
- string
- 'null'
required:
- attr
- code
- detail
Error423:
type: object
properties:
code:
$ref: '#/components/schemas/ErrorCode423Enum'
detail:
type: string
attr:
type:
- string
- 'null'
required:
- attr
- code
- detail
Error429:
type: object
properties:
code:
$ref: '#/components/schemas/ErrorCode429Enum'
detail:
type: string
attr:
type:
- string
- 'null'
required:
- attr
- code
- detail
Error500:
type: object
properties:
code:
$ref: '#/components/schemas/ErrorCode500Enum'
detail:
type: string
attr:
type:
- string
- 'null'
required:
- attr
- code
- detail
ErrorCode401Enum:
enum:
- authentication_failed
- not_authenticated
type: string
description: |-
* `authentication_failed` - Authentication Failed
* `not_authenticated` - Not Authenticated
ErrorCode403Enum:
enum:
- permission_denied
type: string
description: '* `permission_denied` - Permission Denied'
ErrorCode404Enum:
enum:
- not_found
type: string
description: '* `not_found` - Not Found'
ErrorCode405Enum:
enum:
- method_not_allowed
type: string
description: '* `method_not_allowed` - Method Not Allowed'
ErrorCode406Enum:
enum:
- not_acceptable
type: string
description: '* `not_acceptable` - Not Acceptable'
ErrorCode415Enum:
enum:
- unsupported_media_type
type: string
description: '* `unsupported_media_type` - Unsupported Media Type'
ErrorCode423Enum:
enum:
- repository-locked
- component-locked
- unknown-locked
type: string
description: |-
* `repository-locked` - Repository Locked
* `component-locked` - Component Locked
* `unknown-locked` - Unknown Locked
ErrorCode429Enum:
enum:
- throttled
type: string
description: '* `throttled` - Throttled'
ErrorCode500Enum:
enum:
- error
type: string
description: '* `error` - Error'
ErrorResponse400:
type: object
properties:
type:
$ref: '#/components/schemas/ErrorResponse400TypeEnum'
errors:
type: array
items:
$ref: '#/components/schemas/Error400'
required:
- errors
- type
ErrorResponse400TypeEnum:
enum:
- validation_error
- client_error
type: string
description: |-
* `validation_error` - Validation Error
* `client_error` - Client Error
ErrorResponse401:
type: object
properties:
type:
$ref: '#/components/schemas/ClientErrorEnum'
errors:
type: array
items:
$ref: '#/components/schemas/Error401'
required:
- errors
- type
ErrorResponse403:
type: object
properties:
type:
$ref: '#/components/schemas/ClientErrorEnum'
errors:
type: array
items:
$ref: '#/components/schemas/Error403'
required:
- errors
- type
ErrorResponse404:
type: object
properties:
type:
$ref: '#/components/schemas/ClientErrorEnum'
errors:
type: array
items:
$ref: '#/components/schemas/Error404'
required:
- errors
- type
ErrorResponse405:
type: object
properties:
type:
$ref: '#/components/schemas/ClientErrorEnum'
errors:
type: array
items:
$ref: '#/components/schemas/Error405'
required:
- errors
- type
ErrorResponse406:
type: object
properties:
type:
$ref: '#/components/schemas/ClientErrorEnum'
errors:
type: array
items:
$ref: '#/components/schemas/Error406'
required:
- errors
- type
ErrorResponse415:
type: object
properties:
type:
$ref: '#/components/schemas/ClientErrorEnum'
errors:
type: array
items:
$ref: '#/components/schemas/Error415'
required:
- errors
- type
ErrorResponse423:
type: object
properties:
type:
$ref: '#/components/schemas/ServerErrorEnum'
errors:
type: array
items:
$ref: '#/components/schemas/Error423'
required:
- errors
- type
ErrorResponse429:
type: object
properties:
type:
$ref: '#/components/schemas/ClientErrorEnum'
errors:
type: array
items:
$ref: '#/components/schemas/Error429'
required:
- errors
- type
ErrorResponse500:
type: object
properties:
type:
$ref: '#/components/schemas/ServerErrorEnum'
errors:
type: array
items:
$ref: '#/components/schemas/Error500'
required:
- errors
- type
FileFormatEnum:
enum:
- apple-xliff
- appstore
- arb
- aresource
- asciidoc
- ass
- catkeys
- cmp-resource
- csv
- csv-multi
- csv-simple
- dokuwiki
- dtd
- flatxml
- fluent
- formatjs
- go-i18n-json
- go-i18n-json-v2
- go-i18n-toml
- gotext
- gwt
- html
- i18next
- i18nextv4
- idml
- ini
- islu
- joomla
- json
- json-nested
- laravel
- markdown
- mdx
- mediawiki
- mi18n-lang
- moko-resource
- nextcloud-json
- odf
- php
- plainxliff
- po
- po-mono
- poxliff
- properties
- rc
- resjson
- resourcedictionary
- resx
- ruby-yaml
- srt
- ssa
- strings
- stringsdict
- sub
- tbx
- toml
- ts
- ts1
- txt
- webextension
- wxl
- xliff
- xliff2
- xliff2-placeables
- xlsx
- xwiki-fullpage
- xwiki-java-properties
- xwiki-page-properties
- yaml
type: string
description: |-
* `apple-xliff` - XLIFF 1.2 with Apple extensions
* `appstore` - App store metadata files
* `arb` - ARB file
* `aresource` - Android String Resource
* `asciidoc` - AsciiDoc file
* `ass` - Advanced SubStation Alpha subtitle file
* `catkeys` - Haiku catkeys
* `cmp-resource` - Compose Multiplatform Resource
* `csv` - CSV file
* `csv-multi` - Multivalue CSV file
* `csv-simple` - Simple CSV file
* `dokuwiki` - DokuWiki text file
* `dtd` - DTD file
* `flatxml` - Flat XML file
* `fluent` - Fluent file
* `formatjs` - Format.JS JSON file
* `go-i18n-json` - go-i18n v1 JSON file
* `go-i18n-json-v2` - go-i18n v2 JSON file
* `go-i18n-toml` - go-i18n TOML file
* `gotext` - gotext JSON file
* `gwt` - GWT properties
* `html` - HTML file
* `i18next` - i18next JSON file v3
* `i18nextv4` - i18next JSON file v4
* `idml` - IDML file
* `ini` - INI file
* `islu` - Inno Setup INI file
* `joomla` - Joomla language file
* `json` - JSON file
* `json-nested` - JSON nested structure file
* `laravel` - Laravel PHP strings
* `markdown` - Markdown file
* `mdx` - MDX file
* `mediawiki` - MediaWiki text file
* `mi18n-lang` - @draggable/i18n lang file
* `moko-resource` - Mobile Kotlin Resource
* `nextcloud-json` - Nextcloud JSON file
* `odf` - OpenDocument file
* `php` - PHP strings
* `plainxliff` - XLIFF 1.2 translation file
* `po` - gettext PO file
* `po-mono` - gettext PO file (monolingual)
* `poxliff` - XLIFF 1.2 with gettext extensions
* `properties` - Java Properties
* `rc` - RC file
* `resjson` - RESJSON file
* `resourcedictionary` - ResourceDictionary file
* `resx` - .NET resource file
* `ruby-yaml` - Ruby YAML file
* `srt` - SubRip subtitle file
* `ssa` - SubStation Alpha subtitle file
* `strings` - iOS strings
* `stringsdict` - Stringsdict file
* `sub` - MicroDVD subtitle file
* `tbx` - TermBase eXchange file
* `toml` - TOML file
* `ts` - Qt Linguist translation file (version 2)
* `ts1` - Qt Linguist translation file (version 1)
* `txt` - Plain text file
* `webextension` - WebExtension JSON file
* `wxl` - WixLocalization file
* `xliff` - XLIFF 1.2 with placeables support
* `xliff2` - XLIFF 2.0 translation file
* `xliff2-placeables` - XLIFF 2.0 translation file with placeables support
* `xlsx` - Excel Open XML
* `xwiki-fullpage` - XWiki Full Page
* `xwiki-java-properties` - XWiki Java Properties
* `xwiki-page-properties` - XWiki Page Properties
* `yaml` - YAML file
FrequencyEnum:
enum:
- 0
- 1
- 2
- 3
- 4
type: integer
description: |-
* `0` - No notification
* `1` - Instant notification
* `2` - Daily digest
* `3` - Weekly digest
* `4` - Monthly digest
FullUser:
type: object
properties:
id:
type: integer
readOnly: true
email:
type:
- string
- 'null'
title: E-mail
format: email
maxLength: 190
full_name:
type: string
maxLength: 150
username:
type: string
description: 'Username may only contain letters, numbers or the following
characters: @ . + - _'
maxLength: 150
groups:
type: array
items:
type: string
format: uri
readOnly: true
profile:
allOf:
- $ref: '#/components/schemas/Profile'
readOnly: true
notifications:
type: string
format: uri
readOnly: true
is_superuser:
type: boolean
title: Superuser status
description: User has all possible permissions.
is_active:
type: boolean
title: Active
description: Mark user as inactive instead of removing.
is_bot:
type: boolean
title: Robot user
date_joined:
type: string
format: date-time
readOnly: true
date_expires:
type:
- string
- 'null'
format: date-time
title: Expires
description: The account will be disabled after the expiry.
last_login:
type:
- string
- 'null'
format: date-time
readOnly: true
url:
type: string
format: uri
readOnly: true
statistics_url:
type: string
format: uri
readOnly: true
contributions_url:
type: string
format: uri
readOnly: true
required:
- contributions_url
- date_joined
- full_name
- groups
- id
- last_login
- notifications
- profile
- statistics_url
- url
- username
FuzzyEnum:
enum:
- process
- approve
type: string
description: "* `` - \n* `process` - process\n* `approve` - approve"
Group:
type: object
properties:
id:
type: integer
readOnly: true
name:
type: string
maxLength: 150
defining_project:
type: string
format: uri
defining_workspace:
type:
- string
- 'null'
format: uuid
project_selection:
allOf:
- $ref: '#/components/schemas/ProjectSelectionEnum'
minimum: -2147483648
maximum: 2147483647
language_selection:
allOf:
- $ref: '#/components/schemas/LanguageSelectionEnum'
minimum: -2147483648
maximum: 2147483647
url:
type: string
format: uri
readOnly: true
roles:
type: array
items:
type: string
format: uri
readOnly: true
languages:
type: array
items:
type: string
format: uri
readOnly: true
projects:
type: array
items:
type: string
format: uri
readOnly: true
componentlists:
type: array
items:
type: string
format: uri
readOnly: true
components:
type: array
items:
type: string
format: uri
readOnly: true
enforced_2fa:
type: boolean
title: Enforced two-factor authentication
description: Requires users to have two-factor authentication configured.
admins:
type: array
items:
type: string
format: uri
readOnly: true
required:
- admins
- componentlists
- components
- id
- languages
- name
- projects
- roles
- url
HookMatch:
type: object
properties:
repository_matches:
type: integer
branch_matches:
type: integer
enabled_hook_matches:
type: integer
required:
- branch_matches
- enabled_hook_matches
- repository_matches
HookResponse:
type: object
properties:
message:
type: string
maxLength: 200
status:
$ref: '#/components/schemas/StatusEnum'
match_status:
$ref: '#/components/schemas/HookMatch'
updated_components:
type: array
items:
type: string
format: uri
readOnly: true
required:
- message
- status
- updated_components
Label:
type: object
properties:
id:
type: integer
readOnly: true
name:
type: string
title: Label name
maxLength: 190
description:
type: string
title: Label description
maxLength: 250
color:
$ref: '#/components/schemas/ColorEnum'
required:
- id
- name
Language:
type: object
properties:
id:
type: integer
readOnly: true
code:
type: string
title: Language code
pattern: ^[A-Za-z0-9]+(?:[-_@][A-Za-z0-9]+)*$
maxLength: 50
name:
type: string
maxLength: 100
plural:
$ref: '#/components/schemas/LanguagePlural'
aliases:
type: array
items: {}
readOnly: true
direction:
title: Text direction
oneOf:
- $ref: '#/components/schemas/DirectionEnum'
- $ref: '#/components/schemas/BlankEnum'
population:
type: integer
maximum: 9223372036854775807
minimum: -9223372036854775808
format: int64
title: Number of speakers
description: Number of people speaking this language.
web_url:
type: string
readOnly: true
url:
type: string
format: uri
readOnly: true
statistics_url:
type: string
format: uri
readOnly: true
required:
- aliases
- code
- id
- statistics_url
- url
- web_url
LanguageCodeStyleEnum:
enum:
- posix
- posix_lowercase
- bcp
- posix_long
- posix_long_lowercase
- bcp_long
- bcp_legacy
- bcp_lower
- android
- appstore
- googleplay
- linux
- linux_lowercase
type: string
description: |-
* `` - Default based on the file format
* `posix` - POSIX style using underscore as a separator
* `posix_lowercase` - POSIX style using underscore as a separator, lower cased
* `bcp` - BCP style using hyphen as a separator
* `posix_long` - POSIX style using underscore as a separator, including country code
* `posix_long_lowercase` - POSIX style using underscore as a separator, including country code, lower cased
* `bcp_long` - BCP style using hyphen as a separator, including country code
* `bcp_legacy` - BCP style using hyphen as a separator, legacy language codes
* `bcp_lower` - BCP style using hyphen as a separator, lower cased
* `android` - Android style
* `appstore` - Apple App Store metadata style
* `googleplay` - Google Play metadata style
* `linux` - Linux style
* `linux_lowercase` - Linux style, lower cased
LanguageEnum:
enum:
- ar
- az
- ba
- be
- be-latn
- bg
- br
- ca
- cs
- cy
- da
- de
- en
- el
- en-gb
- es
- fi
- fr
- ga
- gl
- he
- hu
- hr
- id
- is
- it
- ja
- kab
- kk
- ko
- lo
- nb
- nl
- pl
- pt
- pt-br
- ro
- ru
- sk
- sl
- sq
- sr
- sr-latn
- sv
- ta
- th
- tr
- uk
- vi
- zh-hans
- zh-hant
type: string
description: |-
* `ar` - العربية
* `az` - Azərbaycan
* `ba` - башҡорт теле
* `be` - Беларуская
* `be-latn` - Biełaruskaja
* `bg` - Български
* `br` - Brezhoneg
* `ca` - Català
* `cs` - Čeština
* `cy` - Cymraeg
* `da` - Dansk
* `de` - Deutsch
* `en` - English
* `el` - Ελληνικά
* `en-gb` - English (United Kingdom)
* `es` - Español
* `fi` - Suomi
* `fr` - Français
* `ga` - Gaeilge
* `gl` - Galego
* `he` - עברית
* `hu` - Magyar
* `hr` - Hrvatski
* `id` - Indonesia
* `is` - Íslenska
* `it` - Italiano
* `ja` - 日本語
* `kab` - Taqbaylit
* `kk` - Қазақ тілі
* `ko` - 한국어
* `lo` - ລາວ
* `nb` - Norsk bokmål
* `nl` - Nederlands
* `pl` - Polski
* `pt` - Português
* `pt-br` - Português brasileiro
* `ro` - Română
* `ru` - Русский
* `sk` - Slovenčina
* `sl` - Slovenščina
* `sq` - Shqip
* `sr` - Српски
* `sr-latn` - Srpski
* `sv` - Svenska
* `ta` - தமிழ்
* `th` - ไทย
* `tr` - Türkçe
* `uk` - Українська
* `vi` - Tiếng việt
* `zh-hans` - 简体中文
* `zh-hant` - 正體中文
LanguagePlural:
type: object
properties:
id:
type: integer
readOnly: true
source:
allOf:
- $ref: '#/components/schemas/SourceEnum'
title: Plural definition source
minimum: -32768
maximum: 32767
number:
type: integer
maximum: 10
minimum: 1
title: Number of plurals
formula:
type: string
title: Plural formula
type:
allOf:
- $ref: '#/components/schemas/LanguagePluralTypeEnum'
readOnly: true
title: Plural type
required:
- id
- type
LanguagePluralTypeEnum:
enum:
- 0
- 1
- 2
- 3
- 11
- 4
- 14
- 6
- 13
- 5
- 7
- 8
- 9
- 10
- 12
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 666
type: integer
description: |-
* `0` - None
* `1` - One/other
* `2` - One/few/other
* `3` - Arabic languages
* `11` - Zero/one/other
* `4` - One/two/other
* `14` - One/other/two
* `6` - One/two/few/other
* `13` - Other/one/two/few
* `5` - One/two/three/other
* `7` - One/other/zero
* `8` - One/few/many/other
* `9` - Two/other
* `10` - One/two/few/many/other
* `12` - Zero/one/two/few/many/other
* `15` - Zero/other
* `16` - Zero/one/few/other
* `17` - Zero/one/two/few/other
* `18` - Zero/one/two/other
* `19` - Zero/one/few/many/other
* `20` - One/many/other
* `21` - Zero/one/many/other
* `22` - One/few/many
* `23` - One/zero/few/other
* `666` - Unknown
LanguageSelectionEnum:
enum:
- 0
- 1
type: integer
description: |-
* `0` - As defined
* `1` - All languages
Last2faEnum:
enum:
- totp
- webauthn
type: string
description: |-
* `` - None
* `totp` - TOTP
* `webauthn` - WebAuthn
Lock:
type: object
properties:
locked:
type: boolean
description: Locked component will not get any translation updates.
LockRequest:
type: object
properties:
lock:
type: boolean
required:
- lock
Memory:
type: object
properties:
id:
type: integer
readOnly: true
source:
type: string
target:
type: string
source_language:
type: integer
target_language:
type: integer
origin:
type: string
project:
type:
- integer
- 'null'
readOnly: true
from_file:
type: boolean
readOnly: true
shared:
type: boolean
readOnly: true
required:
- from_file
- id
- origin
- project
- shared
- source
- source_language
- target
- target_language
MemoryLookupMatch:
type: object
properties:
id:
type: integer
source:
type: string
target:
type: string
origin:
type: string
exact:
type: boolean
quality:
type: integer
required:
- exact
- id
- origin
- quality
- source
- target
MemoryLookupRequest:
type: object
properties:
strings:
type: array
items:
type: string
maxLength: 2000
maxItems: 100
required:
- strings
MemoryLookupResult:
type: object
properties:
query:
type: string
match:
oneOf:
- $ref: '#/components/schemas/MemoryLookupMatch'
- type: 'null'
required:
- match
- query
MergeStyleEnum:
enum:
- merge
- rebase
- merge_noff
type: string
description: |-
* `merge` - Merge
* `rebase` - Rebase
* `merge_noff` - Merge without fast-forward
MessageResponse:
type: object
properties:
message:
type: string
required:
- message
MethodEnum:
enum:
- translate
- approve
- suggest
- fuzzy
- replace
- source
- add
type: string
description: |-
* `translate` - translate
* `approve` - approve
* `suggest` - suggest
* `fuzzy` - fuzzy
* `replace` - replace
* `source` - source
* `add` - add
Metrics:
type: object
properties:
units:
type: integer
units_translated:
type: integer
users:
type: integer
changes:
type: integer
projects:
type: integer
components:
type: integer
translations:
type: integer
languages:
type: integer
checks:
type: integer
configuration_errors:
type: integer
suggestions:
type: integer
celery_queues:
type: object
additionalProperties:
type: integer
name:
type: string
version:
type: string
required:
- celery_queues
- changes
- checks
- components
- configuration_errors
- languages
- name
- projects
- suggestions
- translations
- units
- units_translated
- users
MonolingualUnit:
type: object
properties:
state:
$ref: '#/components/schemas/NewUnitStateEnum'
key:
type: string
value:
type: array
items:
type: string
required:
- key
- value
NewLangEnum:
enum:
- contact
- url
- add
- none
type: string
description: |-
* `contact` - Contact maintainers
* `url` - Point to translation instructions URL
* `add` - Create new language file
* `none` - Disable adding new translations
NewUnitRequest:
oneOf:
- $ref: '#/components/schemas/MonolingualUnit'
- $ref: '#/components/schemas/BilingualUnit'
- $ref: '#/components/schemas/BilingualSourceUnit'
NewUnitStateEnum:
enum:
- 0
- 10
- 11
- 12
- 20
- 30
type: integer
description: |-
* `0` - Empty
* `10` - Needs editing
* `11` - Needs editing (Needs rewriting)
* `12` - Needs editing (Needs checking)
* `20` - Translated
* `30` - Approved
Notification:
type: object
properties:
notification:
$ref: '#/components/schemas/NotificationEnum'
id:
type: integer
readOnly: true
scope:
allOf:
- $ref: '#/components/schemas/NotificationScopeEnum'
minimum: -2147483648
maximum: 2147483647
frequency:
allOf:
- $ref: '#/components/schemas/FrequencyEnum'
minimum: -2147483648
maximum: 2147483647
project:
allOf:
- $ref: '#/components/schemas/Project'
readOnly: true
component:
allOf:
- $ref: '#/components/schemas/Component'
readOnly: true
required:
- component
- frequency
- id
- notification
- project
- scope
NotificationEnum:
enum:
- RepositoryNotification
- LockNotification
- LicenseNotification
- ParseErrorNotification
- NewStringNotificaton
- TranslationActivitySummaryNotification
- NewContributorNotificaton
- NewSuggestionNotificaton
- LanguageTranslatedNotificaton
- ComponentTranslatedNotificaton
- NewCommentNotificaton
- MentionCommentNotificaton
- LastAuthorCommentNotificaton
- TranslatedStringNotificaton
- ApprovedStringNotificaton
- ChangedStringNotificaton
- NewTranslationNotificaton
- NewComponentNotificaton
- NewAnnouncementNotificaton
- NewAlertNotificaton
- MergeFailureNotification
- PendingSuggestionsNotification
- ToDoStringsNotification
type: string
description: |-
* `RepositoryNotification` - Operation was performed in the repository
* `LockNotification` - Component was locked or unlocked
* `LicenseNotification` - License was changed
* `ParseErrorNotification` - Parse error occurred
* `NewStringNotificaton` - String is available for translation
* `TranslationActivitySummaryNotification` - Translation activity summary
* `NewContributorNotificaton` - Contributor made their first translation
* `NewSuggestionNotificaton` - Suggestion was added
* `LanguageTranslatedNotificaton` - Language was translated
* `ComponentTranslatedNotificaton` - Component was translated
* `NewCommentNotificaton` - Comment was added
* `MentionCommentNotificaton` - You were mentioned in a comment
* `LastAuthorCommentNotificaton` - String you contributed to received a comment
* `TranslatedStringNotificaton` - String was edited by user
* `ApprovedStringNotificaton` - String was approved
* `ChangedStringNotificaton` - String was changed
* `NewTranslationNotificaton` - New language was added or requested
* `NewComponentNotificaton` - New translation component was created
* `NewAnnouncementNotificaton` - Announcement was published
* `NewAlertNotificaton` - New alert emerged in a component
* `MergeFailureNotification` - Repository operation failed
* `PendingSuggestionsNotification` - Pending suggestions exist
* `ToDoStringsNotification` - Unfinished strings exist
NotificationScopeEnum:
enum:
- 0
- 10
- 20
- 30
- 40
type: integer
description: |-
* `0` - All
* `10` - Watched
* `20` - Administered
* `30` - Project
* `40` - Component
OperationEnum:
enum:
- commit
- pull
- pull-rebase
- pull-merge
- pull-merge-noff
- push
- reset
- reset-keep
- cleanup
- file-sync
- file-scan
type: string
description: |-
* `commit` - Commit
* `pull` - Update
* `pull-rebase` - Update with rebase
* `pull-merge` - Update with merge
* `pull-merge-noff` - Update with merge without fast-forward
* `push` - Push
* `reset` - Reset all changes in the Weblate repository
* `reset-keep` - Reset the Weblate repository and reapply translations
* `cleanup` - Cleanup all untracked files in the Weblate repository
* `file-sync` - Force writing all translations to the Weblate repository
* `file-scan` - Rescan all translation files in the Weblate repository
PaginatedAddonList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
format: uri
example: http://api.example.org/accounts/?page=4
previous:
type: string
format: uri
example: http://api.example.org/accounts/?page=2
results:
type: array
items:
$ref: '#/components/schemas/Addon'
PaginatedAnnouncementList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
format: uri
example: http://api.example.org/accounts/?page=4
previous:
type: string
format: uri
example: http://api.example.org/accounts/?page=2
results:
type: array
items:
$ref: '#/components/schemas/Announcement'
PaginatedBackupList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
format: uri
example: http://api.example.org/accounts/?page=4
previous:
type: string
format: uri
example: http://api.example.org/accounts/?page=2
results:
type: array
items:
$ref: '#/components/schemas/Backup'
PaginatedCategoryList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
format: uri
example: http://api.example.org/accounts/?page=4
previous:
type: string
format: uri
example: http://api.example.org/accounts/?page=2
results:
type: array
items:
$ref: '#/components/schemas/Category'
PaginatedChangeList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
format: uri
example: http://api.example.org/accounts/?page=4
previous:
type: string
format: uri
example: http://api.example.org/accounts/?page=2
results:
type: array
items:
$ref: '#/components/schemas/Change'
PaginatedCommentList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
format: uri
example: http://api.example.org/accounts/?page=4
previous:
type: string
format: uri
example: http://api.example.org/accounts/?page=2
results:
type: array
items:
$ref: '#/components/schemas/Comment'
PaginatedComponentList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
format: uri
example: http://api.example.org/accounts/?page=4
previous:
type: string
format: uri
example: http://api.example.org/accounts/?page=2
results:
type: array
items:
$ref: '#/components/schemas/Component'
PaginatedComponentListList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
format: uri
example: http://api.example.org/accounts/?page=4
previous:
type: string
format: uri
example: http://api.example.org/accounts/?page=2
results:
type: array
items:
$ref: '#/components/schemas/ComponentList'
PaginatedComponentTranslationList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
format: uri
example: http://api.example.org/accounts/?page=4
previous:
type: string
format: uri
example: http://api.example.org/accounts/?page=2
results:
type: array
items:
$ref: '#/components/schemas/ComponentTranslation'
PaginatedFullUserList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
format: uri
example: http://api.example.org/accounts/?page=4
previous:
type: string
format: uri
example: http://api.example.org/accounts/?page=2
results:
type: array
items:
$ref: '#/components/schemas/FullUser'
PaginatedGroupList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
format: uri
example: http://api.example.org/accounts/?page=4
previous:
type: string
format: uri
example: http://api.example.org/accounts/?page=2
results:
type: array
items:
$ref: '#/components/schemas/Group'
PaginatedLabelList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
format: uri
example: http://api.example.org/accounts/?page=4
previous:
type: string
format: uri
example: http://api.example.org/accounts/?page=2
results:
type: array
items:
$ref: '#/components/schemas/Label'
PaginatedLanguageList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
format: uri
example: http://api.example.org/accounts/?page=4
previous:
type: string
format: uri
example: http://api.example.org/accounts/?page=2
results:
type: array
items:
$ref: '#/components/schemas/Language'
PaginatedMemoryList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
format: uri
example: http://api.example.org/accounts/?page=4
previous:
type: string
format: uri
example: http://api.example.org/accounts/?page=2
results:
type: array
items:
$ref: '#/components/schemas/Memory'
PaginatedNotificationList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
format: uri
example: http://api.example.org/accounts/?page=4
previous:
type: string
format: uri
example: http://api.example.org/accounts/?page=2
results:
type: array
items:
$ref: '#/components/schemas/Notification'
PaginatedProjectComponentList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
format: uri
example: http://api.example.org/accounts/?page=4
previous:
type: string
format: uri
example: http://api.example.org/accounts/?page=2
results:
type: array
items:
$ref: '#/components/schemas/ProjectComponent'
PaginatedProjectList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
format: uri
example: http://api.example.org/accounts/?page=4
previous:
type: string
format: uri
example: http://api.example.org/accounts/?page=2
results:
type: array
items:
$ref: '#/components/schemas/Project'
PaginatedReportListList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
format: uri
example: http://api.example.org/accounts/?page=4
previous:
type: string
format: uri
example: http://api.example.org/accounts/?page=2
results:
type: array
items:
$ref: '#/components/schemas/ReportList'
PaginatedRoleList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
format: uri
example: http://api.example.org/accounts/?page=4
previous:
type: string
format: uri
example: http://api.example.org/accounts/?page=2
results:
type: array
items:
$ref: '#/components/schemas/Role'
PaginatedScreenshotList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
format: uri
example: http://api.example.org/accounts/?page=4
previous:
type: string
format: uri
example: http://api.example.org/accounts/?page=2
results:
type: array
items:
$ref: '#/components/schemas/Screenshot'
PaginatedStatisticsList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
format: uri
example: http://api.example.org/accounts/?page=4
previous:
type: string
format: uri
example: http://api.example.org/accounts/?page=2
results:
type: array
items:
$ref: '#/components/schemas/Statistics'
PaginatedSuggestionList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
format: uri
example: http://api.example.org/accounts/?page=4
previous:
type: string
format: uri
example: http://api.example.org/accounts/?page=2
results:
type: array
items:
$ref: '#/components/schemas/Suggestion'
PaginatedTranslationList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
format: uri
example: http://api.example.org/accounts/?page=4
previous:
type: string
format: uri
example: http://api.example.org/accounts/?page=2
results:
type: array
items:
$ref: '#/components/schemas/Translation'
PaginatedUnitList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type: string
format: uri
example: http://api.example.org/accounts/?page=4
previous:
type: string
format: uri
example: http://api.example.org/accounts/?page=2
results:
type: array
items:
$ref: '#/components/schemas/Unit'
PatchedAddon:
type: object
properties:
component:
type: string
format: uri
readOnly: true
project:
type: string
format: uri
readOnly: true
name:
type: string
maxLength: 100
id:
type: integer
readOnly: true
configuration: {}
url:
type: string
format: uri
readOnly: true
PatchedCategory:
type: object
properties:
id:
type: integer
readOnly: true
name:
type: string
title: Category name
description: Display name
maxLength: 100
slug:
type: string
title: URL slug
description: Name used in URLs and filenames.
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
project:
type: string
format: uri
category:
type:
- string
- 'null'
format: uri
url:
type: string
format: uri
readOnly: true
statistics_url:
type: string
format: uri
readOnly: true
announcements_url:
type: string
format: uri
readOnly: true
reports_url:
type: string
format: uri
readOnly: true
check_flags:
type: string
title: Translation flags
description: Additional comma-separated flags to influence Weblate behavior.
effective_check_flags:
type: string
readOnly: true
license:
title: Translation license
type: string
maxLength: 150
examples:
- MIT
- GPL-3.0-or-later
- Apache-2.0
- BSD-3-Clause
- proprietary
inherit_license:
type: boolean
title: Inherit translation license
description: Use the translation license configured in the parent category
or project.
effective_license:
type: string
readOnly: true
agreement:
type: string
title: Contributor license agreement
description: Contributor license agreement which needs to be approved before
a user can translate components in this category.
inherit_agreement:
type: boolean
title: Inherit contributor license agreement
description: Use the contributor license agreement configured in the parent
category or project.
effective_agreement:
type: string
readOnly: true
new_lang:
allOf:
- $ref: '#/components/schemas/NewLangEnum'
title: Adding new translation
description: How to handle requests for creating new translations.
inherit_new_lang:
type: boolean
title: Inherit adding new translations
description: Use the adding new translations setting configured in the parent
category or project.
effective_new_lang:
type: string
readOnly: true
language_code_style:
description: Customize language code used to generate the filename for translations
created by Weblate.
oneOf:
- $ref: '#/components/schemas/LanguageCodeStyleEnum'
- $ref: '#/components/schemas/BlankEnum'
inherit_language_code_style:
type: boolean
description: Use the language code style configured in the parent category
or project.
effective_language_code_style:
type: string
readOnly: true
secondary_language:
type:
- integer
- 'null'
description: Additional language to show together with the source language
while translating.
inherit_secondary_language:
type: boolean
description: Use the secondary language configured in the parent category
or project.
effective_secondary_language:
type:
- integer
- 'null'
readOnly: true
commit_message:
type: string
title: Commit message when translating
description: You can use template language for various info, please consult
the documentation for more details.
inherit_commit_message:
type: boolean
title: Inherit commit message when translating
description: Use the commit message when translating configured in the parent
category or project.
effective_commit_message:
type: string
readOnly: true
add_message:
type: string
title: Commit message when adding translation
description: You can use template language for various info, please consult
the documentation for more details.
inherit_add_message:
type: boolean
title: Inherit commit message when adding translation
description: Use the commit message when adding translation configured in
the parent category or project.
effective_add_message:
type: string
readOnly: true
delete_message:
type: string
title: Commit message when removing translation
description: You can use template language for various info, please consult
the documentation for more details.
inherit_delete_message:
type: boolean
title: Inherit commit message when removing translation
description: Use the commit message when removing translation configured
in the parent category or project.
effective_delete_message:
type: string
readOnly: true
merge_message:
type: string
title: Commit message when merging translation
description: You can use template language for various info, please consult
the documentation for more details.
inherit_merge_message:
type: boolean
title: Inherit commit message when merging translation
description: Use the commit message when merging translation configured
in the parent category or project.
effective_merge_message:
type: string
readOnly: true
addon_message:
type: string
title: Commit message when add-on makes a change
description: You can use template language for various info, please consult
the documentation for more details.
inherit_addon_message:
type: boolean
title: Inherit commit message when add-on makes a change
description: Use the commit message when add-on makes a change configured
in the parent category or project.
effective_addon_message:
type: string
readOnly: true
pull_message:
type: string
title: Merge request message
description: You can use template language for various info, please consult
the documentation for more details.
inherit_pull_message:
type: boolean
title: Inherit merge request message
description: Use the merge request message configured in the parent category
or project.
effective_pull_message:
type: string
readOnly: true
PatchedComponent:
type: object
properties:
name:
type: string
title: Component name
description: Display name
maxLength: 100
slug:
type: string
title: URL slug
description: Name used in URLs and filenames.
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
id:
type: integer
readOnly: true
source_language:
$ref: '#/components/schemas/Language'
project:
allOf:
- $ref: '#/components/schemas/Project'
readOnly: true
vcs:
allOf:
- $ref: '#/components/schemas/VcsEnum'
title: Version control system
description: Version control system to use to access your repository containing
translations. You can also choose additional integration with third party
providers to submit pull/merge requests.
repo:
type: string
maxLength: 300
git_export:
type: string
title: Exported repository URL
description: URL of repository where users can fetch changes from Weblate
maxLength: 220
branch:
type: string
maxLength: 200
push_branch:
type: string
maxLength: 200
filemask:
type: string
title: File mask
description: 'Path of files to translate relative to repository root, use
* instead of language code, for example: po/*.po or locale/*/LC_MESSAGES/django.po.'
maxLength: 400
screenshot_filemask:
type: string
title: Screenshot file mask
description: 'Path of screenshots relative to repository root, for example:
docs/screenshots/*.png.'
maxLength: 400
template:
type: string
title: Monolingual base language file
description: Filename of translation base file, containing all strings and
their source for monolingual translations.
maxLength: 400
edit_template:
type: boolean
title: Edit base file
description: Whether users will be able to edit the base file for monolingual
translations.
intermediate:
type: string
title: Intermediate language file
description: Filename of intermediate translation file. In most cases this
is a translation file provided by developers and is used when creating
actual source strings.
maxLength: 400
new_base:
type: string
title: Template for new translations
description: Filename of file used for creating new translations. For gettext
choose .pot file.
maxLength: 400
file_format:
$ref: '#/components/schemas/FileFormatEnum'
file_format_params:
title: File format parameters
license:
title: Translation license
type: string
maxLength: 150
examples:
- MIT
- GPL-3.0-or-later
- Apache-2.0
- BSD-3-Clause
- proprietary
inherit_license:
type: boolean
title: Inherit translation license
description: Use the translation license configured in the category or project.
effective_license:
type: string
readOnly: true
license_url:
type: string
readOnly: true
announcements_url:
type: string
format: uri
readOnly: true
agreement:
type: string
title: Contributor license agreement
description: Contributor license agreement which needs to be approved before
a user can translate this component.
inherit_agreement:
type: boolean
title: Inherit contributor license agreement
description: Use the contributor license agreement configured in the category
or project.
effective_agreement:
type: string
readOnly: true
web_url:
type: string
readOnly: true
url:
type: string
format: uri
readOnly: true
repository_url:
type: string
format: uri
readOnly: true
translations_url:
type: string
format: uri
readOnly: true
statistics_url:
type: string
format: uri
readOnly: true
lock_url:
type: string
format: uri
readOnly: true
links_url:
type: string
format: uri
readOnly: true
changes_list_url:
type: string
format: uri
readOnly: true
task_url:
type:
- string
- 'null'
format: uri
readOnly: true
reports_url:
type: string
format: uri
readOnly: true
new_lang:
allOf:
- $ref: '#/components/schemas/NewLangEnum'
title: Adding new translation
description: How to handle requests for creating new translations.
inherit_new_lang:
type: boolean
title: Inherit adding new translations
description: Use the adding new translations setting configured in the category
or project.
effective_new_lang:
type: string
readOnly: true
language_code_style:
description: Customize language code used to generate the filename for translations
created by Weblate.
oneOf:
- $ref: '#/components/schemas/LanguageCodeStyleEnum'
- $ref: '#/components/schemas/BlankEnum'
inherit_language_code_style:
type: boolean
description: Use the language code style configured in the category or project.
effective_language_code_style:
type: string
readOnly: true
push:
type: string
maxLength: 300
check_flags:
type: string
title: Translation flags
description: Additional comma-separated flags to influence Weblate behavior.
effective_check_flags:
type: string
readOnly: true
priority:
allOf:
- $ref: '#/components/schemas/PriorityEnum'
description: Components with higher priority are offered first to translators.
minimum: -2147483648
maximum: 2147483647
enforced_checks: {}
restricted:
type: boolean
title: Restricted component
description: Restrict access to the component to only those explicitly given
permission.
repoweb:
type: string
title: Repository browser
description: Link to repository browser, use {{branch}} for branch, {{filename}}
and {{line}} as filename and line placeholders. You might want to strip
leading directory by using {{filename|parentdir}}.
maxLength: 200
report_source_bugs:
title: Source string bug reporting address
description: E-mail address for reports on errors in source strings. Leave
empty for no e-mails.
oneOf:
- type: string
format: email
maxLength: 190
- type: string
maxLength: 0
merge_style:
allOf:
- $ref: '#/components/schemas/MergeStyleEnum'
description: Define whether Weblate should merge the upstream repository
or rebase changes onto it.
commit_message:
type: string
title: Commit message when translating
description: You can use template language for various info, please consult
the documentation for more details.
inherit_commit_message:
type: boolean
title: Inherit commit message when translating
description: Use the commit message when translating configured in the category
or project.
effective_commit_message:
type: string
readOnly: true
add_message:
type: string
title: Commit message when adding translation
description: You can use template language for various info, please consult
the documentation for more details.
inherit_add_message:
type: boolean
title: Inherit commit message when adding translation
description: Use the commit message when adding translation configured in
the category or project.
effective_add_message:
type: string
readOnly: true
delete_message:
type: string
title: Commit message when removing translation
description: You can use template language for various info, please consult
the documentation for more details.
inherit_delete_message:
type: boolean
title: Inherit commit message when removing translation
description: Use the commit message when removing translation configured
in the category or project.
effective_delete_message:
type: string
readOnly: true
merge_message:
type: string
title: Commit message when merging translation
description: You can use template language for various info, please consult
the documentation for more details.
inherit_merge_message:
type: boolean
title: Inherit commit message when merging translation
description: Use the commit message when merging translation configured
in the category or project.
effective_merge_message:
type: string
readOnly: true
addon_message:
type: string
title: Commit message when add-on makes a change
description: You can use template language for various info, please consult
the documentation for more details.
inherit_addon_message:
type: boolean
title: Inherit commit message when add-on makes a change
description: Use the commit message when add-on makes a change configured
in the category or project.
effective_addon_message:
type: string
readOnly: true
pull_message:
type: string
title: Merge request message
description: You can use template language for various info, please consult
the documentation for more details.
inherit_pull_message:
type: boolean
title: Inherit merge request message
description: Use the merge request message configured in the category or
project.
effective_pull_message:
type: string
readOnly: true
allow_translation_propagation:
type: boolean
description: Whether translation updates in other components will cause
automatic translation in this one
hide_glossary_matches:
type: boolean
title: Do not show glossary matches
description: Hides the glossary panel in the translation editor.
contribute_project_tm:
type: boolean
title: Contribute to project translation memory
description: Allow this component's translations to be added to the project-level
translation memory.
manage_units:
type: boolean
title: Manage strings
description: Enables adding and removing strings straight from Weblate.
If your strings are extracted from the source code or managed externally
you probably want to keep it disabled.
enable_suggestions:
type: boolean
title: Turn on suggestions
description: Whether to allow translation suggestions at all.
suggestion_voting:
type: boolean
description: Allows users to vote on suggestions.
suggestion_autoaccept:
type: integer
maximum: 32767
minimum: 0
title: Automatically accept suggestions
description: Automatically accept suggestions with this number of votes,
use 0 to turn it off.
push_on_commit:
type: boolean
description: Whether the repository should be pushed upstream on every commit.
commit_pending_age:
type: integer
maximum: 2160
minimum: -32768
title: Age of changes to commit
description: Time in hours after which any pending changes will be committed
to the VCS.
auto_lock_error:
type: boolean
title: Lock on error
description: Whether the component should be locked on repository errors.
language_regex:
type: string
title: Language filter
description: Regular expression used to filter translation files when scanning
for file mask.
maxLength: 500
key_filter:
type: string
description: Regular expression used to filter keys. This is only available
for monolingual formats.
maxLength: 500
secondary_language:
type:
- integer
- 'null'
description: Additional language to show together with the source language
while translating. This setting is inherited from the project if left
empty.
inherit_secondary_language:
type: boolean
description: Use the secondary language configured in the category or project.
effective_secondary_language:
type:
- integer
- 'null'
readOnly: true
variant_regex:
type: string
title: Variants regular expression
description: Regular expression used to determine variants of a string.
maxLength: 190
zipfile:
type:
- string
- 'null'
format: uri
docfile:
type:
- string
- 'null'
format: uri
from_component:
oneOf:
- type: integer
- type: string
writeOnly: true
addons:
type: array
items:
type: string
format: uri
readOnly: true
is_glossary:
type: boolean
title: Use as a glossary
description: Glossaries are different from regular translations but help
keep track of and share consistent terminology.
glossary_color:
$ref: '#/components/schemas/ColorEnum'
disable_autoshare:
type: boolean
category:
type:
- string
- 'null'
format: uri
linked_component:
type: string
format: uri
readOnly: true
locked:
type: boolean
readOnly: true
PatchedComponentList:
type: object
properties:
name:
type: string
title: Component list name
description: Display name
maxLength: 100
slug:
type: string
title: URL slug
description: Name used in URLs and filenames.
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
id:
type: integer
readOnly: true
show_dashboard:
type: boolean
title: Show on dashboard
description: When enabled this component list will be shown as a tab on
the dashboard
components:
type: array
items:
type: string
format: uri
readOnly: true
auto_assign:
type: array
items:
$ref: '#/components/schemas/AutoComponentList'
readOnly: true
url:
type: string
format: uri
readOnly: true
PatchedGroup:
type: object
properties:
id:
type: integer
readOnly: true
name:
type: string
maxLength: 150
defining_project:
type: string
format: uri
defining_workspace:
type:
- string
- 'null'
format: uuid
project_selection:
allOf:
- $ref: '#/components/schemas/ProjectSelectionEnum'
minimum: -2147483648
maximum: 2147483647
language_selection:
allOf:
- $ref: '#/components/schemas/LanguageSelectionEnum'
minimum: -2147483648
maximum: 2147483647
url:
type: string
format: uri
readOnly: true
roles:
type: array
items:
type: string
format: uri
readOnly: true
languages:
type: array
items:
type: string
format: uri
readOnly: true
projects:
type: array
items:
type: string
format: uri
readOnly: true
componentlists:
type: array
items:
type: string
format: uri
readOnly: true
components:
type: array
items:
type: string
format: uri
readOnly: true
enforced_2fa:
type: boolean
title: Enforced two-factor authentication
description: Requires users to have two-factor authentication configured.
admins:
type: array
items:
type: string
format: uri
readOnly: true
PatchedLanguage:
type: object
properties:
id:
type: integer
readOnly: true
code:
type: string
title: Language code
pattern: ^[A-Za-z0-9]+(?:[-_@][A-Za-z0-9]+)*$
maxLength: 50
name:
type: string
maxLength: 100
plural:
$ref: '#/components/schemas/LanguagePlural'
aliases:
type: array
items: {}
readOnly: true
direction:
title: Text direction
oneOf:
- $ref: '#/components/schemas/DirectionEnum'
- $ref: '#/components/schemas/BlankEnum'
population:
type: integer
maximum: 9223372036854775807
minimum: -9223372036854775808
format: int64
title: Number of speakers
description: Number of people speaking this language.
web_url:
type: string
readOnly: true
url:
type: string
format: uri
readOnly: true
statistics_url:
type: string
format: uri
readOnly: true
PatchedNotification:
type: object
properties:
notification:
$ref: '#/components/schemas/NotificationEnum'
id:
type: integer
readOnly: true
scope:
allOf:
- $ref: '#/components/schemas/NotificationScopeEnum'
minimum: -2147483648
maximum: 2147483647
frequency:
allOf:
- $ref: '#/components/schemas/FrequencyEnum'
minimum: -2147483648
maximum: 2147483647
project:
allOf:
- $ref: '#/components/schemas/Project'
readOnly: true
component:
allOf:
- $ref: '#/components/schemas/Component'
readOnly: true
PatchedProject:
type: object
properties:
name:
type: string
title: Project name
description: Display name
maxLength: 60
slug:
type: string
title: URL slug
description: Name used in URLs and filenames.
maxLength: 60
pattern: ^[-a-zA-Z0-9_]+$
id:
type: integer
readOnly: true
web:
type: string
format: uri
title: Project website
description: Main website of translated project.
maxLength: 200
web_url:
type: string
readOnly: true
url:
type: string
format: uri
readOnly: true
check_flags:
type: string
title: Translation flags
description: Additional comma-separated flags to influence Weblate behavior.
effective_check_flags:
type: string
readOnly: true
components_list_url:
type: string
format: uri
readOnly: true
repository_url:
type: string
format: uri
readOnly: true
statistics_url:
type: string
format: uri
readOnly: true
metrics_url:
type: string
format: uri
readOnly: true
categories_url:
type: string
format: uri
readOnly: true
changes_list_url:
type: string
format: uri
readOnly: true
languages_url:
type: string
format: uri
readOnly: true
labels_url:
type: string
format: uri
readOnly: true
reports_url:
type: string
format: uri
readOnly: true
lock_url:
type: string
format: uri
readOnly: true
translation_review:
type: boolean
title: Enable reviews
description: Requires dedicated reviewers to approve translations.
source_review:
type: boolean
title: Enable source reviews
description: Requires dedicated reviewers to approve source strings.
commit_policy:
allOf:
- $ref: '#/components/schemas/CommitPolicyEnum'
title: Translation quality filter
description: Select which translations should be included when committing
changes. More restrictive options will skip translations with potential
quality issues.
minimum: -2147483648
maximum: 2147483647
workspace:
type:
- string
- 'null'
format: uuid
instructions:
type: string
title: Translation instructions
description: You can use Markdown and mention users by @username.
enable_hooks:
type: boolean
description: Whether to allow updating this repository by remote hooks.
language_aliases:
type: string
description: 'Comma-separated list of language code mappings, for example:
en_GB:en,en_US:en'
access_control:
allOf:
- $ref: '#/components/schemas/AccessControlEnum'
description: How to restrict access to this project is detailed in the documentation.
minimum: -2147483648
maximum: 2147483647
use_shared_tm:
type: boolean
title: Use shared translation memory
description: Uses the pool of shared translations between projects.
contribute_shared_tm:
type: boolean
title: Contribute to shared translation memory
description: Contributes to the pool of shared translations between projects.
use_workspace_tm:
type: boolean
title: Use workspace translation memory
description: Uses the pool of shared translations between projects in the
workspace.
contribute_workspace_tm:
type: boolean
title: Contribute to workspace translation memory
description: Contributes translations to the pool shared between projects
in the workspace.
autoclean_tm:
type: boolean
title: Autoclean translation memory
description: Automatically removes outdated and obsolete entries from translation
memory.
license:
title: Translation license
type: string
maxLength: 150
examples:
- MIT
- GPL-3.0-or-later
- Apache-2.0
- BSD-3-Clause
- proprietary
inherit_license:
type: boolean
title: Inherit translation license
description: Use the translation license configured in the workspace.
effective_license:
type: string
readOnly: true
agreement:
type: string
title: Contributor license agreement
description: Contributor license agreement which needs to be approved before
a user can translate components in this project.
inherit_agreement:
type: boolean
title: Inherit contributor license agreement
description: Use the contributor license agreement configured in the workspace.
effective_agreement:
type: string
readOnly: true
new_lang:
allOf:
- $ref: '#/components/schemas/NewLangEnum'
title: Adding new translation
description: How to handle requests for creating new translations.
inherit_new_lang:
type: boolean
title: Inherit adding new translations
description: Use the adding new translations setting configured in the workspace.
effective_new_lang:
type: string
readOnly: true
language_code_style:
description: Customize language code used to generate the filename for translations
created by Weblate.
oneOf:
- $ref: '#/components/schemas/LanguageCodeStyleEnum'
- $ref: '#/components/schemas/BlankEnum'
inherit_language_code_style:
type: boolean
description: Use the language code style configured in the workspace.
effective_language_code_style:
type: string
readOnly: true
secondary_language:
type:
- integer
- 'null'
description: Additional language to show together with the source language
while translating.
inherit_secondary_language:
type: boolean
description: Use the secondary language configured in the workspace.
effective_secondary_language:
type:
- integer
- 'null'
readOnly: true
commit_message:
type: string
title: Commit message when translating
description: You can use template language for various info, please consult
the documentation for more details.
inherit_commit_message:
type: boolean
title: Inherit commit message when translating
description: Use the commit message when translating configured in the workspace.
effective_commit_message:
type: string
readOnly: true
add_message:
type: string
title: Commit message when adding translation
description: You can use template language for various info, please consult
the documentation for more details.
inherit_add_message:
type: boolean
title: Inherit commit message when adding translation
description: Use the commit message when adding translation configured in
the workspace.
effective_add_message:
type: string
readOnly: true
delete_message:
type: string
title: Commit message when removing translation
description: You can use template language for various info, please consult
the documentation for more details.
inherit_delete_message:
type: boolean
title: Inherit commit message when removing translation
description: Use the commit message when removing translation configured
in the workspace.
effective_delete_message:
type: string
readOnly: true
merge_message:
type: string
title: Commit message when merging translation
description: You can use template language for various info, please consult
the documentation for more details.
inherit_merge_message:
type: boolean
title: Inherit commit message when merging translation
description: Use the commit message when merging translation configured
in the workspace.
effective_merge_message:
type: string
readOnly: true
addon_message:
type: string
title: Commit message when add-on makes a change
description: You can use template language for various info, please consult
the documentation for more details.
inherit_addon_message:
type: boolean
title: Inherit commit message when add-on makes a change
description: Use the commit message when add-on makes a change configured
in the workspace.
effective_addon_message:
type: string
readOnly: true
pull_message:
type: string
title: Merge request message
description: You can use template language for various info, please consult
the documentation for more details.
inherit_pull_message:
type: boolean
title: Inherit merge request message
description: Use the merge request message configured in the workspace.
effective_pull_message:
type: string
readOnly: true
enforced_2fa:
type: boolean
title: Enforced two-factor authentication
description: Requires contributors to have two-factor authentication configured
before being able to contribute.
machinery_settings:
type: string
format: uri
readOnly: true
locked:
type: boolean
readOnly: true
announcements_url:
type: string
format: uri
readOnly: true
PatchedRole:
type: object
properties:
id:
type: integer
readOnly: true
name:
type: string
maxLength: 200
permissions:
type: array
items:
type: string
url:
type: string
format: uri
readOnly: true
PatchedScreenshot:
type: object
properties:
id:
type: integer
readOnly: true
name:
type: string
title: Screenshot name
maxLength: 200
repository_filename:
type: string
title: Repository path to screenshot
description: Scan for screenshot file change on repository update.
maxLength: 200
translation:
type: string
format: uri
readOnly: true
file_url:
type: string
format: uri
readOnly: true
units:
type: array
items:
type: string
format: uri
readOnly: true
url:
type: string
format: uri
readOnly: true
PatchedSingleServiceConfig:
type: object
properties:
service:
type: string
configuration:
type: object
additionalProperties: {}
PatchedUnitWrite:
type: object
description: Serializer for updating source unit.
properties:
target:
type: array
items:
type: string
state:
allOf:
- $ref: '#/components/schemas/StringStateEnum'
minimum: -2147483648
maximum: 2147483647
explanation:
type: string
description: Additional explanation to clarify meaning or usage of the string.
extra_flags:
type: string
title: Translation flags
description: Additional comma-separated flags to influence Weblate behavior.
labels:
type: array
items:
type: integer
PatchedUserUpdateRequest:
type: object
description: |-
Schema-only serializer for user update requests.
Writable nested fields are not supported by default in .update()
'profile' field update logic is handled by ProfileUpdateMixin
properties:
id:
type: integer
readOnly: true
email:
type:
- string
- 'null'
title: E-mail
format: email
maxLength: 190
full_name:
type: string
maxLength: 150
username:
type: string
description: 'Username may only contain letters, numbers or the following
characters: @ . + - _'
maxLength: 150
groups:
type: array
items:
type: string
format: uri
readOnly: true
profile:
$ref: '#/components/schemas/ProfileUpdateRequest'
notifications:
type: string
format: uri
readOnly: true
is_superuser:
type: boolean
title: Superuser status
description: User has all possible permissions.
is_active:
type: boolean
title: Active
description: Mark user as inactive instead of removing.
is_bot:
type: boolean
title: Robot user
date_joined:
type: string
format: date-time
readOnly: true
date_expires:
type:
- string
- 'null'
format: date-time
title: Expires
description: The account will be disabled after the expiry.
last_login:
type:
- string
- 'null'
format: date-time
readOnly: true
url:
type: string
format: uri
readOnly: true
statistics_url:
type: string
format: uri
readOnly: true
contributions_url:
type: string
format: uri
readOnly: true
PendingUnits:
type: object
description: Detailed breakdown of pending translation units.
properties:
total:
type: integer
description: Total number of translation units with pending changes.
errors_skipped:
type: integer
description: Number of units skipped due to commit errors (blocked by retry
policy).
commit_policy_skipped:
type: integer
description: Number of units skipped by the commit policy (e.g., needs editing,
not approved).
eligible_for_commit:
type: integer
description: Number of units eligible to be committed based on the current
policy.
required:
- commit_policy_skipped
- eligible_for_commit
- errors_skipped
- total
PriorityEnum:
enum:
- 60
- 80
- 100
- 120
- 140
type: integer
description: |-
* `60` - Very high
* `80` - High
* `100` - Medium
* `120` - Low
* `140` - Very low
Profile:
type: object
properties:
language:
allOf:
- $ref: '#/components/schemas/LanguageEnum'
title: Interface Language
languages:
type: array
items:
type: string
format: uri
readOnly: true
secondary_languages:
type: array
items:
type: string
format: uri
readOnly: true
suggested:
type: integer
readOnly: true
translated:
type: integer
readOnly: true
uploaded:
type: integer
readOnly: true
commented:
type: integer
readOnly: true
theme:
$ref: '#/components/schemas/ThemeEnum'
hide_completed:
type: boolean
title: Hide completed translations on the dashboard
secondary_in_zen:
type: boolean
title: Show secondary translations in the Zen mode
hide_source_secondary:
type: boolean
title: Hide source if a secondary translation exists
wide_tables:
type: boolean
title: Show all columns in lists using horizontal scrolling
description: Instead of hiding columns on narrow screens, keep all columns
and scroll the table horizontally.
editor_link:
type: string
description: Enter a custom URL to be used as link to the source code. You
can use {{branch}} for branch, {{filename}} and {{line}} as filename and
line placeholders.
maxLength: 200
translate_mode:
allOf:
- $ref: '#/components/schemas/TranslateModeEnum'
title: Translation editor mode
minimum: -2147483648
maximum: 2147483647
zen_mode:
allOf:
- $ref: '#/components/schemas/ZenModeEnum'
title: Zen editor mode
minimum: -2147483648
maximum: 2147483647
special_chars:
type: string
title: Special characters
description: You can specify additional special visual keyboard characters
to be shown while translating. It can be useful for characters you use
frequently, but are hard to type on your keyboard.
maxLength: 30
nearby_strings:
type: integer
maximum: 50
minimum: 1
title: Number of nearby strings
description: Number of nearby strings to show in each direction in the full
editor.
auto_watch:
type: boolean
title: Automatically watch projects on contribution
description: Projects are added to your watched projects when you contribute
to them.
contribute_personal_tm:
type: boolean
title: Contribute to personal translation memory
description: Allow your translations to be added to your personal translation
memory.
dashboard_view:
allOf:
- $ref: '#/components/schemas/DashboardViewEnum'
title: Default dashboard view
minimum: -2147483648
maximum: 2147483647
dashboard_component_list:
type:
- string
- 'null'
- 'null'
format: uri
readOnly: true
watched:
type: array
items:
type: string
format: uri
readOnly: true
website:
title: Website URL
oneOf:
- type: string
format: uri
maxLength: 200
- type: string
maxLength: 0
contact:
title: Contact URL
description: Link to contact you online using services like Signal, SimpleX
or Telegram.
oneOf:
- type: string
format: uri
maxLength: 200
- type: string
maxLength: 0
liberapay:
title: Liberapay username
description: Liberapay is a platform to donate money to teams, organizations
and individuals.
oneOf:
- type: string
maxLength: 50
pattern: ^[-a-zA-Z0-9_]+$
- type: string
maxLength: 0
fediverse:
title: Fediverse URL
description: Link to your Fediverse profile for federated services like
Mastodon or diaspora*.
oneOf:
- type: string
format: uri
maxLength: 200
- type: string
maxLength: 0
codesite:
title: Code site URL
description: Link to your code profile for services like Codeberg or GitLab.
oneOf:
- type: string
format: uri
maxLength: 200
- type: string
maxLength: 0
github:
title: GitHub username
oneOf:
- type: string
maxLength: 50
pattern: ^[-a-zA-Z0-9_]+$
- type: string
maxLength: 0
twitter:
title: X username
oneOf:
- type: string
maxLength: 50
pattern: ^[-a-zA-Z0-9_]+$
- type: string
maxLength: 0
linkedin:
title: LinkedIn profile name
description: Your LinkedIn profile name from linkedin.com/in/profilename
oneOf:
- type: string
pattern: ^[-\w]+$
maxLength: 50
- type: string
maxLength: 0
location:
type: string
maxLength: 100
company:
type: string
maxLength: 100
public_email:
oneOf:
- type: string
format: email
- type: string
enum:
- ''
commit_email:
oneOf:
- type: string
format: email
- type: string
enum:
- ''
commit_name:
$ref: '#/components/schemas/CommitNameEnum'
last_2fa:
readOnly: true
oneOf:
- $ref: '#/components/schemas/Last2faEnum'
- $ref: '#/components/schemas/BlankEnum'
required:
- commented
- commit_email
- commit_name
- dashboard_component_list
- language
- languages
- last_2fa
- public_email
- secondary_languages
- suggested
- translated
- uploaded
- watched
ProfileUpdateRequest:
type: object
description: Schema-only profile serializer for update request bodies.
properties:
language:
allOf:
- $ref: '#/components/schemas/LanguageEnum'
title: Interface Language
languages:
type:
- array
- 'null'
items:
type: string
secondary_languages:
type:
- array
- 'null'
items:
type: string
theme:
$ref: '#/components/schemas/ThemeEnum'
hide_completed:
type: boolean
title: Hide completed translations on the dashboard
secondary_in_zen:
type: boolean
title: Show secondary translations in the Zen mode
hide_source_secondary:
type: boolean
title: Hide source if a secondary translation exists
wide_tables:
type: boolean
title: Show all columns in lists using horizontal scrolling
description: Instead of hiding columns on narrow screens, keep all columns
and scroll the table horizontally.
editor_link:
type: string
description: Enter a custom URL to be used as link to the source code. You
can use {{branch}} for branch, {{filename}} and {{line}} as filename and
line placeholders.
maxLength: 200
translate_mode:
allOf:
- $ref: '#/components/schemas/TranslateModeEnum'
title: Translation editor mode
minimum: -2147483648
maximum: 2147483647
zen_mode:
allOf:
- $ref: '#/components/schemas/ZenModeEnum'
title: Zen editor mode
minimum: -2147483648
maximum: 2147483647
special_chars:
type: string
title: Special characters
description: You can specify additional special visual keyboard characters
to be shown while translating. It can be useful for characters you use
frequently, but are hard to type on your keyboard.
maxLength: 30
nearby_strings:
type: integer
maximum: 50
minimum: 1
title: Number of nearby strings
description: Number of nearby strings to show in each direction in the full
editor.
auto_watch:
type: boolean
title: Automatically watch projects on contribution
description: Projects are added to your watched projects when you contribute
to them.
contribute_personal_tm:
type: boolean
title: Contribute to personal translation memory
description: Allow your translations to be added to your personal translation
memory.
dashboard_view:
allOf:
- $ref: '#/components/schemas/DashboardViewEnum'
title: Default dashboard view
minimum: -2147483648
maximum: 2147483647
dashboard_component_list:
type:
- string
- 'null'
pattern: ^[-a-zA-Z0-9_]+$
watched:
type:
- array
- 'null'
items:
type: string
pattern: ^[-a-zA-Z0-9_]+$
website:
title: Website URL
oneOf:
- type: string
format: uri
maxLength: 200
- type: string
maxLength: 0
contact:
title: Contact URL
description: Link to contact you online using services like Signal, SimpleX
or Telegram.
oneOf:
- type: string
format: uri
maxLength: 200
- type: string
maxLength: 0
liberapay:
title: Liberapay username
description: Liberapay is a platform to donate money to teams, organizations
and individuals.
oneOf:
- type: string
maxLength: 50
pattern: ^[-a-zA-Z0-9_]+$
- type: string
maxLength: 0
fediverse:
title: Fediverse URL
description: Link to your Fediverse profile for federated services like
Mastodon or diaspora*.
oneOf:
- type: string
format: uri
maxLength: 200
- type: string
maxLength: 0
codesite:
title: Code site URL
description: Link to your code profile for services like Codeberg or GitLab.
oneOf:
- type: string
format: uri
maxLength: 200
- type: string
maxLength: 0
github:
title: GitHub username
oneOf:
- type: string
maxLength: 50
pattern: ^[-a-zA-Z0-9_]+$
- type: string
maxLength: 0
twitter:
title: X username
oneOf:
- type: string
maxLength: 50
pattern: ^[-a-zA-Z0-9_]+$
- type: string
maxLength: 0
linkedin:
title: LinkedIn profile name
description: Your LinkedIn profile name from linkedin.com/in/profilename
oneOf:
- type: string
pattern: ^[-\w]+$
maxLength: 50
- type: string
maxLength: 0
location:
type: string
maxLength: 100
company:
type: string
maxLength: 100
public_email:
oneOf:
- type: string
format: email
- type: string
enum:
- ''
commit_email:
oneOf:
- type: string
format: email
- type: string
enum:
- ''
commit_name:
$ref: '#/components/schemas/CommitNameEnum'
Project:
type: object
properties:
name:
type: string
title: Project name
description: Display name
maxLength: 60
slug:
type: string
title: URL slug
description: Name used in URLs and filenames.
maxLength: 60
pattern: ^[-a-zA-Z0-9_]+$
id:
type: integer
readOnly: true
web:
type: string
format: uri
title: Project website
description: Main website of translated project.
maxLength: 200
web_url:
type: string
readOnly: true
url:
type: string
format: uri
readOnly: true
check_flags:
type: string
title: Translation flags
description: Additional comma-separated flags to influence Weblate behavior.
effective_check_flags:
type: string
readOnly: true
components_list_url:
type: string
format: uri
readOnly: true
repository_url:
type: string
format: uri
readOnly: true
statistics_url:
type: string
format: uri
readOnly: true
metrics_url:
type: string
format: uri
readOnly: true
categories_url:
type: string
format: uri
readOnly: true
changes_list_url:
type: string
format: uri
readOnly: true
languages_url:
type: string
format: uri
readOnly: true
labels_url:
type: string
format: uri
readOnly: true
reports_url:
type: string
format: uri
readOnly: true
lock_url:
type: string
format: uri
readOnly: true
translation_review:
type: boolean
title: Enable reviews
description: Requires dedicated reviewers to approve translations.
source_review:
type: boolean
title: Enable source reviews
description: Requires dedicated reviewers to approve source strings.
commit_policy:
allOf:
- $ref: '#/components/schemas/CommitPolicyEnum'
title: Translation quality filter
description: Select which translations should be included when committing
changes. More restrictive options will skip translations with potential
quality issues.
minimum: -2147483648
maximum: 2147483647
workspace:
type:
- string
- 'null'
format: uuid
instructions:
type: string
title: Translation instructions
description: You can use Markdown and mention users by @username.
enable_hooks:
type: boolean
description: Whether to allow updating this repository by remote hooks.
language_aliases:
type: string
description: 'Comma-separated list of language code mappings, for example:
en_GB:en,en_US:en'
access_control:
allOf:
- $ref: '#/components/schemas/AccessControlEnum'
description: How to restrict access to this project is detailed in the documentation.
minimum: -2147483648
maximum: 2147483647
use_shared_tm:
type: boolean
title: Use shared translation memory
description: Uses the pool of shared translations between projects.
contribute_shared_tm:
type: boolean
title: Contribute to shared translation memory
description: Contributes to the pool of shared translations between projects.
use_workspace_tm:
type: boolean
title: Use workspace translation memory
description: Uses the pool of shared translations between projects in the
workspace.
contribute_workspace_tm:
type: boolean
title: Contribute to workspace translation memory
description: Contributes translations to the pool shared between projects
in the workspace.
autoclean_tm:
type: boolean
title: Autoclean translation memory
description: Automatically removes outdated and obsolete entries from translation
memory.
license:
title: Translation license
type: string
maxLength: 150
examples:
- MIT
- GPL-3.0-or-later
- Apache-2.0
- BSD-3-Clause
- proprietary
inherit_license:
type: boolean
title: Inherit translation license
description: Use the translation license configured in the workspace.
effective_license:
type: string
readOnly: true
agreement:
type: string
title: Contributor license agreement
description: Contributor license agreement which needs to be approved before
a user can translate components in this project.
inherit_agreement:
type: boolean
title: Inherit contributor license agreement
description: Use the contributor license agreement configured in the workspace.
effective_agreement:
type: string
readOnly: true
new_lang:
allOf:
- $ref: '#/components/schemas/NewLangEnum'
title: Adding new translation
description: How to handle requests for creating new translations.
inherit_new_lang:
type: boolean
title: Inherit adding new translations
description: Use the adding new translations setting configured in the workspace.
effective_new_lang:
type: string
readOnly: true
language_code_style:
description: Customize language code used to generate the filename for translations
created by Weblate.
oneOf:
- $ref: '#/components/schemas/LanguageCodeStyleEnum'
- $ref: '#/components/schemas/BlankEnum'
inherit_language_code_style:
type: boolean
description: Use the language code style configured in the workspace.
effective_language_code_style:
type: string
readOnly: true
secondary_language:
type:
- integer
- 'null'
description: Additional language to show together with the source language
while translating.
inherit_secondary_language:
type: boolean
description: Use the secondary language configured in the workspace.
effective_secondary_language:
type:
- integer
- 'null'
readOnly: true
commit_message:
type: string
title: Commit message when translating
description: You can use template language for various info, please consult
the documentation for more details.
inherit_commit_message:
type: boolean
title: Inherit commit message when translating
description: Use the commit message when translating configured in the workspace.
effective_commit_message:
type: string
readOnly: true
add_message:
type: string
title: Commit message when adding translation
description: You can use template language for various info, please consult
the documentation for more details.
inherit_add_message:
type: boolean
title: Inherit commit message when adding translation
description: Use the commit message when adding translation configured in
the workspace.
effective_add_message:
type: string
readOnly: true
delete_message:
type: string
title: Commit message when removing translation
description: You can use template language for various info, please consult
the documentation for more details.
inherit_delete_message:
type: boolean
title: Inherit commit message when removing translation
description: Use the commit message when removing translation configured
in the workspace.
effective_delete_message:
type: string
readOnly: true
merge_message:
type: string
title: Commit message when merging translation
description: You can use template language for various info, please consult
the documentation for more details.
inherit_merge_message:
type: boolean
title: Inherit commit message when merging translation
description: Use the commit message when merging translation configured
in the workspace.
effective_merge_message:
type: string
readOnly: true
addon_message:
type: string
title: Commit message when add-on makes a change
description: You can use template language for various info, please consult
the documentation for more details.
inherit_addon_message:
type: boolean
title: Inherit commit message when add-on makes a change
description: Use the commit message when add-on makes a change configured
in the workspace.
effective_addon_message:
type: string
readOnly: true
pull_message:
type: string
title: Merge request message
description: You can use template language for various info, please consult
the documentation for more details.
inherit_pull_message:
type: boolean
title: Inherit merge request message
description: Use the merge request message configured in the workspace.
effective_pull_message:
type: string
readOnly: true
enforced_2fa:
type: boolean
title: Enforced two-factor authentication
description: Requires contributors to have two-factor authentication configured
before being able to contribute.
machinery_settings:
type: string
format: uri
readOnly: true
locked:
type: boolean
readOnly: true
announcements_url:
type: string
format: uri
readOnly: true
required:
- announcements_url
- categories_url
- changes_list_url
- components_list_url
- effective_add_message
- effective_addon_message
- effective_agreement
- effective_check_flags
- effective_commit_message
- effective_delete_message
- effective_language_code_style
- effective_license
- effective_merge_message
- effective_new_lang
- effective_pull_message
- effective_secondary_language
- id
- labels_url
- languages_url
- lock_url
- locked
- machinery_settings
- metrics_url
- name
- reports_url
- repository_url
- slug
- statistics_url
- url
- web
- web_url
ProjectComponent:
type: object
properties:
name:
type: string
title: Component name
description: Display name
maxLength: 100
slug:
type: string
title: URL slug
description: Name used in URLs and filenames.
maxLength: 100
pattern: ^[-a-zA-Z0-9_]+$
id:
type: integer
readOnly: true
source_language:
$ref: '#/components/schemas/Language'
vcs:
allOf:
- $ref: '#/components/schemas/VcsEnum'
title: Version control system
description: Version control system to use to access your repository containing
translations. You can also choose additional integration with third party
providers to submit pull/merge requests.
repo:
type: string
maxLength: 300
git_export:
type: string
title: Exported repository URL
description: URL of repository where users can fetch changes from Weblate
maxLength: 220
branch:
type: string
maxLength: 200
push_branch:
type: string
maxLength: 200
filemask:
type: string
title: File mask
description: 'Path of files to translate relative to repository root, use
* instead of language code, for example: po/*.po or locale/*/LC_MESSAGES/django.po.'
maxLength: 400
screenshot_filemask:
type: string
title: Screenshot file mask
description: 'Path of screenshots relative to repository root, for example:
docs/screenshots/*.png.'
maxLength: 400
template:
type: string
title: Monolingual base language file
description: Filename of translation base file, containing all strings and
their source for monolingual translations.
maxLength: 400
edit_template:
type: boolean
title: Edit base file
description: Whether users will be able to edit the base file for monolingual
translations.
intermediate:
type: string
title: Intermediate language file
description: Filename of intermediate translation file. In most cases this
is a translation file provided by developers and is used when creating
actual source strings.
maxLength: 400
new_base:
type: string
title: Template for new translations
description: Filename of file used for creating new translations. For gettext
choose .pot file.
maxLength: 400
file_format:
$ref: '#/components/schemas/FileFormatEnum'
file_format_params:
title: File format parameters
license:
title: Translation license
type: string
maxLength: 150
examples:
- MIT
- GPL-3.0-or-later
- Apache-2.0
- BSD-3-Clause
- proprietary
inherit_license:
type: boolean
title: Inherit translation license
description: Use the translation license configured in the category or project.
effective_license:
type: string
readOnly: true
license_url:
type: string
readOnly: true
announcements_url:
type: string
format: uri
readOnly: true
agreement:
type: string
title: Contributor license agreement
description: Contributor license agreement which needs to be approved before
a user can translate this component.
inherit_agreement:
type: boolean
title: Inherit contributor license agreement
description: Use the contributor license agreement configured in the category
or project.
effective_agreement:
type: string
readOnly: true
web_url:
type: string
readOnly: true
url:
type: string
format: uri
readOnly: true
repository_url:
type: string
format: uri
readOnly: true
translations_url:
type: string
format: uri
readOnly: true
statistics_url:
type: string
format: uri
readOnly: true
lock_url:
type: string
format: uri
readOnly: true
links_url:
type: string
format: uri
readOnly: true
changes_list_url:
type: string
format: uri
readOnly: true
task_url:
type:
- string
- 'null'
format: uri
readOnly: true
reports_url:
type: string
format: uri
readOnly: true
new_lang:
allOf:
- $ref: '#/components/schemas/NewLangEnum'
title: Adding new translation
description: How to handle requests for creating new translations.
inherit_new_lang:
type: boolean
title: Inherit adding new translations
description: Use the adding new translations setting configured in the category
or project.
effective_new_lang:
type: string
readOnly: true
language_code_style:
description: Customize language code used to generate the filename for translations
created by Weblate.
oneOf:
- $ref: '#/components/schemas/LanguageCodeStyleEnum'
- $ref: '#/components/schemas/BlankEnum'
inherit_language_code_style:
type: boolean
description: Use the language code style configured in the category or project.
effective_language_code_style:
type: string
readOnly: true
push:
type: string
maxLength: 300
check_flags:
type: string
title: Translation flags
description: Additional comma-separated flags to influence Weblate behavior.
effective_check_flags:
type: string
readOnly: true
priority:
allOf:
- $ref: '#/components/schemas/PriorityEnum'
description: Components with higher priority are offered first to translators.
minimum: -2147483648
maximum: 2147483647
enforced_checks: {}
restricted:
type: boolean
title: Restricted component
description: Restrict access to the component to only those explicitly given
permission.
repoweb:
type: string
title: Repository browser
description: Link to repository browser, use {{branch}} for branch, {{filename}}
and {{line}} as filename and line placeholders. You might want to strip
leading directory by using {{filename|parentdir}}.
maxLength: 200
report_source_bugs:
title: Source string bug reporting address
description: E-mail address for reports on errors in source strings. Leave
empty for no e-mails.
oneOf:
- type: string
format: email
maxLength: 190
- type: string
maxLength: 0
merge_style:
allOf:
- $ref: '#/components/schemas/MergeStyleEnum'
description: Define whether Weblate should merge the upstream repository
or rebase changes onto it.
commit_message:
type: string
title: Commit message when translating
description: You can use template language for various info, please consult
the documentation for more details.
inherit_commit_message:
type: boolean
title: Inherit commit message when translating
description: Use the commit message when translating configured in the category
or project.
effective_commit_message:
type: string
readOnly: true
add_message:
type: string
title: Commit message when adding translation
description: You can use template language for various info, please consult
the documentation for more details.
inherit_add_message:
type: boolean
title: Inherit commit message when adding translation
description: Use the commit message when adding translation configured in
the category or project.
effective_add_message:
type: string
readOnly: true
delete_message:
type: string
title: Commit message when removing translation
description: You can use template language for various info, please consult
the documentation for more details.
inherit_delete_message:
type: boolean
title: Inherit commit message when removing translation
description: Use the commit message when removing translation configured
in the category or project.
effective_delete_message:
type: string
readOnly: true
merge_message:
type: string
title: Commit message when merging translation
description: You can use template language for various info, please consult
the documentation for more details.
inherit_merge_message:
type: boolean
title: Inherit commit message when merging translation
description: Use the commit message when merging translation configured
in the category or project.
effective_merge_message:
type: string
readOnly: true
addon_message:
type: string
title: Commit message when add-on makes a change
description: You can use template language for various info, please consult
the documentation for more details.
inherit_addon_message:
type: boolean
title: Inherit commit message when add-on makes a change
description: Use the commit message when add-on makes a change configured
in the category or project.
effective_addon_message:
type: string
readOnly: true
pull_message:
type: string
title: Merge request message
description: You can use template language for various info, please consult
the documentation for more details.
inherit_pull_message:
type: boolean
title: Inherit merge request message
description: Use the merge request message configured in the category or
project.
effective_pull_message:
type: string
readOnly: true
allow_translation_propagation:
type: boolean
description: Whether translation updates in other components will cause
automatic translation in this one
hide_glossary_matches:
type: boolean
title: Do not show glossary matches
description: Hides the glossary panel in the translation editor.
contribute_project_tm:
type: boolean
title: Contribute to project translation memory
description: Allow this component's translations to be added to the project-level
translation memory.
manage_units:
type: boolean
title: Manage strings
description: Enables adding and removing strings straight from Weblate.
If your strings are extracted from the source code or managed externally
you probably want to keep it disabled.
enable_suggestions:
type: boolean
title: Turn on suggestions
description: Whether to allow translation suggestions at all.
suggestion_voting:
type: boolean
description: Allows users to vote on suggestions.
suggestion_autoaccept:
type: integer
maximum: 32767
minimum: 0
title: Automatically accept suggestions
description: Automatically accept suggestions with this number of votes,
use 0 to turn it off.
push_on_commit:
type: boolean
description: Whether the repository should be pushed upstream on every commit.
commit_pending_age:
type: integer
maximum: 2160
minimum: -32768
title: Age of changes to commit
description: Time in hours after which any pending changes will be committed
to the VCS.
auto_lock_error:
type: boolean
title: Lock on error
description: Whether the component should be locked on repository errors.
language_regex:
type: string
title: Language filter
description: Regular expression used to filter translation files when scanning
for file mask.
maxLength: 500
key_filter:
type: string
description: Regular expression used to filter keys. This is only available
for monolingual formats.
maxLength: 500
secondary_language:
type:
- integer
- 'null'
description: Additional language to show together with the source language
while translating. This setting is inherited from the project if left
empty.
inherit_secondary_language:
type: boolean
description: Use the secondary language configured in the category or project.
effective_secondary_language:
type:
- integer
- 'null'
readOnly: true
variant_regex:
type: string
title: Variants regular expression
description: Regular expression used to determine variants of a string.
maxLength: 190
zipfile:
type:
- string
- 'null'
format: uri
docfile:
type:
- string
- 'null'
format: uri
from_component:
oneOf:
- type: integer
- type: string
writeOnly: true
addons:
type: array
items:
type: string
format: uri
readOnly: true
is_glossary:
type: boolean
title: Use as a glossary
description: Glossaries are different from regular translations but help
keep track of and share consistent terminology.
glossary_color:
$ref: '#/components/schemas/ColorEnum'
disable_autoshare:
type: boolean
category:
type:
- string
- 'null'
format: uri
linked_component:
type: string
format: uri
readOnly: true
locked:
type: boolean
readOnly: true
required:
- addons
- announcements_url
- changes_list_url
- effective_add_message
- effective_addon_message
- effective_agreement
- effective_check_flags
- effective_commit_message
- effective_delete_message
- effective_language_code_style
- effective_license
- effective_merge_message
- effective_new_lang
- effective_pull_message
- effective_secondary_language
- file_format
- filemask
- id
- license_url
- linked_component
- links_url
- lock_url
- locked
- name
- repo
- reports_url
- repository_url
- slug
- statistics_url
- task_url
- translations_url
- url
- web_url
ProjectLock:
type: object
properties:
locked:
type: boolean
readOnly: true
required:
- locked
ProjectMachinerySettings:
type: object
properties:
service_name:
type: object
additionalProperties: {}
ProjectSelectionEnum:
enum:
- 0
- 1
- 3
- 4
- 2
type: integer
description: |-
* `0` - As defined
* `1` - All projects
* `3` - All public projects
* `4` - All protected projects
* `2` - From component list
RepoRequest:
type: object
properties:
operation:
$ref: '#/components/schemas/OperationEnum'
required:
- operation
Report:
type: object
properties:
id:
type: integer
readOnly: true
kind:
allOf:
- $ref: '#/components/schemas/ReportKindEnum'
readOnly: true
version:
type: integer
readOnly: true
creator:
type: string
readOnly: true
created:
type: string
format: date-time
readOnly: true
scope:
type:
- object
- 'null'
additionalProperties:
type: string
readOnly: true
url:
type: string
format: uri
readOnly: true
json_url:
type: string
format: uri
readOnly: true
html_url:
type: string
format: uri
readOnly: true
rst_url:
type: string
format: uri
readOnly: true
parameters:
type: object
additionalProperties: {}
readOnly: true
data:
oneOf:
- type: object
additionalProperties: true
- type: array
items: {}
readOnly: true
required:
- created
- creator
- data
- html_url
- id
- json_url
- kind
- parameters
- rst_url
- scope
- url
- version
ReportCreate:
type: object
description: |-
Parameters for generating a report, with at most one optional scope.
Start and end are required for credits, contributor stats, and translator work.
Kind-specific optional fields are ignored by other report kinds.
properties:
kind:
$ref: '#/components/schemas/ReportKindEnum'
workspace:
type: string
format: uuid
project:
type: string
title: URL slug
description: Name used in URLs and filenames.
maxLength: 60
pattern: ^[-a-zA-Z0-9_]+$
category:
type: integer
minimum: 1
component:
type: string
start:
type: string
format: date-time
description: Required for credits, contributor stats, and translator work
reports.
end:
type: string
format: date-time
description: Required for credits, contributor stats, and translator work
reports.
language:
type: string
default: ''
sort_by:
allOf:
- $ref: '#/components/schemas/SortByEnum'
default: count
sort_order:
allOf:
- $ref: '#/components/schemas/SortOrderEnum'
default: descending
counting_mode:
allOf:
- $ref: '#/components/schemas/CountingModeEnum'
default: unique
q:
type: string
default: state:<translated
base_rate:
type: string
format: decimal
pattern: ^-?\d{0,8}(?:\.\d{0,4})?$
default: '1.0000'
tm_threshold:
type: integer
maximum: 100
minimum: 75
default: 80
rate_new:
type: string
format: decimal
pattern: ^-?\d{0,4}(?:\.\d{0,2})?$
default: '100.00'
rate_needs_editing:
type: string
format: decimal
pattern: ^-?\d{0,4}(?:\.\d{0,2})?$
default: '50.00'
rate_tm_100:
type: string
format: decimal
pattern: ^-?\d{0,4}(?:\.\d{0,2})?$
default: '0.00'
rate_tm_fuzzy:
type: string
format: decimal
pattern: ^-?\d{0,4}(?:\.\d{0,2})?$
default: '50.00'
rate_repetition:
type: string
format: decimal
pattern: ^-?\d{0,4}(?:\.\d{0,2})?$
default: '0.00'
min_changes:
type: integer
minimum: 0
default: 5
max_changes:
type: integer
minimum: 1
default: 1000
max_words:
type: integer
minimum: 1
default: 10000
required:
- kind
ReportKindEnum:
enum:
- credits
- contributor_stats
- cost_estimate
- translator_work
type: string
description: |-
* `credits` - Credits
* `contributor_stats` - Contributor stats
* `cost_estimate` - Cost estimate
* `translator_work` - Translator work analysis
ReportList:
type: object
properties:
id:
type: integer
readOnly: true
kind:
allOf:
- $ref: '#/components/schemas/ReportKindEnum'
readOnly: true
version:
type: integer
readOnly: true
creator:
type: string
readOnly: true
created:
type: string
format: date-time
readOnly: true
scope:
type:
- object
- 'null'
additionalProperties:
type: string
readOnly: true
url:
type: string
format: uri
readOnly: true
json_url:
type: string
format: uri
readOnly: true
html_url:
type: string
format: uri
readOnly: true
rst_url:
type: string
format: uri
readOnly: true
required:
- created
- creator
- html_url
- id
- json_url
- kind
- rst_url
- scope
- url
- version
ReportTaskResponse:
type: object
properties:
detail:
type: string
task_url:
type: string
format: uri
required:
- detail
- task_url
Repository:
type: object
description: Serializer for repository status information.
properties:
needs_commit:
type: boolean
description: Whether the repository has pending changes that need to be
committed.
needs_merge:
type: boolean
description: Whether the repository needs to pull changes from upstream.
needs_push:
type: boolean
description: Whether the repository has commits that need to be pushed.
url:
type: string
description: URL to the repository API endpoint.
remote_commit:
oneOf:
- $ref: '#/components/schemas/CommitInfo'
- type: 'null'
description: Detailed information about the last commit in the remote repository
(component/translation only).
weblate_commit:
oneOf:
- $ref: '#/components/schemas/CommitInfo'
- type: 'null'
description: Detailed information about the last commit in the Weblate repository
(component/translation only).
status:
type:
- string
- 'null'
description: Full repository status text (component/translation only).
merge_failure:
type:
- string
- 'null'
description: Details about merge failure if any (component/translation only).
pending_units:
oneOf:
- $ref: '#/components/schemas/PendingUnits'
- type: 'null'
description: Detailed breakdown of translation units with pending changes.
outgoing_commits:
type:
- integer
- 'null'
description: Number of commits ready to be pushed to the remote repository
(component/translation only).
missing_commits:
type:
- integer
- 'null'
description: Number of commits in the remote repository that need to be
pulled (component/translation only).
required:
- needs_commit
- needs_merge
- needs_push
- url
RepositoryOperation:
type: object
properties:
result:
type: boolean
detail:
type: string
required:
- result
ResultEnum:
enum:
- voted
- accepted
type: string
description: |-
* `voted` - voted
* `accepted` - accepted
Role:
type: object
properties:
id:
type: integer
readOnly: true
name:
type: string
maxLength: 200
permissions:
type: array
items:
type: string
url:
type: string
format: uri
readOnly: true
required:
- id
- name
- permissions
- url
ScopedReportCreate:
type: object
description: |-
Parameters for generating a report scoped by the endpoint URL.
Start and end are required for credits, contributor stats, and translator work.
Kind-specific optional fields are ignored by other report kinds.
properties:
kind:
$ref: '#/components/schemas/ReportKindEnum'
start:
type: string
format: date-time
description: Required for credits, contributor stats, and translator work
reports.
end:
type: string
format: date-time
description: Required for credits, contributor stats, and translator work
reports.
language:
type: string
default: ''
sort_by:
allOf:
- $ref: '#/components/schemas/SortByEnum'
default: count
sort_order:
allOf:
- $ref: '#/components/schemas/SortOrderEnum'
default: descending
counting_mode:
allOf:
- $ref: '#/components/schemas/CountingModeEnum'
default: unique
q:
type: string
default: state:<translated
base_rate:
type: string
format: decimal
pattern: ^-?\d{0,8}(?:\.\d{0,4})?$
default: '1.0000'
tm_threshold:
type: integer
maximum: 100
minimum: 75
default: 80
rate_new:
type: string
format: decimal
pattern: ^-?\d{0,4}(?:\.\d{0,2})?$
default: '100.00'
rate_needs_editing:
type: string
format: decimal
pattern: ^-?\d{0,4}(?:\.\d{0,2})?$
default: '50.00'
rate_tm_100:
type: string
format: decimal
pattern: ^-?\d{0,4}(?:\.\d{0,2})?$
default: '0.00'
rate_tm_fuzzy:
type: string
format: decimal
pattern: ^-?\d{0,4}(?:\.\d{0,2})?$
default: '50.00'
rate_repetition:
type: string
format: decimal
pattern: ^-?\d{0,4}(?:\.\d{0,2})?$
default: '0.00'
min_changes:
type: integer
minimum: 0
default: 5
max_changes:
type: integer
minimum: 1
default: 1000
max_words:
type: integer
minimum: 1
default: 10000
required:
- kind
Screenshot:
type: object
properties:
id:
type: integer
readOnly: true
name:
type: string
title: Screenshot name
maxLength: 200
repository_filename:
type: string
title: Repository path to screenshot
description: Scan for screenshot file change on repository update.
maxLength: 200
translation:
type: string
format: uri
readOnly: true
file_url:
type: string
format: uri
readOnly: true
units:
type: array
items:
type: string
format: uri
readOnly: true
url:
type: string
format: uri
readOnly: true
required:
- file_url
- id
- name
- translation
- units
- url
ScreenshotFile:
type: object
properties:
image:
type: string
format: uri
required:
- image
SearchResult:
type: object
properties:
url:
type: string
name:
type: string
category:
type: string
required:
- category
- name
- url
ServerErrorEnum:
enum:
- server_error
type: string
description: '* `server_error` - Server Error'
SeverityEnum:
enum:
- info
- warning
- danger
- success
type: string
description: |-
* `info` - Info (light blue)
* `warning` - Warning (yellow)
* `danger` - Danger (red)
* `success` - Success (green)
SingleServiceConfig:
type: object
properties:
service:
type: string
configuration:
type: object
additionalProperties: {}
required:
- configuration
- service
SortByEnum:
enum:
- count
- date_joined
type: string
description: |-
* `count` - count
* `date_joined` - date_joined
SortOrderEnum:
enum:
- descending
- ascending
type: string
description: |-
* `descending` - descending
* `ascending` - ascending
SourceEnum:
enum:
- 0
- 1
- 3
- 4
- 5
- 6
- 2
type: integer
description: |-
* `0` - Default plural
* `1` - gettext plural formula
* `3` - CLDR plural with zero
* `4` - CLDR v38+ plural
* `5` - Android plural
* `6` - Qt Linguist plural
* `2` - Manually entered formula
Statistics:
type: object
properties:
total:
type: integer
total_words:
type: integer
total_chars:
type: integer
last_change:
type:
- string
- 'null'
format: date-time
recent_changes:
type: integer
translated:
type: integer
translated_words:
type: integer
translated_percent:
type: number
format: double
translated_words_percent:
type: number
format: double
translated_chars:
type: integer
translated_chars_percent:
type: number
format: double
fuzzy:
type: integer
fuzzy_percent:
type: number
format: double
fuzzy_words:
type: integer
fuzzy_words_percent:
type: number
format: double
fuzzy_chars:
type: integer
fuzzy_chars_percent:
type: number
format: double
failing:
type: integer
failing_percent:
type: number
format: double
approved:
type: integer
approved_percent:
type: number
format: double
approved_words:
type: integer
approved_words_percent:
type: number
format: double
approved_chars:
type: integer
approved_chars_percent:
type: number
format: double
readonly:
type: integer
readonly_percent:
type: number
format: double
readonly_words:
type: integer
readonly_words_percent:
type: number
format: double
readonly_chars:
type: integer
readonly_chars_percent:
type: number
format: double
suggestions:
type: integer
comments:
type: integer
code:
type: string
name:
type: string
url:
type: string
format: uri
translate_url:
type: string
format: uri
required:
- approved
- approved_chars
- approved_chars_percent
- approved_percent
- approved_words
- approved_words_percent
- comments
- failing
- failing_percent
- fuzzy
- fuzzy_chars
- fuzzy_chars_percent
- fuzzy_percent
- fuzzy_words
- fuzzy_words_percent
- last_change
- readonly
- readonly_chars
- readonly_chars_percent
- readonly_percent
- readonly_words
- readonly_words_percent
- recent_changes
- suggestions
- total
- total_chars
- total_words
- translated
- translated_chars
- translated_chars_percent
- translated_percent
- translated_words
- translated_words_percent
StatusEnum:
enum:
- success
- failure
type: string
description: |-
* `success` - success
* `failure` - failure
StringStateEnum:
enum:
- 0
- 10
- 11
- 12
- 20
- 30
- 100
type: integer
description: |-
* `0` - Empty
* `10` - Needs editing
* `11` - Needs editing (Needs rewriting)
* `12` - Needs editing (Needs checking)
* `20` - Translated
* `30` - Approved
* `100` - Read-only
Suggestion:
type: object
properties:
id:
type: integer
readOnly: true
unit:
type: string
format: uri
readOnly: true
target:
type: array
items:
type: string
user:
type:
- string
- 'null'
format: uri
readOnly: true
timestamp:
type: string
format: date-time
readOnly: true
votes:
type: integer
readOnly: true
required:
- id
- target
- timestamp
- unit
- user
- votes
SuggestionAcceptRequest:
type: object
properties:
approve:
type: boolean
default: false
SuggestionActionResult:
type: object
properties:
result:
type: string
required:
- result
SuggestionVoteRequest:
type: object
properties:
value:
$ref: '#/components/schemas/ValueEnum'
required:
- value
SuggestionVoteResult:
type: object
properties:
result:
$ref: '#/components/schemas/ResultEnum'
suggestion:
oneOf:
- $ref: '#/components/schemas/Suggestion'
- type: 'null'
required:
- result
- suggestion
Task:
type: object
properties:
completed:
type: boolean
progress:
type: integer
maximum: 100
minimum: 0
result:
oneOf:
- type: object
additionalProperties: true
- type: array
items: {}
- type: string
- type: number
- type: integer
- type: boolean
- type: 'null'
log:
type: string
required:
- completed
- log
- progress
- result
ThemeEnum:
enum:
- auto
- light
- dark
type: string
description: |-
* `auto` - Sync with system
* `light` - Light
* `dark` - Dark
TranslateModeEnum:
enum:
- 0
- 1
type: integer
description: |-
* `0` - Full editor
* `1` - Zen mode
Translation:
type: object
properties:
language:
allOf:
- $ref: '#/components/schemas/Language'
readOnly: true
component:
allOf:
- $ref: '#/components/schemas/Component'
readOnly: true
language_code:
type: string
maxLength: 50
id:
type: integer
readOnly: true
filename:
type: string
maxLength: 400
revision:
type: string
maxLength: 200
web_url:
type: string
readOnly: true
share_url:
type: string
readOnly: true
translate_url:
type: string
readOnly: true
url:
type: string
format: uri
readOnly: true
is_template:
type: boolean
readOnly: true
is_source:
type: boolean
readOnly: true
total:
type: integer
readOnly: true
total_words:
type: integer
readOnly: true
translated:
type: integer
readOnly: true
translated_words:
type: integer
readOnly: true
translated_percent:
type: number
format: double
readOnly: true
fuzzy:
type: integer
readOnly: true
fuzzy_words:
type: integer
readOnly: true
fuzzy_percent:
type: number
format: double
readOnly: true
failing_checks:
type: integer
readOnly: true
failing_checks_words:
type: integer
readOnly: true
failing_checks_percent:
type: number
format: double
readOnly: true
have_suggestion:
type: integer
readOnly: true
have_comment:
type: integer
readOnly: true
last_change:
type: string
format: date-time
readOnly: true
last_author:
type: string
readOnly: true
repository_url:
type: string
format: uri
readOnly: true
file_url:
type: string
format: uri
readOnly: true
statistics_url:
type: string
format: uri
readOnly: true
changes_list_url:
type: string
format: uri
readOnly: true
units_list_url:
type: string
format: uri
readOnly: true
announcements_url:
type: string
format: uri
readOnly: true
required:
- announcements_url
- changes_list_url
- component
- failing_checks
- failing_checks_percent
- failing_checks_words
- file_url
- filename
- fuzzy
- fuzzy_percent
- fuzzy_words
- have_comment
- have_suggestion
- id
- is_source
- is_template
- language
- last_author
- last_change
- repository_url
- share_url
- statistics_url
- total
- total_words
- translate_url
- translated
- translated_percent
- translated_words
- units_list_url
- url
- web_url
TranslationCreate:
type: object
properties:
language_code:
type: string
from_component:
type: array
items:
oneOf:
- type: integer
- type: string
required:
- language_code
Unit:
type: object
properties:
translation:
type: string
format: uri
readOnly: true
language_code:
type: string
readOnly: true
source:
type: array
items:
type: string
previous_source:
type: string
target:
type: array
items:
type: string
id_hash:
type: integer
maximum: 9223372036854775807
minimum: -9223372036854775808
format: int64
content_hash:
type: integer
readOnly: true
location:
type: string
context:
type: string
note:
type: string
flags:
type: string
labels:
type: array
items:
$ref: '#/components/schemas/Label'
state:
allOf:
- $ref: '#/components/schemas/StringStateEnum'
minimum: -2147483648
maximum: 2147483647
fuzzy:
type: boolean
readOnly: true
translated:
type: boolean
readOnly: true
approved:
type: boolean
readOnly: true
position:
type: integer
maximum: 2147483647
minimum: -2147483648
has_suggestion:
type: boolean
readOnly: true
has_comment:
type: boolean
readOnly: true
has_failing_check:
type: boolean
readOnly: true
num_words:
type: integer
maximum: 2147483647
minimum: -2147483648
source_unit:
type: string
format: uri
readOnly: true
priority:
type: integer
maximum: 2147483647
minimum: -2147483648
id:
type: integer
readOnly: true
web_url:
type: string
readOnly: true
url:
type: string
format: uri
readOnly: true
explanation:
type: string
description: Additional explanation to clarify meaning or usage of the string.
extra_flags:
type: string
title: Translation flags
description: Additional comma-separated flags to influence Weblate behavior.
pending:
type: boolean
readOnly: true
timestamp:
type: string
format: date-time
readOnly: true
last_updated:
type: string
format: date-time
readOnly: true
automatically_translated:
type: boolean
description: Indicates whether this string was translated automatically.
required:
- approved
- content_hash
- fuzzy
- has_comment
- has_failing_check
- has_suggestion
- id
- id_hash
- labels
- language_code
- last_updated
- pending
- position
- source
- source_unit
- target
- timestamp
- translated
- translation
- url
- web_url
UnitWrite:
type: object
description: Serializer for updating source unit.
properties:
target:
type: array
items:
type: string
state:
allOf:
- $ref: '#/components/schemas/StringStateEnum'
minimum: -2147483648
maximum: 2147483647
explanation:
type: string
description: Additional explanation to clarify meaning or usage of the string.
extra_flags:
type: string
title: Translation flags
description: Additional comma-separated flags to influence Weblate behavior.
labels:
type: array
items:
type: integer
required:
- labels
- target
UploadRequest:
type: object
properties:
file:
type: string
format: uri
author_email:
type: string
format: email
author_name:
type: string
maxLength: 200
method:
allOf:
- $ref: '#/components/schemas/MethodEnum'
default: translate
fuzzy:
default: ''
oneOf:
- $ref: '#/components/schemas/FuzzyEnum'
- $ref: '#/components/schemas/BlankEnum'
conflicts:
default: ''
oneOf:
- $ref: '#/components/schemas/ConflictsEnum'
- $ref: '#/components/schemas/BlankEnum'
required:
- file
UploadResult:
type: object
properties:
result:
type: boolean
not_found:
type: integer
skipped:
type: integer
accepted:
type: integer
total:
type: integer
count:
type: integer
required:
- accepted
- count
- not_found
- result
- skipped
- total
UserGroupRequest:
type: object
properties:
group_id:
type: integer
limit_language_codes:
type: array
items:
type: string
required:
- group_id
UserResponse:
oneOf:
- $ref: '#/components/schemas/BasicUser'
- $ref: '#/components/schemas/FullUser'
UserStatistics:
type: object
properties:
translated:
type: integer
suggested:
type: integer
uploaded:
type: integer
commented:
type: integer
languages:
type: integer
required:
- commented
- languages
- suggested
- translated
- uploaded
UserUpdateRequest:
type: object
description: |-
Schema-only serializer for user update requests.
Writable nested fields are not supported by default in .update()
'profile' field update logic is handled by ProfileUpdateMixin
properties:
id:
type: integer
readOnly: true
email:
type:
- string
- 'null'
title: E-mail
format: email
maxLength: 190
full_name:
type: string
maxLength: 150
username:
type: string
description: 'Username may only contain letters, numbers or the following
characters: @ . + - _'
maxLength: 150
groups:
type: array
items:
type: string
format: uri
readOnly: true
profile:
$ref: '#/components/schemas/ProfileUpdateRequest'
notifications:
type: string
format: uri
readOnly: true
is_superuser:
type: boolean
title: Superuser status
description: User has all possible permissions.
is_active:
type: boolean
title: Active
description: Mark user as inactive instead of removing.
is_bot:
type: boolean
title: Robot user
date_joined:
type: string
format: date-time
readOnly: true
date_expires:
type:
- string
- 'null'
format: date-time
title: Expires
description: The account will be disabled after the expiry.
last_login:
type:
- string
- 'null'
format: date-time
readOnly: true
url:
type: string
format: uri
readOnly: true
statistics_url:
type: string
format: uri
readOnly: true
contributions_url:
type: string
format: uri
readOnly: true
required:
- contributions_url
- date_joined
- full_name
- groups
- id
- last_login
- notifications
- statistics_url
- url
- username
ValueEnum:
enum:
- 1
- -1
type: integer
description: |-
* `1` - Positive
* `-1` - Negative
VcsEnum:
enum:
- azure_devops
- bitbucketcloud
- bitbucketserver
- gerrit
- git
- git-force-push
- gitea
- github
- github-app
- gitlab
- local
- mercurial
- pagure
- subversion
type: string
description: |-
* `azure_devops` - Azure DevOps pull request
* `bitbucketcloud` - Bitbucket Cloud merge request
* `bitbucketserver` - Bitbucket Data Center pull request
* `gerrit` - Gerrit
* `git` - Git
* `git-force-push` - Git with force push
* `gitea` - Gitea pull request
* `github` - GitHub pull request
* `github-app` - GitHub (via Weblate GitHub app)
* `gitlab` - GitLab merge request
* `local` - No remote repository
* `mercurial` - Mercurial
* `pagure` - Pagure merge request
* `subversion` - Subversion
ZenModeEnum:
enum:
- 0
- 1
type: integer
description: |-
* `0` - Top to bottom
* `1` - Side by side
UserGroupDeleteRequest:
type: object
properties:
group_id:
type: integer
required:
- group_id
ComponentDeleteRequest:
type: object
properties:
delete_memory:
type: boolean
CategoryDeleteRequest:
type: object
properties:
delete_memory:
type: boolean
securitySchemes:
bearerAuth:
type: apiKey
in: header
name: Bearer
description: "Token-based authentication with required prefix `Bearer`.\n\n-
Each user has a personal access token which they can get from their respective
user profile. These tokens have the `wlu_` prefix.\n- It is possible to create
project tokens whose access to the API is limited to operations to their associated
project. These tokens have the `wlp_` prefix.\n "
cookieAuth:
type: apiKey
in: cookie
name: sessionid
description: Session-based authentication used when user is signed in.
tokenAuth:
type: apiKey
in: header
name: Token
description: "Token-based authentication with required prefix `Token`.\n\n-
Each user has a personal access token which they can get from their respective
user profile. These tokens have the `wlu_` prefix.\n- It is possible to create
project tokens whose access to the API is limited to operations to their associated
project. These tokens have the `wlp_` prefix.\n "
servers:
- url: 'http:'
description: Weblate
tags:
- name: root
description: The API root entry point.
- name: users
description: Added in version 4.0.
- name: groups
description: Added in version 4.0.
- name: roles
- name: languages
- name: projects
- name: components
- name: translations
- name: memory
description: Added in version 4.14.
- name: units
description: A unit is a single piece of a translation which pairs a source string
with a corresponding translated string and also contains some related metadata.
The term is derived from the Translate Toolkit and XLIFF.
- name: changes
- name: screenshots
- name: addons
description: Added in version 4.4.1.
- name: component-lists
description: Added in version 4.0.
- name: glossary
description: '**Changed in version 4.5:** Glossaries are now stored as regular components,
translations and strings, please use respective API instead.'
- name: tasks
description: |-
Added in version 4.4.
Listing of the tasks is currently not available.
- name: statistics
description: Many endpoints support displaying statistics for their objects.
- name: metrics
- name: search
description: Added in version 4.18.
- name: categories
- name: hooks
description: |-
Notification hooks allow external applications to notify Weblate that the VCS repository has been updated.
You can use repository endpoints for projects, components and translations to update individual repositories.
- name: exports
description: Weblate provides various exports to allow you to further process the
data.
- name: rssFeeds
description: Changes in translations are exported in RSS feeds.
- name: webhooks
description: Notifications sent by Weblate.
externalDocs:
url: https://docs.weblate.org/en/latest/index.html
description: Official Weblate documentation
webhooks:
AddonWebhook:
post:
description: Pushes events to a notification URL.
summary: A Webhook event for an addon
tags:
- webhooks
- addons
requestBody:
content:
application/json:
schema:
$id: https://weblate.org/schemas/weblate-messaging.schema.json
$schema: http://json-schema.org/draft-07/schema#
title: Weblate Messaging
description: Schema for Weblate Messaging
additionalProperties: false
definitions: {}
type: object
required:
- change_id
- action
- timestamp
properties:
change_id:
title: Change ID
type: integer
description: Numerical ID of change
action:
title: Change Action
type: string
description: Verbose name of the change, see Change actions source
code for possible values
timestamp:
title: Timestamp
type: string
format: date-time
description: ISO formatted timestamp
target:
title: Target
type:
- string
- array
description: New value of the change (eg. new translation of the
string)
old:
title: Old Value
type:
- string
- array
description: Old value of the change (eg. previous translation of
the string)
source:
title: Source
type:
- string
- array
description: Source string
url:
title: URL
type: string
description: Absolute URL to view the related object
author:
title: Author
type: string
description: Author username (this can be different from user for
example when accepting suggestions)
user:
title: Acting username
type: string
project:
title: Project slug
type: string
component:
title: Component slug
type: string
translation:
title: Translation Language Code
type: string
category:
title: Category and subcategory slugs
type: array
items:
title: Category slug
type: string
context:
title: Translation context or key for monolingual formats
type: string
examples:
AuthenticationFailed:
value:
type: client_error
errors:
- code: authentication_failed
detail: Incorrect authentication credentials.
attr: null
NotAuthenticated:
value:
type: client_error
errors:
- code: not_authenticated
detail: Authentication credentials were not provided.
attr: null
PermissionDenied:
value:
type: client_error
errors:
- code: permission_denied
detail: You do not have permission to perform this action.
attr: null
NotFound:
value:
type: client_error
errors:
- code: not_found
detail: Not found.
attr: null
MethodNotAllowed:
value:
type: client_error
errors:
- code: method_not_allowed
detail: Method "get" not allowed.
attr: null
NotAcceptable:
value:
type: client_error
errors:
- code: not_acceptable
detail: Could not satisfy the request Accept header.
attr: null
UnsupportedMediaType:
value:
type: client_error
errors:
- code: unsupported_media_type
detail: Unsupported media type "application/json" in request.
attr: null
Throttled:
value:
type: client_error
errors:
- code: throttled
detail: Request was throttled.
attr: null
APIException:
value:
type: server_error
errors:
- code: error
detail: A server error occurred.
attr: null
responses:
2XX:
description: No response body