Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Weblate categories API

The categories API from Weblate — 5 operation(s) for categories.

Weblate categories API is one of 21 APIs that Weblate publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include categories. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 10 operations across 5 paths, and defines 42 schemas. It is described by OpenAPI 3.1.1.

Requests are made against a single base URL, http:.

10 operations 5 paths 42 schemas 2 DELETE4 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.1
Base URL
https://hosted.weblate.org/api/
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Weblate categories API declares 3 security schemes for authenticating requests. An API key is passed in the header as Bearer (bearerAuth). An API key is passed in the cookie as sessionid (cookieAuth). An API key is passed in the header as Token (tokenAuth).

  • bearerAuth — Token-based authentication with required prefix Bearer. - Each user has a personal access token which they can get from their respective user profile. These to…
  • cookieAuth — Session-based authentication used when user is signed in.
  • tokenAuth — Token-based authentication with required prefix Token. - Each user has a personal access token which they can get from their respective user profile. These tok…

Paths & Operations 10

Across 5 paths, the API surfaces 10 operations — 2 DELETE, 4 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

categories 10
GET
/api/categories/
List available categories.
api_categories_list 2 params → 400401403404405406423429
POST
/api/categories/
Category API.
api_categories_create body → 400401403404405406415423
GET
/api/categories/{id}/
Category API.
api_categories_retrieve 1 param → 400401403404405406423429
PUT
/api/categories/{id}/
Edit full information about category.
api_categories_update 1 param body → 400401403404405406415423
PATCH
/api/categories/{id}/
Category API.
api_categories_partial_update 1 param body → 400401403404405406415423
DELETE
/api/categories/{id}/
Delete category.
api_categories_destroy 1 param → 400401403404405406423429
GET
/api/categories/{id}/announcements/
Return announcements.
api_categories_announcements_list 3 params → 400401403404405406423429
POST
/api/categories/{id}/announcements/
Create an announcement.
api_categories_announcements_create 1 param body → 400401403404405406415423
DELETE
/api/categories/{id}/announcements/{announcement_id}/
Delete an announcement.
api_categories_announcements_destroy 2 params → 400401403404405406423429
GET
/api/categories/{id}/statistics/
Return statistics for a category.
api_categories_statistics_retrieve 1 param → 400401403404405406423429

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are PatchedCategory (43 properties), Category (43 properties), Statistics (37 properties), Announcement (5 properties). Each schema is shown below with its type and property counts.

Error415
object
3 properties 3 required
Announcement
object
5 properties 2 required
ErrorCode406Enum
string
notacceptable - Not Acceptable
Error423
object
3 properties 3 required
ErrorResponse403
object
2 properties 2 required
ErrorResponse404
object
2 properties 2 required
ErrorCode429Enum
string
throttled - Throttled
PatchedCategory
object
43 properties
ErrorCode401Enum
string
authenticationfailed - Authentication Failed notauthenticated - Not Authenticated
Statistics
object
37 properties 33 required
ErrorCode403Enum
string
permissiondenied - Permission Denied
ErrorResponse415
object
2 properties 2 required
Error429
object
3 properties 3 required
NewLangEnum
string
contact - Contact maintainers url - Point to translation instructions URL add - Create new language file none - Disable adding new translations
Error406
object
3 properties 3 required
Error405
object
3 properties 3 required
PaginatedAnnouncementList
object
4 properties 2 required
Error400
object
3 properties 3 required
Error401
object
3 properties 3 required
LanguageCodeStyleEnum
string
- Default based on the file format posix - POSIX style using underscore as a separator posixlowercase - POSIX style using underscore as a separator, lower case…
ErrorResponse400TypeEnum
string
validationerror - Validation Error clienterror - Client Error
Error500
object
3 properties 3 required
ErrorCode500Enum
string
error - Error
PaginatedCategoryList
object
4 properties 2 required
ServerErrorEnum
string
servererror - Server Error
ErrorCode415Enum
string
unsupportedmediatype - Unsupported Media Type
Error404
object
3 properties 3 required
ErrorCode404Enum
string
notfound - Not Found
ErrorResponse500
object
2 properties 2 required
ErrorResponse423
object
2 properties 2 required
Error403
object
3 properties 3 required
ErrorResponse401
object
2 properties 2 required
SeverityEnum
string
info - Info (light blue) warning - Warning (yellow) danger - Danger (red) success - Success (green)
ErrorResponse429
object
2 properties 2 required
ErrorCode423Enum
string
repository-locked - Repository Locked component-locked - Component Locked unknown-locked - Unknown Locked
ErrorResponse400
object
2 properties 2 required
BlankEnum
ErrorResponse405
object
2 properties 2 required
ErrorResponse406
object
2 properties 2 required
Category
object
43 properties 19 required
ErrorCode405Enum
string
methodnotallowed - Method Not Allowed
ClientErrorEnum
string
clienterror - Client Error

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weblate-categories-api-openapi.yml Raw ↑

Other APIs Weblate publishes across the network.

Weblate addons API
Weblate changes API
Weblate component-lists API
Weblate components API
Weblate contributions API
Weblate groups API
Weblate hooks API
Weblate languages API
Weblate memory API
Weblate metrics API
Weblate projects API
Weblate roles API