{ "id": "@itentialopensource/adapter-bitbucket", "type": "Adapter", "export": "Bitbucket", "title": "Bitbucket", "src": "adapter.js", "roles": [ "admin" ], "methods": [ { "name": "iapUpdateAdapterConfiguration", "summary": "Updates the adapter configuration", "description": "Updates the adapter configuration file with the provided changes", "input": [ { "name": "configFile", "type": "string", "info": "The name of the file to change", "required": true, "schema": { "title": "configFile", "type": "string" } }, { "name": "changes", "type": "object", "info": "JSON object containing the configuration changes", "required": true, "schema": { "title": "changes", "type": "object" } }, { "name": "entity", "type": "string", "info": "The entity in which the changes are being made", "required": false, "schema": { "title": "entity", "type": "string" } }, { "name": "type", "type": "string", "info": "The type of file to change - action, schema, or mock", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "action", "type": "string", "info": "The action to be changed", "required": false, "schema": { "title": "action", "type": "string" } }, { "name": "replace", "type": "boolean", "info": "True to replace entire mock data, false to merge/append", "required": false, "schema": { "title": "replace", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUpdateAdapterConfiguration" }, "task": true }, { "name": "iapSuspendAdapter", "summary": "Suspends the adapter", "description": "Suspends the adapter", "input": [ { "name": "mode", "type": "enum", "enumerals": [ "pause", "error" ], "info": "How incoming requests are handled. Defaults to 'pause'", "description": "How incoming requests are handled. Defaults to 'pause'", "schema": { "title": "mode", "type": "string" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapSuspendAdapter" }, "task": true }, { "name": "iapUnsuspendAdapter", "summary": "Unsuspends the adapter", "description": "Unsuspends the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUnsuspendAdapter" }, "task": true }, { "name": "iapGetAdapterQueue", "summary": "Return the requests that are waiting in the queue if throttling is enabled", "description": "Return the requests that are waiting in the queue if throttling is enabled", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter queue", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetAdapterQueue" }, "task": true }, { "name": "iapFindAdapterPath", "summary": "Provides the ability to see if a particular API path is supported by the adapter", "description": "Provides the ability to see if a particular API path is supported by the adapter", "input": [ { "name": "apiPath", "type": "string", "info": "The API Path you want to check - make sure to not include base path and version", "description": "The API Path you want to check - make sure to not include base path and version", "schema": { "title": "apiPath", "type": "string" }, "required": true } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapFindAdapterPath" }, "task": true }, { "name": "iapTroubleshootAdapter", "summary": "Runs troubleshoot script for adapter", "description": "Runs troubleshoot script for adapter", "input": [ { "name": "props", "type": "object", "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}", "required": true, "schema": { "title": "props", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapTroubleshootAdapter" }, "task": true }, { "name": "iapRunAdapterHealthcheck", "summary": "Runs healthcheck script for adapter", "description": "Runs healthcheck script for adapter", "input": [], "output": { "name": "result", "type": "boolean", "description": "Whether healthcheck passed or failed", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterHealthcheck" }, "task": true }, { "name": "iapRunAdapterConnectivity", "summary": "Runs connectivity check script for adapter", "description": "Runs connectivity check script for adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterConnectivity" }, "task": true }, { "name": "iapRunAdapterBasicGet", "summary": "Runs basicGet script for adapter", "description": "Runs basicGet script for adapter", "input": [ { "name": "maxCalls", "required": false, "type": "number", "info": "How many GET endpoints to test (defaults to 5)", "schema": { "title": "maxCalls", "type": "number", "default": 5 } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterBasicGet" }, "task": true }, { "name": "iapMoveAdapterEntitiesToDB", "summary": "Moves entities from an adapter into the Itential Platform database", "description": "Moves entities from an adapter into the Itential Platform database", "input": [], "output": { "name": "res", "type": "object", "description": "A JSON Object containing status, code and the response from the mongo transaction", "schema": { "title": "res", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapMoveAdapterEntitiesToDB" }, "task": true }, { "name": "iapDeactivateTasks", "summary": "Deactivate the inputted tasks", "description": "Deactivate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to deactivate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapDeactivateTasks" }, "task": true }, { "name": "iapActivateTasks", "summary": "Activate the inputted tasks", "description": "activate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to activate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapActivateTasks" }, "task": true }, { "name": "iapPopulateEntityCache", "summary": "Populate the cache for the given entities", "description": "Populate the cache for the given entities", "input": [ { "name": "entityTypes", "type": "array", "info": "the entity type(s) to populate", "required": true, "schema": { "title": "entityTypes", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapPopulateEntityCache" }, "task": true }, { "name": "iapRetrieveEntitiesCache", "summary": "Retrieves data from cache for specified entity type", "description": "Retrieves data from cache for specified entity type", "input": [ { "name": "entityType", "type": "string", "info": "entity of which to retrieve", "required": true, "schema": { "title": "entityType", "type": "string" } }, { "name": "options", "type": "object", "info": "settings of which data to return and how to return it", "required": false, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRetrieveEntitiesCache" }, "task": true }, { "name": "getDevice", "summary": "Get the Appliance", "description": "Get the Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevice" }, "task": false }, { "name": "getDevicesFiltered", "summary": "Get Appliances that match the filter", "description": "Get Appliances that match the filter", "input": [ { "name": "options", "type": "object", "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }", "required": true, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevicesFiltered" }, "task": false }, { "name": "isAlive", "summary": "Checks the status for the provided Appliance", "description": "Checks the status for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "boolean", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/isAlive" }, "task": false }, { "name": "getConfig", "summary": "Gets a config for the provided Appliance", "description": "Gets a config for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } }, { "name": "format", "type": "string", "info": "The format to be returned - this is ignored as we always return json", "required": false, "schema": { "title": "format", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getConfig" }, "task": false }, { "name": "iapGetDeviceCount", "summary": "Gets a device count from the system", "description": "Gets a device count from the system", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetDeviceCount" }, "task": false }, { "name": "iapExpandedGenericAdapterRequest", "summary": "Makes the requested generic call with additional options", "description": "Makes the requested generic call with additional options via metadata", "input": [ { "name": "metadata", "type": "object", "info": "metadata for the call (optional)", "description": "metadata for the call - allows for many enhancements (optional)", "schema": { "title": "metadata", "type": "object" }, "required": false }, { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": false }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": false }, { "name": "pathVars", "type": "object", "info": "the parameters to be put within the url path (optional)", "description": "the parameters to be put within the url path (optional)", "schema": { "title": "pathVars", "type": "object" }, "required": false }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapExpandedGenericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequest", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequestNoBasePath", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequestNoBasePath" }, "task": true }, { "name": "iapRunAdapterLint", "summary": "Run the adapter lint script to return the results", "description": "Run the adapter lint script to return the results", "input": [], "output": { "name": "result", "type": "string", "description": "A string containing the run results", "schema": { "title": "result", "type": "string" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterLint" }, "task": true }, { "name": "iapRunAdapterTests", "summary": "Run the adapter test scripts (baseunit and unit) to return the results", "description": "Run the adapter test scripts (baseunit and unit) to return the results", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterTests" }, "task": true }, { "name": "iapGetAdapterInventory", "summary": "Provide inventory information abbout the adapter", "description": "Provide inventory information abbout the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapGetAdapterInventory" }, "task": true }, { "name": "deleteAddon", "summary": "", "description": "", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/deleteAddon" }, "task": true }, { "name": "putAddon", "summary": "", "description": "", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/putAddon" }, "task": true }, { "name": "getAddonLinkers", "summary": "", "description": "", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getAddonLinkers" }, "task": true }, { "name": "getAddonLinkersLinkerKey", "summary": "", "description": "", "input": [ { "name": "linkerKey", "type": "string", "info": "", "required": true, "schema": { "title": "linkerKey", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getAddonLinkersLinkerKey" }, "task": true }, { "name": "deleteAddonLinkersLinkerKeyValues", "summary": "", "description": "", "input": [ { "name": "linkerKey", "type": "string", "info": "", "required": true, "schema": { "title": "linkerKey", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteAddonLinkersLinkerKeyValues" }, "task": true }, { "name": "getAddonLinkersLinkerKeyValues", "summary": "", "description": "", "input": [ { "name": "linkerKey", "type": "string", "info": "", "required": true, "schema": { "title": "linkerKey", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getAddonLinkersLinkerKeyValues" }, "task": true }, { "name": "postAddonLinkersLinkerKeyValues", "summary": "", "description": "", "input": [ { "name": "linkerKey", "type": "string", "info": "", "required": true, "schema": { "title": "linkerKey", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postAddonLinkersLinkerKeyValues" }, "task": true }, { "name": "putAddonLinkersLinkerKeyValues", "summary": "", "description": "", "input": [ { "name": "linkerKey", "type": "string", "info": "", "required": true, "schema": { "title": "linkerKey", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putAddonLinkersLinkerKeyValues" }, "task": true }, { "name": "deleteAddonLinkersLinkerKeyValues2", "summary": "", "description": "", "input": [ { "name": "linkerKey", "type": "string", "info": "", "required": true, "schema": { "title": "linkerKey", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteAddonLinkersLinkerKeyValues2" }, "task": true }, { "name": "getAddonLinkersLinkerKeyValues2", "summary": "", "description": "", "input": [ { "name": "linkerKey", "type": "string", "info": "", "required": true, "schema": { "title": "linkerKey", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getAddonLinkersLinkerKeyValues2" }, "task": true }, { "name": "getHookEvents", "summary": "Returns the webhook resource or subject types on which webhooks can\nbe registered.\nEach resource/subject type contains an `events` link that returns the\npaginated list of specific events each individual subject type can\nemit.\nThis endpoint is publicly accessible and does not require\nauthentication or scopes.\nExample:\n```\n$ curl https://api.bitbucket.org/2.0/hook_events\n{\n \"repository\": {\n \"links\": {\n \"events\": {\n \"href\": \"https://api.bitbucket.org/2.0/hook_eve...(description truncated)", "description": "Returns the webhook resource or subject types on which webhooks can\nbe registered.\nEach resource/subject type contains an `events` link that returns the\npaginated list of specific events each individual subject type can\nemit.\nThis endpoint is publicly accessible and does not require\nauthentication or scopes.\nExample:\n```\n$ curl https://api.bitbucket.org/2.0/hook_events\n{\n \"repository\": {\n \"links\": {\n \"events\": {\n \"href\": \"https://api.bitbucket.org/2.0/hook_eve...(description truncated)", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getHookEvents" }, "task": true }, { "name": "getHookEventsSubjectType", "summary": "Returns a paginated list of all valid webhook events for the\nspecified entity.\nThis is public data that does not require any scopes or authentication.\nExample:\nNOTE: The following example is a truncated response object for the `team` `subject_type`.\nWe return the same structure for the other `subject_type` objects.\n```\n$ curl https://api.bitbucket.org/2.0/hook_events/team\n{\n \"page\": 1,\n \"pagelen\": 30,\n \"size\": 21,\n \"values\": [\n {\n \"category\": \"Repository\",\n ...(description truncated)", "description": "Returns a paginated list of all valid webhook events for the\nspecified entity.\nThis is public data that does not require any scopes or authentication.\nExample:\nNOTE: The following example is a truncated response object for the `team` `subject_type`.\nWe return the same structure for the other `subject_type` objects.\n```\n$ curl https://api.bitbucket.org/2.0/hook_events/team\n{\n \"page\": 1,\n \"pagelen\": 30,\n \"size\": 21,\n \"values\": [\n {\n \"category\": \"Repository\",\n ...(description truncated)", "input": [ { "name": "subjectType", "type": "string", "info": "A resource or subject type.", "required": true, "schema": { "title": "subjectType", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getHookEventsSubjectType" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugHooks", "summary": "Returns a paginated list of webhooks installed on this repository.", "description": "Returns a paginated list of webhooks installed on this repository.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugHooks" }, "task": true }, { "name": "postRepositoriesUsernameRepoSlugHooks", "summary": "Creates a new webhook on the specified repository.\nExample:\n```\n$ curl -X POST -u credentials -H 'Content-Type: application/json' https://api.bitbucket.org/2.0/repositories/username/slug/hooks -d '\n {\n \"description\": \"Webhook Description\",\n \"url\": \"https://example.com/\",\n \"active\": true,\n \"events\": [\n \"repo:push\",\n \"issue:created\",\n \"issue:updated\"\n ]\n }'\n```\nNote that this call requires the webhook scope, as well as any sco...(description truncated)", "description": "Creates a new webhook on the specified repository.\nExample:\n```\n$ curl -X POST -u credentials -H 'Content-Type: application/json' https://api.bitbucket.org/2.0/repositories/username/slug/hooks -d '\n {\n \"description\": \"Webhook Description\",\n \"url\": \"https://example.com/\",\n \"active\": true,\n \"events\": [\n \"repo:push\",\n \"issue:created\",\n \"issue:updated\"\n ]\n }'\n```\nNote that this call requires the webhook scope, as well as any sco...(description truncated)", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postRepositoriesUsernameRepoSlugHooks" }, "task": true }, { "name": "deleteRepositoriesUsernameRepoSlugHooksUid", "summary": "Deletes the specified webhook subscription from the given\nrepository.", "description": "Deletes the specified webhook subscription from the given\nrepository.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "uid", "type": "string", "info": "The installed webhook's id", "required": true, "schema": { "title": "uid", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteRepositoriesUsernameRepoSlugHooksUid" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugHooksUid", "summary": "Returns the webhook with the specified id installed on the specified\nrepository.", "description": "Returns the webhook with the specified id installed on the specified\nrepository.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "uid", "type": "string", "info": "The installed webhook's id.", "required": true, "schema": { "title": "uid", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugHooksUid" }, "task": true }, { "name": "putRepositoriesUsernameRepoSlugHooksUid", "summary": "Updates the specified webhook subscription.\nThe following properties can be mutated:\n* `description`\n* `url`\n* `active`\n* `events`", "description": "Updates the specified webhook subscription.\nThe following properties can be mutated:\n* `description`\n* `url`\n* `active`\n* `events`", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "uid", "type": "string", "info": "The installed webhook's id", "required": true, "schema": { "title": "uid", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putRepositoriesUsernameRepoSlugHooksUid" }, "task": true }, { "name": "getRepositories", "summary": "Returns a paginated list of all public repositories.\nThis endpoint also supports filtering and sorting of the results. See\n[filtering and sorting](../meta/filtering) for more details.", "description": "Returns a paginated list of all public repositories.\nThis endpoint also supports filtering and sorting of the results. See\n[filtering and sorting](../meta/filtering) for more details.", "input": [ { "name": "after", "type": "string", "info": "Filter the results to include only repositories create on or\nafter this [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601)\n timestamp. Example: `YYYY-MM-DDTHH:mm:ss.sssZ`", "required": false, "schema": { "title": "after", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositories" }, "task": true }, { "name": "getRepositoriesUsername", "summary": "Returns a paginated list of all repositories owned by the specified\naccount or UUID.\nThe result can be narrowed down based on the authenticated user's role.\nE.g. with `?role=contributor`, only those repositories that the\nauthenticated user has write access to are returned (this includes any\nrepo the user is an admin on, as that implies write access).\nThis endpoint also supports filtering and sorting of the results. See\n[filtering and sorting](../../meta/filtering) for more details.", "description": "Returns a paginated list of all repositories owned by the specified\naccount or UUID.\nThe result can be narrowed down based on the authenticated user's role.\nE.g. with `?role=contributor`, only those repositories that the\nauthenticated user has write access to are returned (this includes any\nrepo the user is an admin on, as that implies write access).\nThis endpoint also supports filtering and sorting of the results. See\n[filtering and sorting](../../meta/filtering) for more details.", "input": [ { "name": "username", "type": "string", "info": "This can either be the username or the UUID of the user,\nsurrounded by curly-braces, for example: `{user UUID}`.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "role", "type": "string", "info": "Filters the result based on the authenticated user's role on each repository.\n* **member**: returns repositories to which the user has explicit read access\n* **contributo...(description truncated)", "required": false, "schema": { "title": "role", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsername" }, "task": true }, { "name": "deleteRepositoriesUsernameRepoSlug", "summary": "Deletes the repository. This is an irreversible operation.\nThis does not affect its forks.", "description": "Deletes the repository. This is an irreversible operation.\nThis does not affect its forks.", "input": [ { "name": "username", "type": "string", "info": "This can either be the username or the UUID of the user,\nsurrounded by curly-braces, for example: `{user UUID}`.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteRepositoriesUsernameRepoSlug" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlug", "summary": "Returns the object describing this repository.", "description": "Returns the object describing this repository.", "input": [ { "name": "username", "type": "string", "info": "This can either be the username or the UUID of the user,\nsurrounded by curly-braces, for example: `{user UUID}`.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlug" }, "task": true }, { "name": "postRepositoriesUsernameRepoSlug", "summary": "Creates a new repository.\nNote: In order to set the project for the newly created repository,\npass in either the project key or the project UUID as part of the\nrequest body as shown in the examples below:\n```\n$ curl -X POST -H \"Content-Type: application/json\" -d '{\n \"scm\": \"git\",\n \"project\": {\n \"key\": \"MARS\"\n }\n}' https://api.bitbucket.org/2.0/repositories/teamsinspace/hablanding\n```\nor\n```\n$ curl -X POST -H \"Content-Type: application/json\" -d '{\n \"scm\": \"git\",\n \"project\": ...(description truncated)", "description": "Creates a new repository.\nNote: In order to set the project for the newly created repository,\npass in either the project key or the project UUID as part of the\nrequest body as shown in the examples below:\n```\n$ curl -X POST -H \"Content-Type: application/json\" -d '{\n \"scm\": \"git\",\n \"project\": {\n \"key\": \"MARS\"\n }\n}' https://api.bitbucket.org/2.0/repositories/teamsinspace/hablanding\n```\nor\n```\n$ curl -X POST -H \"Content-Type: application/json\" -d '{\n \"scm\": \"git\",\n \"project\": ...(description truncated)", "input": [ { "name": "username", "type": "string", "info": "This can either be the username or the UUID of the user,\nsurrounded by curly-braces, for example: `{user UUID}`.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "body", "type": "object", "info": "The repository that is to be created. Note that most object elements are optional. Elements \"owner\" and \"full_name\" are ignored as the URL implies them.", "required": false, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postRepositoriesUsernameRepoSlug" }, "task": true }, { "name": "postRepositoriesUsernameRepoSlugSrc", "summary": "Creates a new repository.\nNote: In order to set the project for the newly created repository,\npass in either the project key or the project UUID as part of the\nrequest body as shown in the examples below:\n```\n$ curl -X POST -H \"Content-Type: application/json\" -d '{\n \"scm\": \"git\",\n \"project\": {\n \"key\": \"MARS\"\n }\n}' https://api.bitbucket.org/2.0/repositories/teamsinspace/hablanding\n```\nor\n```\n$ curl -X POST -H \"Content-Type: application/json\" -d '{\n \"scm\": \"git\",\n \"project\": ...(description truncated)", "description": "Creates a new repository.\nNote: In order to set the project for the newly created repository,\npass in either the project key or the project UUID as part of the\nrequest body as shown in the examples below:\n```\n$ curl -X POST -H \"Content-Type: application/json\" -d '{\n \"scm\": \"git\",\n \"project\": {\n \"key\": \"MARS\"\n }\n}' https://api.bitbucket.org/2.0/repositories/teamsinspace/hablanding\n```\nor\n```\n$ curl -X POST -H \"Content-Type: application/json\" -d '{\n \"scm\": \"git\",\n \"project\": ...(description truncated)", "input": [ { "name": "username", "type": "string", "info": "This can either be the username or the UUID of the user,\nsurrounded by curly-braces, for example: `{user UUID}`.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "body", "type": "object", "info": "The repository that is to be created. Note that most object elements are optional. Elements \"owner\" and \"full_name\" are ignored as the URL implies them.", "required": false, "schema": { "title": "body", "type": "object" } }, { "name": "filename", "type": "string", "info": "The name of the file we are sending src for.", "required": true, "schema": { "title": "filename", "type": "string" } }, { "name": "attribute", "type": "string", "info": "The attribute of the file (e.g. link, executable, etc)", "required": true, "schema": { "title": "attribute", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postRepositoriesUsernameRepoSlugSrc" }, "task": true }, { "name": "CreateACommitByUploadingAFile", "summary": "This endpoint is used to create new commits in the repository by uploading files.", "description": "This endpoint is used to create new commits in the repository by uploading files.", "input": [ { "name": "username", "type": "string", "info": "This can either be the username or the UUID of the user,\nsurrounded by curly-braces, for example: `{user UUID}`.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "message", "type": "string", "info": "The commit message. When omitted, Bitbucket uses a canned string.", "required": false, "schema": { "title": "message", "type": "string" } }, { "name": "author", "type": "string", "info": "The raw string to be used as the new commit's author.", "required": false, "schema": { "title": "author", "type": "string" } }, { "name": "parents", "type": "string", "info": "A comma-separated list of SHA1s of the commits that should be the parents of the newly created commit.", "required": false, "schema": { "title": "parents", "type": "string" } }, { "name": "files", "type": "object", "info": "Optional field that declares the files that the request is manipulating. ex. {'path/to/file.txt':'Contents of File'}", "required": false, "schema": { "title": "file", "type": "object" } }, { "name": "branch", "type": "object", "info": "The name of the branch that the new commit should be created on. When omitted, the commit will be created on top of the main branch and will become the main branch's new head.", "required": false, "schema": { "title": "branch", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postRepositoriesUsernameRepoSlugSrc" }, "task": true }, { "name": "putRepositoriesUsernameRepoSlug", "summary": "Since this endpoint can be used to both update and to create a\nrepository, the request body depends on the intent.\n### Creation\nSee the POST documentation for the repository endpoint for an example\nof the request body.\n### Update\nNote: Changing the `name` of the repository will cause the location to\nbe changed. This is because the URL of the repo is derived from the\nname (a process called slugification). In such a scenario, it is\npossible for the request to fail if the newly created slug conflic...(description truncated)", "description": "Since this endpoint can be used to both update and to create a\nrepository, the request body depends on the intent.\n### Creation\nSee the POST documentation for the repository endpoint for an example\nof the request body.\n### Update\nNote: Changing the `name` of the repository will cause the location to\nbe changed. This is because the URL of the repo is derived from the\nname (a process called slugification). In such a scenario, it is\npossible for the request to fail if the newly created slug conflic...(description truncated)", "input": [ { "name": "username", "type": "string", "info": "This can either be the username or the UUID of the user,\nsurrounded by curly-braces, for example: `{user UUID}`.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "body", "type": "object", "info": "The repository that is to be updated.\nNote that the elements \"owner\" and \"full_name\" are ignored since the\nURL implies them.", "required": false, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putRepositoriesUsernameRepoSlug" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugCommitNodeStatuses", "summary": "Returns all statuses (e.g. build results) for a specific commit.", "description": "Returns all statuses (e.g. build results) for a specific commit.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "node", "type": "string", "info": "The commit's SHA1", "required": true, "schema": { "title": "node", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugCommitNodeStatuses" }, "task": true }, { "name": "postRepositoriesUsernameRepoSlugCommitNodeStatusesBuild", "summary": "Creates a new build status against the specified commit.\nIf the specified key already exists, the existing status object will\nbe overwritten.\nWhen creating a new commit status, you can use a URI template for the URL.\nTemplates are URLs that contain variable names that Bitbucket will\nevaluate at runtime whenever the URL is displayed anywhere similar to\nparameter substitution in\n[Bitbucket Connect](https://developer.atlassian.com/bitbucket/concepts/context-parameters.html).\nFor example, one could ...(description truncated)", "description": "Creates a new build status against the specified commit.\nIf the specified key already exists, the existing status object will\nbe overwritten.\nWhen creating a new commit status, you can use a URI template for the URL.\nTemplates are URLs that contain variable names that Bitbucket will\nevaluate at runtime whenever the URL is displayed anywhere similar to\nparameter substitution in\n[Bitbucket Connect](https://developer.atlassian.com/bitbucket/concepts/context-parameters.html).\nFor example, one could ...(description truncated)", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "node", "type": "string", "info": "The commit's SHA1", "required": true, "schema": { "title": "node", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postRepositoriesUsernameRepoSlugCommitNodeStatusesBuild" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugCommitNodeStatusesBuildKey", "summary": "Returns the specified build status for a commit.", "description": "Returns the specified build status for a commit.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "node", "type": "string", "info": "The commit's SHA1", "required": true, "schema": { "title": "node", "type": "string" } }, { "name": "key", "type": "string", "info": "The build status' unique key", "required": true, "schema": { "title": "key", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugCommitNodeStatusesBuildKey" }, "task": true }, { "name": "putRepositoriesUsernameRepoSlugCommitNodeStatusesBuildKey", "summary": "Used to update the current status of a build status object on the\nspecific commit.\nThis operation can also be used to change other properties of the\nbuild status:\n* `state`\n* `name`\n* `description`\n* `url`\n* `refname`\nThe `key` cannot be changed.", "description": "Used to update the current status of a build status object on the\nspecific commit.\nThis operation can also be used to change other properties of the\nbuild status:\n* `state`\n* `name`\n* `description`\n* `url`\n* `refname`\nThe `key` cannot be changed.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "node", "type": "string", "info": "The commit's SHA1", "required": true, "schema": { "title": "node", "type": "string" } }, { "name": "key", "type": "string", "info": "The commit status' unique key", "required": true, "schema": { "title": "key", "type": "string" } }, { "name": "body", "type": "object", "info": "The updated build status object", "required": false, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putRepositoriesUsernameRepoSlugCommitNodeStatusesBuildKey" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugForks", "summary": "Returns a paginated list of all the forks of the specified\nrepository.", "description": "Returns a paginated list of all the forks of the specified\nrepository.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugForks" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugPullrequestsPullRequestIdStatuses", "summary": "Returns all statuses (e.g. build results) for the given pull\nrequest.", "description": "Returns all statuses (e.g. build results) for the given pull\nrequest.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "The pull request's id", "required": true, "schema": { "title": "pullRequestId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugPullrequestsPullRequestIdStatuses" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugWatchers", "summary": "Returns a paginated list of all the watchers on the specified\nrepository.", "description": "Returns a paginated list of all the watchers on the specified\nrepository.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugWatchers" }, "task": true }, { "name": "getTeamsUsernameHooks", "summary": "Returns a paginated list of webhooks installed on this team.", "description": "Returns a paginated list of webhooks installed on this team.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getTeamsUsernameHooks" }, "task": true }, { "name": "postTeamsUsernameHooks", "summary": "Creates a new webhook on the specified team.\nTeam webhooks are fired for events from all repositories belonging to\nthat team account.\nNote that only admins can install webhooks on teams.", "description": "Creates a new webhook on the specified team.\nTeam webhooks are fired for events from all repositories belonging to\nthat team account.\nNote that only admins can install webhooks on teams.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postTeamsUsernameHooks" }, "task": true }, { "name": "deleteTeamsUsernameHooksUid", "summary": "Deletes the specified webhook subscription from the given team\naccount.", "description": "Deletes the specified webhook subscription from the given team\naccount.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "uid", "type": "string", "info": "The installed webhook's id", "required": true, "schema": { "title": "uid", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTeamsUsernameHooksUid" }, "task": true }, { "name": "getTeamsUsernameHooksUid", "summary": "Returns the webhook with the specified id installed on the given\nteam account.", "description": "Returns the webhook with the specified id installed on the given\nteam account.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "uid", "type": "string", "info": "The installed webhook's id.", "required": true, "schema": { "title": "uid", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getTeamsUsernameHooksUid" }, "task": true }, { "name": "putTeamsUsernameHooksUid", "summary": "Updates the specified webhook subscription.\nThe following properties can be mutated:\n* `description`\n* `url`\n* `active`\n* `events`", "description": "Updates the specified webhook subscription.\nThe following properties can be mutated:\n* `description`\n* `url`\n* `active`\n* `events`", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "uid", "type": "string", "info": "The installed webhook's id", "required": true, "schema": { "title": "uid", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putTeamsUsernameHooksUid" }, "task": true }, { "name": "getTeams", "summary": "Returns all the teams that the authenticated user is associated\nwith.", "description": "Returns all the teams that the authenticated user is associated\nwith.", "input": [ { "name": "role", "type": "string", "info": "Filters the teams based on the authenticated user's role on each team.\n* **member**: returns a list of all the teams which the caller is a member of\n at least one team g...(description truncated)", "required": false, "schema": { "title": "role", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getTeams" }, "task": true }, { "name": "getTeamsUsername", "summary": "Gets the public information associated with a team.\nIf the team's profile is private, `location`, `website` and\n`created_on` elements are omitted.", "description": "Gets the public information associated with a team.\nIf the team's profile is private, `location`, `website` and\n`created_on` elements are omitted.", "input": [ { "name": "username", "type": "string", "info": "The team's username or UUID.", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getTeamsUsername" }, "task": true }, { "name": "getTeamsUsernameFollowers", "summary": "Returns the list of accounts that are following this team.", "description": "Returns the list of accounts that are following this team.", "input": [ { "name": "username", "type": "string", "info": "The team's username", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getTeamsUsernameFollowers" }, "task": true }, { "name": "getTeamsUsernameFollowing", "summary": "Returns the list of accounts this team is following.", "description": "Returns the list of accounts this team is following.", "input": [ { "name": "username", "type": "string", "info": "The team's username", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getTeamsUsernameFollowing" }, "task": true }, { "name": "getTeamsUsernameMembers", "summary": "All members of a team.\nReturns all members of the specified team. Any member of any of the\nteam's groups is considered a member of the team. This includes users\nin groups that may not actually have access to any of the team's\nrepositories.\nNote that members using the \"private profile\" feature are not included.", "description": "All members of a team.\nReturns all members of the specified team. Any member of any of the\nteam's groups is considered a member of the team. This includes users\nin groups that may not actually have access to any of the team's\nrepositories.\nNote that members using the \"private profile\" feature are not included.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getTeamsUsernameMembers" }, "task": true }, { "name": "getUsersUsernameHooks", "summary": "Returns a paginated list of webhooks installed on this user account.", "description": "Returns a paginated list of webhooks installed on this user account.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersUsernameHooks" }, "task": true }, { "name": "postUsersUsernameHooks", "summary": "Creates a new webhook on the specified user account.\nAccount-level webhooks are fired for events from all repositories\nbelonging to that account.\nNote that one can only register webhooks on one's own account, not that\nof others.", "description": "Creates a new webhook on the specified user account.\nAccount-level webhooks are fired for events from all repositories\nbelonging to that account.\nNote that one can only register webhooks on one's own account, not that\nof others.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postUsersUsernameHooks" }, "task": true }, { "name": "deleteUsersUsernameHooksUid", "summary": "Deletes the specified webhook subscription from the given user\naccount.", "description": "Deletes the specified webhook subscription from the given user\naccount.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "uid", "type": "string", "info": "The installed webhook's id", "required": true, "schema": { "title": "uid", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteUsersUsernameHooksUid" }, "task": true }, { "name": "getUsersUsernameHooksUid", "summary": "Returns the webhook with the specified id installed on the given\nuser account.", "description": "Returns the webhook with the specified id installed on the given\nuser account.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "uid", "type": "string", "info": "The installed webhook's id.", "required": true, "schema": { "title": "uid", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersUsernameHooksUid" }, "task": true }, { "name": "putUsersUsernameHooksUid", "summary": "Updates the specified webhook subscription.\nThe following properties can be mutated:\n* `description`\n* `url`\n* `active`\n* `events`", "description": "Updates the specified webhook subscription.\nThe following properties can be mutated:\n* `description`\n* `url`\n* `active`\n* `events`", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "uid", "type": "string", "info": "The installed webhook's id", "required": true, "schema": { "title": "uid", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putUsersUsernameHooksUid" }, "task": true }, { "name": "getTeamsUsernameRepositories", "summary": "All repositories owned by a user/team. This includes private\nrepositories, but filtered down to the ones that the calling user has\naccess to.", "description": "All repositories owned by a user/team. This includes private\nrepositories, but filtered down to the ones that the calling user has\naccess to.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getTeamsUsernameRepositories" }, "task": true }, { "name": "getUsersUsernameRepositories", "summary": "All repositories owned by a user/team. This includes private\nrepositories, but filtered down to the ones that the calling user has\naccess to.", "description": "All repositories owned by a user/team. This includes private\nrepositories, but filtered down to the ones that the calling user has\naccess to.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersUsernameRepositories" }, "task": true }, { "name": "getUser", "summary": "Returns the currently logged in user.", "description": "Returns the currently logged in user.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getUser" }, "task": true }, { "name": "getUserEmails", "summary": "Returns all the authenticated user's email addresses. Both\nconfirmed and unconfirmed.", "description": "Returns all the authenticated user's email addresses. Both\nconfirmed and unconfirmed.", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getUserEmails" }, "task": true }, { "name": "getUserEmailsEmail", "summary": "Returns details about a specific one of the authenticated user's\nemail addresses.\nDetails describe whether the address has been confirmed by the user and\nwhether it is the user's primary address or not.", "description": "Returns details about a specific one of the authenticated user's\nemail addresses.\nDetails describe whether the address has been confirmed by the user and\nwhether it is the user's primary address or not.", "input": [ { "name": "email", "type": "string", "info": "", "required": true, "schema": { "title": "email", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUserEmailsEmail" }, "task": true }, { "name": "getUsersUsername", "summary": "Gets the public information associated with a user account.\nIf the user's profile is private, `location`, `website` and\n`created_on` elements are omitted.", "description": "Gets the public information associated with a user account.\nIf the user's profile is private, `location`, `website` and\n`created_on` elements are omitted.", "input": [ { "name": "username", "type": "string", "info": "The account's username or UUID.", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersUsername" }, "task": true }, { "name": "getUsersUsernameFollowers", "summary": "Returns the list of accounts that are following this team.", "description": "Returns the list of accounts that are following this team.", "input": [ { "name": "username", "type": "string", "info": "The account's username", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersUsernameFollowers" }, "task": true }, { "name": "getUsersUsernameFollowing", "summary": "Returns the list of accounts this user is following.", "description": "Returns the list of accounts this user is following.", "input": [ { "name": "username", "type": "string", "info": "The user's username", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getUsersUsernameFollowing" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugSrcNodePath", "summary": "", "description": "", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "node", "type": "string", "info": "", "required": true, "schema": { "title": "node", "type": "string" } }, { "name": "pathParam", "type": "string", "info": "", "required": true, "schema": { "title": "pathParam", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "format", "type": "string", "info": "Instead of returning the file's contents, return the (json) meta data for it.", "required": false, "schema": { "title": "format", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugSrcNodePath" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugBranchRestrictions", "summary": "Returns a paginated list of all branch restrictions on the\nrepository.", "description": "Returns a paginated list of all branch restrictions on the\nrepository.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugBranchRestrictions" }, "task": true }, { "name": "postRepositoriesUsernameRepoSlugBranchRestrictions", "summary": "Creates a new branch restriction rule for a repository.\n`kind` describes what will be restricted. Allowed values are: `push`,\n`force`, `delete`, and `restrict_merges`.\nDifferent kinds of branch restrictions have different requirements:\n* `push` and `restrict_merges` require `users` and `groups` to be\n specified. Empty lists are allowed, in which case permission is\n denied for everybody.\n* `force` can not be specified in a Mercurial repository.\n`pattern` is used to determine which branches will...(description truncated)", "description": "Creates a new branch restriction rule for a repository.\n`kind` describes what will be restricted. Allowed values are: `push`,\n`force`, `delete`, and `restrict_merges`.\nDifferent kinds of branch restrictions have different requirements:\n* `push` and `restrict_merges` require `users` and `groups` to be\n specified. Empty lists are allowed, in which case permission is\n denied for everybody.\n* `force` can not be specified in a Mercurial repository.\n`pattern` is used to determine which branches will...(description truncated)", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "body", "type": "object", "info": "The new rule", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postRepositoriesUsernameRepoSlugBranchRestrictions" }, "task": true }, { "name": "deleteRepositoriesUsernameRepoSlugBranchRestrictionsId", "summary": "Deletes an existing branch restriction rule.", "description": "Deletes an existing branch restriction rule.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "id", "type": "string", "info": "The restriction rule's id", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteRepositoriesUsernameRepoSlugBranchRestrictionsId" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugBranchRestrictionsId", "summary": "Returns a specific branch restriction rule.", "description": "Returns a specific branch restriction rule.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "id", "type": "string", "info": "The restriction rule's id", "required": true, "schema": { "title": "id", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugBranchRestrictionsId" }, "task": true }, { "name": "putRepositoriesUsernameRepoSlugBranchRestrictionsId", "summary": "Updates an existing branch restriction rule.\nFields not present in the request body are ignored.\nSee [`POST`](../../branch-restrictions#post) for details.", "description": "Updates an existing branch restriction rule.\nFields not present in the request body are ignored.\nSee [`POST`](../../branch-restrictions#post) for details.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "id", "type": "string", "info": "The restriction rule's id", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "body", "type": "object", "info": "The new version of the existing rule", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putRepositoriesUsernameRepoSlugBranchRestrictionsId" }, "task": true }, { "name": "deleteRepositoriesUsernameRepoSlugCommitNodeApprove", "summary": "Redact the authenticated user's approval of the specified commit.\nThis operation is only available to users that have explicit access to\nthe repository. In contrast, just the fact that a repository is\npublicly accessible to users does not give them the ability to approve\ncommits.", "description": "Redact the authenticated user's approval of the specified commit.\nThis operation is only available to users that have explicit access to\nthe repository. In contrast, just the fact that a repository is\npublicly accessible to users does not give them the ability to approve\ncommits.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "node", "type": "string", "info": "The commit's SHA1.", "required": true, "schema": { "title": "node", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteRepositoriesUsernameRepoSlugCommitNodeApprove" }, "task": true }, { "name": "postRepositoriesUsernameRepoSlugCommitNodeApprove", "summary": "Approve the specified commit as the authenticated user.\nThis operation is only available to users that have explicit access to\nthe repository. In contrast, just the fact that a repository is\npublicly accessible to users does not give them the ability to approve\ncommits.", "description": "Approve the specified commit as the authenticated user.\nThis operation is only available to users that have explicit access to\nthe repository. In contrast, just the fact that a repository is\npublicly accessible to users does not give them the ability to approve\ncommits.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "node", "type": "string", "info": "The commit's SHA1.", "required": true, "schema": { "title": "node", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postRepositoriesUsernameRepoSlugCommitNodeApprove" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugCommitRevision", "summary": "Returns the specified commit.", "description": "Returns the specified commit.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "revision", "type": "string", "info": "The commit's SHA1.", "required": true, "schema": { "title": "revision", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugCommitRevision" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugCommitShaComments", "summary": "Returns the commit's comments.\nThis includes both global and inline comments.\nThe default sorting is oldest to newest and can be overridden with\nthe `sort` query parameter.", "description": "Returns the commit's comments.\nThis includes both global and inline comments.\nThe default sorting is oldest to newest and can be overridden with\nthe `sort` query parameter.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "sha", "type": "string", "info": "", "required": true, "schema": { "title": "sha", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugCommitShaComments" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugCommitShaCommentsCommentId", "summary": "Returns the specified commit comment.", "description": "Returns the specified commit comment.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "sha", "type": "string", "info": "", "required": true, "schema": { "title": "sha", "type": "string" } }, { "name": "commentId", "type": "string", "info": "", "required": true, "schema": { "title": "commentId", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugCommitShaCommentsCommentId" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugCommits", "summary": "These are the repository's commits. They are paginated and returned\nin reverse chronological order, similar to the output of `git log` and\n`hg log`. Like these tools, the DAG can be filtered.\n## GET /repositories/{username}/{repo_slug}/commits/\nReturns all commits in the repo in topological order (newest commit\nfirst). All branches and tags are included (similar to\n`git log --all` and `hg log`).\n## GET /repositories/{username}/{repo_slug}/commits/master\nReturns all commits on rev `master` (simil...(description truncated)", "description": "These are the repository's commits. They are paginated and returned\nin reverse chronological order, similar to the output of `git log` and\n`hg log`. Like these tools, the DAG can be filtered.\n## GET /repositories/{username}/{repo_slug}/commits/\nReturns all commits in the repo in topological order (newest commit\nfirst). All branches and tags are included (similar to\n`git log --all` and `hg log`).\n## GET /repositories/{username}/{repo_slug}/commits/master\nReturns all commits on rev `master` (simil...(description truncated)", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugCommits" }, "task": true }, { "name": "postRepositoriesUsernameRepoSlugCommits", "summary": "Identical to `GET /repositories/{username}/{repo_slug}/commits`,\nexcept that POST allows clients to place the include and exclude\nparameters in the request body to avoid URL length issues.\n**Note that this resource does NOT support new commit creation.**", "description": "Identical to `GET /repositories/{username}/{repo_slug}/commits`,\nexcept that POST allows clients to place the include and exclude\nparameters in the request body to avoid URL length issues.\n**Note that this resource does NOT support new commit creation.**", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postRepositoriesUsernameRepoSlugCommits" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugCommitsRevision", "summary": "These are the repository's commits. They are paginated and returned\nin reverse chronological order, similar to the output of `git log` and\n`hg log`. Like these tools, the DAG can be filtered.\n## GET /repositories/{username}/{repo_slug}/commits/\nReturns all commits in the repo in topological order (newest commit\nfirst). All branches and tags are included (similar to\n`git log --all` and `hg log`).\n## GET /repositories/{username}/{repo_slug}/commits/master\nReturns all commits on rev `master` (simil...(description truncated)", "description": "These are the repository's commits. They are paginated and returned\nin reverse chronological order, similar to the output of `git log` and\n`hg log`. Like these tools, the DAG can be filtered.\n## GET /repositories/{username}/{repo_slug}/commits/\nReturns all commits in the repo in topological order (newest commit\nfirst). All branches and tags are included (similar to\n`git log --all` and `hg log`).\n## GET /repositories/{username}/{repo_slug}/commits/master\nReturns all commits on rev `master` (simil...(description truncated)", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "revision", "type": "string", "info": "", "required": true, "schema": { "title": "revision", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugCommitsRevision" }, "task": true }, { "name": "postRepositoriesUsernameRepoSlugCommitsRevision", "summary": "Identical to `GET /repositories/{username}/{repo_slug}/commits`,\nexcept that POST allows clients to place the include and exclude\nparameters in the request body to avoid URL length issues.\n**Note that this resource does NOT support new commit creation.**", "description": "Identical to `GET /repositories/{username}/{repo_slug}/commits`,\nexcept that POST allows clients to place the include and exclude\nparameters in the request body to avoid URL length issues.\n**Note that this resource does NOT support new commit creation.**", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "revision", "type": "string", "info": "", "required": true, "schema": { "title": "revision", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postRepositoriesUsernameRepoSlugCommitsRevision" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugDiffSpec", "summary": "Produces a raw, git-style diff for either a single commit (diffed\nagainst its first parent), or a revspec of 2 commits (e.g.\n`3a8b42..9ff173` where the first commit represents the source and the\nsecond commit the destination).\nIn case of the latter (diffing a revspec), a 3-way diff, or merge diff,\nis computed. This shows the changes introduced by the left branch\n(`3a8b42` in our example) as compared againt the right branch\n(`9ff173`).\nThis is equivalent to merging the left branch into the right ...(description truncated)", "description": "Produces a raw, git-style diff for either a single commit (diffed\nagainst its first parent), or a revspec of 2 commits (e.g.\n`3a8b42..9ff173` where the first commit represents the source and the\nsecond commit the destination).\nIn case of the latter (diffing a revspec), a 3-way diff, or merge diff,\nis computed. This shows the changes introduced by the left branch\n(`3a8b42` in our example) as compared againt the right branch\n(`9ff173`).\nThis is equivalent to merging the left branch into the right ...(description truncated)", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "spec", "type": "string", "info": "", "required": true, "schema": { "title": "spec", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "context", "type": "number", "info": "Generate diffs with lines of context instead of the usual three", "required": false, "schema": { "title": "context", "type": "number" } }, { "name": "pathParam", "type": "string", "info": "Limit the diff to a single file", "required": false, "schema": { "title": "pathParam", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugDiffSpec" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugPatchSpec", "summary": "Produces a raw patch for a single commit (diffed against its first\nparent), or a patch-series for a revspec of 2 commits (e.g.\n`3a8b42..9ff173` where the first commit represents the source and the\nsecond commit the destination).\nIn case of the latter (diffing a revspec), a patch series is returned\nfor the commits on the source branch (`3a8b42` and its ancestors in\nour example). For Mercurial, a single patch is returned that combines\nthe changes of all commits on the source branch.\nWhile similar ...(description truncated)", "description": "Produces a raw patch for a single commit (diffed against its first\nparent), or a patch-series for a revspec of 2 commits (e.g.\n`3a8b42..9ff173` where the first commit represents the source and the\nsecond commit the destination).\nIn case of the latter (diffing a revspec), a patch series is returned\nfor the commits on the source branch (`3a8b42` and its ancestors in\nour example). For Mercurial, a single patch is returned that combines\nthe changes of all commits on the source branch.\nWhile similar ...(description truncated)", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "spec", "type": "string", "info": "", "required": true, "schema": { "title": "spec", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugPatchSpec" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugComponents", "summary": "Returns the components that have been defined in the issue tracker.\nThis resource is only available on repositories that have the issue\ntracker enabled.", "description": "Returns the components that have been defined in the issue tracker.\nThis resource is only available on repositories that have the issue\ntracker enabled.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugComponents" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugComponentsComponentId", "summary": "Returns the specified issue tracker component object.", "description": "Returns the specified issue tracker component object.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "componentId", "type": "number", "info": "The component's id", "required": true, "schema": { "title": "componentId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugComponentsComponentId" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugIssues", "summary": "Returns the issues in the issue tracker.", "description": "Returns the issues in the issue tracker.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugIssues" }, "task": true }, { "name": "postRepositoriesUsernameRepoSlugIssues", "summary": "Creates a new issue.\nThis call requires authentication. Private repositories or private\nissue trackers require the caller to authenticate with an account that\nhas appropriate authorisation.\nThe authenticated user is used for the issue's `reporter` field.", "description": "Creates a new issue.\nThis call requires authentication. Private repositories or private\nissue trackers require the caller to authenticate with an account that\nhas appropriate authorisation.\nThe authenticated user is used for the issue's `reporter` field.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "body", "type": "object", "info": "The new issue. Note that the only required element is `title`. All other elements can be omitted from the body.", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postRepositoriesUsernameRepoSlugIssues" }, "task": true }, { "name": "deleteRepositoriesUsernameRepoSlugIssuesIssueId", "summary": "Deletes the specified issue. This requires write access to the\nrepository.", "description": "Deletes the specified issue. This requires write access to the\nrepository.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "issueId", "type": "string", "info": "", "required": true, "schema": { "title": "issueId", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteRepositoriesUsernameRepoSlugIssuesIssueId" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugIssuesIssueId", "summary": "Returns the specified issue.", "description": "Returns the specified issue.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "issueId", "type": "string", "info": "", "required": true, "schema": { "title": "issueId", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugIssuesIssueId" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugIssuesIssueIdAttachments", "summary": "Returns all attachments for this issue.\nThis returns the files' meta data. This does not return the files'\nactual contents.\nThe files are always ordered by their upload date.", "description": "Returns all attachments for this issue.\nThis returns the files' meta data. This does not return the files'\nactual contents.\nThe files are always ordered by their upload date.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "issueId", "type": "number", "info": "The issue's id", "required": true, "schema": { "title": "issueId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugIssuesIssueIdAttachments" }, "task": true }, { "name": "postRepositoriesUsernameRepoSlugIssuesIssueIdAttachments", "summary": "Upload new issue attachments.\nTo upload files, perform a `multipart/form-data` POST containing one\nor more file fields.\nWhen a file is uploaded with the same name as an existing attachment,\nthen the existing file will be replaced.", "description": "Upload new issue attachments.\nTo upload files, perform a `multipart/form-data` POST containing one\nor more file fields.\nWhen a file is uploaded with the same name as an existing attachment,\nthen the existing file will be replaced.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "issueId", "type": "number", "info": "The issue's id", "required": true, "schema": { "title": "issueId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postRepositoriesUsernameRepoSlugIssuesIssueIdAttachments" }, "task": true }, { "name": "deleteRepositoriesUsernameRepoSlugIssuesIssueIdAttachmentsPath", "summary": "Deletes an attachment.", "description": "Deletes an attachment.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "pathParam", "type": "string", "info": "", "required": true, "schema": { "title": "pathParam", "type": "string" } }, { "name": "issueId", "type": "string", "info": "", "required": true, "schema": { "title": "issueId", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteRepositoriesUsernameRepoSlugIssuesIssueIdAttachmentsPath" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugIssuesIssueIdAttachmentsPath", "summary": "Returns the contents of the specified file attachment.\nNote that this endpoint does not return a JSON response, but instead\nreturns a redirect pointing to the actual file that in turn will return\nthe raw contents.\nThe redirect URL contains a one-time token that has a limited lifetime.\nAs a result, the link should not be persisted, stored, or shared.", "description": "Returns the contents of the specified file attachment.\nNote that this endpoint does not return a JSON response, but instead\nreturns a redirect pointing to the actual file that in turn will return\nthe raw contents.\nThe redirect URL contains a one-time token that has a limited lifetime.\nAs a result, the link should not be persisted, stored, or shared.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "pathParam", "type": "string", "info": "", "required": true, "schema": { "title": "pathParam", "type": "string" } }, { "name": "issueId", "type": "string", "info": "", "required": true, "schema": { "title": "issueId", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugIssuesIssueIdAttachmentsPath" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugIssuesIssueIdComments", "summary": "Returns all comments that were made on the specified issue.\nThe default sorting is oldest to newest and can be overridden with\nthe `sort` query parameter.", "description": "Returns all comments that were made on the specified issue.\nThe default sorting is oldest to newest and can be overridden with\nthe `sort` query parameter.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "issueId", "type": "string", "info": "", "required": true, "schema": { "title": "issueId", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugIssuesIssueIdComments" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugIssuesIssueIdCommentsCommentId", "summary": "Returns the specified issue comment object.", "description": "Returns the specified issue comment object.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "commentId", "type": "string", "info": "", "required": true, "schema": { "title": "commentId", "type": "string" } }, { "name": "issueId", "type": "string", "info": "", "required": true, "schema": { "title": "issueId", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugIssuesIssueIdCommentsCommentId" }, "task": true }, { "name": "deleteRepositoriesUsernameRepoSlugIssuesIssueIdVote", "summary": "Retract your vote.", "description": "Retract your vote.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "issueId", "type": "number", "info": "The issue's id", "required": true, "schema": { "title": "issueId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteRepositoriesUsernameRepoSlugIssuesIssueIdVote" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugIssuesIssueIdVote", "summary": "Check whether the authenticated user has voted for this issue.\nA 204 status code indicates that the user has voted, while a 404\nimplies they haven't.", "description": "Check whether the authenticated user has voted for this issue.\nA 204 status code indicates that the user has voted, while a 404\nimplies they haven't.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "issueId", "type": "number", "info": "The issue's id", "required": true, "schema": { "title": "issueId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugIssuesIssueIdVote" }, "task": true }, { "name": "putRepositoriesUsernameRepoSlugIssuesIssueIdVote", "summary": "Vote for this issue.\nTo cast your vote, do an empty PUT. The 204 status code indicates that\nthe operation was successful.", "description": "Vote for this issue.\nTo cast your vote, do an empty PUT. The 204 status code indicates that\nthe operation was successful.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "issueId", "type": "number", "info": "The issue's id", "required": true, "schema": { "title": "issueId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putRepositoriesUsernameRepoSlugIssuesIssueIdVote" }, "task": true }, { "name": "deleteRepositoriesUsernameRepoSlugIssuesIssueIdWatch", "summary": "Stop watching this issue.", "description": "Stop watching this issue.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "issueId", "type": "number", "info": "The issue's id", "required": true, "schema": { "title": "issueId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteRepositoriesUsernameRepoSlugIssuesIssueIdWatch" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugIssuesIssueIdWatch", "summary": "Indicated whether or not the authenticated user is watching this\nissue.", "description": "Indicated whether or not the authenticated user is watching this\nissue.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "issueId", "type": "number", "info": "The issue's id", "required": true, "schema": { "title": "issueId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugIssuesIssueIdWatch" }, "task": true }, { "name": "putRepositoriesUsernameRepoSlugIssuesIssueIdWatch", "summary": "Start watching this issue.\nTo start watching this issue, do an empty PUT. The 204 status code\nindicates that the operation was successful.", "description": "Start watching this issue.\nTo start watching this issue, do an empty PUT. The 204 status code\nindicates that the operation was successful.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "issueId", "type": "number", "info": "The issue's id", "required": true, "schema": { "title": "issueId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putRepositoriesUsernameRepoSlugIssuesIssueIdWatch" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugMilestones", "summary": "Returns the milestones that have been defined in the issue tracker.\nThis resource is only available on repositories that have the issue\ntracker enabled.", "description": "Returns the milestones that have been defined in the issue tracker.\nThis resource is only available on repositories that have the issue\ntracker enabled.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugMilestones" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugMilestonesMilestoneId", "summary": "Returns the specified issue tracker milestone object.", "description": "Returns the specified issue tracker milestone object.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "milestoneId", "type": "number", "info": "The milestone's id", "required": true, "schema": { "title": "milestoneId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugMilestonesMilestoneId" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugVersions", "summary": "Returns the versions that have been defined in the issue tracker.\nThis resource is only available on repositories that have the issue\ntracker enabled.", "description": "Returns the versions that have been defined in the issue tracker.\nThis resource is only available on repositories that have the issue\ntracker enabled.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugVersions" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugVersionsVersionId", "summary": "Returns the specified issue tracker version object.", "description": "Returns the specified issue tracker version object.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "versionId", "type": "number", "info": "The version's id", "required": true, "schema": { "title": "versionId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugVersionsVersionId" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugDefaultReviewers", "summary": "Returns the repository's default reviewers.\nThese are the users that are automatically added as reviewers on every\nnew pull request that is created.", "description": "Returns the repository's default reviewers.\nThese are the users that are automatically added as reviewers on every\nnew pull request that is created.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugDefaultReviewers" }, "task": true }, { "name": "deleteRepositoriesUsernameRepoSlugDefaultReviewersTargetUsername", "summary": "Removes a default reviewer from the repository.", "description": "Removes a default reviewer from the repository.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "targetUsername", "type": "string", "info": "", "required": true, "schema": { "title": "targetUsername", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteRepositoriesUsernameRepoSlugDefaultReviewersTargetUsername" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugDefaultReviewersTargetUsername", "summary": "Returns the specified reviewer.\nThis can be used to test whether a user is among the repository's\ndefault reviewers list. A 404 indicates that that specified user is not\na default reviewer.", "description": "Returns the specified reviewer.\nThis can be used to test whether a user is among the repository's\ndefault reviewers list. A 404 indicates that that specified user is not\na default reviewer.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "targetUsername", "type": "string", "info": "", "required": true, "schema": { "title": "targetUsername", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugDefaultReviewersTargetUsername" }, "task": true }, { "name": "putRepositoriesUsernameRepoSlugDefaultReviewersTargetUsername", "summary": "Adds the specified user to the repository's list of default\nreviewers.\nThis method is idempotent. Adding a user a second time has no effect.", "description": "Adds the specified user to the repository's list of default\nreviewers.\nThis method is idempotent. Adding a user a second time has no effect.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "targetUsername", "type": "string", "info": "", "required": true, "schema": { "title": "targetUsername", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putRepositoriesUsernameRepoSlugDefaultReviewersTargetUsername" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugPullrequests", "summary": "Returns a paginated list of all pull requests on the specified\nrepository. By default only open pull requests are returned. This can\nbe controlled using the `state` query parameter. To retrieve pull\nrequests that are in one of multiple states, repeat the `state`\nparameter for each individual state.\nThis endpoint also supports filtering and sorting of the results. See\n[filtering and sorting](../../../../meta/filtering) for more details.", "description": "Returns a paginated list of all pull requests on the specified\nrepository. By default only open pull requests are returned. This can\nbe controlled using the `state` query parameter. To retrieve pull\nrequests that are in one of multiple states, repeat the `state`\nparameter for each individual state.\nThis endpoint also supports filtering and sorting of the results. See\n[filtering and sorting](../../../../meta/filtering) for more details.", "input": [ { "name": "username", "type": "string", "info": "This can either be the username or the UUID of the user,\nsurrounded by curly-braces, for example: `{user UUID}`.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "state", "type": "string", "info": "Only return pull requests that are in this state. This parameter can be repeated.", "required": false, "schema": { "title": "state", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugPullrequests" }, "task": true }, { "name": "postRepositoriesUsernameRepoSlugPullrequests", "summary": "Creates a new pull request.", "description": "Creates a new pull request.", "input": [ { "name": "username", "type": "string", "info": "This can either be the username or the UUID of the user,\nsurrounded by curly-braces, for example: `{user UUID}`.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "body", "type": "object", "info": "The new pull request.\nThe request URL you POST to becomes the destination repository URL. For this reason, you must specify an explicit source repository in the request o...(description truncated)", "required": false, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postRepositoriesUsernameRepoSlugPullrequests" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugPullrequestsActivity", "summary": "Returns a paginated list of the pull request's activity log.\nThis includes comments that were made by the reviewers, updates and\napprovals.", "description": "Returns a paginated list of the pull request's activity log.\nThis includes comments that were made by the reviewers, updates and\napprovals.", "input": [ { "name": "username", "type": "string", "info": "This can either be the username or the UUID of the user,\nsurrounded by curly-braces, for example: `{user UUID}`.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugPullrequestsActivity" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugPullrequestsPullRequestId", "summary": "Returns the specified pull request.", "description": "Returns the specified pull request.", "input": [ { "name": "username", "type": "string", "info": "This can either be the username or the UUID of the account,\nsurrounded by curly-braces, for example: `{user UUID}`.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "The id of the pull request.", "required": true, "schema": { "title": "pullRequestId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugPullrequestsPullRequestId" }, "task": true }, { "name": "putRepositoriesUsernameRepoSlugPullrequestsPullRequestId", "summary": "Mutates the specified pull request.\nThis can be used to change the pull request's branches or description.\nOnly open pull requests can be mutated.", "description": "Mutates the specified pull request.\nThis can be used to change the pull request's branches or description.\nOnly open pull requests can be mutated.", "input": [ { "name": "username", "type": "string", "info": "This can either be the username or the UUID of the user,\nsurrounded by curly-braces, for example: `{user UUID}`.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "The id of the open pull request.", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "body", "type": "object", "info": "The pull request that is to be updated.", "required": false, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putRepositoriesUsernameRepoSlugPullrequestsPullRequestId" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugPullrequestsPullRequestIdActivity", "summary": "Returns a paginated list of the pull request's activity log.\nThis includes comments that were made by the reviewers, updates and\napprovals.", "description": "Returns a paginated list of the pull request's activity log.\nThis includes comments that were made by the reviewers, updates and\napprovals.", "input": [ { "name": "username", "type": "string", "info": "This can either be the username or the UUID of the user,\nsurrounded by curly-braces, for example: `{user UUID}`.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "The id of the pull request.", "required": true, "schema": { "title": "pullRequestId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugPullrequestsPullRequestIdActivity" }, "task": true }, { "name": "deleteRepositoriesUsernameRepoSlugPullrequestsPullRequestIdApprove", "summary": "Redact the authenticated user's approval of the specified pull\nrequest.", "description": "Redact the authenticated user's approval of the specified pull\nrequest.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "pullRequestId", "type": "string", "info": "", "required": true, "schema": { "title": "pullRequestId", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteRepositoriesUsernameRepoSlugPullrequestsPullRequestIdApprove" }, "task": true }, { "name": "postRepositoriesUsernameRepoSlugPullrequestsPullRequestIdApprove", "summary": "Approve the specified pull request as the authenticated user.", "description": "Approve the specified pull request as the authenticated user.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "pullRequestId", "type": "string", "info": "", "required": true, "schema": { "title": "pullRequestId", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postRepositoriesUsernameRepoSlugPullrequestsPullRequestIdApprove" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugPullrequestsPullRequestIdComments", "summary": "Returns a paginated list of the pull request's comments.\nThis includes both global, inline comments and replies.\nThe default sorting is oldest to newest and can be overridden with\nthe `sort` query parameter.\nThis endpoint also supports filtering and sorting of the results. See\n[filtering and sorting](../../../../../../meta/filtering) for more\ndetails.", "description": "Returns a paginated list of the pull request's comments.\nThis includes both global, inline comments and replies.\nThe default sorting is oldest to newest and can be overridden with\nthe `sort` query parameter.\nThis endpoint also supports filtering and sorting of the results. See\n[filtering and sorting](../../../../../../meta/filtering) for more\ndetails.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "pullRequestId", "type": "string", "info": "", "required": true, "schema": { "title": "pullRequestId", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugPullrequestsPullRequestIdComments" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugPullrequestsPullRequestIdCommentsCommentId", "summary": "Returns a specific pull request comment.", "description": "Returns a specific pull request comment.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "pullRequestId", "type": "string", "info": "", "required": true, "schema": { "title": "pullRequestId", "type": "string" } }, { "name": "commentId", "type": "string", "info": "", "required": true, "schema": { "title": "commentId", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugPullrequestsPullRequestIdCommentsCommentId" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugPullrequestsPullRequestIdCommits", "summary": "Returns a paginated list of the pull request's commits.\nThese are the commits that are being merged into the destination\nbranch when the pull requests gets accepted.", "description": "Returns a paginated list of the pull request's commits.\nThese are the commits that are being merged into the destination\nbranch when the pull requests gets accepted.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "pullRequestId", "type": "string", "info": "", "required": true, "schema": { "title": "pullRequestId", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugPullrequestsPullRequestIdCommits" }, "task": true }, { "name": "postRepositoriesUsernameRepoSlugPullrequestsPullRequestIdDecline", "summary": "Declines the pull request.", "description": "Declines the pull request.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "pullRequestId", "type": "string", "info": "", "required": true, "schema": { "title": "pullRequestId", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postRepositoriesUsernameRepoSlugPullrequestsPullRequestIdDecline" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugPullrequestsPullRequestIdDiff", "summary": "", "description": "", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "pullRequestId", "type": "string", "info": "", "required": true, "schema": { "title": "pullRequestId", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugPullrequestsPullRequestIdDiff" }, "task": true }, { "name": "postRepositoriesUsernameRepoSlugPullrequestsPullRequestIdMerge", "summary": "Merges the pull request.", "description": "Merges the pull request.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "pullRequestId", "type": "string", "info": "", "required": true, "schema": { "title": "pullRequestId", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "body", "type": "object", "info": "", "required": false, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postRepositoriesUsernameRepoSlugPullrequestsPullRequestIdMerge" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugPullrequestsPullRequestIdPatch", "summary": "", "description": "", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "pullRequestId", "type": "string", "info": "", "required": true, "schema": { "title": "pullRequestId", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugPullrequestsPullRequestIdPatch" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugDownloads", "summary": "Returns a list of download links associated with the repository.", "description": "Returns a list of download links associated with the repository.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugDownloads" }, "task": true }, { "name": "postRepositoriesUsernameRepoSlugDownloads", "summary": "Upload new download artifacts.\nTo upload files, perform a `multipart/form-data` POST containing one\nor more `files` fields:\n $ echo Hello World > hello.txt\n $ curl -s -u evzijst -X POST https://api.bitbucket.org/2.0/repositories/evzijst/git-tests/downloads -F files=@hello.txt\nWhen a file is uploaded with the same name as an existing artifact,\nthen the existing file will be replaced.", "description": "Upload new download artifacts.\nTo upload files, perform a `multipart/form-data` POST containing one\nor more `files` fields:\n $ echo Hello World > hello.txt\n $ curl -s -u evzijst -X POST https://api.bitbucket.org/2.0/repositories/evzijst/git-tests/downloads -F files=@hello.txt\nWhen a file is uploaded with the same name as an existing artifact,\nthen the existing file will be replaced.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postRepositoriesUsernameRepoSlugDownloads" }, "task": true }, { "name": "deleteRepositoriesUsernameRepoSlugDownloadsFilename", "summary": "Deletes the specified download artifact from the repository.", "description": "Deletes the specified download artifact from the repository.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "filename", "type": "string", "info": "", "required": true, "schema": { "title": "filename", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteRepositoriesUsernameRepoSlugDownloadsFilename" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugDownloadsFilename", "summary": "Return a redirect to the contents of a download artifact.\nThis endpoint returns the actual file contents and not the artifact's\nmetadata.\n $ curl -s -L https://api.bitbucket.org/2.0/repositories/evzijst/git-tests/downloads/hello.txt\n Hello World", "description": "Return a redirect to the contents of a download artifact.\nThis endpoint returns the actual file contents and not the artifact's\nmetadata.\n $ curl -s -L https://api.bitbucket.org/2.0/repositories/evzijst/git-tests/downloads/hello.txt\n Hello World", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "filename", "type": "string", "info": "", "required": true, "schema": { "title": "filename", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugDownloadsFilename" }, "task": true }, { "name": "getPipelinesForRepository", "summary": "Find pipelines", "description": "Find pipelines", "input": [ { "name": "username", "type": "string", "info": "The account.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "The repository.", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getPipelinesForRepository" }, "task": true }, { "name": "createPipelineForRepository", "summary": "Endpoint to create and initiate a pipeline.\nThere are a couple of different options to initiate a pipeline, where the payload of the request will determine which type of pipeline will be instantiated.\n# Trigger a Pipeline for a branch or tag\nOne way to trigger pipelines is by specifying the reference for which you want to trigger a pipeline (e.g. a branch or tag).\nThe specified reference will be used to determine which pipeline definition from the `bitbucket-pipelines.yml` file will be applied...(description truncated)", "description": "Endpoint to create and initiate a pipeline.\nThere are a couple of different options to initiate a pipeline, where the payload of the request will determine which type of pipeline will be instantiated.\n# Trigger a Pipeline for a branch or tag\nOne way to trigger pipelines is by specifying the reference for which you want to trigger a pipeline (e.g. a branch or tag).\nThe specified reference will be used to determine which pipeline definition from the `bitbucket-pipelines.yml` file will be applied...(description truncated)", "input": [ { "name": "username", "type": "string", "info": "The account.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "The repository.", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "body", "type": "object", "info": "The pipeline to initiate.", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createPipelineForRepository" }, "task": true }, { "name": "getPipelineForRepository", "summary": "Retrieve a specified pipeline", "description": "Retrieve a specified pipeline", "input": [ { "name": "username", "type": "string", "info": "The account.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "The repository.", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "pipelineUuid", "type": "string", "info": "The pipeline UUID.", "required": true, "schema": { "title": "pipelineUuid", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getPipelineForRepository" }, "task": true }, { "name": "getPipelineStepsForRepository", "summary": "Find steps for the given pipeline.", "description": "Find steps for the given pipeline.", "input": [ { "name": "username", "type": "string", "info": "The account.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "The repository.", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "pipelineUuid", "type": "string", "info": "The UUID of the pipeline.", "required": true, "schema": { "title": "pipelineUuid", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getPipelineStepsForRepository" }, "task": true }, { "name": "getPipelineStepForRepository", "summary": "Retrieve a given step of a pipeline.", "description": "Retrieve a given step of a pipeline.", "input": [ { "name": "username", "type": "string", "info": "The account.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "The repository.", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "pipelineUuid", "type": "string", "info": "The UUID of the pipeline.", "required": true, "schema": { "title": "pipelineUuid", "type": "string" } }, { "name": "stepUuid", "type": "string", "info": "The UUID of the step.", "required": true, "schema": { "title": "stepUuid", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getPipelineStepForRepository" }, "task": true }, { "name": "getPipelineStepLogForRepository", "summary": "Retrieve the log file for a given step of a pipeline.\nThis endpoint supports (and encourages!) the use of [HTTP Range requests](https://tools.ietf.org/html/rfc7233) to deal with potentially very large log files.", "description": "Retrieve the log file for a given step of a pipeline.\nThis endpoint supports (and encourages!) the use of [HTTP Range requests](https://tools.ietf.org/html/rfc7233) to deal with potentially very large log files.", "input": [ { "name": "username", "type": "string", "info": "The account.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "The repository.", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "pipelineUuid", "type": "string", "info": "The UUID of the pipeline.", "required": true, "schema": { "title": "pipelineUuid", "type": "string" } }, { "name": "stepUuid", "type": "string", "info": "The UUID of the step.", "required": true, "schema": { "title": "stepUuid", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getPipelineStepLogForRepository" }, "task": true }, { "name": "stopPipeline", "summary": "Signal the stop of a pipeline and all of its steps that not have completed yet.", "description": "Signal the stop of a pipeline and all of its steps that not have completed yet.", "input": [ { "name": "username", "type": "string", "info": "The account.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "The repository.", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "pipelineUuid", "type": "string", "info": "The UUID of the pipeline.", "required": true, "schema": { "title": "pipelineUuid", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/stopPipeline" }, "task": true }, { "name": "getRepositoryPipelineConfig", "summary": "Retrieve the repository pipelines configuration.", "description": "Retrieve the repository pipelines configuration.", "input": [ { "name": "username", "type": "string", "info": "The account.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "The repository.", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoryPipelineConfig" }, "task": true }, { "name": "updateRepositoryPipelineConfig", "summary": "Update the pipelines configuration for a repository.", "description": "Update the pipelines configuration for a repository.", "input": [ { "name": "username", "type": "string", "info": "The account.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "The repository.", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "body", "type": "object", "info": "The updated repository pipelines configuration.", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateRepositoryPipelineConfig" }, "task": true }, { "name": "deleteRepositoryPipelineKeyPair", "summary": "Delete the repository SSH key pair.", "description": "Delete the repository SSH key pair.", "input": [ { "name": "username", "type": "string", "info": "The account.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "The repository.", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteRepositoryPipelineKeyPair" }, "task": true }, { "name": "getRepositoryPipelineSshKeyPair", "summary": "Retrieve the repository SSH key pair excluding the SSH private key. The private key is a write only field and will never be exposed in the logs or the REST API.", "description": "Retrieve the repository SSH key pair excluding the SSH private key. The private key is a write only field and will never be exposed in the logs or the REST API.", "input": [ { "name": "username", "type": "string", "info": "The account.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "The repository.", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoryPipelineSshKeyPair" }, "task": true }, { "name": "updateRepositoryPipelineKeyPair", "summary": "Create or update the repository SSH key pair. The private key will be set as a default SSH identity in your build container.", "description": "Create or update the repository SSH key pair. The private key will be set as a default SSH identity in your build container.", "input": [ { "name": "username", "type": "string", "info": "The account.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "The repository.", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "body", "type": "object", "info": "The created or updated SSH key pair.", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateRepositoryPipelineKeyPair" }, "task": true }, { "name": "getRepositoryPipelineKnownHosts", "summary": "Find repository level known hosts.", "description": "Find repository level known hosts.", "input": [ { "name": "username", "type": "string", "info": "The account.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "The repository.", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoryPipelineKnownHosts" }, "task": true }, { "name": "createRepositoryPipelineKnownHost", "summary": "Create a repository level known host.", "description": "Create a repository level known host.", "input": [ { "name": "username", "type": "string", "info": "The account.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "The repository.", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "body", "type": "object", "info": "The known host to create.", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createRepositoryPipelineKnownHost" }, "task": true }, { "name": "deleteRepositoryPipelineKnownHost", "summary": "Delete a repository level known host.", "description": "Delete a repository level known host.", "input": [ { "name": "username", "type": "string", "info": "The account.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "The repository.", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "knownHostUuid", "type": "string", "info": "The UUID of the known host to delete.", "required": true, "schema": { "title": "knownHostUuid", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteRepositoryPipelineKnownHost" }, "task": true }, { "name": "getRepositoryPipelineKnownHost", "summary": "Retrieve a repository level known host.", "description": "Retrieve a repository level known host.", "input": [ { "name": "username", "type": "string", "info": "The account.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "The repository.", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "knownHostUuid", "type": "string", "info": "The UUID of the known host to retrieve.", "required": true, "schema": { "title": "knownHostUuid", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoryPipelineKnownHost" }, "task": true }, { "name": "updateRepositoryPipelineKnownHost", "summary": "Update a repository level known host.", "description": "Update a repository level known host.", "input": [ { "name": "username", "type": "string", "info": "The account.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "The repository.", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "knownHostUuid", "type": "string", "info": "The UUID of the known host to update.", "required": true, "schema": { "title": "knownHostUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "The updated known host.", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateRepositoryPipelineKnownHost" }, "task": true }, { "name": "getRepositoryPipelineVariables", "summary": "Find repository level variables.", "description": "Find repository level variables.", "input": [ { "name": "username", "type": "string", "info": "The account.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "The repository.", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoryPipelineVariables" }, "task": true }, { "name": "createRepositoryPipelineVariable", "summary": "Create a repository level variable.", "description": "Create a repository level variable.", "input": [ { "name": "username", "type": "string", "info": "The account.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "The repository.", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "body", "type": "object", "info": "The variable to create.", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createRepositoryPipelineVariable" }, "task": true }, { "name": "deleteRepositoryPipelineVariable", "summary": "Delete a repository level variable.", "description": "Delete a repository level variable.", "input": [ { "name": "username", "type": "string", "info": "The account.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "The repository.", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "variableUuid", "type": "string", "info": "The UUID of the variable to delete.", "required": true, "schema": { "title": "variableUuid", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteRepositoryPipelineVariable" }, "task": true }, { "name": "getRepositoryPipelineVariable", "summary": "Retrieve a repository level variable.", "description": "Retrieve a repository level variable.", "input": [ { "name": "username", "type": "string", "info": "The account.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "The repository.", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "variableUuid", "type": "string", "info": "The UUID of the variable to retrieve.", "required": true, "schema": { "title": "variableUuid", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoryPipelineVariable" }, "task": true }, { "name": "updateRepositoryPipelineVariable", "summary": "Update a repository level variable.", "description": "Update a repository level variable.", "input": [ { "name": "username", "type": "string", "info": "The account.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "The repository.", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "variableUuid", "type": "string", "info": "The UUID of the variable to update.", "required": true, "schema": { "title": "variableUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "The updated variable", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateRepositoryPipelineVariable" }, "task": true }, { "name": "getPipelineVariablesForTeam", "summary": "Find account level variables.", "description": "Find account level variables.", "input": [ { "name": "username", "type": "string", "info": "The account.", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getPipelineVariablesForTeam" }, "task": true }, { "name": "createPipelineVariableForTeam", "summary": "Create an account level variable.", "description": "Create an account level variable.", "input": [ { "name": "username", "type": "string", "info": "The account.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "body", "type": "object", "info": "The variable to create.", "required": false, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createPipelineVariableForTeam" }, "task": true }, { "name": "deletePipelineVariableForTeam", "summary": "Delete a team level variable.", "description": "Delete a team level variable.", "input": [ { "name": "username", "type": "string", "info": "The account.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "variableUuid", "type": "string", "info": "The UUID of the variable to delete.", "required": true, "schema": { "title": "variableUuid", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deletePipelineVariableForTeam" }, "task": true }, { "name": "getPipelineVariableForTeam", "summary": "Retrieve a team level variable.", "description": "Retrieve a team level variable.", "input": [ { "name": "username", "type": "string", "info": "The account.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "variableUuid", "type": "string", "info": "The UUID of the variable to retrieve.", "required": true, "schema": { "title": "variableUuid", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getPipelineVariableForTeam" }, "task": true }, { "name": "updatePipelineVariableForTeam", "summary": "Update a team level variable.", "description": "Update a team level variable.", "input": [ { "name": "username", "type": "string", "info": "The account.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "variableUuid", "type": "string", "info": "The UUID of the variable.", "required": true, "schema": { "title": "variableUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "The updated variable.", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updatePipelineVariableForTeam" }, "task": true }, { "name": "getPipelineVariablesForUser", "summary": "Find user level variables.", "description": "Find user level variables.", "input": [ { "name": "username", "type": "string", "info": "The account.", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getPipelineVariablesForUser" }, "task": true }, { "name": "createPipelineVariableForUser", "summary": "Create a user level variable.", "description": "Create a user level variable.", "input": [ { "name": "username", "type": "string", "info": "The account.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "body", "type": "object", "info": "The variable to create.", "required": false, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createPipelineVariableForUser" }, "task": true }, { "name": "deletePipelineVariableForUser", "summary": "Delete an account level variable.", "description": "Delete an account level variable.", "input": [ { "name": "username", "type": "string", "info": "The account.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "variableUuid", "type": "string", "info": "The UUID of the variable to delete.", "required": true, "schema": { "title": "variableUuid", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deletePipelineVariableForUser" }, "task": true }, { "name": "getPipelineVariableForUser", "summary": "Retrieve a user level variable.", "description": "Retrieve a user level variable.", "input": [ { "name": "username", "type": "string", "info": "The account.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "variableUuid", "type": "string", "info": "The UUID of the variable to retrieve.", "required": true, "schema": { "title": "variableUuid", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getPipelineVariableForUser" }, "task": true }, { "name": "updatePipelineVariableForUser", "summary": "Update a user level variable.", "description": "Update a user level variable.", "input": [ { "name": "username", "type": "string", "info": "The account.", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "variableUuid", "type": "string", "info": "The UUID of the variable.", "required": true, "schema": { "title": "variableUuid", "type": "string" } }, { "name": "body", "type": "object", "info": "The updated variable.", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updatePipelineVariableForUser" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugRefs", "summary": "", "description": "", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugRefs" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugRefsBranches", "summary": "", "description": "", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugRefsBranches" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugRefsBranchesName", "summary": "", "description": "", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "name", "type": "string", "info": "", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugRefsBranchesName" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugRefsTags", "summary": "", "description": "", "input": [ { "name": "username", "type": "string", "info": "The username for the owner of the repository. This can either be the\n`username` of the owner or the `UUID` of the owner (surrounded by\ncurly-braces (`{}`)). Owners can be...(description truncated)", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "The repo slug for the repository. This can either be the `repo_slug` of\nthe repository or the `UUID` of the repository (surrounded by\ncurly-braces (`{}`))", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugRefsTags" }, "task": true }, { "name": "postRepositoriesUsernameRepoSlugRefsTags", "summary": "Creates a new tag in the specified repository.\nThe payload of the POST should consist of a JSON document that\ncontains the name of the tag and the target hash.\n```\n{\n \"name\" : \"new tag name\",\n \"target\" : {\n \"hash\" : \"target commit hash\",\n }\n}\n```\nThis endpoint does support using short hash prefixes for the commit\nhash, but it may return a 400 response if the provided prefix is\nambiguous. Using a full commit hash is the preferred approach.", "description": "Creates a new tag in the specified repository.\nThe payload of the POST should consist of a JSON document that\ncontains the name of the tag and the target hash.\n```\n{\n \"name\" : \"new tag name\",\n \"target\" : {\n \"hash\" : \"target commit hash\",\n }\n}\n```\nThis endpoint does support using short hash prefixes for the commit\nhash, but it may return a 400 response if the provided prefix is\nambiguous. Using a full commit hash is the preferred approach.", "input": [ { "name": "username", "type": "string", "info": "The username for the owner of the repository. This can either be the\n`username` of the owner or the `UUID` of the owner (surrounded by\ncurly-braces (`{}`)). Owners can be...(description truncated)", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "The repo slug for the repository. This can either be the `repo_slug` of\nthe repository or the `UUID` of the repository (surrounded by\ncurly-braces (`{}`))", "required": true, "schema": { "title": "repoSlug", "type": "string" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postRepositoriesUsernameRepoSlugRefsTags" }, "task": true }, { "name": "getRepositoriesUsernameRepoSlugRefsTagsName", "summary": "", "description": "", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "name", "type": "string", "info": "", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "repoSlug", "type": "string", "info": "", "required": true, "schema": { "title": "repoSlug", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getRepositoriesUsernameRepoSlugRefsTagsName" }, "task": true }, { "name": "getSnippets", "summary": "Returns all snippets. Like pull requests, repositories and teams, the\nfull set of snippets is defined by what the current user has access to.\nThis includes all snippets owned by the current user, but also all snippets\nowned by any of the teams the user is a member of, or snippets by other\nusers that the current user is either watching or has collaborated on (for\ninstance by commenting on it).\nTo limit the set of returned snippets, apply the\n`?role=[owner|contributor|member]` query parameter wher...(description truncated)", "description": "Returns all snippets. Like pull requests, repositories and teams, the\nfull set of snippets is defined by what the current user has access to.\nThis includes all snippets owned by the current user, but also all snippets\nowned by any of the teams the user is a member of, or snippets by other\nusers that the current user is either watching or has collaborated on (for\ninstance by commenting on it).\nTo limit the set of returned snippets, apply the\n`?role=[owner|contributor|member]` query parameter wher...(description truncated)", "input": [ { "name": "role", "type": "string", "info": "Filter down the result based on the authenticated user's role (`owner`, `contributor`, or `member`).", "required": false, "schema": { "title": "role", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getSnippets" }, "task": true }, { "name": "postSnippets", "summary": "Creates a new snippet under the authenticated user's account.\nSnippets can contain multiple files. Both text and binary files are\nsupported.\nThe simplest way to create a new snippet from a local file:\n $ curl -u username:password -X POST https://api.bitbucket.org/2.0/snippets -F file=@image.png\nCreating snippets through curl has a few limitations and so let's look\nat a more complicated scenario.\nSnippets are created with a multipart POST. Both `multipart/form-data`\nand `multipar...(description truncated)", "description": "Creates a new snippet under the authenticated user's account.\nSnippets can contain multiple files. Both text and binary files are\nsupported.\nThe simplest way to create a new snippet from a local file:\n $ curl -u username:password -X POST https://api.bitbucket.org/2.0/snippets -F file=@image.png\nCreating snippets through curl has a few limitations and so let's look\nat a more complicated scenario.\nSnippets are created with a multipart POST. Both `multipart/form-data`\nand `multipar...(description truncated)", "input": [ { "name": "body", "type": "object", "info": "The new snippet object.", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postSnippets" }, "task": true }, { "name": "getSnippetsUsername", "summary": "Identical to `/snippets`, except that the result is further filtered\nby the snippet owner and only those that are owned by `{username}` are\nreturned.", "description": "Identical to `/snippets`, except that the result is further filtered\nby the snippet owner and only those that are owned by `{username}` are\nreturned.", "input": [ { "name": "role", "type": "string", "info": "Filter down the result based on the authenticated user's role (`owner`, `contributor`, or `member`).", "required": false, "schema": { "title": "role", "type": "string" } }, { "name": "username", "type": "string", "info": "Limits the result to snippets owned by this user.", "required": true, "schema": { "title": "username", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getSnippetsUsername" }, "task": true }, { "name": "postSnippetsUsername", "summary": "Identical to `/snippets`, except that the new snippet will be\ncreated under the account specified in the path parameter `{username}`.", "description": "Identical to `/snippets`, except that the new snippet will be\ncreated under the account specified in the path parameter `{username}`.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "body", "type": "object", "info": "The new snippet object.", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postSnippetsUsername" }, "task": true }, { "name": "deleteSnippetsUsernameEncodedId", "summary": "Deletes a snippet and returns an empty response.", "description": "Deletes a snippet and returns an empty response.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "encodedId", "type": "string", "info": "The snippet's id.", "required": true, "schema": { "title": "encodedId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSnippetsUsernameEncodedId" }, "task": true }, { "name": "getSnippetsUsernameEncodedId", "summary": "Retrieves a single snippet.\nSnippets support multiple content types:\n* application/json\n* multipart/related\n* multipart/form-data\napplication/json\n----------------\nThe default content type of the response is `application/json`.\nSince JSON is always `utf-8`, it cannot reliably contain file contents\nfor files that are not text. Therefore, JSON snippet documents only\ncontain the filename and links to the file contents.\nThis means that in order to retrieve all parts of a snippet, N+1\nrequests need t...(description truncated)", "description": "Retrieves a single snippet.\nSnippets support multiple content types:\n* application/json\n* multipart/related\n* multipart/form-data\napplication/json\n----------------\nThe default content type of the response is `application/json`.\nSince JSON is always `utf-8`, it cannot reliably contain file contents\nfor files that are not text. Therefore, JSON snippet documents only\ncontain the filename and links to the file contents.\nThis means that in order to retrieve all parts of a snippet, N+1\nrequests need t...(description truncated)", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "encodedId", "type": "string", "info": "The snippet's id.", "required": true, "schema": { "title": "encodedId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getSnippetsUsernameEncodedId" }, "task": true }, { "name": "putSnippetsUsernameEncodedId", "summary": "Used to update a snippet. Use this to add and delete files and to\nchange a snippet's title.\nTo update a snippet, one can either PUT a full snapshot, or only the\nparts that need to be changed.\nThe contract for PUT on this API is that properties missing from the\nrequest remain untouched so that snippets can be efficiently\nmanipulated with differential payloads.\nTo delete a property (e.g. the title, or a file), include its name in\nthe request, but omit its value (use `null`).\nAs in Git, explicit re...(description truncated)", "description": "Used to update a snippet. Use this to add and delete files and to\nchange a snippet's title.\nTo update a snippet, one can either PUT a full snapshot, or only the\nparts that need to be changed.\nThe contract for PUT on this API is that properties missing from the\nrequest remain untouched so that snippets can be efficiently\nmanipulated with differential payloads.\nTo delete a property (e.g. the title, or a file), include its name in\nthe request, but omit its value (use `null`).\nAs in Git, explicit re...(description truncated)", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "encodedId", "type": "string", "info": "The snippet's id.", "required": true, "schema": { "title": "encodedId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putSnippetsUsernameEncodedId" }, "task": true }, { "name": "getSnippetsUsernameEncodedIdComments", "summary": "Used to retrieve a paginated list of all comments for a specific\nsnippet.\nThis resource works identical to commit and pull request comments.\nThe default sorting is oldest to newest and can be overridden with\nthe `sort` query parameter.", "description": "Used to retrieve a paginated list of all comments for a specific\nsnippet.\nThis resource works identical to commit and pull request comments.\nThe default sorting is oldest to newest and can be overridden with\nthe `sort` query parameter.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "encodedId", "type": "string", "info": "", "required": true, "schema": { "title": "encodedId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getSnippetsUsernameEncodedIdComments" }, "task": true }, { "name": "postSnippetsUsernameEncodedIdComments", "summary": "Creates a new comment.\nThe only required field in the body is `content.raw`.\nTo create a threaded reply to an existing comment, include `parent.id`.", "description": "Creates a new comment.\nThe only required field in the body is `content.raw`.\nTo create a threaded reply to an existing comment, include `parent.id`.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "encodedId", "type": "string", "info": "", "required": true, "schema": { "title": "encodedId", "type": "string" } }, { "name": "body", "type": "object", "info": "The contents of the new comment.", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postSnippetsUsernameEncodedIdComments" }, "task": true }, { "name": "deleteSnippetsUsernameEncodedIdCommentsCommentId", "summary": "Deletes a snippet comment.\nComments can only be removed by their author.", "description": "Deletes a snippet comment.\nComments can only be removed by their author.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "commentId", "type": "string", "info": "", "required": true, "schema": { "title": "commentId", "type": "string" } }, { "name": "encodedId", "type": "string", "info": "", "required": true, "schema": { "title": "encodedId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSnippetsUsernameEncodedIdCommentsCommentId" }, "task": true }, { "name": "getSnippetsUsernameEncodedIdCommentsCommentId", "summary": "Returns the specific snippet comment.", "description": "Returns the specific snippet comment.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "commentId", "type": "string", "info": "", "required": true, "schema": { "title": "commentId", "type": "string" } }, { "name": "encodedId", "type": "string", "info": "", "required": true, "schema": { "title": "encodedId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getSnippetsUsernameEncodedIdCommentsCommentId" }, "task": true }, { "name": "putSnippetsUsernameEncodedIdCommentsCommentId", "summary": "Updates a comment.\nComments can only be updated by their author.", "description": "Updates a comment.\nComments can only be updated by their author.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "commentId", "type": "string", "info": "", "required": true, "schema": { "title": "commentId", "type": "string" } }, { "name": "encodedId", "type": "string", "info": "", "required": true, "schema": { "title": "encodedId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putSnippetsUsernameEncodedIdCommentsCommentId" }, "task": true }, { "name": "getSnippetsUsernameEncodedIdCommits", "summary": "Returns the changes (commits) made on this snippet.", "description": "Returns the changes (commits) made on this snippet.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "encodedId", "type": "string", "info": "", "required": true, "schema": { "title": "encodedId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getSnippetsUsernameEncodedIdCommits" }, "task": true }, { "name": "getSnippetsUsernameEncodedIdCommitsRevision", "summary": "", "description": "", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "encodedId", "type": "string", "info": "", "required": true, "schema": { "title": "encodedId", "type": "string" } }, { "name": "revision", "type": "string", "info": "", "required": true, "schema": { "title": "revision", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getSnippetsUsernameEncodedIdCommitsRevision" }, "task": true }, { "name": "deleteSnippetsUsernameEncodedIdWatch", "summary": "Used to stop watching a specific snippet. Returns 204 (No Content)\nto indicate success.", "description": "Used to stop watching a specific snippet. Returns 204 (No Content)\nto indicate success.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "encodedId", "type": "string", "info": "The snippet id.", "required": true, "schema": { "title": "encodedId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSnippetsUsernameEncodedIdWatch" }, "task": true }, { "name": "getSnippetsUsernameEncodedIdWatch", "summary": "Used to check if the current user is watching a specific snippet.\nReturns 204 (No Content) if the user is watching the snippet and 404 if\nnot.\nHitting this endpoint anonymously always returns a 404.", "description": "Used to check if the current user is watching a specific snippet.\nReturns 204 (No Content) if the user is watching the snippet and 404 if\nnot.\nHitting this endpoint anonymously always returns a 404.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "encodedId", "type": "string", "info": "The snippet id.", "required": true, "schema": { "title": "encodedId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getSnippetsUsernameEncodedIdWatch" }, "task": true }, { "name": "putSnippetsUsernameEncodedIdWatch", "summary": "Used to start watching a specific snippet. Returns 204 (No Content).", "description": "Used to start watching a specific snippet. Returns 204 (No Content).", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "encodedId", "type": "string", "info": "The snippet id.", "required": true, "schema": { "title": "encodedId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putSnippetsUsernameEncodedIdWatch" }, "task": true }, { "name": "getSnippetsUsernameEncodedIdWatchers", "summary": "Returns a paginated list of all users watching a specific snippet.", "description": "Returns a paginated list of all users watching a specific snippet.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "encodedId", "type": "string", "info": "The snippet id.", "required": true, "schema": { "title": "encodedId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getSnippetsUsernameEncodedIdWatchers" }, "task": true }, { "name": "deleteSnippetsUsernameEncodedIdNodeId", "summary": "Deletes the snippet.\nNote that this only works for versioned URLs that point to the latest\ncommit of the snippet. Pointing to an older commit results in a 405\nstatus code.\nTo delete a snippet, regardless of whether or not concurrent changes\nare being made to it, use `DELETE /snippets/{encoded_id}` instead.", "description": "Deletes the snippet.\nNote that this only works for versioned URLs that point to the latest\ncommit of the snippet. Pointing to an older commit results in a 405\nstatus code.\nTo delete a snippet, regardless of whether or not concurrent changes\nare being made to it, use `DELETE /snippets/{encoded_id}` instead.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "nodeId", "type": "string", "info": "", "required": true, "schema": { "title": "nodeId", "type": "string" } }, { "name": "encodedId", "type": "string", "info": "The snippet's id.", "required": true, "schema": { "title": "encodedId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSnippetsUsernameEncodedIdNodeId" }, "task": true }, { "name": "getSnippetsUsernameEncodedIdNodeId", "summary": "Identical to `GET /snippets/encoded_id`, except that this endpoint\ncan be used to retrieve the contents of the snippet as it was at an\nolder revision, while `/snippets/encoded_id` always returns the\nsnippet's current revision.\nNote that only the snippet's file contents are versioned, not its\nmeta data properties like the title.\nOther than that, the two endpoints are identical in behavior.", "description": "Identical to `GET /snippets/encoded_id`, except that this endpoint\ncan be used to retrieve the contents of the snippet as it was at an\nolder revision, while `/snippets/encoded_id` always returns the\nsnippet's current revision.\nNote that only the snippet's file contents are versioned, not its\nmeta data properties like the title.\nOther than that, the two endpoints are identical in behavior.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "encodedId", "type": "string", "info": "The snippet's id.", "required": true, "schema": { "title": "encodedId", "type": "string" } }, { "name": "nodeId", "type": "string", "info": "A commit revision (SHA1).", "required": true, "schema": { "title": "nodeId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getSnippetsUsernameEncodedIdNodeId" }, "task": true }, { "name": "putSnippetsUsernameEncodedIdNodeId", "summary": "Identical to `UPDATE /snippets/encoded_id`, except that this endpoint\ntakes an explicit commit revision. Only the snippet's \"HEAD\"/\"tip\"\n(most recent) version can be updated and requests on all other,\nolder revisions fail by returning a 405 status.\nUsage of this endpoint over the unrestricted `/snippets/encoded_id`\ncould be desired if the caller wants to be sure no concurrent\nmodifications have taken place between the moment of the UPDATE\nrequest and the original GET.\nThis can be considered a so...(description truncated)", "description": "Identical to `UPDATE /snippets/encoded_id`, except that this endpoint\ntakes an explicit commit revision. Only the snippet's \"HEAD\"/\"tip\"\n(most recent) version can be updated and requests on all other,\nolder revisions fail by returning a 405 status.\nUsage of this endpoint over the unrestricted `/snippets/encoded_id`\ncould be desired if the caller wants to be sure no concurrent\nmodifications have taken place between the moment of the UPDATE\nrequest and the original GET.\nThis can be considered a so...(description truncated)", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "encodedId", "type": "string", "info": "The snippet's id.", "required": true, "schema": { "title": "encodedId", "type": "string" } }, { "name": "nodeId", "type": "string", "info": "A commit revision (SHA1).", "required": true, "schema": { "title": "nodeId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putSnippetsUsernameEncodedIdNodeId" }, "task": true }, { "name": "getSnippetsUsernameEncodedIdNodeIdFilesPath", "summary": "Retrieves the raw contents of a specific file in the snippet. The\n`Content-Disposition` header will be \"attachment\" to avoid issues with\nmalevolent executable files.\nThe file's mime type is derived from its filename and returned in the\n`Content-Type` header.\nNote that for text files, no character encoding is included as part of\nthe content type.", "description": "Retrieves the raw contents of a specific file in the snippet. The\n`Content-Disposition` header will be \"attachment\" to avoid issues with\nmalevolent executable files.\nThe file's mime type is derived from its filename and returned in the\n`Content-Type` header.\nNote that for text files, no character encoding is included as part of\nthe content type.", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "pathParam", "type": "string", "info": "", "required": true, "schema": { "title": "pathParam", "type": "string" } }, { "name": "nodeId", "type": "string", "info": "", "required": true, "schema": { "title": "nodeId", "type": "string" } }, { "name": "encodedId", "type": "string", "info": "", "required": true, "schema": { "title": "encodedId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getSnippetsUsernameEncodedIdNodeIdFilesPath" }, "task": true }, { "name": "getSnippetsUsernameEncodedIdRevisionDiff", "summary": "Returns the diff of the specified commit against its first parent.\nNote that this resource is different in functionality from the `patch`\nresource.\nThe differences between a diff and a patch are:\n* patches have a commit header with the username, message, etc\n* diffs support the optional `path=foo/bar.py` query param to filter the\n diff to just that one file diff (not supported for patches)\n* for a merge, the diff will show the diff between the merge commit and\n its first parent (identical to h...(description truncated)", "description": "Returns the diff of the specified commit against its first parent.\nNote that this resource is different in functionality from the `patch`\nresource.\nThe differences between a diff and a patch are:\n* patches have a commit header with the username, message, etc\n* diffs support the optional `path=foo/bar.py` query param to filter the\n diff to just that one file diff (not supported for patches)\n* for a merge, the diff will show the diff between the merge commit and\n its first parent (identical to h...(description truncated)", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "pathParam", "type": "string", "info": "When used, only one the diff of the specified file will be returned.", "required": false, "schema": { "title": "pathParam", "type": "string" } }, { "name": "encodedId", "type": "string", "info": "The snippet id.", "required": true, "schema": { "title": "encodedId", "type": "string" } }, { "name": "revision", "type": "string", "info": "A revspec expression. This can simply be a commit SHA1, a ref name, or a compare expression like `staging..production`.", "required": true, "schema": { "title": "revision", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getSnippetsUsernameEncodedIdRevisionDiff" }, "task": true }, { "name": "getSnippetsUsernameEncodedIdRevisionPatch", "summary": "Returns the patch of the specified commit against its first\nparent.\nNote that this resource is different in functionality from the `diff`\nresource.\nThe differences between a diff and a patch are:\n* patches have a commit header with the username, message, etc\n* diffs support the optional `path=foo/bar.py` query param to filter the\n diff to just that one file diff (not supported for patches)\n* for a merge, the diff will show the diff between the merge commit and\n its first parent (identical to h...(description truncated)", "description": "Returns the patch of the specified commit against its first\nparent.\nNote that this resource is different in functionality from the `diff`\nresource.\nThe differences between a diff and a patch are:\n* patches have a commit header with the username, message, etc\n* diffs support the optional `path=foo/bar.py` query param to filter the\n diff to just that one file diff (not supported for patches)\n* for a merge, the diff will show the diff between the merge commit and\n its first parent (identical to h...(description truncated)", "input": [ { "name": "username", "type": "string", "info": "", "required": true, "schema": { "title": "username", "type": "string" } }, { "name": "encodedId", "type": "string", "info": "The snippet id.", "required": true, "schema": { "title": "encodedId", "type": "string" } }, { "name": "revision", "type": "string", "info": "A revspec expression. This can simply be a commit SHA1, a ref name, or a compare expression like `staging..production`.", "required": true, "schema": { "title": "revision", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getSnippetsUsernameEncodedIdRevisionPatch" }, "task": true }, { "name": "getTeamsOwnerProjects", "summary": "", "description": "", "input": [ { "name": "owner", "type": "string", "info": "The team which owns the project. This can either be the `username` of\nthe team or the `UUID` of the team (surrounded by curly-braces (`{}`)).", "required": true, "schema": { "title": "owner", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getTeamsOwnerProjects" }, "task": true }, { "name": "postTeamsOwnerProjects", "summary": "Creates a new project.\nNote that the avatar has to be embedded as either a data-url\nor a URL to an external image as shown in the examples below:\n```\n$ body=$(cat << EOF\n{\n \"name\": \"Mars Project\",\n \"key\": \"MARS\",\n \"description\": \"Software for colonizing mars.\",\n \"links\": {\n \"avatar\": {\n \"href\": \"data:image/gif;base64,R0lGODlhEAAQAMQAAORHHOVSKudfOulrSOp3WOyDZu6QdvCchPGolfO0o/...\"\n }\n },\n \"is_private\": false\n}\nEOF\n)\n$ curl -H \"Content-Type: application/js...(description truncated)", "description": "Creates a new project.\nNote that the avatar has to be embedded as either a data-url\nor a URL to an external image as shown in the examples below:\n```\n$ body=$(cat << EOF\n{\n \"name\": \"Mars Project\",\n \"key\": \"MARS\",\n \"description\": \"Software for colonizing mars.\",\n \"links\": {\n \"avatar\": {\n \"href\": \"data:image/gif;base64,R0lGODlhEAAQAMQAAORHHOVSKudfOulrSOp3WOyDZu6QdvCchPGolfO0o/...\"\n }\n },\n \"is_private\": false\n}\nEOF\n)\n$ curl -H \"Content-Type: application/js...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The team which owns the project. This can either be the `username` of\nthe team or the `UUID` of the team (surrounded by curly-braces (`{}`)).", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postTeamsOwnerProjects" }, "task": true }, { "name": "deleteTeamsOwnerProjectsProjectKey", "summary": "", "description": "", "input": [ { "name": "owner", "type": "string", "info": "The team which owns the project. This can either be the `username` of\nthe team or the `UUID` of the team (surrounded by curly-braces (`{}`)).", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "projectKey", "type": "string", "info": "The project in question. This can either be the actual `key` assigned\nto the project or the `UUID` (surrounded by curly-braces (`{}`)).", "required": true, "schema": { "title": "projectKey", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTeamsOwnerProjectsProjectKey" }, "task": true }, { "name": "getTeamsOwnerProjectsProjectKey", "summary": "", "description": "", "input": [ { "name": "owner", "type": "string", "info": "The team which owns the project. This can either be the `username` of\nthe team or the `UUID` of the team (surrounded by curly-braces (`{}`)).", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "projectKey", "type": "string", "info": "The project in question. This can either be the actual `key` assigned\nto the project or the `UUID` (surrounded by curly-braces (`{}`)).", "required": true, "schema": { "title": "projectKey", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getTeamsOwnerProjectsProjectKey" }, "task": true }, { "name": "putTeamsOwnerProjectsProjectKey", "summary": "Since this endpoint can be used to both update and to create a\nproject, the request body depends on the intent.\n### Creation\nSee the POST documentation for the project collection for an\nexample of the request body.\nNote: The `key` should not be specified in the body of request\n(since it is already present in the URL). The `name` is required,\neverything else is optional.\n### Update\nSee the POST documentation for the project collection for an\nexample of the request body.\nNote: The key is not requi...(description truncated)", "description": "Since this endpoint can be used to both update and to create a\nproject, the request body depends on the intent.\n### Creation\nSee the POST documentation for the project collection for an\nexample of the request body.\nNote: The `key` should not be specified in the body of request\n(since it is already present in the URL). The `name` is required,\neverything else is optional.\n### Update\nSee the POST documentation for the project collection for an\nexample of the request body.\nNote: The key is not requi...(description truncated)", "input": [ { "name": "owner", "type": "string", "info": "The team which owns the project. This can either be the `username` of\nthe team or the `UUID` of the team (surrounded by curly-braces (`{}`)).", "required": true, "schema": { "title": "owner", "type": "string" } }, { "name": "projectKey", "type": "string", "info": "The project in question. This can either be the actual `key` assigned\nto the project or the `UUID` (surrounded by curly-braces (`{}`)).", "required": true, "schema": { "title": "projectKey", "type": "string" } }, { "name": "body", "type": "object", "info": "", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putTeamsOwnerProjectsProjectKey" }, "task": true } ] }