{ "opencollection": "1.0.0", "info": { "name": "Weblate's REST addons projects API", "version": "1.0" }, "items": [ { "info": { "name": "projects", "type": "folder" }, "items": [ { "info": { "name": "api_projects_list", "type": "http" }, "http": { "method": "GET", "url": "http:/api/projects/", "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 all projects." }, { "info": { "name": "api_projects_create", "type": "http" }, "http": { "method": "POST", "url": "http:/api/projects/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Create a new project." }, { "info": { "name": "api_projects_retrieve", "type": "http" }, "http": { "method": "GET", "url": "http:/api/projects/:slug/", "params": [ { "name": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Return information about a project." }, { "info": { "name": "api_projects_update", "type": "http" }, "http": { "method": "PUT", "url": "http:/api/projects/:slug/", "params": [ { "name": "slug", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Edit a project by a PUT request." }, { "info": { "name": "api_projects_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "http:/api/projects/:slug/", "params": [ { "name": "slug", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Edit a project by a PATCH request." }, { "info": { "name": "api_projects_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "http:/api/projects/:slug/", "params": [ { "name": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Delete a project." }, { "info": { "name": "api_projects_addons_create", "type": "http" }, "http": { "method": "POST", "url": "http:/api/projects/:slug/addons/", "params": [ { "name": "slug", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Translation projects API." }, { "info": { "name": "api_projects_announcements_list", "type": "http" }, "http": { "method": "GET", "url": "http:/api/projects/: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": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Return announcements." }, { "info": { "name": "api_projects_announcements_create", "type": "http" }, "http": { "method": "POST", "url": "http:/api/projects/:slug/announcements/", "params": [ { "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_projects_announcements_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "http:/api/projects/:slug/announcements/:announcement_id/", "params": [ { "name": "announcement_id", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Delete an announcement." }, { "info": { "name": "api_projects_categories_list", "type": "http" }, "http": { "method": "GET", "url": "http:/api/projects/:slug/categories/", "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": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Return categories for a project." }, { "info": { "name": "api_projects_changes_list", "type": "http" }, "http": { "method": "GET", "url": "http:/api/projects/: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": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Return a list of project changes." }, { "info": { "name": "api_projects_components_list", "type": "http" }, "http": { "method": "GET", "url": "http:/api/projects/:slug/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." }, { "name": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Return a list of translation components in the given project." }, { "info": { "name": "api_projects_components_create", "type": "http" }, "http": { "method": "POST", "url": "http:/api/projects/:slug/components/", "params": [ { "name": "slug", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Create translation components in the given project." }, { "info": { "name": "api_projects_credits_retrieve", "type": "http" }, "http": { "method": "GET", "url": "http:/api/projects/:slug/credits/", "params": [ { "name": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Return contributor credits for a project." }, { "info": { "name": "api_projects_file_retrieve", "type": "http" }, "http": { "method": "GET", "url": "http:/api/projects/:slug/file/", "params": [ { "name": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Download all translation files in the project." }, { "info": { "name": "api_projects_labels_list", "type": "http" }, "http": { "method": "GET", "url": "http:/api/projects/:slug/labels/", "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": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Return labels for a project." }, { "info": { "name": "api_projects_labels_create", "type": "http" }, "http": { "method": "POST", "url": "http:/api/projects/:slug/labels/", "params": [ { "name": "slug", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Create a label for a project." }, { "info": { "name": "api_projects_labels_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "http:/api/projects/:slug/labels/:label_id/", "params": [ { "name": "label_id", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Delete a label from a project." }, { "info": { "name": "api_projects_languages_list", "type": "http" }, "http": { "method": "GET", "url": "http:/api/projects/:slug/languages/", "params": [ { "name": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Return statistics for all languages within a project." }, { "info": { "name": "api_projects_languages_announcements_list", "type": "http" }, "http": { "method": "GET", "url": "http:/api/projects/:slug/languages/:language_code/announcements/", "params": [ { "name": "language_code", "value": "", "type": "path" }, { "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": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Return project language announcements." }, { "info": { "name": "api_projects_languages_announcements_create", "type": "http" }, "http": { "method": "POST", "url": "http:/api/projects/:slug/languages/:language_code/announcements/", "params": [ { "name": "language_code", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Create a project language announcement." }, { "info": { "name": "api_projects_languages_announcements_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "http:/api/projects/:slug/languages/:language_code/announcements/:announcement_id/", "params": [ { "name": "announcement_id", "value": "", "type": "path" }, { "name": "language_code", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Delete a project language announcement." }, { "info": { "name": "api_projects_languages_file_retrieve", "type": "http" }, "http": { "method": "GET", "url": "http:/api/projects/:slug/languages/:language_code/file/", "params": [ { "name": "language_code", "value": "", "type": "path", "description": "Language code for the requested translations." }, { "name": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Download all component translation files in the project for a specific language." }, { "info": { "name": "api_projects_lock_retrieve", "type": "http" }, "http": { "method": "GET", "url": "http:/api/projects/:slug/lock/", "params": [ { "name": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Return project lock status." }, { "info": { "name": "api_projects_lock_create", "type": "http" }, "http": { "method": "POST", "url": "http:/api/projects/:slug/lock/", "params": [ { "name": "slug", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Sets project lock status." }, { "info": { "name": "api_projects_machinery_settings_retrieve", "type": "http" }, "http": { "method": "GET", "url": "http:/api/projects/:slug/machinery_settings/", "params": [ { "name": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "List machinery settings for a project." }, { "info": { "name": "api_projects_machinery_settings_create", "type": "http" }, "http": { "method": "POST", "url": "http:/api/projects/:slug/machinery_settings/", "params": [ { "name": "slug", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Install a new machinery service." }, { "info": { "name": "api_projects_machinery_settings_update", "type": "http" }, "http": { "method": "PUT", "url": "http:/api/projects/:slug/machinery_settings/", "params": [ { "name": "slug", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Replace configuration for all services." }, { "info": { "name": "api_projects_machinery_settings_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "http:/api/projects/:slug/machinery_settings/", "params": [ { "name": "slug", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Partially update a single service. Leave configuration blank to remove the service." }, { "info": { "name": "api_projects_repository_retrieve", "type": "http" }, "http": { "method": "GET", "url": "http:/api/projects/:slug/repository/", "params": [ { "name": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Return information about VCS repository status." }, { "info": { "name": "api_projects_repository_create", "type": "http" }, "http": { "method": "POST", "url": "http:/api/projects/:slug/repository/", "params": [ { "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_projects_statistics_retrieve", "type": "http" }, "http": { "method": "GET", "url": "http:/api/projects/:slug/statistics/", "params": [ { "name": "slug", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Return statistics for a project." } ] } ], "bundled": true }