{ "opencollection": "1.0.0", "info": { "name": "Weblate's REST addons components API", "version": "1.0" }, "items": [ { "info": { "name": "components", "type": "folder" }, "items": [ { "info": { "name": "api_components_list", "type": "http" }, "http": { "method": "GET", "url": "http:/api/components/", "params": [ { "name": "page", "value": "", "type": "query", "description": "A page number within the paginated result set." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of results to return per page." } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Return a list of translation components." }, { "info": { "name": "api_components_retrieve", "type": "http" }, "http": { "method": "GET", "url": "http:/api/components/:project__slug/:slug/", "params": [ { "name": "project__slug", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Return information about translation component." }, { "info": { "name": "api_components_update", "type": "http" }, "http": { "method": "PUT", "url": "http:/api/components/:project__slug/:slug/", "params": [ { "name": "project__slug", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Edit a component by a PUT or PATCH request." }, { "info": { "name": "api_components_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "http:/api/components/:project__slug/:slug/", "params": [ { "name": "project__slug", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Edit a component by a PATCH request." }, { "info": { "name": "api_components_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "http:/api/components/:project__slug/:slug/", "params": [ { "name": "project__slug", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Delete a component." }, { "info": { "name": "api_components_addons_create", "type": "http" }, "http": { "method": "POST", "url": "http:/api/components/:project__slug/:slug/addons/", "params": [ { "name": "project__slug", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Translation components API." }, { "info": { "name": "api_components_announcements_list", "type": "http" }, "http": { "method": "GET", "url": "http:/api/components/:project__slug/:slug/announcements/", "params": [ { "name": "page", "value": "", "type": "query", "description": "A page number within the paginated result set." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "project__slug", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Return announcements." }, { "info": { "name": "api_components_announcements_create", "type": "http" }, "http": { "method": "POST", "url": "http:/api/components/:project__slug/:slug/announcements/", "params": [ { "name": "project__slug", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Create an announcement." }, { "info": { "name": "api_components_announcements_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "http:/api/components/:project__slug/:slug/announcements/:announcement_id/", "params": [ { "name": "announcement_id", "value": "", "type": "path" }, { "name": "project__slug", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Delete an announcement." }, { "info": { "name": "api_components_changes_list", "type": "http" }, "http": { "method": "GET", "url": "http:/api/components/:project__slug/:slug/changes/", "params": [ { "name": "page", "value": "", "type": "query", "description": "A page number within the paginated result set." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "project__slug", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Return a list of component changes." }, { "info": { "name": "api_components_credits_retrieve", "type": "http" }, "http": { "method": "GET", "url": "http:/api/components/:project__slug/:slug/credits/", "params": [ { "name": "project__slug", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Translation components API." }, { "info": { "name": "api_components_file_retrieve", "type": "http" }, "http": { "method": "GET", "url": "http:/api/components/:project__slug/:slug/file/", "params": [ { "name": "project__slug", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Download all translation files in the component." }, { "info": { "name": "api_components_links_list", "type": "http" }, "http": { "method": "GET", "url": "http:/api/components/:project__slug/:slug/links/", "params": [ { "name": "page", "value": "", "type": "query", "description": "A page number within the paginated result set." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "project__slug", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Return projects linked with a component." }, { "info": { "name": "api_components_links_create", "type": "http" }, "http": { "method": "POST", "url": "http:/api/components/:project__slug/:slug/links/", "params": [ { "name": "project__slug", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Associate project with a component." }, { "info": { "name": "api_components_links_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "http:/api/components/:project__slug/:slug/links/:project_slug/", "params": [ { "name": "project__slug", "value": "", "type": "path" }, { "name": "project_slug", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Remove association of a project with a component." }, { "info": { "name": "api_components_lock_retrieve", "type": "http" }, "http": { "method": "GET", "url": "http:/api/components/:project__slug/:slug/lock/", "params": [ { "name": "project__slug", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Return component lock status." }, { "info": { "name": "api_components_lock_create", "type": "http" }, "http": { "method": "POST", "url": "http:/api/components/:project__slug/:slug/lock/", "params": [ { "name": "project__slug", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Sets component lock status." }, { "info": { "name": "api_components_monolingual_base_retrieve", "type": "http" }, "http": { "method": "GET", "url": "http:/api/components/:project__slug/:slug/monolingual_base/", "params": [ { "name": "project__slug", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Download base file for monolingual translations." }, { "info": { "name": "api_components_new_template_retrieve", "type": "http" }, "http": { "method": "GET", "url": "http:/api/components/:project__slug/:slug/new_template/", "params": [ { "name": "project__slug", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Download template file for new translations." }, { "info": { "name": "api_components_repository_retrieve", "type": "http" }, "http": { "method": "GET", "url": "http:/api/components/:project__slug/:slug/repository/", "params": [ { "name": "project__slug", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Return information about VCS repository status." }, { "info": { "name": "api_components_repository_create", "type": "http" }, "http": { "method": "POST", "url": "http:/api/components/:project__slug/:slug/repository/", "params": [ { "name": "project__slug", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Perform given operation on the VCS repository." }, { "info": { "name": "api_components_screenshots_list", "type": "http" }, "http": { "method": "GET", "url": "http:/api/components/:project__slug/:slug/screenshots/", "params": [ { "name": "page", "value": "", "type": "query", "description": "A page number within the paginated result set." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "project__slug", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Return a list of component screenshots." }, { "info": { "name": "api_components_statistics_list", "type": "http" }, "http": { "method": "GET", "url": "http:/api/components/:project__slug/:slug/statistics/", "params": [ { "name": "page", "value": "", "type": "query", "description": "A page number within the paginated result set." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "project__slug", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Return paginated statistics for all translations within component." }, { "info": { "name": "api_components_translations_list", "type": "http" }, "http": { "method": "GET", "url": "http:/api/components/:project__slug/:slug/translations/", "params": [ { "name": "page", "value": "", "type": "query", "description": "A page number within the paginated result set." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "project__slug", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Return a list of translation objects in the given component." }, { "info": { "name": "api_components_translations_create", "type": "http" }, "http": { "method": "POST", "url": "http:/api/components/:project__slug/:slug/translations/", "params": [ { "name": "project__slug", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Create a new translation in the given component." } ] } ], "bundled": true }