{ "opencollection": "1.0.0", "info": { "name": "Weblate's REST addons users API", "version": "1.0" }, "items": [ { "info": { "name": "users", "type": "folder" }, "items": [ { "info": { "name": "api_users_list", "type": "http" }, "http": { "method": "GET", "url": "http:/api/users/", "params": [ { "name": "id", "value": "", "type": "query" }, { "name": "is_active", "value": "", "type": "query" }, { "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": "username", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "List of users if you have permissions to see manage users.\n\nWithout a permission you get to see only your own details." }, { "info": { "name": "api_users_create", "type": "http" }, "http": { "method": "POST", "url": "http:/api/users/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Create a new user." }, { "info": { "name": "api_users_retrieve", "type": "http" }, "http": { "method": "GET", "url": "http:/api/users/:username/", "params": [ { "name": "username", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Return information about users." }, { "info": { "name": "api_users_update", "type": "http" }, "http": { "method": "PUT", "url": "http:/api/users/:username/", "params": [ { "name": "username", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Change the user parameters." }, { "info": { "name": "api_users_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "http:/api/users/:username/", "params": [ { "name": "username", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Change the user parameters." }, { "info": { "name": "api_users_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "http:/api/users/:username/", "params": [ { "name": "username", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Delete all user information and mark the user inactive." }, { "info": { "name": "api_users_contributions_list", "type": "http" }, "http": { "method": "GET", "url": "http:/api/users/:username/contributions/", "params": [ { "name": "id", "value": "", "type": "query" }, { "name": "is_active", "value": "", "type": "query" }, { "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": "username", "value": "", "type": "path" }, { "name": "username", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "List translation contributions of a user." }, { "info": { "name": "api_users_groups_create", "type": "http" }, "http": { "method": "POST", "url": "http:/api/users/:username/groups/", "params": [ { "name": "username", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Associate groups with a user." }, { "info": { "name": "api_users_groups_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "http:/api/users/:username/groups/", "params": [ { "name": "username", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Remove a user from a group." }, { "info": { "name": "api_users_notifications_list", "type": "http" }, "http": { "method": "GET", "url": "http:/api/users/:username/notifications/", "params": [ { "name": "id", "value": "", "type": "query" }, { "name": "is_active", "value": "", "type": "query" }, { "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": "username", "value": "", "type": "path" }, { "name": "username", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "List subscriptions of a user." }, { "info": { "name": "api_users_notifications_create", "type": "http" }, "http": { "method": "POST", "url": "http:/api/users/:username/notifications/", "params": [ { "name": "id", "value": "", "type": "query" }, { "name": "is_active", "value": "", "type": "query" }, { "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": "username", "value": "", "type": "path" }, { "name": "username", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Associate subscriptions with a user." }, { "info": { "name": "api_users_notifications_retrieve", "type": "http" }, "http": { "method": "GET", "url": "http:/api/users/:username/notifications/:subscription_id/", "params": [ { "name": "subscription_id", "value": "", "type": "path" }, { "name": "username", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Get a subscription associated with a user." }, { "info": { "name": "api_users_notifications_update", "type": "http" }, "http": { "method": "PUT", "url": "http:/api/users/:username/notifications/:subscription_id/", "params": [ { "name": "subscription_id", "value": "", "type": "path" }, { "name": "username", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Edit a subscription associated with a user." }, { "info": { "name": "api_users_notifications_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "http:/api/users/:username/notifications/:subscription_id/", "params": [ { "name": "subscription_id", "value": "", "type": "path" }, { "name": "username", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Edit a subscription associated with a user." }, { "info": { "name": "api_users_notifications_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "http:/api/users/:username/notifications/:subscription_id/", "params": [ { "name": "subscription_id", "value": "", "type": "path" }, { "name": "username", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "Delete a subscription associated with a user." }, { "info": { "name": "api_users_statistics_retrieve", "type": "http" }, "http": { "method": "GET", "url": "http:/api/users/:username/statistics/", "params": [ { "name": "username", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Token", "value": "{{Token}}", "placement": "header" } }, "docs": "List statistics of a user." } ] } ], "bundled": true }