Created
March 5, 2019 15:20
-
-
Save sowderca/01602cd77bd4ec503a81684500db09a3 to your computer and use it in GitHub Desktop.
Azure DevOps spec
This file has been truncated, but you can view the full file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "openapi" : "3.0.1", | |
| "info" : { | |
| "title" : "Azure DevOps", | |
| "description" : "Azure DevOps REST APIs", | |
| "termsOfService" : "https://go.microsoft.com/fwlink/?LinkId=329770", | |
| "contact" : { | |
| "name" : "nugetvss", | |
| "email" : "nugetvss@microsoft.com" | |
| }, | |
| "license" : { | |
| "name" : "MICROSOFT SOFTWARE LICENSE TERMS", | |
| "url" : "https://go.microsoft.com/fwlink/?LinkId=329770" | |
| }, | |
| "version" : "5.0" | |
| }, | |
| "externalDocs" : { | |
| "description" : "Azure DevOps REST APIs", | |
| "url" : "https://aka.ms/azure-devops-rest-apis" | |
| }, | |
| "servers" : [ { | |
| "url" : "https://dev.azure.com/" | |
| } ], | |
| "security" : [ { | |
| "accessToken" : [ ] | |
| } ], | |
| "tags" : [ { | |
| "name" : "Backlogconfiguration" | |
| }, { | |
| "name" : "Backlogs" | |
| }, { | |
| "name" : "Boardcolumns" | |
| }, { | |
| "name" : "Boardparents" | |
| }, { | |
| "name" : "Boardrows" | |
| }, { | |
| "name" : "Boards" | |
| }, { | |
| "name" : "Boardusersettings" | |
| }, { | |
| "name" : "Capacities" | |
| }, { | |
| "name" : "Cardrulesettings" | |
| }, { | |
| "name" : "Cardsettings" | |
| }, { | |
| "name" : "Charts" | |
| }, { | |
| "name" : "Columns" | |
| }, { | |
| "name" : "Deliverytimeline" | |
| }, { | |
| "name" : "Iterations" | |
| }, { | |
| "name" : "Plans", | |
| "description" : "Controller for the Scaled Agile plans REST API" | |
| }, { | |
| "name" : "Processconfiguration" | |
| }, { | |
| "name" : "Rows" | |
| }, { | |
| "name" : "Teamdaysoff" | |
| }, { | |
| "name" : "Teamfieldvalues" | |
| }, { | |
| "name" : "Teamsettings" | |
| } ], | |
| "paths" : { | |
| "/_apis/accounts" : { | |
| "get" : { | |
| "tags" : [ "Accounts" ], | |
| "description" : "Get a list of accounts for a specific owner or a specific member.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "ownerId", | |
| "in" : "query", | |
| "description" : "ID for the owner of the accounts.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "memberId", | |
| "in" : "query", | |
| "description" : "ID for a member of the accounts.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "properties", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/Account" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.profile" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "accounts", | |
| "x-ms-vss-method" : "GetAccounts", | |
| "x-ms-examples" : { | |
| "By owner" : { | |
| "$ref" : "./httpExamples/Accounts/GET__Accounts_ownerId-_userId_.json" | |
| }, | |
| "By member" : { | |
| "$ref" : "./httpExamples/Accounts/GET__Accounts_memberId-_userId_.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/feedchanges" : { | |
| "get" : { | |
| "tags" : [ "Change Tracking" ], | |
| "description" : "Query to determine which feeds have changed since the last call, tracked through the provided continuationToken. Only changes to a feed itself are returned and impact the continuationToken, not additions or alterations to packages within the feeds.", | |
| "operationId" : "Get Feed Changes", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "includeDeleted", | |
| "in" : "query", | |
| "description" : "If true, get changes for all feeds including deleted feeds. The default value is false.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "continuationToken", | |
| "in" : "query", | |
| "description" : "A continuation token which acts as a bookmark to a previously retrieved change. This token allows the user to continue retrieving changes in batches, picking up where the previous batch left off. If specified, all the changes that occur strictly after the token will be returned. If not specified or 0, iteration will start with the first change.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int64" | |
| } | |
| }, { | |
| "name" : "batchSize", | |
| "in" : "query", | |
| "description" : "Number of package changes to fetch. The default value is 1000. The maximum value is 2000.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/FeedChangesResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "feedChanges", | |
| "x-ms-vss-method" : "GetFeedChanges", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/feedchanges/{feedId}" : { | |
| "get" : { | |
| "tags" : [ "Change Tracking" ], | |
| "description" : "Query a feed to determine its current state.", | |
| "operationId" : "Get Feed Change", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/FeedChange" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "feedChanges", | |
| "x-ms-vss-method" : "GetFeedChange", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/feeds" : { | |
| "get" : { | |
| "tags" : [ "Feed Management" ], | |
| "description" : "Get all feeds in an account where you have the provided role access.", | |
| "operationId" : "Get Feeds", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedRole", | |
| "in" : "query", | |
| "description" : "Filter by this role, either Administrator(4), Contributor(3), or Reader(2) level permissions.", | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "custom", "none", "reader", "contributor", "administrator", "collaborator" ], | |
| "x-ms-enum" : { | |
| "name" : "FeedRole", | |
| "values" : [ { | |
| "value" : "custom", | |
| "description" : "Unsupported." | |
| }, { | |
| "value" : "none", | |
| "description" : "Unsupported." | |
| }, { | |
| "value" : "reader", | |
| "description" : "Readers can only read packages and view settings." | |
| }, { | |
| "value" : "contributor", | |
| "description" : "Contributors can do anything to packages in the feed including adding new packages, but they may not modify feed settings." | |
| }, { | |
| "value" : "administrator", | |
| "description" : "Administrators have total control over the feed." | |
| }, { | |
| "value" : "collaborator", | |
| "description" : "Collaborators have the same permissions as readers, but can also ingest packages from configured upstream sources." | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "FeedRole", | |
| "values" : [ { | |
| "value" : "custom", | |
| "description" : "Unsupported." | |
| }, { | |
| "value" : "none", | |
| "description" : "Unsupported." | |
| }, { | |
| "value" : "reader", | |
| "description" : "Readers can only read packages and view settings." | |
| }, { | |
| "value" : "contributor", | |
| "description" : "Contributors can do anything to packages in the feed including adding new packages, but they may not modify feed settings." | |
| }, { | |
| "value" : "administrator", | |
| "description" : "Administrators have total control over the feed." | |
| }, { | |
| "value" : "collaborator", | |
| "description" : "Collaborators have the same permissions as readers, but can also ingest packages from configured upstream sources." | |
| } ] | |
| } | |
| }, { | |
| "name" : "includeDeletedUpstreams", | |
| "in" : "query", | |
| "description" : "Include upstreams that have been deleted in the response.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/Feed" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "feeds", | |
| "x-ms-vss-method" : "GetFeeds", | |
| "x-ms-preview" : true | |
| }, | |
| "post" : { | |
| "tags" : [ "Feed Management" ], | |
| "description" : "Create a feed, a container for various package types.", | |
| "operationId" : "Create Feed", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "A JSON object containing both required and optional attributes for the feed. Name is the only required value.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Feed" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Feed" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_write" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "feeds", | |
| "x-ms-vss-method" : "CreateFeed", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/feeds/{feedId}" : { | |
| "get" : { | |
| "tags" : [ "Feed Management" ], | |
| "description" : "Get the settings for a specific feed.", | |
| "operationId" : "Get Feed", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or Id of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "includeDeletedUpstreams", | |
| "in" : "query", | |
| "description" : "Include upstreams that have been deleted in the response.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Feed" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "feeds", | |
| "x-ms-vss-method" : "GetFeed", | |
| "x-ms-preview" : true | |
| }, | |
| "delete" : { | |
| "tags" : [ "Feed Management" ], | |
| "description" : "Remove a feed and all its packages. The action does not result in packages moving to the RecycleBin and is not reversible.", | |
| "operationId" : "Delete Feed", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or Id of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "feeds", | |
| "x-ms-vss-method" : "DeleteFeed", | |
| "x-ms-preview" : true | |
| }, | |
| "patch" : { | |
| "tags" : [ "Feed Management" ], | |
| "description" : "Change the attributes of a feed.", | |
| "operationId" : "Update Feed", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or Id of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "A JSON object containing the feed settings to be updated.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/FeedUpdate" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Feed" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "feeds", | |
| "x-ms-vss-method" : "UpdateFeed", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/Feeds/{feedId}/packagechanges" : { | |
| "get" : { | |
| "tags" : [ "Change Tracking" ], | |
| "description" : "Get a batch of package changes made to a feed. The changes returned are 'most recent change' so if an Add is followed by an Update before you begin enumerating, you'll only see one change in the batch. While consuming batches using the continuation token, you may see changes to the same package version multiple times if they are happening as you enumerate.", | |
| "operationId" : "Get Package Changes", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or Id of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "continuationToken", | |
| "in" : "query", | |
| "description" : "A continuation token which acts as a bookmark to a previously retrieved change. This token allows the user to continue retrieving changes in batches, picking up where the previous batch left off. If specified, all the changes that occur strictly after the token will be returned. If not specified or 0, iteration will start with the first change.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int64" | |
| } | |
| }, { | |
| "name" : "batchSize", | |
| "in" : "query", | |
| "description" : "Number of package changes to fetch. The default value is 1000. The maximum value is 2000.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/PackageChangesResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "packageChanges", | |
| "x-ms-vss-method" : "GetPackageChanges", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/Feeds/{feedId}/packages" : { | |
| "get" : { | |
| "tags" : [ "Artifact Details" ], | |
| "description" : "Get details about all of the packages in the feed. Use the various filters to include or exclude information from the result set.", | |
| "operationId" : "Get Packages", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or Id of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "protocolType", | |
| "in" : "query", | |
| "description" : "One of the supported artifact package types.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageNameQuery", | |
| "in" : "query", | |
| "description" : "Filter to packages that contain the provided string. Characters in the string must conform to the package name constraints.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "normalizedPackageName", | |
| "in" : "query", | |
| "description" : "[Obsolete] Used for legacy scenarios and may be removed in future versions.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "includeUrls", | |
| "in" : "query", | |
| "description" : "True to return REST Urls with the response. Default is True.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "includeAllVersions", | |
| "in" : "query", | |
| "description" : "True to return all versions of the package in the response. Default is false (latest version only).", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "isListed", | |
| "in" : "query", | |
| "description" : "Only applicable for NuGet packages, setting it for other package types will result in a 404. If false, delisted package versions will be returned. Use this to filter the response when includeAllVersions is set to true. Default is unset (do not return delisted packages).", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "getTopPackageVersions", | |
| "in" : "query", | |
| "description" : "Changes the behavior of $top and $skip to return all versions of each package up to $top. Must be used in conjunction with includeAllVersions=true", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "isRelease", | |
| "in" : "query", | |
| "description" : "Only applicable for Nuget packages. Use this to filter the response when includeAllVersions is set to true. Default is True (only return packages without prerelease versioning).", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "includeDescription", | |
| "in" : "query", | |
| "description" : "Return the description for every version of each package in the response. Default is False.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "$top", | |
| "in" : "query", | |
| "description" : "Get the top N packages (or package versions where getTopPackageVersions=true)", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "$skip", | |
| "in" : "query", | |
| "description" : "Skip the first N packages (or package versions where getTopPackageVersions=true)", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "includeDeleted", | |
| "in" : "query", | |
| "description" : "Return deleted or unpublished versions of packages in the response. Default is False.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "isCached", | |
| "in" : "query", | |
| "description" : "[Obsolete] Used for legacy scenarios and may be removed in future versions.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "directUpstreamId", | |
| "in" : "query", | |
| "description" : "Filter results to return packages from a specific upstream.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/Package" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "packages", | |
| "x-ms-vss-method" : "GetPackages", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/Feeds/{feedId}/packages/{packageId}" : { | |
| "get" : { | |
| "tags" : [ "Artifact Details" ], | |
| "description" : "Get details about a specific package.", | |
| "operationId" : "Get Package", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or Id of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageId", | |
| "in" : "path", | |
| "description" : "The package Id (GUID Id, not the package name).", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "includeAllVersions", | |
| "in" : "query", | |
| "description" : "True to return all versions of the package in the response. Default is false (latest version only).", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "includeUrls", | |
| "in" : "query", | |
| "description" : "True to return REST Urls with the response. Default is True.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "isListed", | |
| "in" : "query", | |
| "description" : "Only applicable for NuGet packages, setting it for other package types will result in a 404. If false, delisted package versions will be returned. Use this to filter the response when includeAllVersions is set to true. Default is unset (do not return delisted packages).", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "isRelease", | |
| "in" : "query", | |
| "description" : "Only applicable for Nuget packages. Use this to filter the response when includeAllVersions is set to true. Default is True (only return packages without prerelease versioning).", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "includeDeleted", | |
| "in" : "query", | |
| "description" : "Return deleted or unpublished versions of packages in the response. Default is False.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "includeDescription", | |
| "in" : "query", | |
| "description" : "Return the description for every version of each package in the response. Default is False.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Package" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "packages", | |
| "x-ms-vss-method" : "GetPackage", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/Feeds/{feedId}/Packages/{packageId}/versions" : { | |
| "get" : { | |
| "tags" : [ "Artifact Details" ], | |
| "description" : "Get a list of package versions, optionally filtering by state.", | |
| "operationId" : "Get Package Versions", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or Id of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageId", | |
| "in" : "path", | |
| "description" : "Id of the package (GUID Id, not name).", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "includeUrls", | |
| "in" : "query", | |
| "description" : "True to include urls for each version. Default is true.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "isListed", | |
| "in" : "query", | |
| "description" : "Only applicable for NuGet packages. If false, delisted package versions will be returned.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "isDeleted", | |
| "in" : "query", | |
| "description" : "Return deleted or unpublished versions of packages in the response. Default is unset (do not return deleted versions).", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/PackageVersion" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "versions", | |
| "x-ms-vss-method" : "GetPackageVersions", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/Feeds/{feedId}/Packages/{packageId}/versions/{packageVersionId}" : { | |
| "get" : { | |
| "tags" : [ "Artifact Details" ], | |
| "description" : "Get details about a specific package version.", | |
| "operationId" : "Get Package Version", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or Id of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageId", | |
| "in" : "path", | |
| "description" : "Id of the package (GUID Id, not name).", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersionId", | |
| "in" : "path", | |
| "description" : "Id of the package version (GUID Id, not name).", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "includeUrls", | |
| "in" : "query", | |
| "description" : "True to include urls for each version. Default is true.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "isListed", | |
| "in" : "query", | |
| "description" : "Only applicable for NuGet packages. If false, delisted package versions will be returned.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "isDeleted", | |
| "in" : "query", | |
| "description" : "Return deleted or unpublished versions of packages in the response. Default is unset (do not return deleted versions).", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/PackageVersion" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "versions", | |
| "x-ms-vss-method" : "GetPackageVersion", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/Feeds/{feedId}/Packages/{packageId}/Versions/{packageVersionId}/provenance" : { | |
| "get" : { | |
| "tags" : [ "Artifact Details" ], | |
| "description" : "Gets provenance for a package version.", | |
| "operationId" : "GetPackageVersionProvenance", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or Id of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageId", | |
| "in" : "path", | |
| "description" : "Id of the package (GUID Id, not name).", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "packageVersionId", | |
| "in" : "path", | |
| "description" : "Id of the package version (GUID Id, not name).", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/PackageVersionProvenance" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "provenance", | |
| "x-ms-vss-method" : "GetPackageVersionProvenance", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/Feeds/{feedId}/permissions" : { | |
| "get" : { | |
| "tags" : [ "Feed Management" ], | |
| "description" : "Get the permissions for a feed.", | |
| "operationId" : "Get Feed Permissions", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or Id of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "includeIds", | |
| "in" : "query", | |
| "description" : "True to include user Ids in the response. Default is false.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "excludeInheritedPermissions", | |
| "in" : "query", | |
| "description" : "True to only return explicitly set permissions on the feed. Default is false.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "identityDescriptor", | |
| "in" : "query", | |
| "description" : "Filter permissions to the provided identity.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/FeedPermission" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "permissions", | |
| "x-ms-vss-method" : "GetFeedPermissions", | |
| "x-ms-preview" : true | |
| }, | |
| "patch" : { | |
| "tags" : [ "Feed Management" ], | |
| "description" : "Update the permissions on a feed.", | |
| "operationId" : "Set Feed Permissions", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or Id of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Permissions to set.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/FeedPermission" | |
| } | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/FeedPermission" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "permissions", | |
| "x-ms-vss-method" : "SetFeedPermissions", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/Feeds/{feedId}/RecycleBin/Packages" : { | |
| "get" : { | |
| "tags" : [ "Recycle Bin" ], | |
| "description" : "Query for packages within the recycle bin.", | |
| "operationId" : "Get Recycle Bin Packages", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or Id of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "protocolType", | |
| "in" : "query", | |
| "description" : "Type of package (e.g. NuGet, npm, ...).", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageNameQuery", | |
| "in" : "query", | |
| "description" : "Filter to packages matching this name.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "includeUrls", | |
| "in" : "query", | |
| "description" : "True to return REST Urls with the response. Default is True.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "$top", | |
| "in" : "query", | |
| "description" : "Get the top N packages.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "$skip", | |
| "in" : "query", | |
| "description" : "Skip the first N packages.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "includeAllVersions", | |
| "in" : "query", | |
| "description" : "True to return all versions of the package in the response. Default is false (latest version only).", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/Package" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "recycleBinPackages", | |
| "x-ms-vss-method" : "GetRecycleBinPackages", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/Feeds/{feedId}/RecycleBin/Packages/{packageId}" : { | |
| "get" : { | |
| "tags" : [ "Recycle Bin" ], | |
| "description" : "Get information about a package and all its versions within the recycle bin.", | |
| "operationId" : "Get Recycle Bin Package", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or Id of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageId", | |
| "in" : "path", | |
| "description" : "The package Id (GUID Id, not the package name).", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "includeUrls", | |
| "in" : "query", | |
| "description" : "True to return REST Urls with the response. Default is True.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Package" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "recycleBinPackages", | |
| "x-ms-vss-method" : "GetRecycleBinPackage", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/Feeds/{feedId}/RecycleBin/Packages/{packageId}/Versions" : { | |
| "get" : { | |
| "tags" : [ "Recycle Bin" ], | |
| "description" : "Get a list of package versions within the recycle bin.", | |
| "operationId" : "Get Recycle Bin Package Versions", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or Id of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageId", | |
| "in" : "path", | |
| "description" : "The package Id (GUID Id, not the package name).", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "includeUrls", | |
| "in" : "query", | |
| "description" : "True to return REST Urls with the response. Default is True.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/RecycleBinPackageVersion" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "recycleBinVersions", | |
| "x-ms-vss-method" : "GetRecycleBinPackageVersions", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/Feeds/{feedId}/RecycleBin/Packages/{packageId}/Versions/{packageVersionId}" : { | |
| "get" : { | |
| "tags" : [ "Recycle Bin" ], | |
| "description" : "Get information about a package version within the recycle bin.", | |
| "operationId" : "Get Recycle Bin Package Version", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or Id of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageId", | |
| "in" : "path", | |
| "description" : "The package Id (GUID Id, not the package name).", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "packageVersionId", | |
| "in" : "path", | |
| "description" : "The package version Id 9guid Id, not the version string).", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "includeUrls", | |
| "in" : "query", | |
| "description" : "True to return REST Urls with the response. Default is True.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/RecycleBinPackageVersion" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "recycleBinVersions", | |
| "x-ms-vss-method" : "GetRecycleBinPackageVersion", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/Feeds/{feedId}/retentionpolicies" : { | |
| "get" : { | |
| "tags" : [ "Retention Policies" ], | |
| "description" : "Get the retention policy for a feed.", | |
| "operationId" : "Get Retention Policy", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/FeedRetentionPolicy" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "retentionPolicies", | |
| "x-ms-vss-method" : "GetFeedRetentionPolicies", | |
| "x-ms-preview" : true | |
| }, | |
| "put" : { | |
| "tags" : [ "Retention Policies" ], | |
| "description" : "Set the retention policy for a feed.", | |
| "operationId" : "Set Retention Policy", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Feed retention policy.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/FeedRetentionPolicy" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/FeedRetentionPolicy" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_write" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "retentionPolicies", | |
| "x-ms-vss-method" : "SetFeedRetentionPolicies", | |
| "x-ms-preview" : true | |
| }, | |
| "delete" : { | |
| "tags" : [ "Retention Policies" ], | |
| "description" : "Delete the retention policy for a feed.", | |
| "operationId" : "Delete Retention Policy", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "retentionPolicies", | |
| "x-ms-vss-method" : "DeleteFeedRetentionPolicies", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/Feeds/{feedId}/views" : { | |
| "get" : { | |
| "tags" : [ "Feed Management" ], | |
| "description" : "Get all views for a feed.", | |
| "operationId" : "Get Feed Views", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or Id of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/FeedView" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "views", | |
| "x-ms-vss-method" : "GetFeedViews", | |
| "x-ms-preview" : true | |
| }, | |
| "post" : { | |
| "tags" : [ "Feed Management" ], | |
| "description" : "Create a new view on the referenced feed.", | |
| "operationId" : "Create Feed View", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or Id of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "View to be created.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/FeedView" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/FeedView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_write" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "views", | |
| "x-ms-vss-method" : "CreateFeedView", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/Feeds/{feedId}/views/{viewId}" : { | |
| "get" : { | |
| "tags" : [ "Feed Management" ], | |
| "description" : "Get a view by Id.", | |
| "operationId" : "Get Feed View", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or Id of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "viewId", | |
| "in" : "path", | |
| "description" : "Name or Id of the view.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/FeedView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "views", | |
| "x-ms-vss-method" : "GetFeedView", | |
| "x-ms-preview" : true | |
| }, | |
| "delete" : { | |
| "tags" : [ "Feed Management" ], | |
| "description" : "Delete a feed view.", | |
| "operationId" : "Delete Feed View", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or Id of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "viewId", | |
| "in" : "path", | |
| "description" : "Name or Id of the view.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "views", | |
| "x-ms-vss-method" : "DeleteFeedView", | |
| "x-ms-preview" : true | |
| }, | |
| "patch" : { | |
| "tags" : [ "Feed Management" ], | |
| "description" : "Update a view.", | |
| "operationId" : "Update Feed View", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or Id of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "viewId", | |
| "in" : "path", | |
| "description" : "Name or Id of the view.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "New settings to apply to the specified view.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/FeedView" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/FeedView" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "views", | |
| "x-ms-vss-method" : "UpdateFeedView", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/globalpermissions" : { | |
| "get" : { | |
| "tags" : [ "Service Settings" ], | |
| "description" : "Get all service-wide feed creation permissions.", | |
| "operationId" : "GetGlobalPermissions", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/GlobalPermission" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "globalPermissions", | |
| "x-ms-vss-method" : "GetGlobalPermissions", | |
| "x-ms-preview" : true | |
| }, | |
| "patch" : { | |
| "tags" : [ "Service Settings" ], | |
| "description" : "Set service-wide permissions that govern feed creation.", | |
| "operationId" : "SetGlobalPermissions", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "New permissions for the organization.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/GlobalPermission" | |
| } | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/GlobalPermission" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "globalPermissions", | |
| "x-ms-vss-method" : "SetGlobalPermissions", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/public/packaging/Feeds/{feedId}/Packages/{packageId}/badge" : { | |
| "get" : { | |
| "tags" : [ "Artifact Details" ], | |
| "description" : "Generate a SVG badge for the latest version of a package. The generated SVG is typically used as the image in an HTML link which takes users to the feed containing the package to accelerate discovery and consumption.", | |
| "operationId" : "Get Badge", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or Id of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageId", | |
| "in" : "path", | |
| "description" : "Id of the package (GUID Id, not name).", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "badge", | |
| "x-ms-vss-method" : "GetBadge", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/provenance/session/{protocol}" : { | |
| "post" : { | |
| "tags" : [ "Provenance" ], | |
| "description" : "Creates a session, a wrapper around a feed that can store additional metadata on the packages published to it.", | |
| "operationId" : "CreateSession", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "protocol", | |
| "in" : "path", | |
| "description" : "The protocol that the session will target", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "The feed and metadata for the session", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/SessionRequest" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/SessionResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "session", | |
| "x-ms-vss-method" : "CreateSession", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/feeds/{feed}/maven/groups/{groupId}/artifacts/{artifactId}/versions/{version}" : { | |
| "get" : { | |
| "tags" : [ "Maven" ], | |
| "description" : "Get information about a package version.", | |
| "operationId" : "Get Package Version", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feed", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "groupId", | |
| "in" : "path", | |
| "description" : "Group ID of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "artifactId", | |
| "in" : "path", | |
| "description" : "Artifact ID of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "version", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "showDeleted", | |
| "in" : "query", | |
| "description" : "True to show information for deleted packages.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Package" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "versions", | |
| "x-ms-vss-method" : "GetPackageVersion", | |
| "x-ms-preview" : true | |
| }, | |
| "delete" : { | |
| "tags" : [ "Maven" ], | |
| "description" : "Delete a package version from the feed and move it to the feed's recycle bin.", | |
| "operationId" : "DeletePackageVersion", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feed", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "groupId", | |
| "in" : "path", | |
| "description" : "Group ID of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "artifactId", | |
| "in" : "path", | |
| "description" : "Artifact ID of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "version", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "202" : { | |
| "description" : "The package has been successfully marked for deletion.", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_write" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "versions", | |
| "x-ms-vss-method" : "PackageDelete", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/feeds/{feed}/maven/RecycleBin/groups/{groupId}/artifacts/{artifactId}/versions/{version}" : { | |
| "get" : { | |
| "tags" : [ "Maven" ], | |
| "description" : "Get information about a package version in the recycle bin.", | |
| "operationId" : "GetPackageVersionFromRecycleBin", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feed", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "groupId", | |
| "in" : "path", | |
| "description" : "Group ID of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "artifactId", | |
| "in" : "path", | |
| "description" : "Artifact ID of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "version", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/MavenPackageVersionDeletionState" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "recycleBinVersions", | |
| "x-ms-vss-method" : "GetPackageVersionMetadataFromRecycleBin", | |
| "x-ms-preview" : true | |
| }, | |
| "delete" : { | |
| "tags" : [ "Maven" ], | |
| "description" : "Permanently delete a package from a feed's recycle bin.", | |
| "operationId" : "DeletePackageVersionFromRecycleBin", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feed", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "groupId", | |
| "in" : "path", | |
| "description" : "Group ID of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "artifactId", | |
| "in" : "path", | |
| "description" : "Artifact ID of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "version", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "recycleBinVersions", | |
| "x-ms-vss-method" : "DeletePackageVersionFromRecycleBin", | |
| "x-ms-preview" : true | |
| }, | |
| "patch" : { | |
| "tags" : [ "Maven" ], | |
| "description" : "Restore a package version from the recycle bin to its associated feed.", | |
| "operationId" : "Restore Package Version From Recycle Bin", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feed", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "groupId", | |
| "in" : "path", | |
| "description" : "Group ID of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "artifactId", | |
| "in" : "path", | |
| "description" : "Artifact ID of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "version", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Set the 'Deleted' property to false to restore the package.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/MavenRecycleBinPackageVersionDetails" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "recycleBinVersions", | |
| "x-ms-vss-method" : "RestorePackageVersionFromRecycleBin", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/feeds/{feedId}/npm/@{packageScope}/{unscopedPackageName}/versions/{packageVersion}" : { | |
| "get" : { | |
| "tags" : [ "Npm" ], | |
| "description" : "Get information about a scoped package version (such as @scope/name).", | |
| "operationId" : "GetScopedPackageVersion", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageScope", | |
| "in" : "path", | |
| "description" : "Scope of the package (the 'scope' part of @scope/name).", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "unscopedPackageName", | |
| "in" : "path", | |
| "description" : "Name of the package (the 'name' part of @scope/name).", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Package" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "versions", | |
| "x-ms-vss-method" : "GetScopedPackageInfoAsync", | |
| "x-ms-preview" : true | |
| }, | |
| "delete" : { | |
| "tags" : [ "Npm" ], | |
| "description" : "Unpublish a scoped package version (such as @scope/name).", | |
| "operationId" : "Unpublish Scoped Package", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageScope", | |
| "in" : "path", | |
| "description" : "Scope of the package (the 'scope' part of @scope/name).", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "unscopedPackageName", | |
| "in" : "path", | |
| "description" : "Name of the package (the 'name' part of @scope/name).", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Package" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "versions", | |
| "x-ms-vss-method" : "UnpublishScopedPackageAsync", | |
| "x-ms-preview" : true | |
| }, | |
| "patch" : { | |
| "tags" : [ "Npm" ], | |
| "operationId" : "Update Scoped Package", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageScope", | |
| "in" : "path", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "unscopedPackageName", | |
| "in" : "path", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/PackageVersionDetails" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Package" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "versions", | |
| "x-ms-vss-method" : "UpdateScopedPackageAsync", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/feeds/{feedId}/npm/{packageName}/versions/{packageVersion}" : { | |
| "get" : { | |
| "tags" : [ "Npm" ], | |
| "description" : "Get information about an unscoped package version.", | |
| "operationId" : "GetPackageVersion", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageName", | |
| "in" : "path", | |
| "description" : "Name of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Package" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "versions", | |
| "x-ms-vss-method" : "GetPackageInfoAsync", | |
| "x-ms-preview" : true | |
| }, | |
| "delete" : { | |
| "tags" : [ "Npm" ], | |
| "description" : "Unpublish an unscoped package version.", | |
| "operationId" : "Unpublish Package", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageName", | |
| "in" : "path", | |
| "description" : "Name of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Package" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "versions", | |
| "x-ms-vss-method" : "UnpublishPackageAsync", | |
| "x-ms-preview" : true | |
| }, | |
| "patch" : { | |
| "tags" : [ "Npm" ], | |
| "operationId" : "Update Package", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageName", | |
| "in" : "path", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/PackageVersionDetails" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Package" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "versions", | |
| "x-ms-vss-method" : "UpdatePackageAsync", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/feeds/{feedId}/npm/packages/@{packageScope}/{unscopedPackageName}/versions/{packageVersion}/content" : { | |
| "get" : { | |
| "tags" : [ "Npm" ], | |
| "operationId" : "DownloadScopedPackage", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageScope", | |
| "in" : "path", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "unscopedPackageName", | |
| "in" : "path", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/octet-stream" : { | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "Stream" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "content", | |
| "x-ms-vss-method" : "GetContentScopedPackageAsync", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/feeds/{feedId}/npm/packages/@{packageScope}/{unscopedPackageName}/versions/{packageVersion}/readme" : { | |
| "get" : { | |
| "tags" : [ "Npm" ], | |
| "description" : "Get the Readme for a package version with an npm scope.", | |
| "operationId" : "GetScopedPackageReadme", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageScope", | |
| "in" : "path", | |
| "description" : "Scope of the package (the 'scope' part of @scope\\name)", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "unscopedPackageName", | |
| "in" : "path", | |
| "description" : "Name of the package (the 'name' part of @scope\\name)", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "text/plain" : { | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "Stream" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "readme", | |
| "x-ms-vss-method" : "GetReadmeScopedPackageAsync", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/feeds/{feedId}/npm/packages/{packageName}/versions/{packageVersion}/content" : { | |
| "get" : { | |
| "tags" : [ "Npm" ], | |
| "description" : "Get an unscoped npm package.", | |
| "operationId" : "DownloadPackage", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageName", | |
| "in" : "path", | |
| "description" : "Name of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/octet-stream" : { | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "Stream" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "content", | |
| "x-ms-vss-method" : "GetContentUnscopedPackageAsync", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/feeds/{feedId}/npm/packages/{packageName}/versions/{packageVersion}/readme" : { | |
| "get" : { | |
| "tags" : [ "Npm" ], | |
| "description" : "Get the Readme for a package version that has no npm scope.", | |
| "operationId" : "GetPackageReadme", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageName", | |
| "in" : "path", | |
| "description" : "Name of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "text/plain" : { | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "Stream" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "readme", | |
| "x-ms-vss-method" : "GetReadmeUnscopedPackageAsync", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/feeds/{feedId}/npm/packagesbatch" : { | |
| "post" : { | |
| "tags" : [ "Npm" ], | |
| "description" : "Update several packages from a single feed in a single request. The updates to the packages do not happen atomically.", | |
| "operationId" : "Update Packages", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Information about the packages to update, the operation to perform, and its associated data.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/NpmPackagesBatchRequest" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_write" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "packagesbatch", | |
| "x-ms-vss-method" : "UpdatePackagesAsync", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/feeds/{feedId}/npm/RecycleBin/packages/@{packageScope}/{unscopedPackageName}/versions/{packageVersion}" : { | |
| "get" : { | |
| "tags" : [ "Npm" ], | |
| "description" : "Get information about a scoped package version in the recycle bin.", | |
| "operationId" : "GetScopedPackageVersionFromRecycleBin", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageScope", | |
| "in" : "path", | |
| "description" : "Scope of the package (the 'scope' part of @scope/name)", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "unscopedPackageName", | |
| "in" : "path", | |
| "description" : "Name of the package (the 'name' part of @scope/name).", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/NpmPackageVersionDeletionState" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "recycleBinVersions", | |
| "x-ms-vss-method" : "GetScopedPackageVersionMetadataFromRecycleBin", | |
| "x-ms-preview" : true | |
| }, | |
| "delete" : { | |
| "tags" : [ "Npm" ], | |
| "description" : "Delete a package version with an npm scope from the recycle bin.", | |
| "operationId" : "Delete Scoped Package Version From Recycle Bin", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageScope", | |
| "in" : "path", | |
| "description" : "Scope of the package (the 'scope' part of @scope/name).", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "unscopedPackageName", | |
| "in" : "path", | |
| "description" : "Name of the package (the 'name' part of @scope/name).", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "recycleBinVersions", | |
| "x-ms-vss-method" : "DeleteScopedPackageVersionFromRecycleBin", | |
| "x-ms-preview" : true | |
| }, | |
| "patch" : { | |
| "tags" : [ "Npm" ], | |
| "description" : "Restore a package version with an npm scope from the recycle bin to its feed.", | |
| "operationId" : "Restore Scoped Package Version From Recycle Bin", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageScope", | |
| "in" : "path", | |
| "description" : "Scope of the package (the 'scope' part of @scope/name).", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "unscopedPackageName", | |
| "in" : "path", | |
| "description" : "Name of the package (the 'name' part of @scope/name).", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/NpmRecycleBinPackageVersionDetails" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "recycleBinVersions", | |
| "x-ms-vss-method" : "RestoreScopedPackageVersionFromRecycleBin", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/feeds/{feedId}/npm/RecycleBin/packages/{packageName}/versions/{packageVersion}" : { | |
| "get" : { | |
| "tags" : [ "Npm" ], | |
| "description" : "Get information about an unscoped package version in the recycle bin.", | |
| "operationId" : "GetPackageVersionFromRecycleBin", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageName", | |
| "in" : "path", | |
| "description" : "Name of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/NpmPackageVersionDeletionState" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "recycleBinVersions", | |
| "x-ms-vss-method" : "GetPackageVersionMetadataFromRecycleBin", | |
| "x-ms-preview" : true | |
| }, | |
| "delete" : { | |
| "tags" : [ "Npm" ], | |
| "description" : "Delete a package version without an npm scope from the recycle bin.", | |
| "operationId" : "Delete Package Version From Recycle Bin", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageName", | |
| "in" : "path", | |
| "description" : "Name of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "recycleBinVersions", | |
| "x-ms-vss-method" : "DeletePackageVersionFromRecycleBin", | |
| "x-ms-preview" : true | |
| }, | |
| "patch" : { | |
| "tags" : [ "Npm" ], | |
| "description" : "Restore a package version without an npm scope from the recycle bin to its feed.", | |
| "operationId" : "Restore Package Version From Recycle Bin", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageName", | |
| "in" : "path", | |
| "description" : "Name of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/NpmRecycleBinPackageVersionDetails" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "recycleBinVersions", | |
| "x-ms-vss-method" : "RestorePackageVersionFromRecycleBin", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/feeds/{feedId}/nuget/packages/{packageName}/versions/{packageVersion}" : { | |
| "get" : { | |
| "tags" : [ "NuGet" ], | |
| "description" : "Get information about a package version.", | |
| "operationId" : "Get Package Version", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageName", | |
| "in" : "path", | |
| "description" : "Name of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "showDeleted", | |
| "in" : "query", | |
| "description" : "True to include deleted packages in the response.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Package" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "versions", | |
| "x-ms-vss-method" : "GetPackageVersion", | |
| "x-ms-preview" : true | |
| }, | |
| "delete" : { | |
| "tags" : [ "NuGet" ], | |
| "description" : "Send a package version from the feed to its paired recycle bin.", | |
| "operationId" : "Delete Package Version", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageName", | |
| "in" : "path", | |
| "description" : "Name of the package to delete.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "description" : "Version of the package to delete.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Package" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "versions", | |
| "x-ms-vss-method" : "DeletePackageVersion", | |
| "x-ms-preview" : true | |
| }, | |
| "patch" : { | |
| "tags" : [ "NuGet" ], | |
| "description" : "Set mutable state on a package version.", | |
| "operationId" : "Update Package Version", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageName", | |
| "in" : "path", | |
| "description" : "Name of the package to update.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "description" : "Version of the package to update.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "New state to apply to the referenced package.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/PackageVersionDetails" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "versions", | |
| "x-ms-vss-method" : "UpdatePackageVersion", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/feeds/{feedId}/nuget/packages/{packageName}/versions/{packageVersion}/content" : { | |
| "get" : { | |
| "tags" : [ "NuGet" ], | |
| "description" : "Download a package version directly. This API is intended for manual UI download options, not for programmatic access and scripting. You may be heavily throttled if accessing this api for scripting purposes.", | |
| "operationId" : "Download Package", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageName", | |
| "in" : "path", | |
| "description" : "Name of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "sourceProtocolVersion", | |
| "in" : "query", | |
| "description" : "Unused", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "Stream" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "content", | |
| "x-ms-vss-method" : "DownloadPackage", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/feeds/{feedId}/nuget/packagesbatch" : { | |
| "post" : { | |
| "tags" : [ "NuGet" ], | |
| "description" : "Update several packages from a single feed in a single request. The updates to the packages do not happen atomically.", | |
| "operationId" : "Update Package Versions", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Information about the packages to update, the operation to perform, and its associated data.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/NuGetPackagesBatchRequest" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_write" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "packagesBatch", | |
| "x-ms-vss-method" : "UpdatePackageVersions", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/feeds/{feedId}/nuget/RecycleBin/packages/{packageName}/versions/{packageVersion}" : { | |
| "get" : { | |
| "tags" : [ "NuGet" ], | |
| "description" : "View a package version's deletion/recycled status", | |
| "operationId" : "GetPackageVersionFromRecycleBin", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageName", | |
| "in" : "path", | |
| "description" : "Name of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/NuGetPackageVersionDeletionState" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "recycleBinVersions", | |
| "x-ms-vss-method" : "GetPackageVersionMetadataFromRecycleBin", | |
| "x-ms-preview" : true | |
| }, | |
| "delete" : { | |
| "tags" : [ "NuGet" ], | |
| "description" : "Delete a package version from a feed's recycle bin.", | |
| "operationId" : "Delete Package Version From Recycle Bin", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageName", | |
| "in" : "path", | |
| "description" : "Name of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "recycleBinVersions", | |
| "x-ms-vss-method" : "DeletePackageVersionFromRecycleBin", | |
| "x-ms-preview" : true | |
| }, | |
| "patch" : { | |
| "tags" : [ "NuGet" ], | |
| "description" : "Restore a package version from a feed's recycle bin back into the active feed.", | |
| "operationId" : "Restore Package Version From Recycle Bin", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageName", | |
| "in" : "path", | |
| "description" : "Name of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Set the 'Deleted' member to 'false' to apply the restore operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/NuGetRecycleBinPackageVersionDetails" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "recycleBinVersions", | |
| "x-ms-vss-method" : "RestorePackageVersionFromRecycleBin", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/feeds/{feedId}/pypi/packages/{packageName}/versions/{packageVersion}" : { | |
| "get" : { | |
| "tags" : [ "Python" ], | |
| "description" : "Get information about a package version.", | |
| "operationId" : "Get Package Version", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageName", | |
| "in" : "path", | |
| "description" : "Name of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "showDeleted", | |
| "in" : "query", | |
| "description" : "True to show information for deleted package versions.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Package" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "versions", | |
| "x-ms-vss-method" : "GetPackageVersion", | |
| "x-ms-preview" : true | |
| }, | |
| "delete" : { | |
| "tags" : [ "Python" ], | |
| "description" : "Delete a package version, moving it to the recycle bin.", | |
| "operationId" : "Delete Package Version", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageName", | |
| "in" : "path", | |
| "description" : "Name of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Package" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "versions", | |
| "x-ms-vss-method" : "DeletePackageVersion", | |
| "x-ms-preview" : true | |
| }, | |
| "patch" : { | |
| "tags" : [ "Python" ], | |
| "description" : "Update state for a package version.", | |
| "operationId" : "Update Package Version", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageName", | |
| "in" : "path", | |
| "description" : "Name of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Details to be updated.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/PackageVersionDetails" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "versions", | |
| "x-ms-vss-method" : "UpdatePackageVersion", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/feeds/{feedId}/pypi/packages/{packageName}/versions/{packageVersion}/{fileName}/content" : { | |
| "get" : { | |
| "tags" : [ "Python" ], | |
| "description" : "Download a python package file directly. This API is intended for manual UI download options, not for programmatic access and scripting.", | |
| "operationId" : "Download Package", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageName", | |
| "in" : "path", | |
| "description" : "Name of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "fileName", | |
| "in" : "path", | |
| "description" : "Name of the file in the package", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "Stream" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "content", | |
| "x-ms-vss-method" : "DownloadPackage", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/feeds/{feedId}/pypi/RecycleBin/packages/{packageName}/versions/{packageVersion}" : { | |
| "get" : { | |
| "tags" : [ "Python" ], | |
| "description" : "Get information about a package version in the recycle bin.", | |
| "operationId" : "GetPackageVersionFromRecycleBin", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageName", | |
| "in" : "path", | |
| "description" : "Name of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/PyPiPackageVersionDeletionState" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "recycleBinVersions", | |
| "x-ms-vss-method" : "GetPackageVersionMetadataFromRecycleBin", | |
| "x-ms-preview" : true | |
| }, | |
| "delete" : { | |
| "tags" : [ "Python" ], | |
| "description" : "Delete a package version from the feed, moving it to the recycle bin.", | |
| "operationId" : "Delete Package Version From Recycle Bin", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageName", | |
| "in" : "path", | |
| "description" : "Name of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "recycleBinVersions", | |
| "x-ms-vss-method" : "DeletePackageVersionFromRecycleBin", | |
| "x-ms-preview" : true | |
| }, | |
| "patch" : { | |
| "tags" : [ "Python" ], | |
| "description" : "Restore a package version from the recycle bin to its associated feed.", | |
| "operationId" : "Restore Package Version From Recycle Bin", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageName", | |
| "in" : "path", | |
| "description" : "Name of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Set the 'Deleted' state to 'false' to restore the package to its feed.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/PyPiRecycleBinPackageVersionDetails" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "recycleBinVersions", | |
| "x-ms-vss-method" : "RestorePackageVersionFromRecycleBin", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/feeds/{feedId}/upack/packages/{packageName}/versions/{packageVersion}" : { | |
| "get" : { | |
| "tags" : [ "Universal" ], | |
| "description" : "Show information about a package version.", | |
| "operationId" : "Get Package Version", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageName", | |
| "in" : "path", | |
| "description" : "Name of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "showDeleted", | |
| "in" : "query", | |
| "description" : "True to show information for deleted versions", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Package" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "versions", | |
| "x-ms-vss-method" : "GetPackageVersion", | |
| "x-ms-preview" : true | |
| }, | |
| "delete" : { | |
| "tags" : [ "Universal" ], | |
| "description" : "Delete a package version from a feed's recycle bin.", | |
| "operationId" : "Delete Package Version", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageName", | |
| "in" : "path", | |
| "description" : "Name of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Package" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "versions", | |
| "x-ms-vss-method" : "DeletePackageVersion", | |
| "x-ms-preview" : true | |
| }, | |
| "patch" : { | |
| "tags" : [ "Universal" ], | |
| "description" : "Update information for a package version.", | |
| "operationId" : "Update Package Version", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageName", | |
| "in" : "path", | |
| "description" : "Name of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/PackageVersionDetails" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "versions", | |
| "x-ms-vss-method" : "UpdatePackageVersion", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/packaging/feeds/{feedId}/upack/RecycleBin/packages/{packageName}/versions/{packageVersion}" : { | |
| "get" : { | |
| "tags" : [ "Universal" ], | |
| "description" : "Get information about a package version in the recycle bin.", | |
| "operationId" : "GetPackageVersionFromRecycleBin", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageName", | |
| "in" : "path", | |
| "description" : "Name of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/UPackPackageVersionDeletionState" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "recycleBinVersions", | |
| "x-ms-vss-method" : "GetPackageVersionMetadataFromRecycleBin", | |
| "x-ms-preview" : true | |
| }, | |
| "delete" : { | |
| "tags" : [ "Universal" ], | |
| "description" : "Delete a package version from the recycle bin.", | |
| "operationId" : "Delete Package Version From Recycle Bin", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageName", | |
| "in" : "path", | |
| "description" : "Name of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "recycleBinVersions", | |
| "x-ms-vss-method" : "DeletePackageVersionFromRecycleBin", | |
| "x-ms-preview" : true | |
| }, | |
| "patch" : { | |
| "tags" : [ "Universal" ], | |
| "description" : "Restore a package version from the recycle bin to its associated feed.", | |
| "operationId" : "Restore Package Version From Recycle Bin", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "feedId", | |
| "in" : "path", | |
| "description" : "Name or ID of the feed.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageName", | |
| "in" : "path", | |
| "description" : "Name of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "packageVersion", | |
| "in" : "path", | |
| "description" : "Version of the package.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Set the 'Deleted' property to 'false' to restore the package.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/UPackRecycleBinPackageVersionDetails" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.packaging_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "recycleBinVersions", | |
| "x-ms-vss-method" : "RestorePackageVersionFromRecycleBin", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/build/controllers" : { | |
| "get" : { | |
| "tags" : [ "Controllers" ], | |
| "description" : "Gets controller, optionally filtered by name", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "name", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/BuildController" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "controllers", | |
| "x-ms-vss-method" : "GetBuildControllers" | |
| } | |
| }, | |
| "/{organization}/_apis/build/controllers/{controllerId}" : { | |
| "get" : { | |
| "tags" : [ "Controllers" ], | |
| "description" : "Gets a controller", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "controllerId", | |
| "in" : "path", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/BuildController" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "controllers", | |
| "x-ms-vss-method" : "GetBuildController" | |
| } | |
| }, | |
| "/{organization}/_apis/build/resourceusage" : { | |
| "get" : { | |
| "tags" : [ "Resource Usage" ], | |
| "description" : "Gets information about build resources in the system.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.2' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/BuildResourceUsage" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0-preview.2", | |
| "x-ms-vss-resource" : "resourceUsage", | |
| "x-ms-vss-method" : "GetResourceUsage", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/public/build/definitions/{project}/{definitionId}/badge" : { | |
| "get" : { | |
| "tags" : [ "Badge" ], | |
| "description" : "Use StatusBadgeController.GetStatusBadge", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "The project ID or name.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "definitionId", | |
| "in" : "path", | |
| "description" : "The ID of the definition.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "branchName", | |
| "in" : "query", | |
| "description" : "The name of the branch.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "deprecated" : true, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "badge", | |
| "x-ms-vss-method" : "GetBadge" | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/authorizedresources" : { | |
| "get" : { | |
| "tags" : [ "Authorizedresources" ], | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "type", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "id", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/DefinitionResourceReference" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "authorizedresources", | |
| "x-ms-vss-method" : "GetProjectResources", | |
| "x-ms-preview" : true | |
| }, | |
| "patch" : { | |
| "tags" : [ "Authorizedresources" ], | |
| "operationId" : "Authorize Project Resources", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/DefinitionResourceReference" | |
| } | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/DefinitionResourceReference" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "authorizedresources", | |
| "x-ms-vss-method" : "AuthorizeProjectResources", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/builds" : { | |
| "get" : { | |
| "tags" : [ "Builds" ], | |
| "description" : "Gets a list of builds.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "definitions", | |
| "in" : "query", | |
| "description" : "A comma-delimited list of definition IDs. If specified, filters to builds for these definitions.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "array (int32)" | |
| } | |
| }, { | |
| "name" : "queues", | |
| "in" : "query", | |
| "description" : "A comma-delimited list of queue IDs. If specified, filters to builds that ran against these queues.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "array (int32)" | |
| } | |
| }, { | |
| "name" : "buildNumber", | |
| "in" : "query", | |
| "description" : "If specified, filters to builds that match this build number. Append * to do a prefix search.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "minTime", | |
| "in" : "query", | |
| "description" : "If specified, filters to builds that finished/started/queued after this date based on the queryOrder specified.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "date-time" | |
| } | |
| }, { | |
| "name" : "maxTime", | |
| "in" : "query", | |
| "description" : "If specified, filters to builds that finished/started/queued before this date based on the queryOrder specified.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "date-time" | |
| } | |
| }, { | |
| "name" : "requestedFor", | |
| "in" : "query", | |
| "description" : "If specified, filters to builds requested for the specified user.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "reasonFilter", | |
| "in" : "query", | |
| "description" : "If specified, filters to builds that match this reason.", | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "none", "manual", "individualCI", "batchedCI", "schedule", "userCreated", "validateShelveset", "checkInShelveset", "pullRequest", "buildCompletion", "triggered", "all" ], | |
| "x-ms-enum" : { | |
| "name" : "BuildReason", | |
| "values" : [ { | |
| "value" : "none", | |
| "description" : "No reason. This value should not be used." | |
| }, { | |
| "value" : "manual", | |
| "description" : "The build was started manually." | |
| }, { | |
| "value" : "individualCI", | |
| "description" : "The build was started for the trigger TriggerType.ContinuousIntegration." | |
| }, { | |
| "value" : "batchedCI", | |
| "description" : "The build was started for the trigger TriggerType.BatchedContinuousIntegration." | |
| }, { | |
| "value" : "schedule", | |
| "description" : "The build was started for the trigger TriggerType.Schedule." | |
| }, { | |
| "value" : "userCreated", | |
| "description" : "The build was created by a user." | |
| }, { | |
| "value" : "validateShelveset", | |
| "description" : "The build was started manually for private validation." | |
| }, { | |
| "value" : "checkInShelveset", | |
| "description" : "The build was started for the trigger ContinuousIntegrationType.Gated." | |
| }, { | |
| "value" : "pullRequest", | |
| "description" : "The build was started by a pull request. Added in resource version 3." | |
| }, { | |
| "value" : "buildCompletion", | |
| "description" : "The build was started when another build completed." | |
| }, { | |
| "value" : "triggered", | |
| "description" : "The build was triggered for retention policy purposes." | |
| }, { | |
| "value" : "all", | |
| "description" : "All reasons." | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "BuildReason", | |
| "values" : [ { | |
| "value" : "none", | |
| "description" : "No reason. This value should not be used." | |
| }, { | |
| "value" : "manual", | |
| "description" : "The build was started manually." | |
| }, { | |
| "value" : "individualCI", | |
| "description" : "The build was started for the trigger TriggerType.ContinuousIntegration." | |
| }, { | |
| "value" : "batchedCI", | |
| "description" : "The build was started for the trigger TriggerType.BatchedContinuousIntegration." | |
| }, { | |
| "value" : "schedule", | |
| "description" : "The build was started for the trigger TriggerType.Schedule." | |
| }, { | |
| "value" : "userCreated", | |
| "description" : "The build was created by a user." | |
| }, { | |
| "value" : "validateShelveset", | |
| "description" : "The build was started manually for private validation." | |
| }, { | |
| "value" : "checkInShelveset", | |
| "description" : "The build was started for the trigger ContinuousIntegrationType.Gated." | |
| }, { | |
| "value" : "pullRequest", | |
| "description" : "The build was started by a pull request. Added in resource version 3." | |
| }, { | |
| "value" : "buildCompletion", | |
| "description" : "The build was started when another build completed." | |
| }, { | |
| "value" : "triggered", | |
| "description" : "The build was triggered for retention policy purposes." | |
| }, { | |
| "value" : "all", | |
| "description" : "All reasons." | |
| } ] | |
| } | |
| }, { | |
| "name" : "statusFilter", | |
| "in" : "query", | |
| "description" : "If specified, filters to builds that match this status.", | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "none", "inProgress", "completed", "cancelling", "postponed", "notStarted", "all" ], | |
| "x-ms-enum" : { | |
| "name" : "BuildStatus", | |
| "values" : [ { | |
| "value" : "none", | |
| "description" : "No status." | |
| }, { | |
| "value" : "inProgress", | |
| "description" : "The build is currently in progress." | |
| }, { | |
| "value" : "completed", | |
| "description" : "The build has completed." | |
| }, { | |
| "value" : "cancelling", | |
| "description" : "The build is cancelling" | |
| }, { | |
| "value" : "postponed", | |
| "description" : "The build is inactive in the queue." | |
| }, { | |
| "value" : "notStarted", | |
| "description" : "The build has not yet started." | |
| }, { | |
| "value" : "all", | |
| "description" : "All status." | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "BuildStatus", | |
| "values" : [ { | |
| "value" : "none", | |
| "description" : "No status." | |
| }, { | |
| "value" : "inProgress", | |
| "description" : "The build is currently in progress." | |
| }, { | |
| "value" : "completed", | |
| "description" : "The build has completed." | |
| }, { | |
| "value" : "cancelling", | |
| "description" : "The build is cancelling" | |
| }, { | |
| "value" : "postponed", | |
| "description" : "The build is inactive in the queue." | |
| }, { | |
| "value" : "notStarted", | |
| "description" : "The build has not yet started." | |
| }, { | |
| "value" : "all", | |
| "description" : "All status." | |
| } ] | |
| } | |
| }, { | |
| "name" : "resultFilter", | |
| "in" : "query", | |
| "description" : "If specified, filters to builds that match this result.", | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "none", "succeeded", "partiallySucceeded", "failed", "canceled" ], | |
| "x-ms-enum" : { | |
| "name" : "BuildResult", | |
| "values" : [ { | |
| "value" : "none", | |
| "description" : "No result" | |
| }, { | |
| "value" : "succeeded", | |
| "description" : "The build completed successfully." | |
| }, { | |
| "value" : "partiallySucceeded", | |
| "description" : "The build completed compilation successfully but had other errors." | |
| }, { | |
| "value" : "failed", | |
| "description" : "The build completed unsuccessfully." | |
| }, { | |
| "value" : "canceled", | |
| "description" : "The build was canceled before starting." | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "BuildResult", | |
| "values" : [ { | |
| "value" : "none", | |
| "description" : "No result" | |
| }, { | |
| "value" : "succeeded", | |
| "description" : "The build completed successfully." | |
| }, { | |
| "value" : "partiallySucceeded", | |
| "description" : "The build completed compilation successfully but had other errors." | |
| }, { | |
| "value" : "failed", | |
| "description" : "The build completed unsuccessfully." | |
| }, { | |
| "value" : "canceled", | |
| "description" : "The build was canceled before starting." | |
| } ] | |
| } | |
| }, { | |
| "name" : "tagFilters", | |
| "in" : "query", | |
| "description" : "A comma-delimited list of tags. If specified, filters to builds that have the specified tags.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "array (string)" | |
| } | |
| }, { | |
| "name" : "properties", | |
| "in" : "query", | |
| "description" : "A comma-delimited list of properties to retrieve.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "array (string)" | |
| } | |
| }, { | |
| "name" : "$top", | |
| "in" : "query", | |
| "description" : "The maximum number of builds to return.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "continuationToken", | |
| "in" : "query", | |
| "description" : "A continuation token, returned by a previous call to this method, that can be used to return the next set of builds.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "maxBuildsPerDefinition", | |
| "in" : "query", | |
| "description" : "The maximum number of builds to return per definition.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "deletedFilter", | |
| "in" : "query", | |
| "description" : "Indicates whether to exclude, include, or only return deleted builds.", | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "excludeDeleted", "includeDeleted", "onlyDeleted" ], | |
| "x-ms-enum" : { | |
| "name" : "QueryDeletedOption", | |
| "values" : [ { | |
| "value" : "excludeDeleted", | |
| "description" : "Include only non-deleted builds." | |
| }, { | |
| "value" : "includeDeleted", | |
| "description" : "Include deleted and non-deleted builds." | |
| }, { | |
| "value" : "onlyDeleted", | |
| "description" : "Include only deleted builds." | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "QueryDeletedOption", | |
| "values" : [ { | |
| "value" : "excludeDeleted", | |
| "description" : "Include only non-deleted builds." | |
| }, { | |
| "value" : "includeDeleted", | |
| "description" : "Include deleted and non-deleted builds." | |
| }, { | |
| "value" : "onlyDeleted", | |
| "description" : "Include only deleted builds." | |
| } ] | |
| } | |
| }, { | |
| "name" : "queryOrder", | |
| "in" : "query", | |
| "description" : "The order in which builds should be returned.", | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "finishTimeAscending", "finishTimeDescending", "queueTimeDescending", "queueTimeAscending", "startTimeDescending", "startTimeAscending" ], | |
| "x-ms-enum" : { | |
| "name" : "BuildQueryOrder", | |
| "values" : [ { | |
| "value" : "finishTimeAscending", | |
| "description" : "Order by finish time ascending." | |
| }, { | |
| "value" : "finishTimeDescending", | |
| "description" : "Order by finish time descending." | |
| }, { | |
| "value" : "queueTimeDescending", | |
| "description" : "Order by queue time descending." | |
| }, { | |
| "value" : "queueTimeAscending", | |
| "description" : "Order by queue time ascending." | |
| }, { | |
| "value" : "startTimeDescending", | |
| "description" : "Order by start time descending." | |
| }, { | |
| "value" : "startTimeAscending", | |
| "description" : "Order by start time ascending." | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "BuildQueryOrder", | |
| "values" : [ { | |
| "value" : "finishTimeAscending", | |
| "description" : "Order by finish time ascending." | |
| }, { | |
| "value" : "finishTimeDescending", | |
| "description" : "Order by finish time descending." | |
| }, { | |
| "value" : "queueTimeDescending", | |
| "description" : "Order by queue time descending." | |
| }, { | |
| "value" : "queueTimeAscending", | |
| "description" : "Order by queue time ascending." | |
| }, { | |
| "value" : "startTimeDescending", | |
| "description" : "Order by start time descending." | |
| }, { | |
| "value" : "startTimeAscending", | |
| "description" : "Order by start time ascending." | |
| } ] | |
| } | |
| }, { | |
| "name" : "branchName", | |
| "in" : "query", | |
| "description" : "If specified, filters to builds that built branches that built this branch.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "buildIds", | |
| "in" : "query", | |
| "description" : "A comma-delimited list that specifies the IDs of builds to retrieve.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "array (int32)" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "query", | |
| "description" : "If specified, filters to builds that built from this repository.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryType", | |
| "in" : "query", | |
| "description" : "If specified, filters to builds that built from repositories of this type.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/Build" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "builds", | |
| "x-ms-vss-method" : "GetBuilds" | |
| }, | |
| "post" : { | |
| "tags" : [ "Builds" ], | |
| "description" : "Queues a build", | |
| "operationId" : "Queue", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "ignoreWarnings", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "checkInTicket", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "sourceBuildId", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Build" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Build" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build_execute" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "builds", | |
| "x-ms-vss-method" : "QueueBuild" | |
| }, | |
| "patch" : { | |
| "tags" : [ "Builds" ], | |
| "description" : "Updates multiple builds.", | |
| "operationId" : "Update Builds", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "The builds to update.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/Build" | |
| } | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/Build" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build_execute" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "builds", | |
| "x-ms-vss-method" : "UpdateBuilds" | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/builds/{buildId}" : { | |
| "get" : { | |
| "tags" : [ "Builds" ], | |
| "description" : "Gets a build", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "buildId", | |
| "in" : "path", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "propertyFilters", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Build" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "builds", | |
| "x-ms-vss-method" : "GetBuild" | |
| }, | |
| "delete" : { | |
| "tags" : [ "Builds" ], | |
| "description" : "Deletes a build.", | |
| "operationId" : "Delete", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "buildId", | |
| "in" : "path", | |
| "description" : "The ID of the build.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build_execute" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "builds", | |
| "x-ms-vss-method" : "DeleteBuild" | |
| }, | |
| "patch" : { | |
| "tags" : [ "Builds" ], | |
| "description" : "Updates a build.", | |
| "operationId" : "Update Build", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "buildId", | |
| "in" : "path", | |
| "description" : "The ID of the build.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "retry", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "The build.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Build" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Build" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build_execute" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "builds", | |
| "x-ms-vss-method" : "UpdateBuild" | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/builds/{buildId}/{timelineId}/{recordId}/attachments/{type}/{name}" : { | |
| "get" : { | |
| "tags" : [ "Attachments" ], | |
| "description" : "Gets a specific attachment.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "buildId", | |
| "in" : "path", | |
| "description" : "The ID of the build.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "timelineId", | |
| "in" : "path", | |
| "description" : "The ID of the timeline.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "recordId", | |
| "in" : "path", | |
| "description" : "The ID of the timeline record.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "type", | |
| "in" : "path", | |
| "description" : "The type of the attachment.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "name", | |
| "in" : "path", | |
| "description" : "The name of the attachment.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.2' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/octet-stream" : { | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "Stream" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.2", | |
| "x-ms-vss-resource" : "attachments", | |
| "x-ms-vss-method" : "GetAttachment", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/builds/{buildId}/artifacts" : { | |
| "get" : { | |
| "tags" : [ "Artifacts" ], | |
| "description" : "Gets all artifacts for a build.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "buildId", | |
| "in" : "path", | |
| "description" : "The ID of the build.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/BuildArtifact" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "artifacts", | |
| "x-ms-vss-method" : "GetArtifacts" | |
| }, | |
| "post" : { | |
| "tags" : [ "Artifacts" ], | |
| "description" : "Associates an artifact with a build.", | |
| "operationId" : "Create", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "buildId", | |
| "in" : "path", | |
| "description" : "The ID of the build.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "The artifact.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/BuildArtifact" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/BuildArtifact" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build_execute" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "artifacts", | |
| "x-ms-vss-method" : "CreateArtifact" | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/builds/{buildId}/attachments/{type}" : { | |
| "get" : { | |
| "tags" : [ "Attachments" ], | |
| "description" : "Gets the list of attachments of a specific type that are associated with a build.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "buildId", | |
| "in" : "path", | |
| "description" : "The ID of the build.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "type", | |
| "in" : "path", | |
| "description" : "The type of attachment.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.2' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/Attachment" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.2", | |
| "x-ms-vss-resource" : "attachments", | |
| "x-ms-vss-method" : "GetAttachments", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/builds/{buildId}/changes" : { | |
| "get" : { | |
| "tags" : [ "Builds" ], | |
| "description" : "Gets the changes associated with a build", | |
| "operationId" : "Get Build Changes", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "buildId", | |
| "in" : "path", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "continuationToken", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "$top", | |
| "in" : "query", | |
| "description" : "The maximum number of changes to return", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "includeSourceChange", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/Change" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "changes", | |
| "x-ms-vss-method" : "GetBuildChanges" | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/builds/{buildId}/logs" : { | |
| "get" : { | |
| "tags" : [ "Builds" ], | |
| "description" : "Gets the logs for a build.", | |
| "operationId" : "Get Build Logs", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "buildId", | |
| "in" : "path", | |
| "description" : "The ID of the build.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/zip" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/BuildLog" | |
| } | |
| } | |
| }, | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/BuildLog" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "logs", | |
| "x-ms-vss-method" : "GetBuildLogs" | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/builds/{buildId}/logs/{logId}" : { | |
| "get" : { | |
| "tags" : [ "Builds" ], | |
| "description" : "Gets an individual log file for a build.", | |
| "operationId" : "Get Build Log", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "buildId", | |
| "in" : "path", | |
| "description" : "The ID of the build.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "logId", | |
| "in" : "path", | |
| "description" : "The ID of the log file.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "startLine", | |
| "in" : "query", | |
| "description" : "The start line.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int64" | |
| } | |
| }, { | |
| "name" : "endLine", | |
| "in" : "query", | |
| "description" : "The end line.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int64" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/zip" : { | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "Stream" | |
| } | |
| }, | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "Stream" | |
| } | |
| }, | |
| "text/plain" : { | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "Stream" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "logs", | |
| "x-ms-vss-method" : "GetBuildLog" | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/builds/{buildId}/properties" : { | |
| "get" : { | |
| "tags" : [ "Properties" ], | |
| "description" : "Gets properties for a build.", | |
| "operationId" : "Get Build Properties", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "buildId", | |
| "in" : "path", | |
| "description" : "The ID of the build.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "filter", | |
| "in" : "query", | |
| "description" : "A comma-delimited list of properties. If specified, filters to these specific properties.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "array (string)" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/PropertiesCollection" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "properties", | |
| "x-ms-vss-method" : "GetBuildProperties", | |
| "x-ms-preview" : true | |
| }, | |
| "patch" : { | |
| "tags" : [ "Properties" ], | |
| "description" : "Updates properties for a build.", | |
| "operationId" : "Update Build Properties", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "buildId", | |
| "in" : "path", | |
| "description" : "The ID of the build.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "A json-patch document describing the properties to update.", | |
| "content" : { | |
| "application/json-patch+json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/JsonPatchDocument" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/PropertiesCollection" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build_execute" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "properties", | |
| "x-ms-vss-method" : "UpdateBuildProperties", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/builds/{buildId}/report" : { | |
| "get" : { | |
| "tags" : [ "Report" ], | |
| "description" : "Gets a build report.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "buildId", | |
| "in" : "path", | |
| "description" : "The ID of the build.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "type", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.2' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "text/html" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/BuildReportMetadata" | |
| } | |
| }, | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/BuildReportMetadata" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.2", | |
| "x-ms-vss-resource" : "report", | |
| "x-ms-vss-method" : "GetBuildReport", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/builds/{buildId}/tags" : { | |
| "get" : { | |
| "tags" : [ "Tags" ], | |
| "description" : "Gets the tags for a build.", | |
| "operationId" : "Get Build Tags", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "buildId", | |
| "in" : "path", | |
| "description" : "The ID of the build.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "tags", | |
| "x-ms-vss-method" : "GetBuildTags" | |
| }, | |
| "post" : { | |
| "tags" : [ "Tags" ], | |
| "description" : "Adds tags to a build.", | |
| "operationId" : "Add Build Tags", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "buildId", | |
| "in" : "path", | |
| "description" : "The ID of the build.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "The tags to add.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build_execute" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "tags", | |
| "x-ms-vss-method" : "AddBuildTags" | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/builds/{buildId}/tags/{tag}" : { | |
| "put" : { | |
| "tags" : [ "Tags" ], | |
| "description" : "Adds a tag to a build.", | |
| "operationId" : "Add Build Tag", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "buildId", | |
| "in" : "path", | |
| "description" : "The ID of the build.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "tag", | |
| "in" : "path", | |
| "description" : "The tag to add.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build_execute" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "tags", | |
| "x-ms-vss-method" : "AddBuildTag" | |
| }, | |
| "delete" : { | |
| "tags" : [ "Tags" ], | |
| "description" : "Removes a tag from a build.", | |
| "operationId" : "Delete Build Tag", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "buildId", | |
| "in" : "path", | |
| "description" : "The ID of the build.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "tag", | |
| "in" : "path", | |
| "description" : "The tag to remove.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build_execute" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "tags", | |
| "x-ms-vss-method" : "DeleteBuildTag" | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/builds/{buildId}/timeline/{timelineId}" : { | |
| "get" : { | |
| "tags" : [ "Timeline" ], | |
| "description" : "Gets details for a build", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "buildId", | |
| "in" : "path", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "timelineId", | |
| "in" : "path", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "changeId", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "planId", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Timeline" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "timeline", | |
| "x-ms-vss-method" : "GetBuildTimeline" | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/builds/{buildId}/workitems" : { | |
| "get" : { | |
| "tags" : [ "Builds" ], | |
| "description" : "Gets the work items associated with a build.", | |
| "operationId" : "Get Build Work Items Refs", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "buildId", | |
| "in" : "path", | |
| "description" : "The ID of the build.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "$top", | |
| "in" : "query", | |
| "description" : "The maximum number of work items to return.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/ResourceRef" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "workitems", | |
| "x-ms-vss-method" : "GetBuildWorkItemsRefs" | |
| }, | |
| "post" : { | |
| "tags" : [ "Builds" ], | |
| "description" : "Gets the work items associated with a build, filtered to specific commits.", | |
| "operationId" : "Get Build Work Items Refs From Commits", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "buildId", | |
| "in" : "path", | |
| "description" : "The ID of the build.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "$top", | |
| "in" : "query", | |
| "description" : "The maximum number of work items to return, or the number of commits to consider if no commit IDs are specified.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "A comma-delimited list of commit IDs.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/ResourceRef" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build_execute" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "workitems", | |
| "x-ms-vss-method" : "GetBuildWorkItemsRefsFromCommits" | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/changes" : { | |
| "get" : { | |
| "tags" : [ "Builds" ], | |
| "description" : "Gets the changes made to the repository between two given builds.", | |
| "operationId" : "Get Changes Between Builds", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "fromBuildId", | |
| "in" : "query", | |
| "description" : "The ID of the first build.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "toBuildId", | |
| "in" : "query", | |
| "description" : "The ID of the last build.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "$top", | |
| "in" : "query", | |
| "description" : "The maximum number of changes to return.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.2' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/Change" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.2", | |
| "x-ms-vss-resource" : "changes", | |
| "x-ms-vss-method" : "GetChangesBetweenBuilds", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/definitions" : { | |
| "get" : { | |
| "tags" : [ "Definitions" ], | |
| "description" : "Gets a list of definitions.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "name", | |
| "in" : "query", | |
| "description" : "If specified, filters to definitions whose names match this pattern.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "query", | |
| "description" : "A repository ID. If specified, filters to definitions that use this repository.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryType", | |
| "in" : "query", | |
| "description" : "If specified, filters to definitions that have a repository of this type.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "queryOrder", | |
| "in" : "query", | |
| "description" : "Indicates the order in which definitions should be returned.", | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "none", "lastModifiedAscending", "lastModifiedDescending", "definitionNameAscending", "definitionNameDescending" ], | |
| "x-ms-enum" : { | |
| "name" : "DefinitionQueryOrder", | |
| "values" : [ { | |
| "value" : "none", | |
| "description" : "No order" | |
| }, { | |
| "value" : "lastModifiedAscending", | |
| "description" : "Order by created on/last modified time ascending." | |
| }, { | |
| "value" : "lastModifiedDescending", | |
| "description" : "Order by created on/last modified time descending." | |
| }, { | |
| "value" : "definitionNameAscending", | |
| "description" : "Order by definition name ascending." | |
| }, { | |
| "value" : "definitionNameDescending", | |
| "description" : "Order by definition name descending." | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "DefinitionQueryOrder", | |
| "values" : [ { | |
| "value" : "none", | |
| "description" : "No order" | |
| }, { | |
| "value" : "lastModifiedAscending", | |
| "description" : "Order by created on/last modified time ascending." | |
| }, { | |
| "value" : "lastModifiedDescending", | |
| "description" : "Order by created on/last modified time descending." | |
| }, { | |
| "value" : "definitionNameAscending", | |
| "description" : "Order by definition name ascending." | |
| }, { | |
| "value" : "definitionNameDescending", | |
| "description" : "Order by definition name descending." | |
| } ] | |
| } | |
| }, { | |
| "name" : "$top", | |
| "in" : "query", | |
| "description" : "The maximum number of definitions to return.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "continuationToken", | |
| "in" : "query", | |
| "description" : "A continuation token, returned by a previous call to this method, that can be used to return the next set of definitions.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "minMetricsTime", | |
| "in" : "query", | |
| "description" : "If specified, indicates the date from which metrics should be included.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "date-time" | |
| } | |
| }, { | |
| "name" : "definitionIds", | |
| "in" : "query", | |
| "description" : "A comma-delimited list that specifies the IDs of definitions to retrieve.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "array (int32)" | |
| } | |
| }, { | |
| "name" : "path", | |
| "in" : "query", | |
| "description" : "If specified, filters to definitions under this folder.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "builtAfter", | |
| "in" : "query", | |
| "description" : "If specified, filters to definitions that have builds after this date.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "date-time" | |
| } | |
| }, { | |
| "name" : "notBuiltAfter", | |
| "in" : "query", | |
| "description" : "If specified, filters to definitions that do not have builds after this date.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "date-time" | |
| } | |
| }, { | |
| "name" : "includeAllProperties", | |
| "in" : "query", | |
| "description" : "Indicates whether the full definitions should be returned. By default, shallow representations of the definitions are returned.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "includeLatestBuilds", | |
| "in" : "query", | |
| "description" : "Indicates whether to return the latest and latest completed builds for this definition.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "taskIdFilter", | |
| "in" : "query", | |
| "description" : "If specified, filters to definitions that use the specified task.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "processType", | |
| "in" : "query", | |
| "description" : "If specified, filters to definitions with the given process type.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "yamlFilename", | |
| "in" : "query", | |
| "description" : "If specified, filters to YAML definitions that match the given filename.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/BuildDefinitionReference" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "definitions", | |
| "x-ms-vss-method" : "GetDefinitions" | |
| }, | |
| "post" : { | |
| "tags" : [ "Definitions" ], | |
| "description" : "Creates a new definition.", | |
| "operationId" : "Create", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "definitionToCloneId", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "definitionToCloneRevision", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "The definition.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/BuildDefinition" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/BuildDefinition" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build_execute" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "definitions", | |
| "x-ms-vss-method" : "CreateDefinition" | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/definitions/{definitionId}" : { | |
| "get" : { | |
| "tags" : [ "Definitions" ], | |
| "description" : "Gets a definition, optionally at a specific revision.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "definitionId", | |
| "in" : "path", | |
| "description" : "The ID of the definition.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "revision", | |
| "in" : "query", | |
| "description" : "The revision number to retrieve. If this is not specified, the latest version will be returned.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "minMetricsTime", | |
| "in" : "query", | |
| "description" : "If specified, indicates the date from which metrics should be included.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "date-time" | |
| } | |
| }, { | |
| "name" : "propertyFilters", | |
| "in" : "query", | |
| "description" : "A comma-delimited list of properties to include in the results.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "array (string)" | |
| } | |
| }, { | |
| "name" : "includeLatestBuilds", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/BuildDefinition" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "definitions", | |
| "x-ms-vss-method" : "GetDefinition" | |
| }, | |
| "put" : { | |
| "tags" : [ "Definitions" ], | |
| "description" : "Updates an existing definition.", | |
| "operationId" : "Update", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "definitionId", | |
| "in" : "path", | |
| "description" : "The ID of the definition.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "secretsSourceDefinitionId", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "secretsSourceDefinitionRevision", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "The new version of the defintion.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/BuildDefinition" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/BuildDefinition" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build_execute" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "definitions", | |
| "x-ms-vss-method" : "UpdateDefinition" | |
| }, | |
| "delete" : { | |
| "tags" : [ "Definitions" ], | |
| "description" : "Deletes a definition and all associated builds.", | |
| "operationId" : "Delete", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "definitionId", | |
| "in" : "path", | |
| "description" : "The ID of the definition.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build_execute" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "definitions", | |
| "x-ms-vss-method" : "DeleteDefinition" | |
| }, | |
| "patch" : { | |
| "tags" : [ "Definitions" ], | |
| "description" : "Restores a deleted definition", | |
| "operationId" : "Restore Definition", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "definitionId", | |
| "in" : "path", | |
| "description" : "The identifier of the definition to restore.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "deleted", | |
| "in" : "query", | |
| "description" : "When false, restores a deleted definition.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/BuildDefinition" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build_execute" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "definitions", | |
| "x-ms-vss-method" : "RestoreDefinition" | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/definitions/{definitionId}/metrics" : { | |
| "get" : { | |
| "tags" : [ "Metrics" ], | |
| "description" : "Gets build metrics for a definition.", | |
| "operationId" : "Get Definition Metrics", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "definitionId", | |
| "in" : "path", | |
| "description" : "The ID of the definition.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "minMetricsTime", | |
| "in" : "query", | |
| "description" : "The date from which to calculate metrics.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "date-time" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/BuildMetric" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "metrics", | |
| "x-ms-vss-method" : "GetDefinitionMetrics", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/definitions/{definitionId}/properties" : { | |
| "get" : { | |
| "tags" : [ "Properties" ], | |
| "description" : "Gets properties for a definition.", | |
| "operationId" : "Get Definition Properties", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "definitionId", | |
| "in" : "path", | |
| "description" : "The ID of the definition.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "filter", | |
| "in" : "query", | |
| "description" : "A comma-delimited list of properties. If specified, filters to these specific properties.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "array (string)" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/PropertiesCollection" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "properties", | |
| "x-ms-vss-method" : "GetDefinitionProperties", | |
| "x-ms-preview" : true | |
| }, | |
| "patch" : { | |
| "tags" : [ "Properties" ], | |
| "description" : "Updates properties for a definition.", | |
| "operationId" : "Update Definition Properties", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "definitionId", | |
| "in" : "path", | |
| "description" : "The ID of the definition.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "A json-patch document describing the properties to update.", | |
| "content" : { | |
| "application/json-patch+json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/JsonPatchDocument" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/PropertiesCollection" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build_execute" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "properties", | |
| "x-ms-vss-method" : "UpdateDefinitionProperties", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/definitions/{definitionId}/resources" : { | |
| "get" : { | |
| "tags" : [ "Resources" ], | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "definitionId", | |
| "in" : "path", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/DefinitionResourceReference" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "resources", | |
| "x-ms-vss-method" : "GetDefinitionResources", | |
| "x-ms-preview" : true | |
| }, | |
| "patch" : { | |
| "tags" : [ "Resources" ], | |
| "operationId" : "Authorize Definition Resources", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "definitionId", | |
| "in" : "path", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/DefinitionResourceReference" | |
| } | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/DefinitionResourceReference" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build_execute" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "resources", | |
| "x-ms-vss-method" : "AuthorizeDefinitionResources", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/definitions/{definitionId}/revisions" : { | |
| "get" : { | |
| "tags" : [ "Definitions" ], | |
| "description" : "Gets all revisions of a definition.", | |
| "operationId" : "Get Definition Revisions", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "definitionId", | |
| "in" : "path", | |
| "description" : "The ID of the definition.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/BuildDefinitionRevision" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "revisions", | |
| "x-ms-vss-method" : "GetDefinitionRevisions" | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/definitions/{DefinitionId}/tags" : { | |
| "get" : { | |
| "tags" : [ "Tags" ], | |
| "description" : "Gets the tags for a definition.", | |
| "operationId" : "Get Definition Tags", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "definitionId", | |
| "in" : "path", | |
| "description" : "The ID of the definition.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "revision", | |
| "in" : "query", | |
| "description" : "The definition revision number. If not specified, uses the latest revision of the definition.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.2' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.2", | |
| "x-ms-vss-resource" : "tags", | |
| "x-ms-vss-method" : "GetDefinitionTags", | |
| "x-ms-preview" : true | |
| }, | |
| "post" : { | |
| "tags" : [ "Tags" ], | |
| "description" : "Adds multiple tags to a definition.", | |
| "operationId" : "Add Definition Tags", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "definitionId", | |
| "in" : "path", | |
| "description" : "The ID of the definition.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.2' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "The tags to add.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build_execute" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.2", | |
| "x-ms-vss-resource" : "tags", | |
| "x-ms-vss-method" : "AddDefinitionTags", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/definitions/{DefinitionId}/tags/{tag}" : { | |
| "put" : { | |
| "tags" : [ "Tags" ], | |
| "description" : "Adds a tag to a definition", | |
| "operationId" : "Add Definition Tag", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "definitionId", | |
| "in" : "path", | |
| "description" : "The ID of the definition.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "tag", | |
| "in" : "path", | |
| "description" : "The tag to add.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.2' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build_execute" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.2", | |
| "x-ms-vss-resource" : "tags", | |
| "x-ms-vss-method" : "AddDefinitionTag", | |
| "x-ms-preview" : true | |
| }, | |
| "delete" : { | |
| "tags" : [ "Tags" ], | |
| "description" : "Removes a tag from a definition.", | |
| "operationId" : "Delete Definition Tag", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "definitionId", | |
| "in" : "path", | |
| "description" : "The ID of the definition.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "tag", | |
| "in" : "path", | |
| "description" : "The tag to remove.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.2' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build_execute" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.2", | |
| "x-ms-vss-resource" : "tags", | |
| "x-ms-vss-method" : "DeleteDefinitionTag", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/definitions/templates" : { | |
| "get" : { | |
| "tags" : [ "Templates" ], | |
| "description" : "Gets all definition templates.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/BuildDefinitionTemplate" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "templates", | |
| "x-ms-vss-method" : "GetTemplates" | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/definitions/templates/{templateId}" : { | |
| "get" : { | |
| "tags" : [ "Templates" ], | |
| "description" : "Gets a specific build definition template.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "templateId", | |
| "in" : "path", | |
| "description" : "The ID of the requested template.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/BuildDefinitionTemplate" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "templates", | |
| "x-ms-vss-method" : "GetTemplate" | |
| }, | |
| "put" : { | |
| "tags" : [ "Templates" ], | |
| "description" : "Updates an existing build definition template.", | |
| "operationId" : "Save Template", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "templateId", | |
| "in" : "path", | |
| "description" : "The ID of the template.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "The new version of the template.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/BuildDefinitionTemplate" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/BuildDefinitionTemplate" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build_execute" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "templates", | |
| "x-ms-vss-method" : "SaveTemplate" | |
| }, | |
| "delete" : { | |
| "tags" : [ "Templates" ], | |
| "description" : "Deletes a build definition template.", | |
| "operationId" : "Delete", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "templateId", | |
| "in" : "path", | |
| "description" : "The ID of the template.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build_execute" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "templates", | |
| "x-ms-vss-method" : "DeleteTemplate" | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/folders/{path}" : { | |
| "get" : { | |
| "tags" : [ "Folders" ], | |
| "description" : "Gets a list of build definition folders.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "path", | |
| "in" : "path", | |
| "description" : "The path to start with.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "queryOrder", | |
| "in" : "query", | |
| "description" : "The order in which folders should be returned.", | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "none", "folderAscending", "folderDescending" ], | |
| "x-ms-enum" : { | |
| "name" : "FolderQueryOrder", | |
| "values" : [ { | |
| "value" : "none", | |
| "description" : "No order" | |
| }, { | |
| "value" : "folderAscending", | |
| "description" : "Order by folder name and path ascending." | |
| }, { | |
| "value" : "folderDescending", | |
| "description" : "Order by folder name and path descending." | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "FolderQueryOrder", | |
| "values" : [ { | |
| "value" : "none", | |
| "description" : "No order" | |
| }, { | |
| "value" : "folderAscending", | |
| "description" : "Order by folder name and path ascending." | |
| }, { | |
| "value" : "folderDescending", | |
| "description" : "Order by folder name and path descending." | |
| } ] | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.2' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/Folder" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.2", | |
| "x-ms-vss-resource" : "folders", | |
| "x-ms-vss-method" : "GetFolders", | |
| "x-ms-preview" : true | |
| }, | |
| "put" : { | |
| "tags" : [ "Folders" ], | |
| "description" : "Creates a new folder.", | |
| "operationId" : "Create", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "path", | |
| "in" : "path", | |
| "description" : "The full path of the folder.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.2' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "The folder.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Folder" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Folder" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build_execute" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.2", | |
| "x-ms-vss-resource" : "folders", | |
| "x-ms-vss-method" : "CreateFolder", | |
| "x-ms-preview" : true | |
| }, | |
| "post" : { | |
| "tags" : [ "Folders" ], | |
| "description" : "Updates an existing folder at given existing path", | |
| "operationId" : "Update", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "path", | |
| "in" : "path", | |
| "description" : "The full path to the folder.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.2' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "The new version of the folder.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Folder" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Folder" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build_execute" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.2", | |
| "x-ms-vss-resource" : "folders", | |
| "x-ms-vss-method" : "UpdateFolder", | |
| "x-ms-preview" : true | |
| }, | |
| "delete" : { | |
| "tags" : [ "Folders" ], | |
| "description" : "Deletes a definition folder. Definitions and their corresponding builds will also be deleted.", | |
| "operationId" : "Delete", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "path", | |
| "in" : "path", | |
| "description" : "The full path to the folder.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.2' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build_execute" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.2", | |
| "x-ms-vss-resource" : "folders", | |
| "x-ms-vss-method" : "DeleteFolder", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/latest/{definition}" : { | |
| "get" : { | |
| "tags" : [ "Latest" ], | |
| "description" : "Gets the latest build for a definition, optionally scoped to a specific branch.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "definition", | |
| "in" : "path", | |
| "description" : "definition name with optional leading folder path, or the definition id", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "branchName", | |
| "in" : "query", | |
| "description" : "optional parameter that indicates the specific branch to use", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Build" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "latest", | |
| "x-ms-vss-method" : "GetLatestBuild", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/metrics/{metricAggregationType}" : { | |
| "get" : { | |
| "tags" : [ "Metrics" ], | |
| "description" : "Gets build metrics for a project.", | |
| "operationId" : "Get Project Metrics", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "metricAggregationType", | |
| "in" : "path", | |
| "description" : "The aggregation type to use (hourly, daily).", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "minMetricsTime", | |
| "in" : "query", | |
| "description" : "The date from which to calculate metrics.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "date-time" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/BuildMetric" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "metrics", | |
| "x-ms-vss-method" : "GetProjectMetrics", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/options" : { | |
| "get" : { | |
| "tags" : [ "Options" ], | |
| "description" : "Gets all build definition options supported by the system.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/BuildOptionDefinition" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "options", | |
| "x-ms-vss-method" : "GetBuildOptionDefinitions" | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/repos/{repoType}/badge" : { | |
| "get" : { | |
| "tags" : [ "Badge" ], | |
| "description" : "Gets a badge that indicates the status of the most recent build for the specified branch.", | |
| "operationId" : "Get Build Badge Data", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repoType", | |
| "in" : "path", | |
| "description" : "The repository type.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repoId", | |
| "in" : "query", | |
| "description" : "The repository ID.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "branchName", | |
| "in" : "query", | |
| "description" : "The branch name.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.2' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.2", | |
| "x-ms-vss-resource" : "buildbadge", | |
| "x-ms-vss-method" : "GetBuildBadge", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/settings" : { | |
| "get" : { | |
| "tags" : [ "Settings" ], | |
| "description" : "Gets the build settings.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/BuildSettings" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "settings", | |
| "x-ms-vss-method" : "GetBuildSettings" | |
| }, | |
| "patch" : { | |
| "tags" : [ "Settings" ], | |
| "description" : "Updates the build settings.", | |
| "operationId" : "Update", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "The new settings.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/BuildSettings" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/BuildSettings" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "settings", | |
| "x-ms-vss-method" : "UpdateBuildSettings" | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/status/{definition}" : { | |
| "get" : { | |
| "tags" : [ "Status" ], | |
| "description" : "<p>Gets the build status for a definition, optionally scoped to a specific branch, stage, job, and configuration.</p> <p>If there are more than one, then it is required to pass in a stageName value when specifying a jobName, and the same rule then applies for both if passing a configuration parameter.</p>", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "definition", | |
| "in" : "path", | |
| "description" : "Either the definition name with optional leading folder path, or the definition id.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "branchName", | |
| "in" : "query", | |
| "description" : "Only consider the most recent build for this branch.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "stageName", | |
| "in" : "query", | |
| "description" : "Use this stage within the pipeline to render the status.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "jobName", | |
| "in" : "query", | |
| "description" : "Use this job within a stage of the pipeline to render the status.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "configuration", | |
| "in" : "query", | |
| "description" : "Use this job configuration to render the status", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "label", | |
| "in" : "query", | |
| "description" : "Replaces the default text on the left side of the badge.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "status", | |
| "x-ms-vss-method" : "GetStatusBadge", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/tags" : { | |
| "get" : { | |
| "tags" : [ "Tags" ], | |
| "description" : "Gets a list of all build and definition tags in the project.", | |
| "operationId" : "Get Tags", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.build" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "tags", | |
| "x-ms-vss-method" : "GetTags" | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/build/workitems" : { | |
| "get" : { | |
| "tags" : [ "Builds" ], | |
| "description" : "Gets all the work items between two builds.", | |
| "operationId" : "Get Work Items Between Builds", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "fromBuildId", | |
| "in" : "query", | |
| "description" : "The ID of the first build.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "toBuildId", | |
| "in" : "query", | |
| "description" : "The ID of the last build.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "$top", | |
| "in" : "query", | |
| "description" : "The maximum number of work items to return.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.2' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/ResourceRef" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0-preview.2", | |
| "x-ms-vss-resource" : "workitems", | |
| "x-ms-vss-method" : "GetWorkItemsBetweenBuilds", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/sourceproviders" : { | |
| "get" : { | |
| "tags" : [ "Source Providers" ], | |
| "description" : "Get a list of source providers and their capabilities.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/SourceProviderAttributes" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "sourceProviders", | |
| "x-ms-vss-method" : "ListSourceProviders", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/sourceProviders/{providerName}/branches" : { | |
| "get" : { | |
| "tags" : [ "Source Providers" ], | |
| "description" : "Gets a list of branches for the given source code repository.", | |
| "operationId" : "List Branches", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "providerName", | |
| "in" : "path", | |
| "description" : "The name of the source provider.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "serviceEndpointId", | |
| "in" : "query", | |
| "description" : "If specified, the ID of the service endpoint to query. Can only be omitted for providers that do not use service endpoints, e.g. TFVC or TFGit.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "repository", | |
| "in" : "query", | |
| "description" : "If specified, the vendor-specific identifier or the name of the repository to get branches. Can only be omitted for providers that do not support multiple repositories.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "branches", | |
| "x-ms-vss-method" : "ListBranches", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/sourceProviders/{providerName}/filecontents" : { | |
| "get" : { | |
| "tags" : [ "Source Providers" ], | |
| "description" : "Gets the contents of a file in the given source code repository.", | |
| "operationId" : "Get File Contents", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "providerName", | |
| "in" : "path", | |
| "description" : "The name of the source provider.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "serviceEndpointId", | |
| "in" : "query", | |
| "description" : "If specified, the ID of the service endpoint to query. Can only be omitted for providers that do not use service endpoints, e.g. TFVC or TFGit.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "repository", | |
| "in" : "query", | |
| "description" : "If specified, the vendor-specific identifier or the name of the repository to get branches. Can only be omitted for providers that do not support multiple repositories.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "commitOrBranch", | |
| "in" : "query", | |
| "description" : "The identifier of the commit or branch from which a file's contents are retrieved.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "path", | |
| "in" : "query", | |
| "description" : "The path to the file to retrieve, relative to the root of the repository.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "text/plain" : { | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "Stream" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "fileContents", | |
| "x-ms-vss-method" : "GetFileContents", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/sourceProviders/{providerName}/pathcontents" : { | |
| "get" : { | |
| "tags" : [ "Source Providers" ], | |
| "description" : "Gets the contents of a directory in the given source code repository.", | |
| "operationId" : "Get Path Contents", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "providerName", | |
| "in" : "path", | |
| "description" : "The name of the source provider.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "serviceEndpointId", | |
| "in" : "query", | |
| "description" : "If specified, the ID of the service endpoint to query. Can only be omitted for providers that do not use service endpoints, e.g. TFVC or TFGit.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "repository", | |
| "in" : "query", | |
| "description" : "If specified, the vendor-specific identifier or the name of the repository to get branches. Can only be omitted for providers that do not support multiple repositories.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "commitOrBranch", | |
| "in" : "query", | |
| "description" : "The identifier of the commit or branch from which a file's contents are retrieved.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "path", | |
| "in" : "query", | |
| "description" : "The path contents to list, relative to the root of the repository.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/SourceRepositoryItem" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "pathContents", | |
| "x-ms-vss-method" : "GetPathContents", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/sourceProviders/{providerName}/pullrequests/{pullRequestId}" : { | |
| "get" : { | |
| "tags" : [ "Source Providers" ], | |
| "description" : "Gets a pull request object from source provider.", | |
| "operationId" : "Get Pull Request", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "providerName", | |
| "in" : "path", | |
| "description" : "The name of the source provider.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "Vendor-specific id of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "query", | |
| "description" : "Vendor-specific identifier or the name of the repository that contains the pull request.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "serviceEndpointId", | |
| "in" : "query", | |
| "description" : "If specified, the ID of the service endpoint to query. Can only be omitted for providers that do not use service endpoints, e.g. TFVC or TFGit.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/PullRequest" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "pullRequests", | |
| "x-ms-vss-method" : "GetPullRequest", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/sourceProviders/{providerName}/repositories" : { | |
| "get" : { | |
| "tags" : [ "Source Providers" ], | |
| "description" : "Gets a list of source code repositories.", | |
| "operationId" : "List Repositories", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "providerName", | |
| "in" : "path", | |
| "description" : "The name of the source provider.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "serviceEndpointId", | |
| "in" : "query", | |
| "description" : "If specified, the ID of the service endpoint to query. Can only be omitted for providers that do not use service endpoints, e.g. TFVC or TFGit.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "repository", | |
| "in" : "query", | |
| "description" : "If specified, the vendor-specific identifier or the name of a single repository to get.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "resultSet", | |
| "in" : "query", | |
| "description" : "'top' for the repositories most relevant for the endpoint. If not set, all repositories are returned. Ignored if 'repository' is set.", | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "all", "top" ], | |
| "x-ms-enum" : { | |
| "name" : "ResultSet", | |
| "values" : [ { | |
| "value" : "all", | |
| "description" : "Include all repositories" | |
| }, { | |
| "value" : "top", | |
| "description" : "Include most relevant repositories for user" | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "ResultSet", | |
| "values" : [ { | |
| "value" : "all", | |
| "description" : "Include all repositories" | |
| }, { | |
| "value" : "top", | |
| "description" : "Include most relevant repositories for user" | |
| } ] | |
| } | |
| }, { | |
| "name" : "pageResults", | |
| "in" : "query", | |
| "description" : "If set to true, this will limit the set of results and will return a continuation token to continue the query.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "continuationToken", | |
| "in" : "query", | |
| "description" : "When paging results, this is a continuation token, returned by a previous call to this method, that can be used to return the next set of repositories.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/SourceRepositories" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "repositories", | |
| "x-ms-vss-method" : "ListRepositories", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/sourceProviders/{providerName}/webhooks" : { | |
| "get" : { | |
| "tags" : [ "Source Providers" ], | |
| "description" : "Gets a list of webhooks installed in the given source code repository.", | |
| "operationId" : "List Webhooks", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "providerName", | |
| "in" : "path", | |
| "description" : "The name of the source provider.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "serviceEndpointId", | |
| "in" : "query", | |
| "description" : "If specified, the ID of the service endpoint to query. Can only be omitted for providers that do not use service endpoints, e.g. TFVC or TFGit.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "repository", | |
| "in" : "query", | |
| "description" : "If specified, the vendor-specific identifier or the name of the repository to get webhooks. Can only be omitted for providers that do not support multiple repositories.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/RepositoryWebhook" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "webhooks", | |
| "x-ms-vss-method" : "ListWebhooks", | |
| "x-ms-preview" : true | |
| }, | |
| "post" : { | |
| "tags" : [ "Source Providers" ], | |
| "description" : "Recreates the webhooks for the specified triggers in the given source code repository.", | |
| "operationId" : "Restore Webhooks", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "providerName", | |
| "in" : "path", | |
| "description" : "The name of the source provider.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "serviceEndpointId", | |
| "in" : "query", | |
| "description" : "If specified, the ID of the service endpoint to query. Can only be omitted for providers that do not use service endpoints, e.g. TFVC or TFGit.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "repository", | |
| "in" : "query", | |
| "description" : "If specified, the vendor-specific identifier or the name of the repository to get webhooks. Can only be omitted for providers that do not support multiple repositories.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "The types of triggers to restore webhooks for.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string", | |
| "format" : "DefinitionTriggerType" | |
| } | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "webhooks", | |
| "x-ms-vss-method" : "RestoreWebhooks", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/clt/agentgroups" : { | |
| "post" : { | |
| "tags" : [ "Agent Groups" ], | |
| "operationId" : "Create", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Agent group to be created", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/AgentGroup" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/AgentGroup" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "agentGroups", | |
| "x-ms-vss-method" : "CreateAgentGroup", | |
| "x-ms-examples" : { | |
| "Create an agent group" : { | |
| "$ref" : "./httpExamples/AgentGroups/POST__AgentGroups.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/clt/agentgroups/{agentGroupId}" : { | |
| "get" : { | |
| "tags" : [ "Agent Groups" ], | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "agentGroupId", | |
| "in" : "path", | |
| "description" : "The agent group indentifier", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "machineSetupInput", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "machineAccessData", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "outgoingRequestUrls", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "agentGroupName", | |
| "in" : "query", | |
| "description" : "Name of the agent group", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "object" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "agentGroups", | |
| "x-ms-vss-method" : "GetAgentGroups", | |
| "x-ms-examples" : { | |
| "All agent groups" : { | |
| "$ref" : "./httpExamples/AgentGroups/GET__AgentGroups.json" | |
| }, | |
| "By group id" : { | |
| "$ref" : "./httpExamples/AgentGroups/GET__AgentGroups_agentGroupId.json" | |
| }, | |
| "By name" : { | |
| "$ref" : "./httpExamples/AgentGroups/GET__AgentGroups_agentGroupName.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/clt/agentGroups/{agentGroupId}/agents" : { | |
| "get" : { | |
| "tags" : [ "Agents" ], | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "agentGroupId", | |
| "in" : "path", | |
| "description" : "The agent group identifier", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "agentName", | |
| "in" : "query", | |
| "description" : "Name of the static agent", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "object" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "agents", | |
| "x-ms-vss-method" : "GetStaticAgents", | |
| "x-ms-examples" : { | |
| "By group id" : { | |
| "$ref" : "./httpExamples/Agents/GET__Agents_agentGroupId.json" | |
| }, | |
| "By agent name" : { | |
| "$ref" : "./httpExamples/Agents/GET__Agents_agentName.json" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "Agents" ], | |
| "operationId" : "Delete", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "agentGroupId", | |
| "in" : "path", | |
| "description" : "The agent group identifier", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "agentName", | |
| "in" : "query", | |
| "description" : "Name of the static agent", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "agents", | |
| "x-ms-vss-method" : "DeleteStaticAgent", | |
| "x-ms-examples" : { | |
| "Delete an agent" : { | |
| "$ref" : "./httpExamples/Agents/DELETE__Agents_agentName.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/clt/apm/applications" : { | |
| "get" : { | |
| "tags" : [ "Applications" ], | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "type", | |
| "in" : "query", | |
| "description" : "Filters the results based on the plugin type.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/Application" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "applications", | |
| "x-ms-vss-method" : "GetApplications", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Applications/GET__ApmApplications__type_.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/clt/apm/applications/{applicationId}" : { | |
| "get" : { | |
| "tags" : [ "Applications" ], | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "applicationId", | |
| "in" : "path", | |
| "description" : "Filter by APM application identifier.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Application" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "applications", | |
| "x-ms-vss-method" : "GetApplication" | |
| } | |
| }, | |
| "/{organization}/_apis/clt/apm/counters" : { | |
| "get" : { | |
| "tags" : [ "Counters" ], | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "applicationId", | |
| "in" : "query", | |
| "description" : "Filter by APM application identifier.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "plugintype", | |
| "in" : "query", | |
| "description" : "Currently ApplicationInsights is the only available plugin type.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/ApplicationCounters" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "counters", | |
| "x-ms-vss-method" : "GetApplicationCounters", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Counters/GET__ApmCounters.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/clt/apm/plugins" : { | |
| "get" : { | |
| "tags" : [ "Plugins" ], | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/ApplicationType" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "plugins", | |
| "x-ms-vss-method" : "GetPlugins", | |
| "x-ms-examples" : { | |
| "Get a list of plugins" : { | |
| "$ref" : "./httpExamples/Plugins/GET__ApmPlugins.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/clt/apm/plugins/{type}" : { | |
| "get" : { | |
| "tags" : [ "Plugins" ], | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "type", | |
| "in" : "path", | |
| "description" : "Currently ApplicationInsights is the only available plugin type.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/ApplicationType" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "plugins", | |
| "x-ms-vss-method" : "GetPlugin", | |
| "x-ms-examples" : { | |
| "Get a plugin" : { | |
| "$ref" : "./httpExamples/Plugins/GET__ApmPlugins__type_.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/clt/testdefinitions" : { | |
| "get" : { | |
| "tags" : [ "Test Definitions" ], | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "fromDate", | |
| "in" : "query", | |
| "description" : "Date after which test definitions were created", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "toDate", | |
| "in" : "query", | |
| "description" : "Date before which test definitions were crated", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "top", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/TestDefinitionBasic" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "testDefinitions", | |
| "x-ms-vss-method" : "GetTestDefinitions", | |
| "x-ms-examples" : { | |
| "All test definitions" : { | |
| "$ref" : "./httpExamples/TestDefinitions/GET__TestDefinitions.json" | |
| } | |
| } | |
| }, | |
| "put" : { | |
| "tags" : [ "Test Definitions" ], | |
| "operationId" : "Update", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/TestDefinition" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/TestDefinition" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "testDefinitions", | |
| "x-ms-vss-method" : "UpdateTestDefinition", | |
| "x-ms-examples" : { | |
| "Update a test definition" : { | |
| "$ref" : "./httpExamples/TestDefinitions/PUT__TestDefinitions.json" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "Test Definitions" ], | |
| "operationId" : "Create", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Test definition to be created", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/TestDefinition" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/TestDefinition" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "testDefinitions", | |
| "x-ms-vss-method" : "CreateTestDefinition", | |
| "x-ms-examples" : { | |
| "Create a test definition" : { | |
| "$ref" : "./httpExamples/TestDefinitions/POST__TestDefinitions.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/clt/testdefinitions/{testDefinitionId}" : { | |
| "get" : { | |
| "tags" : [ "Test Definitions" ], | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "testDefinitionId", | |
| "in" : "path", | |
| "description" : "The test definition identifier", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/TestDefinition" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "testDefinitions", | |
| "x-ms-vss-method" : "GetTestDefinition", | |
| "x-ms-examples" : { | |
| "By test definition id" : { | |
| "$ref" : "./httpExamples/TestDefinitions/GET__TestDefinitions_testDefinitionId.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/clt/testdrops" : { | |
| "post" : { | |
| "tags" : [ "Test Drops" ], | |
| "operationId" : "Create", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Test drop to be created", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/TestDrop" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/TestDrop" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "testDrops", | |
| "x-ms-vss-method" : "CreateTestDrop", | |
| "x-ms-examples" : { | |
| "Create a test drop" : { | |
| "$ref" : "./httpExamples/TestDrops/POST__TestDrops__dropType_.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/clt/testdrops/{testDropId}" : { | |
| "get" : { | |
| "tags" : [ "Test Drops" ], | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "testDropId", | |
| "in" : "path", | |
| "description" : "The test drop identifier", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/TestDrop" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "testDrops", | |
| "x-ms-vss-method" : "GetTestDrop", | |
| "x-ms-examples" : { | |
| "Get a test drop" : { | |
| "$ref" : "./httpExamples/TestDrops/GET__TestDrops__testDropId_.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/clt/testruns" : { | |
| "get" : { | |
| "tags" : [ "Test Runs" ], | |
| "description" : "Returns test runs based on the filter specified. Returns all runs of the tenant if there is no filter.", | |
| "operationId" : "Get Test Runs", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "name", | |
| "in" : "query", | |
| "description" : "Name for the test run. Names are not unique. Test runs with same name are assigned sequential rolling numbers.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "requestedBy", | |
| "in" : "query", | |
| "description" : "Filter by the user who requested the test run. Here requestedBy should be the display name of the user.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "status", | |
| "in" : "query", | |
| "description" : "Filter by the test run status.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "runType", | |
| "in" : "query", | |
| "description" : "Valid values include: null, one of TestRunType, or \"*\"", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "fromDate", | |
| "in" : "query", | |
| "description" : "Filter by the test runs that have been modified after the fromDate timestamp.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "toDate", | |
| "in" : "query", | |
| "description" : "Filter by the test runs that have been modified before the toDate timestamp.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "detailed", | |
| "in" : "query", | |
| "description" : "Include the detailed test run attributes.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "top", | |
| "in" : "query", | |
| "description" : "The maximum number of test runs to return.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "runsourceidentifier", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "retentionState", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "object" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "testRuns", | |
| "x-ms-vss-method" : "GetTestRuns", | |
| "x-ms-examples" : { | |
| "All test runs" : { | |
| "$ref" : "./httpExamples/TestRuns/GET__TestRuns.json" | |
| }, | |
| "By name" : { | |
| "$ref" : "./httpExamples/TestRuns/GET__TestRuns__filter__name_.json" | |
| }, | |
| "By user" : { | |
| "$ref" : "./httpExamples/TestRuns/GET__TestRuns__filter__user_.json" | |
| }, | |
| "By status" : { | |
| "$ref" : "./httpExamples/TestRuns/GET__TestRuns__filter__status_.json" | |
| }, | |
| "By date" : { | |
| "$ref" : "./httpExamples/TestRuns/GET__TestRuns__filter__date_.json" | |
| }, | |
| "With detailed attributes" : { | |
| "$ref" : "./httpExamples/TestRuns/GET__TestRuns__filter__detailed_.json" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "Test Runs" ], | |
| "operationId" : "Create", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/TestRun" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/TestRun" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "testRuns", | |
| "x-ms-vss-method" : "CreateTestRun", | |
| "x-ms-examples" : { | |
| "Create a test run" : { | |
| "$ref" : "./httpExamples/TestRuns/POST__TestRuns.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/clt/testruns/{testRunId}" : { | |
| "get" : { | |
| "tags" : [ "Test Runs" ], | |
| "operationId" : "Get Test Run", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "testRunId", | |
| "in" : "path", | |
| "description" : "Unique ID of the test run", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/TestRun" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "testRuns", | |
| "x-ms-vss-method" : "GetTestRun", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/TestRuns/GET__TestRuns__testRunId_.json" | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "Test Runs" ], | |
| "operationId" : "Update", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "testRunId", | |
| "in" : "path", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/TestRun" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "testRuns", | |
| "x-ms-vss-method" : "UpdateTestRun", | |
| "x-ms-examples" : { | |
| "Start a test run" : { | |
| "$ref" : "./httpExamples/TestRuns/PATCH__TestRuns__testRunId_Queued.json" | |
| }, | |
| "Stop a test run" : { | |
| "$ref" : "./httpExamples/TestRuns/PATCH__TestRuns__testRunId_Aborted.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/clt/testRuns/{testRunId}/counterinstances" : { | |
| "get" : { | |
| "tags" : [ "Counter Instances" ], | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "testRunId", | |
| "in" : "path", | |
| "description" : "The test run identifier", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "groupNames", | |
| "in" : "query", | |
| "description" : "Comma separated names of counter groups, such as 'Application', 'Performance' and 'Throughput'", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "includeSummary", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/TestRunCounterInstance" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "counterInstances", | |
| "x-ms-vss-method" : "GetCounters", | |
| "x-ms-examples" : { | |
| "Get a list of counter instances" : { | |
| "$ref" : "./httpExamples/CounterInstances/GET__CounterInstances__run_.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/clt/testRuns/{testRunId}/countersamples" : { | |
| "post" : { | |
| "tags" : [ "Counter Samples" ], | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "testRunId", | |
| "in" : "path", | |
| "description" : "The test run identifier", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/VssJsonCollectionWrapper" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/CounterSamplesResult" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "counterSamples", | |
| "x-ms-vss-method" : "GetCounterSamples", | |
| "x-ms-examples" : { | |
| "Get a list of counter samples" : { | |
| "$ref" : "./httpExamples/CounterSamples/POST__CounterSamples__run_.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/clt/testRuns/{testRunId}/errors" : { | |
| "get" : { | |
| "tags" : [ "Errors" ], | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "testRunId", | |
| "in" : "path", | |
| "description" : "The test run identifier", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "type", | |
| "in" : "query", | |
| "description" : "Filter for the particular type of errors.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "subType", | |
| "in" : "query", | |
| "description" : "Filter for a particular subtype of errors. You should not provide error subtype without error type.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "detailed", | |
| "in" : "query", | |
| "description" : "To include the details of test errors such as messagetext, request, stacktrace, testcasename, scenarioname, and lasterrordate.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/LoadTestErrors" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "errors", | |
| "x-ms-vss-method" : "GetLoadTestRunErrors", | |
| "x-ms-examples" : { | |
| "With Error Type specified" : { | |
| "$ref" : "./httpExamples/Errors/errortype.json" | |
| }, | |
| "With Error Type and Subtype specified" : { | |
| "$ref" : "./httpExamples/Errors/errortypesubtype.json" | |
| }, | |
| "With Error Type and Subtype specified and detailed=true" : { | |
| "$ref" : "./httpExamples/Errors/errortypesubtypedetailed.json" | |
| }, | |
| "With Detailed=true" : { | |
| "$ref" : "./httpExamples/Errors/GetTestRunErrorsDetailedTrue.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/clt/testRuns/{testRunId}/messages" : { | |
| "get" : { | |
| "tags" : [ "Messages" ], | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "testRunId", | |
| "in" : "path", | |
| "description" : "Id of the test run", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/TestRunMessage" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "messages", | |
| "x-ms-vss-method" : "GetTestRunMessages", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Messages/GET__messages_.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/clt/testRuns/{testRunId}/results" : { | |
| "get" : { | |
| "tags" : [ "Results" ], | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "testRunId", | |
| "in" : "path", | |
| "description" : "The test run identifier", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/TestResults" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "results", | |
| "x-ms-vss-method" : "GetLoadTestResult", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Results/GET__TestResults_.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/process/processes" : { | |
| "get" : { | |
| "tags" : [ "Processes" ], | |
| "description" : "Get a list of processes.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/Process" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.work" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "processes", | |
| "x-ms-vss-method" : "GetProcesses" | |
| } | |
| }, | |
| "/{organization}/_apis/process/processes/{processId}" : { | |
| "get" : { | |
| "tags" : [ "Processes" ], | |
| "description" : "Get a process by ID.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "processId", | |
| "in" : "path", | |
| "description" : "ID for a process.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Process" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.work" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "processes", | |
| "x-ms-vss-method" : "GetProcessById" | |
| } | |
| }, | |
| "/{organization}/_apis/projects" : { | |
| "get" : { | |
| "tags" : [ "Projects" ], | |
| "description" : "Get all projects in the organization that the authenticated user has access to.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "stateFilter", | |
| "in" : "query", | |
| "description" : "Filter on team projects in a specific team project state (default: WellFormed).", | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "deleting", "new", "wellFormed", "createPending", "all", "unchanged", "deleted" ], | |
| "x-ms-enum" : { | |
| "name" : "ProjectState", | |
| "values" : [ { | |
| "value" : "deleting", | |
| "description" : "Project is in the process of being deleted." | |
| }, { | |
| "value" : "new", | |
| "description" : "Project is in the process of being created." | |
| }, { | |
| "value" : "wellFormed", | |
| "description" : "Project is completely created and ready to use." | |
| }, { | |
| "value" : "createPending", | |
| "description" : "Project has been queued for creation, but the process has not yet started." | |
| }, { | |
| "value" : "all", | |
| "description" : "All projects regardless of state." | |
| }, { | |
| "value" : "unchanged", | |
| "description" : "Project has not been changed." | |
| }, { | |
| "value" : "deleted", | |
| "description" : "Project has been deleted." | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "ProjectState", | |
| "values" : [ { | |
| "value" : "deleting", | |
| "description" : "Project is in the process of being deleted." | |
| }, { | |
| "value" : "new", | |
| "description" : "Project is in the process of being created." | |
| }, { | |
| "value" : "wellFormed", | |
| "description" : "Project is completely created and ready to use." | |
| }, { | |
| "value" : "createPending", | |
| "description" : "Project has been queued for creation, but the process has not yet started." | |
| }, { | |
| "value" : "all", | |
| "description" : "All projects regardless of state." | |
| }, { | |
| "value" : "unchanged", | |
| "description" : "Project has not been changed." | |
| }, { | |
| "value" : "deleted", | |
| "description" : "Project has been deleted." | |
| } ] | |
| } | |
| }, { | |
| "name" : "$top", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "$skip", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "continuationToken", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "getDefaultTeamImageUrl", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/TeamProjectReference" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.profile", "vso.project" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "projects", | |
| "x-ms-vss-method" : "GetProjects", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/projects/GET__projects.json" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "Projects" ], | |
| "description" : "Queues a project to be created. Use the [GetOperation](../../operations/operations/get) to periodically check for create project status.", | |
| "operationId" : "Create", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "The project to create.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/TeamProject" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/OperationReference" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.project_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "projects", | |
| "x-ms-vss-method" : "QueueCreateProject", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/projects/POST__projects.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/projects/{projectId}" : { | |
| "get" : { | |
| "tags" : [ "Projects" ], | |
| "description" : "Get project with the specified id or name, optionally including capabilities.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "projectId", | |
| "in" : "path", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "includeCapabilities", | |
| "in" : "query", | |
| "description" : "Include capabilities (such as source control) in the team project result (default: false).", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "includeHistory", | |
| "in" : "query", | |
| "description" : "Search within renamed projects (that had such name in the past).", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/TeamProject" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.profile", "vso.project" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "projects", | |
| "x-ms-vss-method" : "GetProject" | |
| }, | |
| "delete" : { | |
| "tags" : [ "Projects" ], | |
| "description" : "Queues a project to be deleted. Use the [GetOperation](../../operations/operations/get) to periodically check for delete project status.", | |
| "operationId" : "Delete", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "projectId", | |
| "in" : "path", | |
| "description" : "The project id of the project to delete.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/OperationReference" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.project_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "projects", | |
| "x-ms-vss-method" : "QueueDeleteProject" | |
| }, | |
| "patch" : { | |
| "tags" : [ "Projects" ], | |
| "description" : "Update an existing project's name, abbreviation, or description.", | |
| "operationId" : "Update", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "projectId", | |
| "in" : "path", | |
| "description" : "The project id of the project to update.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "The updates for the project.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/TeamProject" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/OperationReference" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.project_write" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "projects", | |
| "x-ms-vss-method" : "UpdateProject" | |
| } | |
| }, | |
| "/{organization}/_apis/projects/{projectId}/properties" : { | |
| "get" : { | |
| "tags" : [ "Projects" ], | |
| "description" : "Get a collection of team project properties.", | |
| "operationId" : "Get Project Properties", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "projectId", | |
| "in" : "path", | |
| "description" : "The team project ID.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "keys", | |
| "in" : "query", | |
| "description" : "A comma-delimited string of team project property names. Wildcard characters (\"?\" and \"*\") are supported. If no key is specified, all properties will be returned.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "array (string)" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/ProjectProperty" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.profile", "vso.project" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "properties", | |
| "x-ms-vss-method" : "GetProjectProperties", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "Get all team project properties" : { | |
| "$ref" : "./httpExamples/properties/GET__projects__project__properties.json" | |
| }, | |
| "Get specific team project properties" : { | |
| "$ref" : "./httpExamples/properties/GET__projects__project__properties_keys-_propertyName_,_wildcard_.json" | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "Projects" ], | |
| "description" : "Create, update, and delete team project properties.", | |
| "operationId" : "Set Project Properties", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "projectId", | |
| "in" : "path", | |
| "description" : "The team project ID.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "A JSON Patch document that represents an array of property operations. See RFC 6902 for more details on JSON Patch. The accepted operation verbs are Add and Remove, where Add is used for both creating and updating properties. The path consists of a forward slash and a property name.", | |
| "content" : { | |
| "application/json-patch+json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/JsonPatchDocument" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.project_write" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "properties", | |
| "x-ms-vss-method" : "SetProjectProperties", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "Create or update a team project property" : { | |
| "$ref" : "./httpExamples/properties/PATCH__projects__project__properties.json" | |
| }, | |
| "Delete a team project property" : { | |
| "$ref" : "./httpExamples/properties/PATCH__projects__project__properties2.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/projects/{projectId}/teams" : { | |
| "get" : { | |
| "tags" : [ "Teams" ], | |
| "description" : "Get a list of teams.", | |
| "operationId" : "Get Teams", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "projectId", | |
| "in" : "path", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "$mine", | |
| "in" : "query", | |
| "description" : "If true return all the teams requesting user is member, otherwise return all the teams user has read access", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "$top", | |
| "in" : "query", | |
| "description" : "Maximum number of teams to return.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "$skip", | |
| "in" : "query", | |
| "description" : "Number of teams to skip.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/WebApiTeam" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.profile", "vso.project" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "teams", | |
| "x-ms-vss-method" : "GetTeams", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/teams/GET__projects__projectId__teams.json" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "Teams" ], | |
| "description" : "Create a team in a team project.\n\nPossible failure scenarios\nInvalid project name/ID (project doesn't exist) 404\nInvalid team name or description 400\nTeam already exists 400\nInsufficient privileges 400", | |
| "operationId" : "Create", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "projectId", | |
| "in" : "path", | |
| "description" : "The name or ID (GUID) of the team project in which to create the team.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "The team data used to create the team.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/WebApiTeam" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/WebApiTeam" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.project_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "teams", | |
| "x-ms-vss-method" : "CreateTeam", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/teams/POST__projects__projectId__teams.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/projects/{projectId}/teams/{teamId}" : { | |
| "get" : { | |
| "tags" : [ "Teams" ], | |
| "description" : "Get a specific team.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "projectId", | |
| "in" : "path", | |
| "description" : "The name or ID (GUID) of the team project containing the team.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "teamId", | |
| "in" : "path", | |
| "description" : "The name or ID (GUID) of the team.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/WebApiTeam" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.profile", "vso.project" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "teams", | |
| "x-ms-vss-method" : "GetTeam", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/teams/GET__projects__projectId__teams__teamId_.json" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "Teams" ], | |
| "description" : "Delete a team.", | |
| "operationId" : "Delete", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "projectId", | |
| "in" : "path", | |
| "description" : "The name or ID (GUID) of the team project containing the team to delete.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "teamId", | |
| "in" : "path", | |
| "description" : "The name of ID of the team to delete.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.project_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "teams", | |
| "x-ms-vss-method" : "DeleteTeam", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/teams/DELETE__projects__projectId__teams__newTeamId_.json" | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "Teams" ], | |
| "description" : "Update a team's name and/or description.", | |
| "operationId" : "Update", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "projectId", | |
| "in" : "path", | |
| "description" : "The name or ID (GUID) of the team project containing the team to update.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "teamId", | |
| "in" : "path", | |
| "description" : "The name of ID of the team to update.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/WebApiTeam" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/WebApiTeam" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.project_write" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "teams", | |
| "x-ms-vss-method" : "UpdateTeam", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/teams/PATCH__projects__projectId__teams.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/projects/{projectId}/teams/{teamId}/members" : { | |
| "get" : { | |
| "tags" : [ "Teams" ], | |
| "description" : "Get a list of members for a specific team.", | |
| "operationId" : "Get Team Members With Extended Properties", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "projectId", | |
| "in" : "path", | |
| "description" : "The name or ID (GUID) of the team project the team belongs to.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "teamId", | |
| "in" : "path", | |
| "description" : "The name or ID (GUID) of the team .", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "$top", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "$skip", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/TeamMember" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.profile", "vso.project" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "members", | |
| "x-ms-vss-method" : "GetTeamMembersWithExtendedProperties", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/members/GET__projects__projectId__teams__teamId__members4.1_.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/teams" : { | |
| "get" : { | |
| "tags" : [ "Teams" ], | |
| "description" : "Get a list of all teams.", | |
| "operationId" : "Get All Teams", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "$mine", | |
| "in" : "query", | |
| "description" : "If true return all the teams requesting user is member, otherwise return all the teams user has read access", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "$top", | |
| "in" : "query", | |
| "description" : "Maximum number of teams to return.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "$skip", | |
| "in" : "query", | |
| "description" : "Number of teams to skip.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.2' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/WebApiTeam" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.project" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.2", | |
| "x-ms-vss-resource" : "teams", | |
| "x-ms-vss-method" : "GetAllTeams", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/teams/GET__teams__mine-_mine.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/dashboard/widgettypes" : { | |
| "get" : { | |
| "tags" : [ "Widget Types" ], | |
| "description" : "Get all available widget metadata in alphabetical order.", | |
| "operationId" : "Get Widget Types", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "$scope", | |
| "in" : "query", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "collection_User", "project_Team" ], | |
| "x-ms-enum" : { | |
| "name" : "WidgetScope", | |
| "values" : [ { | |
| "value" : "collection_User", | |
| "description" : "" | |
| }, { | |
| "value" : "project_Team", | |
| "description" : "" | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "WidgetScope", | |
| "values" : [ { | |
| "value" : "collection_User", | |
| "description" : "" | |
| }, { | |
| "value" : "project_Team", | |
| "description" : "" | |
| } ] | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/WidgetTypesResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "widgetTypes", | |
| "x-ms-vss-method" : "GetWidgetTypes", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/WidgetTypes/GET__dashboard_WidgetTypes.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/dashboard/widgettypes/{contributionId}" : { | |
| "get" : { | |
| "tags" : [ "Widget Types" ], | |
| "description" : "Get the widget metadata satisfying the specified contribution ID.", | |
| "operationId" : "Get Widget Metadata", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "contributionId", | |
| "in" : "path", | |
| "description" : "The ID of Contribution for the Widget", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/WidgetMetadataResponse" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "widgetTypes", | |
| "x-ms-vss-method" : "GetWidgetMetadata", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/WidgetTypes/GET__dashboard_WidgetTypes__widgetId_.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/{team}/_apis/dashboard/dashboards" : { | |
| "get" : { | |
| "tags" : [ "Dashboards" ], | |
| "description" : "Get a list of dashboards.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "team", | |
| "in" : "path", | |
| "description" : "Team ID or team name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.2' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/DashboardGroup" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.dashboards", "vso.dashboards_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.2", | |
| "x-ms-vss-resource" : "dashboards", | |
| "x-ms-vss-method" : "GetDashboards", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Dashboards/GET_dashboards.json" | |
| } | |
| } | |
| }, | |
| "put" : { | |
| "tags" : [ "Dashboards" ], | |
| "description" : "Update the name and position of dashboards in the supplied group, and remove omitted dashboards. Does not modify dashboard content.", | |
| "operationId" : "Replace Dashboards", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "team", | |
| "in" : "path", | |
| "description" : "Team ID or team name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.2' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/DashboardGroup" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/DashboardGroup" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0-preview.2", | |
| "x-ms-vss-resource" : "dashboards", | |
| "x-ms-vss-method" : "ReplaceDashboards", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Dashboards/PUT__dashboard_groups__groupId__dashboards__dashboardId__.json" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "Dashboards" ], | |
| "description" : "Create the supplied dashboard.", | |
| "operationId" : "Create", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "team", | |
| "in" : "path", | |
| "description" : "Team ID or team name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.2' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "The initial state of the dashboard", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Dashboard" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Dashboard" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.dashboards_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.2", | |
| "x-ms-vss-resource" : "dashboards", | |
| "x-ms-vss-method" : "CreateDashboard", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Dashboards/POST_dashboard.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/{team}/_apis/dashboard/dashboards/{dashboardId}" : { | |
| "get" : { | |
| "tags" : [ "Dashboards" ], | |
| "description" : "Get a dashboard by its ID.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "dashboardId", | |
| "in" : "path", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "team", | |
| "in" : "path", | |
| "description" : "Team ID or team name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.2' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Dashboard" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.dashboards", "vso.dashboards_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.2", | |
| "x-ms-vss-resource" : "dashboards", | |
| "x-ms-vss-method" : "GetDashboard", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Dashboards/GET_dashboard.json" | |
| } | |
| } | |
| }, | |
| "put" : { | |
| "tags" : [ "Dashboards" ], | |
| "description" : "Replace configuration for the specified dashboard. Replaces Widget list on Dashboard, only if property is supplied.", | |
| "operationId" : "Replace Dashboard", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "dashboardId", | |
| "in" : "path", | |
| "description" : "ID of the dashboard to replace.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "team", | |
| "in" : "path", | |
| "description" : "Team ID or team name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.2' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "The Configuration of the dashboard to replace.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Dashboard" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Dashboard" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0-preview.2", | |
| "x-ms-vss-resource" : "dashboards", | |
| "x-ms-vss-method" : "ReplaceDashboard", | |
| "x-ms-preview" : true | |
| }, | |
| "delete" : { | |
| "tags" : [ "Dashboards" ], | |
| "description" : "Delete a dashboard given its ID. This also deletes the widgets associated with this dashboard.", | |
| "operationId" : "Delete", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "dashboardId", | |
| "in" : "path", | |
| "description" : "ID of the dashboard to delete.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "team", | |
| "in" : "path", | |
| "description" : "Team ID or team name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.2' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.dashboards_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.2", | |
| "x-ms-vss-resource" : "dashboards", | |
| "x-ms-vss-method" : "DeleteDashboard", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Dashboards/DELETE__dashboard_groups__groupId__dashboards__dashboardId_.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/{team}/_apis/dashboard/dashboards/{dashboardId}/widgets" : { | |
| "get" : { | |
| "tags" : [ "Widgets" ], | |
| "description" : "Get widgets contained on the specified dashboard.", | |
| "operationId" : "Get Widgets", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "dashboardId", | |
| "in" : "path", | |
| "description" : "ID of the dashboard to read.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "team", | |
| "in" : "path", | |
| "description" : "Team ID or team name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "eTag", | |
| "in" : "header", | |
| "description" : "Dashboard Widgets Version", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.2' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "headers" : { | |
| "ETag" : { | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/Widget" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.dashboards", "vso.dashboards_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.2", | |
| "x-ms-vss-resource" : "widgets", | |
| "x-ms-vss-method" : "GetWidgets", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Widgets/GET_widgets.json" | |
| } | |
| } | |
| }, | |
| "put" : { | |
| "tags" : [ "Widgets" ], | |
| "description" : "Replace the widgets on specified dashboard with the supplied widgets.", | |
| "operationId" : "Replace Widgets", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "dashboardId", | |
| "in" : "path", | |
| "description" : "ID of the Dashboard to modify.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "team", | |
| "in" : "path", | |
| "description" : "Team ID or team name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "eTag", | |
| "in" : "header", | |
| "description" : "Dashboard Widgets Version", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.2' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Revised state of widgets to store for the dashboard.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/Widget" | |
| } | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "headers" : { | |
| "ETag" : { | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/Widget" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.dashboards_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.2", | |
| "x-ms-vss-resource" : "widgets", | |
| "x-ms-vss-method" : "ReplaceWidgets", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Widgets/PUT_widgets.json" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "Widgets" ], | |
| "description" : "Create a widget on the specified dashboard.", | |
| "operationId" : "Create", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "dashboardId", | |
| "in" : "path", | |
| "description" : "ID of dashboard the widget will be added to.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "team", | |
| "in" : "path", | |
| "description" : "Team ID or team name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.2' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "State of the widget to add", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Widget" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Widget" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.dashboards_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.2", | |
| "x-ms-vss-resource" : "widgets", | |
| "x-ms-vss-method" : "CreateWidget", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Widgets/POST_widgets.json" | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "Widgets" ], | |
| "description" : "Update the supplied widgets on the dashboard using supplied state. State of existing Widgets not passed in the widget list is preserved.", | |
| "operationId" : "Update Widgets", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "dashboardId", | |
| "in" : "path", | |
| "description" : "ID of the Dashboard to modify.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "team", | |
| "in" : "path", | |
| "description" : "Team ID or team name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "eTag", | |
| "in" : "header", | |
| "description" : "Dashboard Widgets Version", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.2' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "The set of widget states to update on the dashboard.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/Widget" | |
| } | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "headers" : { | |
| "ETag" : { | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/Widget" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.dashboards_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.2", | |
| "x-ms-vss-resource" : "widgets", | |
| "x-ms-vss-method" : "UpdateWidgets", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Widgets/PATCH_widgets.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/{team}/_apis/dashboard/dashboards/{dashboardId}/widgets/{widgetId}" : { | |
| "get" : { | |
| "tags" : [ "Widgets" ], | |
| "description" : "Get the current state of the specified widget.", | |
| "operationId" : "Get Widget", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "dashboardId", | |
| "in" : "path", | |
| "description" : "ID of the dashboard containing the widget.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "widgetId", | |
| "in" : "path", | |
| "description" : "ID of the widget to read.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "team", | |
| "in" : "path", | |
| "description" : "Team ID or team name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.2' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Widget" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.dashboards", "vso.dashboards_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.2", | |
| "x-ms-vss-resource" : "widgets", | |
| "x-ms-vss-method" : "GetWidget", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Widgets/GET_widgets_widgetid.json" | |
| } | |
| } | |
| }, | |
| "put" : { | |
| "tags" : [ "Widgets" ], | |
| "description" : "Override the state of the specified widget.", | |
| "operationId" : "Replace Widget", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "dashboardId", | |
| "in" : "path", | |
| "description" : "ID of the dashboard containing the widget.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "widgetId", | |
| "in" : "path", | |
| "description" : "ID of the widget to update.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "team", | |
| "in" : "path", | |
| "description" : "Team ID or team name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.2' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "State to be written for the widget.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Widget" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Widget" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.dashboards_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.2", | |
| "x-ms-vss-resource" : "widgets", | |
| "x-ms-vss-method" : "ReplaceWidget", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Widgets/PUT_widgets_widgetid.json" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "Widgets" ], | |
| "description" : "Delete the specified widget.", | |
| "operationId" : "Delete", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "dashboardId", | |
| "in" : "path", | |
| "description" : "ID of the dashboard containing the widget.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "widgetId", | |
| "in" : "path", | |
| "description" : "ID of the widget to update.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "team", | |
| "in" : "path", | |
| "description" : "Team ID or team name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.2' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Dashboard" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.dashboards_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.2", | |
| "x-ms-vss-resource" : "widgets", | |
| "x-ms-vss-method" : "DeleteWidget", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Widgets/DELETE__dashboard_groups__groupId__dashboards__dashboardId__widgets__widgetId_.json" | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "Widgets" ], | |
| "description" : "Perform a partial update of the specified widget.", | |
| "operationId" : "Update Widget", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "dashboardId", | |
| "in" : "path", | |
| "description" : "ID of the dashboard containing the widget.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "widgetId", | |
| "in" : "path", | |
| "description" : "ID of the widget to update.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "team", | |
| "in" : "path", | |
| "description" : "Team ID or team name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.2' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Description of the widget changes to apply. All non-null fields will be replaced.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Widget" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Widget" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.dashboards_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.2", | |
| "x-ms-vss-resource" : "widgets", | |
| "x-ms-vss-method" : "UpdateWidget", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Widgets/PATCH_widgets_widgetid.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/distributedtask/agentclouds" : { | |
| "get" : { | |
| "tags" : [ "Agentclouds" ], | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/TaskAgentCloud" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "agentclouds", | |
| "x-ms-vss-method" : "GetAgentClouds", | |
| "x-ms-preview" : true | |
| }, | |
| "post" : { | |
| "tags" : [ "Agentclouds" ], | |
| "operationId" : "Add", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/TaskAgentCloud" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/TaskAgentCloud" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "agentclouds", | |
| "x-ms-vss-method" : "AddAgentCloud", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/distributedtask/agentclouds/{agentCloudId}" : { | |
| "get" : { | |
| "tags" : [ "Agentclouds" ], | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "agentCloudId", | |
| "in" : "path", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/TaskAgentCloud" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "agentclouds", | |
| "x-ms-vss-method" : "GetAgentCloud", | |
| "x-ms-preview" : true | |
| }, | |
| "delete" : { | |
| "tags" : [ "Agentclouds" ], | |
| "operationId" : "Delete", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "agentCloudId", | |
| "in" : "path", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/TaskAgentCloud" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "agentclouds", | |
| "x-ms-vss-method" : "DeleteAgentCloud", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/distributedtask/agentclouds/{agentCloudId}/requests" : { | |
| "get" : { | |
| "tags" : [ "Requests" ], | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "agentCloudId", | |
| "in" : "path", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/TaskAgentCloudRequest" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "requests", | |
| "x-ms-vss-method" : "GetAgentCloudRequests", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/distributedtask/agentcloudtypes" : { | |
| "get" : { | |
| "tags" : [ "Agentcloudtypes" ], | |
| "description" : "Get agent cloud types.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/TaskAgentCloudType" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "agentcloudtypes", | |
| "x-ms-vss-method" : "GetAgentCloudTypes", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/distributedtask/deploymentgroups" : { | |
| "get" : { | |
| "tags" : [ "Deploymentgroups" ], | |
| "description" : "Get a list of deployment groups by name or IDs.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "name", | |
| "in" : "query", | |
| "description" : "Name of the deployment group.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "actionFilter", | |
| "in" : "query", | |
| "description" : "Get only deployment groups on which this action can be performed.", | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "none", "manage", "use" ], | |
| "x-ms-enum" : { | |
| "name" : "DeploymentGroupActionFilter", | |
| "values" : [ { | |
| "value" : "none", | |
| "description" : "All deployment groups." | |
| }, { | |
| "value" : "manage", | |
| "description" : "Only deployment groups for which caller has **manage** permission." | |
| }, { | |
| "value" : "use", | |
| "description" : "Only deployment groups for which caller has **use** permission." | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "DeploymentGroupActionFilter", | |
| "values" : [ { | |
| "value" : "none", | |
| "description" : "All deployment groups." | |
| }, { | |
| "value" : "manage", | |
| "description" : "Only deployment groups for which caller has **manage** permission." | |
| }, { | |
| "value" : "use", | |
| "description" : "Only deployment groups for which caller has **use** permission." | |
| } ] | |
| } | |
| }, { | |
| "name" : "$expand", | |
| "in" : "query", | |
| "description" : "Include these additional details in the returned objects.", | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "none", "machines", "tags" ], | |
| "x-ms-enum" : { | |
| "name" : "DeploymentGroupExpands", | |
| "values" : [ { | |
| "value" : "none", | |
| "description" : "No additional properties." | |
| }, { | |
| "value" : "machines", | |
| "description" : "Deprecated: Include all the deployment targets." | |
| }, { | |
| "value" : "tags", | |
| "description" : "Include unique list of tags across all deployment targets." | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "DeploymentGroupExpands", | |
| "values" : [ { | |
| "value" : "none", | |
| "description" : "No additional properties." | |
| }, { | |
| "value" : "machines", | |
| "description" : "Deprecated: Include all the deployment targets." | |
| }, { | |
| "value" : "tags", | |
| "description" : "Include unique list of tags across all deployment targets." | |
| } ] | |
| } | |
| }, { | |
| "name" : "continuationToken", | |
| "in" : "query", | |
| "description" : "Get deployment groups with names greater than this continuationToken lexicographically.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "$top", | |
| "in" : "query", | |
| "description" : "Maximum number of deployment groups to return. Default is **1000**.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "ids", | |
| "in" : "query", | |
| "description" : "Comma separated list of IDs of the deployment groups.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "array (int32)" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/DeploymentGroup" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.machinegroup_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "deploymentgroups", | |
| "x-ms-vss-method" : "GetDeploymentGroups", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "Get a deployment group by name" : { | |
| "$ref" : "./httpExamples/deploymentgroups/GET__distributedtask_DeploymentGroups__Name_.json" | |
| }, | |
| "Get deployment groups by IDs" : { | |
| "$ref" : "./httpExamples/deploymentgroups/GET__distributedtask_DeploymentGroups__Ids_.json" | |
| }, | |
| "List all deployment groups" : { | |
| "$ref" : "./httpExamples/deploymentgroups/GET__distributedtask_DeploymentGroups.json" | |
| }, | |
| "Get deployment groups in pages" : { | |
| "$ref" : "./httpExamples/deploymentgroups/GET__distributedtask_DeploymentGroups__Page_.json" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "Deploymentgroups" ], | |
| "description" : "Create a deployment group.", | |
| "operationId" : "Add", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Deployment group to create.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/DeploymentGroupCreateParameter" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/DeploymentGroup" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.machinegroup_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "deploymentgroups", | |
| "x-ms-vss-method" : "AddDeploymentGroup", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "Create a deployment group" : { | |
| "$ref" : "./httpExamples/deploymentgroups/POST__distributedtask_DeploymentGroups.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}" : { | |
| "get" : { | |
| "tags" : [ "Deploymentgroups" ], | |
| "description" : "Get a deployment group by its ID.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "deploymentGroupId", | |
| "in" : "path", | |
| "description" : "ID of the deployment group.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "actionFilter", | |
| "in" : "query", | |
| "description" : "Get the deployment group only if this action can be performed on it.", | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "none", "manage", "use" ], | |
| "x-ms-enum" : { | |
| "name" : "DeploymentGroupActionFilter", | |
| "values" : [ { | |
| "value" : "none", | |
| "description" : "All deployment groups." | |
| }, { | |
| "value" : "manage", | |
| "description" : "Only deployment groups for which caller has **manage** permission." | |
| }, { | |
| "value" : "use", | |
| "description" : "Only deployment groups for which caller has **use** permission." | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "DeploymentGroupActionFilter", | |
| "values" : [ { | |
| "value" : "none", | |
| "description" : "All deployment groups." | |
| }, { | |
| "value" : "manage", | |
| "description" : "Only deployment groups for which caller has **manage** permission." | |
| }, { | |
| "value" : "use", | |
| "description" : "Only deployment groups for which caller has **use** permission." | |
| } ] | |
| } | |
| }, { | |
| "name" : "$expand", | |
| "in" : "query", | |
| "description" : "Include these additional details in the returned object.", | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "none", "machines", "tags" ], | |
| "x-ms-enum" : { | |
| "name" : "DeploymentGroupExpands", | |
| "values" : [ { | |
| "value" : "none", | |
| "description" : "No additional properties." | |
| }, { | |
| "value" : "machines", | |
| "description" : "Deprecated: Include all the deployment targets." | |
| }, { | |
| "value" : "tags", | |
| "description" : "Include unique list of tags across all deployment targets." | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "DeploymentGroupExpands", | |
| "values" : [ { | |
| "value" : "none", | |
| "description" : "No additional properties." | |
| }, { | |
| "value" : "machines", | |
| "description" : "Deprecated: Include all the deployment targets." | |
| }, { | |
| "value" : "tags", | |
| "description" : "Include unique list of tags across all deployment targets." | |
| } ] | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/DeploymentGroup" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.machinegroup_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "deploymentgroups", | |
| "x-ms-vss-method" : "GetDeploymentGroup", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "Get a deployment group by its ID" : { | |
| "$ref" : "./httpExamples/deploymentgroups/GET__distributedtask_DeploymentGroups__Id_.json" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "Deploymentgroups" ], | |
| "description" : "Delete a deployment group.", | |
| "operationId" : "Delete", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "deploymentGroupId", | |
| "in" : "path", | |
| "description" : "ID of the deployment group to be deleted.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.machinegroup_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "deploymentgroups", | |
| "x-ms-vss-method" : "DeleteDeploymentGroup", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "Delete a deployment group" : { | |
| "$ref" : "./httpExamples/deploymentgroups/DELETE__distributedtask_DeploymentGroup__Id_.json" | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "Deploymentgroups" ], | |
| "description" : "Update a deployment group.", | |
| "operationId" : "Update", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "deploymentGroupId", | |
| "in" : "path", | |
| "description" : "ID of the deployment group.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Deployment group to update.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/DeploymentGroupUpdateParameter" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/DeploymentGroup" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.machinegroup_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "deploymentgroups", | |
| "x-ms-vss-method" : "UpdateDeploymentGroup", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "Update a deployment group" : { | |
| "$ref" : "./httpExamples/deploymentgroups/PATCH__distributedtask_DeploymentGroups__Id_.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}/targets" : { | |
| "get" : { | |
| "tags" : [ "Targets" ], | |
| "description" : "Get a list of deployment targets in a deployment group.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "deploymentGroupId", | |
| "in" : "path", | |
| "description" : "ID of the deployment group.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "tags", | |
| "in" : "query", | |
| "description" : "Get only the deployment targets that contain all these comma separted list of tags.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "array (string)" | |
| } | |
| }, { | |
| "name" : "name", | |
| "in" : "query", | |
| "description" : "Name pattern of the deployment targets to return.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "partialNameMatch", | |
| "in" : "query", | |
| "description" : "When set to true, treats **name** as pattern. Else treats it as absolute match. Default is **false**.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "$expand", | |
| "in" : "query", | |
| "description" : "Include these additional details in the returned objects.", | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "none", "capabilities", "assignedRequest", "lastCompletedRequest" ], | |
| "x-ms-enum" : { | |
| "name" : "DeploymentTargetExpands", | |
| "values" : [ { | |
| "value" : "none", | |
| "description" : "No additional properties." | |
| }, { | |
| "value" : "capabilities", | |
| "description" : "Include capabilities of the deployment agent." | |
| }, { | |
| "value" : "assignedRequest", | |
| "description" : "Include the job request assigned to the deployment agent." | |
| }, { | |
| "value" : "lastCompletedRequest", | |
| "description" : "Include the last completed job request of the deployment agent." | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "DeploymentTargetExpands", | |
| "values" : [ { | |
| "value" : "none", | |
| "description" : "No additional properties." | |
| }, { | |
| "value" : "capabilities", | |
| "description" : "Include capabilities of the deployment agent." | |
| }, { | |
| "value" : "assignedRequest", | |
| "description" : "Include the job request assigned to the deployment agent." | |
| }, { | |
| "value" : "lastCompletedRequest", | |
| "description" : "Include the last completed job request of the deployment agent." | |
| } ] | |
| } | |
| }, { | |
| "name" : "agentStatus", | |
| "in" : "query", | |
| "description" : "Get only deployment targets that have this status.", | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "offline", "online", "all" ], | |
| "x-ms-enum" : { | |
| "name" : "TaskAgentStatusFilter", | |
| "values" : [ { | |
| "value" : "offline", | |
| "description" : "Only deployment targets that are offline." | |
| }, { | |
| "value" : "online", | |
| "description" : "Only deployment targets that are online." | |
| }, { | |
| "value" : "all", | |
| "description" : "All deployment targets." | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "TaskAgentStatusFilter", | |
| "values" : [ { | |
| "value" : "offline", | |
| "description" : "Only deployment targets that are offline." | |
| }, { | |
| "value" : "online", | |
| "description" : "Only deployment targets that are online." | |
| }, { | |
| "value" : "all", | |
| "description" : "All deployment targets." | |
| } ] | |
| } | |
| }, { | |
| "name" : "agentJobResult", | |
| "in" : "query", | |
| "description" : "Get only deployment targets that have this last job result.", | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "failed", "passed", "neverDeployed", "all" ], | |
| "x-ms-enum" : { | |
| "name" : "TaskAgentJobResultFilter", | |
| "values" : [ { | |
| "value" : "failed", | |
| "description" : "Only those deployment targets on which last job failed (**Abandoned**, **Canceled**, **Failed**, **Skipped**)." | |
| }, { | |
| "value" : "passed", | |
| "description" : "Only those deployment targets on which last job Passed (**Succeeded**, **Succeeded with issues**)." | |
| }, { | |
| "value" : "neverDeployed", | |
| "description" : "Only those deployment targets that never executed a job." | |
| }, { | |
| "value" : "all", | |
| "description" : "All deployment targets." | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "TaskAgentJobResultFilter", | |
| "values" : [ { | |
| "value" : "failed", | |
| "description" : "Only those deployment targets on which last job failed (**Abandoned**, **Canceled**, **Failed**, **Skipped**)." | |
| }, { | |
| "value" : "passed", | |
| "description" : "Only those deployment targets on which last job Passed (**Succeeded**, **Succeeded with issues**)." | |
| }, { | |
| "value" : "neverDeployed", | |
| "description" : "Only those deployment targets that never executed a job." | |
| }, { | |
| "value" : "all", | |
| "description" : "All deployment targets." | |
| } ] | |
| } | |
| }, { | |
| "name" : "continuationToken", | |
| "in" : "query", | |
| "description" : "Get deployment targets with names greater than this continuationToken lexicographically.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "$top", | |
| "in" : "query", | |
| "description" : "Maximum number of deployment targets to return. Default is **1000**.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "enabled", | |
| "in" : "query", | |
| "description" : "Get only deployment targets that are enabled or disabled. Default is 'null' which returns all the targets.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/DeploymentMachine" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.machinegroup_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "targets", | |
| "x-ms-vss-method" : "GetDeploymentTargets", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "List all deployment targets in a deployment group" : { | |
| "$ref" : "./httpExamples/targets/GET__distributedtask_DeploymentTargets.json" | |
| }, | |
| "Get deployment targets having given tags" : { | |
| "$ref" : "./httpExamples/targets/GET__distributedtask_DeploymentTargets__Tags_.json" | |
| }, | |
| "Get deployment targets by partial name match" : { | |
| "$ref" : "./httpExamples/targets/GET__distributedtask_DeploymentTargets__Name_.json" | |
| }, | |
| "Get deployment targets including their last job requests" : { | |
| "$ref" : "./httpExamples/targets/GET__distributedtask_DeploymentTargets__LastRequest_.json" | |
| }, | |
| "Get deployment targets filtered by agent status" : { | |
| "$ref" : "./httpExamples/targets/GET__distributedtask_DeploymentTargets__AgentStatus_.json" | |
| }, | |
| "Get deployment targets in pages" : { | |
| "$ref" : "./httpExamples/targets/GET__distributedtask_DeploymentTargets__Page_.json" | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "Targets" ], | |
| "description" : "Update tags of a list of deployment targets in a deployment group.", | |
| "operationId" : "Update", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "deploymentGroupId", | |
| "in" : "path", | |
| "description" : "ID of the deployment group in which deployment targets are updated.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Deployment targets with tags to udpdate.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/DeploymentTargetUpdateParameter" | |
| } | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/DeploymentMachine" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.machinegroup_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "targets", | |
| "x-ms-vss-method" : "UpdateDeploymentTargets", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "Update tags of a deployment target" : { | |
| "$ref" : "./httpExamples/targets/PATCH__distributedtask_DeploymentTargets.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}/targets/{targetId}" : { | |
| "get" : { | |
| "tags" : [ "Targets" ], | |
| "description" : "Get a deployment target by its ID in a deployment group", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "deploymentGroupId", | |
| "in" : "path", | |
| "description" : "ID of the deployment group to which deployment target belongs.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "targetId", | |
| "in" : "path", | |
| "description" : "ID of the deployment target to return.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "$expand", | |
| "in" : "query", | |
| "description" : "Include these additional details in the returned objects.", | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "none", "capabilities", "assignedRequest", "lastCompletedRequest" ], | |
| "x-ms-enum" : { | |
| "name" : "DeploymentTargetExpands", | |
| "values" : [ { | |
| "value" : "none", | |
| "description" : "No additional properties." | |
| }, { | |
| "value" : "capabilities", | |
| "description" : "Include capabilities of the deployment agent." | |
| }, { | |
| "value" : "assignedRequest", | |
| "description" : "Include the job request assigned to the deployment agent." | |
| }, { | |
| "value" : "lastCompletedRequest", | |
| "description" : "Include the last completed job request of the deployment agent." | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "DeploymentTargetExpands", | |
| "values" : [ { | |
| "value" : "none", | |
| "description" : "No additional properties." | |
| }, { | |
| "value" : "capabilities", | |
| "description" : "Include capabilities of the deployment agent." | |
| }, { | |
| "value" : "assignedRequest", | |
| "description" : "Include the job request assigned to the deployment agent." | |
| }, { | |
| "value" : "lastCompletedRequest", | |
| "description" : "Include the last completed job request of the deployment agent." | |
| } ] | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/DeploymentMachine" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.machinegroup_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "targets", | |
| "x-ms-vss-method" : "GetDeploymentTarget", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "Get a deployment target by its ID" : { | |
| "$ref" : "./httpExamples/targets/GET__distributedtask_DeploymentTargets__Id_.json" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "Targets" ], | |
| "description" : "Delete a deployment target in a deployment group. This deletes the agent from associated deployment pool too.", | |
| "operationId" : "Delete", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "deploymentGroupId", | |
| "in" : "path", | |
| "description" : "ID of the deployment group in which deployment target is deleted.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "targetId", | |
| "in" : "path", | |
| "description" : "ID of the deployment target to delete.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.machinegroup_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "targets", | |
| "x-ms-vss-method" : "DeleteDeploymentTarget", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "Delete a deployment target" : { | |
| "$ref" : "./httpExamples/targets/DELETE_distributedtask_DeploymentTargets__Id_.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/distributedtask/taskgroups" : { | |
| "post" : { | |
| "tags" : [ "Taskgroups" ], | |
| "description" : "Create a task group.", | |
| "operationId" : "Add", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Task group object to create.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/TaskGroupCreateParameter" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/TaskGroup" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.taskgroups_write" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "taskgroups", | |
| "x-ms-vss-method" : "AddTaskGroup", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "Create a task group" : { | |
| "$ref" : "./httpExamples/taskgroups/POST__CreateTaskGroup.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/distributedtask/taskgroups/{taskGroupId}" : { | |
| "get" : { | |
| "tags" : [ "Taskgroups" ], | |
| "description" : "List task groups.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "taskGroupId", | |
| "in" : "path", | |
| "description" : "Id of the task group.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "expanded", | |
| "in" : "query", | |
| "description" : "'true' to recursively expand task groups. Default is 'false'.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "taskIdFilter", | |
| "in" : "query", | |
| "description" : "Guid of the taskId to filter.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "deleted", | |
| "in" : "query", | |
| "description" : "'true'to include deleted task groups. Default is 'false'.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "$top", | |
| "in" : "query", | |
| "description" : "Number of task groups to get.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "continuationToken", | |
| "in" : "query", | |
| "description" : "Gets the task groups after the continuation token provided.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "date-time" | |
| } | |
| }, { | |
| "name" : "queryOrder", | |
| "in" : "query", | |
| "description" : "Gets the results in the defined order. Default is 'CreatedOnDescending'.", | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "createdOnAscending", "createdOnDescending" ], | |
| "x-ms-enum" : { | |
| "name" : "TaskGroupQueryOrder", | |
| "values" : [ { | |
| "value" : "createdOnAscending", | |
| "description" : "Order by createdon ascending." | |
| }, { | |
| "value" : "createdOnDescending", | |
| "description" : "Order by createdon descending." | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "TaskGroupQueryOrder", | |
| "values" : [ { | |
| "value" : "createdOnAscending", | |
| "description" : "Order by createdon ascending." | |
| }, { | |
| "value" : "createdOnDescending", | |
| "description" : "Order by createdon descending." | |
| } ] | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/TaskGroup" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.taskgroups_read" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "taskgroups", | |
| "x-ms-vss-method" : "GetTaskGroups", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "List all task groups" : { | |
| "$ref" : "./httpExamples/taskgroups/LIST__ListAllTaskGroups.json" | |
| }, | |
| "List all versions of a task group" : { | |
| "$ref" : "./httpExamples/taskgroups/LIST__ListAllVersionsOfTaskGroup.json" | |
| } | |
| } | |
| }, | |
| "put" : { | |
| "tags" : [ "Taskgroups" ], | |
| "description" : "Update a task group.", | |
| "operationId" : "Update", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "taskGroupId", | |
| "in" : "path", | |
| "description" : "Id of the task group to update.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Task group to update.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/TaskGroupUpdateParameter" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/TaskGroup" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.taskgroups_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "taskgroups", | |
| "x-ms-vss-method" : "UpdateTaskGroup", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "Update a task group" : { | |
| "$ref" : "./httpExamples/taskgroups/PUT__UpdateTaskGroup.json" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "Taskgroups" ], | |
| "description" : "Delete a task group.", | |
| "operationId" : "Delete", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "taskGroupId", | |
| "in" : "path", | |
| "description" : "Id of the task group to be deleted.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "comment", | |
| "in" : "query", | |
| "description" : "Comments to delete.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.taskgroups_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "taskgroups", | |
| "x-ms-vss-method" : "DeleteTaskGroup", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "Delete a task group" : { | |
| "$ref" : "./httpExamples/taskgroups/DELETE__DeleteATaskGroup.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/distributedtask/variablegroups" : { | |
| "get" : { | |
| "tags" : [ "Variablegroups" ], | |
| "description" : "Get variable groups by ids.", | |
| "operationId" : "Get Variable Groups By Id", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "groupIds", | |
| "in" : "query", | |
| "description" : "Comma separated list of Ids of variable groups.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "array (int32)" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/VariableGroup" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.variablegroups_read" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "variablegroups", | |
| "x-ms-vss-method" : "GetVariableGroupsById", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "Get variable groups by ids" : { | |
| "$ref" : "./httpExamples/variablegroups/GET_VariableGroupsByIds.json" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "Variablegroups" ], | |
| "description" : "Add a variable group.", | |
| "operationId" : "Add", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Variable group to add.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/VariableGroupParameters" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/VariableGroup" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.variablegroups_write" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "variablegroups", | |
| "x-ms-vss-method" : "AddVariableGroup", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "Add a variable group" : { | |
| "$ref" : "./httpExamples/variablegroups/POST_CreateVariableGroup.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/distributedtask/variablegroups/{groupId}" : { | |
| "get" : { | |
| "tags" : [ "Variablegroups" ], | |
| "description" : "Get a variable group.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "groupId", | |
| "in" : "path", | |
| "description" : "Id of the variable group.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/VariableGroup" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.variablegroups_read" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "variablegroups", | |
| "x-ms-vss-method" : "GetVariableGroup", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "Get a variable group" : { | |
| "$ref" : "./httpExamples/variablegroups/GET_VariableGroup.json" | |
| } | |
| } | |
| }, | |
| "put" : { | |
| "tags" : [ "Variablegroups" ], | |
| "description" : "Update a variable group.", | |
| "operationId" : "Update", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "groupId", | |
| "in" : "path", | |
| "description" : "Id of the variable group to update.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Variable group to update.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/VariableGroupParameters" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/VariableGroup" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.variablegroups_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "variablegroups", | |
| "x-ms-vss-method" : "UpdateVariableGroup", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "Update a variable group" : { | |
| "$ref" : "./httpExamples/variablegroups/PUT_UpdateVariableGroup.json" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "Variablegroups" ], | |
| "description" : "Delete a variable group", | |
| "operationId" : "Delete", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "groupId", | |
| "in" : "path", | |
| "description" : "Id of the variable group.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.variablegroups_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "variablegroups", | |
| "x-ms-vss-method" : "DeleteVariableGroup", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "Delete a variable group" : { | |
| "$ref" : "./httpExamples/variablegroups/DELETE_VariableGroup.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/extensionmanagement/installedextensions" : { | |
| "get" : { | |
| "tags" : [ "Installed Extensions" ], | |
| "description" : "List the installed extensions in the account / project collection.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "includeDisabledExtensions", | |
| "in" : "query", | |
| "description" : "If true (the default), include disabled extensions in the results.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "includeErrors", | |
| "in" : "query", | |
| "description" : "If true, include installed extensions with errors.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "assetTypes", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "array (string)" | |
| } | |
| }, { | |
| "name" : "includeInstallationIssues", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/InstalledExtension" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.extension" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "installedExtensions", | |
| "x-ms-vss-method" : "GetInstalledExtensions", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/InstalledExtensions/ListInstalledExtensions.json" | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "Installed Extensions" ], | |
| "description" : "Update an installed extension. Typically this API is used to enable or disable an extension.", | |
| "operationId" : "Update", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/InstalledExtension" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/InstalledExtension" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.extension_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "installedExtensions", | |
| "x-ms-vss-method" : "UpdateInstalledExtension", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/extensionmanagement/installedextensionsbyname/{publisherName}/{extensionName}" : { | |
| "get" : { | |
| "tags" : [ "Installed Extensions" ], | |
| "description" : "Get an installed extension by its publisher and extension name.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "publisherName", | |
| "in" : "path", | |
| "description" : "Name of the publisher. Example: \"fabrikam\".", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "extensionName", | |
| "in" : "path", | |
| "description" : "Name of the extension. Example: \"ops-tools\".", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "assetTypes", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "array (string)" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/InstalledExtension" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.extension_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "installedExtensionsByName", | |
| "x-ms-vss-method" : "GetInstalledExtensionByName", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/InstalledExtensionsByName/GetInstalledSampleExtension.json" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "Installed Extensions" ], | |
| "description" : "Uninstall the specified extension from the account / project collection.", | |
| "operationId" : "Uninstall Extension By Name", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "publisherName", | |
| "in" : "path", | |
| "description" : "Name of the publisher. Example: \"fabrikam\".", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "extensionName", | |
| "in" : "path", | |
| "description" : "Name of the extension. Example: \"ops-tools\".", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "reason", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "reasonCode", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.extension_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "installedExtensionsByName", | |
| "x-ms-vss-method" : "UninstallExtensionByName", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/InstalledExtensionsByName/UninstallSampleExtension.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/extensionmanagement/installedextensionsbyname/{publisherName}/{extensionName}/{version}" : { | |
| "post" : { | |
| "tags" : [ "Installed Extensions" ], | |
| "description" : "Install the specified extension into the account / project collection.", | |
| "operationId" : "Install Extension By Name", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "publisherName", | |
| "in" : "path", | |
| "description" : "Name of the publisher. Example: \"fabrikam\".", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "extensionName", | |
| "in" : "path", | |
| "description" : "Name of the extension. Example: \"ops-tools\".", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "version", | |
| "in" : "path", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/InstalledExtension" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.extension_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "installedExtensionsByName", | |
| "x-ms-vss-method" : "InstallExtensionByName", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/InstalledExtensionsByName/InstallSampleExtension.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/deletedrepositories" : { | |
| "get" : { | |
| "tags" : [ "Repositories" ], | |
| "description" : "Retrieve deleted git repositories.", | |
| "operationId" : "Get Deleted Repositories", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/GitDeletedRepository" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "deletedRepositories", | |
| "x-ms-vss-method" : "GetDeletedRepositories", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/favorites/refs" : { | |
| "get" : { | |
| "tags" : [ "Refs Favorites" ], | |
| "description" : "Gets the refs favorites for a repo and an identity.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "query", | |
| "description" : "The id of the repository.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "identityId", | |
| "in" : "query", | |
| "description" : "The id of the identity whose favorites are to be retrieved. If null, the requesting identity is used.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/GitRefFavorite" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "refsFavorites", | |
| "x-ms-vss-method" : "GetRefFavorites", | |
| "x-ms-preview" : true | |
| }, | |
| "post" : { | |
| "tags" : [ "Refs Favorites" ], | |
| "description" : "Creates a ref favorite", | |
| "operationId" : "Create", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "The ref favorite to create.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitRefFavorite" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitRefFavorite" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "refsFavorites", | |
| "x-ms-vss-method" : "CreateFavorite", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/favorites/refs/{favoriteId}" : { | |
| "get" : { | |
| "tags" : [ "Refs Favorites" ], | |
| "description" : "Gets the refs favorite for a favorite Id.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "favoriteId", | |
| "in" : "path", | |
| "description" : "The Id of the requested ref favorite.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitRefFavorite" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "refsFavorites", | |
| "x-ms-vss-method" : "GetRefFavorite", | |
| "x-ms-preview" : true | |
| }, | |
| "delete" : { | |
| "tags" : [ "Refs Favorites" ], | |
| "description" : "Deletes the refs favorite specified", | |
| "operationId" : "Delete", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "favoriteId", | |
| "in" : "path", | |
| "description" : "The Id of the ref favorite to delete.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "refsFavorites", | |
| "x-ms-vss-method" : "DeleteRefFavorite", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/policy/configurations" : { | |
| "get" : { | |
| "tags" : [ "Policy Configurations" ], | |
| "description" : "Retrieve a list of policy configurations by a given set of scope/filtering criteria.\n\nBelow is a short description of how all of the query parameters interact with each other:\n- repositoryId set, refName set: returns all policy configurations that *apply* to a particular branch in a repository\n- repositoryId set, refName unset: returns all policy configurations that *apply* to a particular repository\n- repositoryId unset, refName unset: returns all policy configurations that are *defined* at the project level\n- repositoryId unset, refName set: returns all project-level branch policies, plus the project level configurations\nFor all of the examples above, when policyType is set, it'll restrict results to the given policy type", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "query", | |
| "description" : "The repository id.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "refName", | |
| "in" : "query", | |
| "description" : "The fully-qualified Git ref name (e.g. refs/heads/master).", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "policyType", | |
| "in" : "query", | |
| "description" : "The policy type filter.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/PolicyConfiguration" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "policyConfigurations", | |
| "x-ms-vss-method" : "GetPolicyConfigurations", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/pullrequests" : { | |
| "get" : { | |
| "tags" : [ "Pull Requests" ], | |
| "description" : "Retrieve all pull requests matching a specified criteria.", | |
| "operationId" : "Get Pull Requests By Project", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "searchCriteria.includeLinks", | |
| "in" : "query", | |
| "description" : "Whether to include the _links field on the shallow references", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "searchCriteria.sourceRefName", | |
| "in" : "query", | |
| "description" : "If set, search for pull requests from this branch.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "searchCriteria.sourceRepositoryId", | |
| "in" : "query", | |
| "description" : "If set, search for pull requests whose source branch is in this repository.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "searchCriteria.targetRefName", | |
| "in" : "query", | |
| "description" : "If set, search for pull requests into this branch.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "searchCriteria.status", | |
| "in" : "query", | |
| "description" : "If set, search for pull requests that are in this state. Defaults to Active if unset.", | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "notSet", "active", "abandoned", "completed", "all" ], | |
| "x-ms-enum" : { | |
| "name" : "PullRequestStatus", | |
| "values" : [ { | |
| "value" : "notSet", | |
| "description" : "Status not set. Default state." | |
| }, { | |
| "value" : "active", | |
| "description" : "Pull request is active." | |
| }, { | |
| "value" : "abandoned", | |
| "description" : "Pull request is abandoned." | |
| }, { | |
| "value" : "completed", | |
| "description" : "Pull request is completed." | |
| }, { | |
| "value" : "all", | |
| "description" : "Used in pull request search criterias to include all statuses." | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "PullRequestStatus", | |
| "values" : [ { | |
| "value" : "notSet", | |
| "description" : "Status not set. Default state." | |
| }, { | |
| "value" : "active", | |
| "description" : "Pull request is active." | |
| }, { | |
| "value" : "abandoned", | |
| "description" : "Pull request is abandoned." | |
| }, { | |
| "value" : "completed", | |
| "description" : "Pull request is completed." | |
| }, { | |
| "value" : "all", | |
| "description" : "Used in pull request search criterias to include all statuses." | |
| } ] | |
| } | |
| }, { | |
| "name" : "searchCriteria.reviewerId", | |
| "in" : "query", | |
| "description" : "If set, search for pull requests that have this identity as a reviewer.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "searchCriteria.creatorId", | |
| "in" : "query", | |
| "description" : "If set, search for pull requests that were created by this identity.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "searchCriteria.repositoryId", | |
| "in" : "query", | |
| "description" : "If set, search for pull requests whose target branch is in this repository.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "maxCommentLength", | |
| "in" : "query", | |
| "description" : "Not used.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "$skip", | |
| "in" : "query", | |
| "description" : "The number of pull requests to ignore. For example, to retrieve results 101-150, set top to 50 and skip to 100.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "$top", | |
| "in" : "query", | |
| "description" : "The number of pull requests to retrieve.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/GitPullRequest" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "pullRequests", | |
| "x-ms-vss-method" : "GetPullRequestsByProject", | |
| "x-ms-examples" : { | |
| "Pull requests by project" : { | |
| "$ref" : "./httpExamples/PullRequests/GET__git_pullRequests.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/pullrequests/{pullRequestId}" : { | |
| "get" : { | |
| "tags" : [ "Pull Requests" ], | |
| "description" : "Retrieve a pull request.", | |
| "operationId" : "Get Pull Request By Id", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "The ID of the pull request to retrieve.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitPullRequest" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "pullRequests", | |
| "x-ms-vss-method" : "GetPullRequestById", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/PullRequests/GET__git_repositories__repositoryId__pullRequests__pullRequestId_.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/recycleBin/repositories" : { | |
| "get" : { | |
| "tags" : [ "Repositories" ], | |
| "description" : "Retrieve soft-deleted git repositories from the recycle bin.", | |
| "operationId" : "Get Recycle Bin Repositories", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/GitDeletedRepository" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "recycleBinRepositories", | |
| "x-ms-vss-method" : "GetRecycleBinRepositories", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/recycleBin/repositories/{repositoryId}" : { | |
| "delete" : { | |
| "tags" : [ "Repositories" ], | |
| "description" : "Destroy (hard delete) a soft-deleted Git repository.", | |
| "operationId" : "Delete Repository From Recycle Bin", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The ID of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "recycleBinRepositories", | |
| "x-ms-vss-method" : "DeleteRepositoryFromRecycleBin", | |
| "x-ms-preview" : true | |
| }, | |
| "patch" : { | |
| "tags" : [ "Repositories" ], | |
| "description" : "Recover a soft-deleted Git repository. Recently deleted repositories go into a soft-delete state for a period of time before they are hard deleted and become unrecoverable.", | |
| "operationId" : "Restore Repository From Recycle Bin", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The ID of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitRecycleBinRepositoryDetails" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitRepository" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "recycleBinRepositories", | |
| "x-ms-vss-method" : "RestoreRepositoryFromRecycleBin", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories" : { | |
| "get" : { | |
| "tags" : [ "Repositories" ], | |
| "description" : "Retrieve git repositories.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "includeLinks", | |
| "in" : "query", | |
| "description" : "[optional] True to include reference links. The default value is false.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "includeAllUrls", | |
| "in" : "query", | |
| "description" : "[optional] True to include all remote URLs. The default value is false.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "includeHidden", | |
| "in" : "query", | |
| "description" : "[optional] True to include hidden repositories. The default value is false.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/GitRepository" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "repositories", | |
| "x-ms-vss-method" : "GetRepositories", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Repositories/GET__git_repositories.json" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "Repositories" ], | |
| "description" : "Create a git repository in a team project.", | |
| "operationId" : "Create", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "sourceRef", | |
| "in" : "query", | |
| "description" : "[optional] Specify the source refs to use while creating a fork repo", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Specify the repo name, team project and/or parent repository. Team project information can be ommitted from gitRepositoryToCreate if the request is project-scoped (i.e., includes project Id).", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitRepositoryCreateOptions" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "201" : { | |
| "description" : "Created", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitRepository" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "repositories", | |
| "x-ms-vss-method" : "CreateRepository", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Repositories/POST__git_repositories.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}" : { | |
| "get" : { | |
| "tags" : [ "Repositories" ], | |
| "description" : "Retrieve a git repository.", | |
| "operationId" : "Get Repository", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The name or ID of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitRepository" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "repositories", | |
| "x-ms-vss-method" : "GetRepository", | |
| "x-ms-examples" : { | |
| "Get a repository by repositoryId" : { | |
| "$ref" : "./httpExamples/Repositories/GET__git_repositories__repositoryId_.json" | |
| }, | |
| "Get a repository by remote URL" : { | |
| "$ref" : "./httpExamples/Repositories/GET__git_repositories__remoteurl.json" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "Repositories" ], | |
| "description" : "Delete a git repository", | |
| "operationId" : "Delete", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The name or ID of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "repositories", | |
| "x-ms-vss-method" : "DeleteRepository", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Repositories/DELETE__git_repositories__repositoryId_.json" | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "Repositories" ], | |
| "description" : "Updates the Git repository with either a new repo name or a new default branch.", | |
| "operationId" : "Update", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The name or ID of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Specify a new repo name or a new default branch of the repository", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitRepository" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitRepository" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "repositories", | |
| "x-ms-vss-method" : "UpdateRepository", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Repositories/PATCH__git_repositories__repositoryId_.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/annotatedtags" : { | |
| "post" : { | |
| "tags" : [ "Annotated Tags" ], | |
| "description" : "Create an annotated tag.\n\nRepositories have both a name and an identifier. Identifiers are globally unique, but several projects\nmay contain a repository of the same name. You don't need to include the project if you specify a\nrepository by ID. However, if you specify a repository by name, you must also specify the project (by name or ID).", | |
| "operationId" : "Create", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "ID or name of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Object containing details of tag to be created.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitAnnotatedTag" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitAnnotatedTag" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "annotatedTags", | |
| "x-ms-vss-method" : "CreateAnnotatedTag", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/annotatedTags/POST__git_repositories__annotated__tags.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/annotatedtags/{objectId}" : { | |
| "get" : { | |
| "tags" : [ "Annotated Tags" ], | |
| "description" : "Get an annotated tag.\n\nRepositories have both a name and an identifier. Identifiers are globally unique, but several projects\nmay contain a repository of the same name. You don't need to include the project if you specify a\nrepository by ID. However, if you specify a repository by name, you must also specify the project (by name or ID).", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "ID or name of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "objectId", | |
| "in" : "path", | |
| "description" : "ObjectId (Sha1Id) of tag to get.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitAnnotatedTag" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "annotatedTags", | |
| "x-ms-vss-method" : "GetAnnotatedTag", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/annotatedTags/GET__git_repositories__annotated__tags.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/blobs" : { | |
| "post" : { | |
| "tags" : [ "Blobs" ], | |
| "description" : "Gets one or more blobs in a zip file download.", | |
| "operationId" : "Get Blobs Zip", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The name or ID of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "filename", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Blob IDs (SHA1 hashes) to be returned in the zip file.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "string" | |
| } | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/zip" : { | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "Stream" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "blobs", | |
| "x-ms-vss-method" : "GetBlobs" | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/blobs/{sha1}" : { | |
| "get" : { | |
| "tags" : [ "Blobs" ], | |
| "description" : "Get a single blob.\n\nRepositories have both a name and an identifier. Identifiers are globally unique,\nbut several projects may contain a repository of the same name. You don't need to include\nthe project if you specify a repository by ID. However, if you specify a repository by name,\nyou must also specify the project (by name or ID).", | |
| "operationId" : "Get Blob", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The name or ID of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "sha1", | |
| "in" : "path", | |
| "description" : "SHA1 hash of the file. You can get the SHA1 of a file using the \"Git/Items/Get Item\" endpoint.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "download", | |
| "in" : "query", | |
| "description" : "If true, prompt for a download rather than rendering in a browser. Note: this value defaults to true if $format is zip", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "fileName", | |
| "in" : "query", | |
| "description" : "Provide a fileName to use for a download.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "$format", | |
| "in" : "query", | |
| "description" : "Options: json, zip, text, octetstream. If not set, defaults to the MIME type set in the Accept header.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "resolveLfs", | |
| "in" : "query", | |
| "description" : "If true, try to resolve a blob to its LFS contents, if it's an LFS pointer file. Only compatible with octet-stream Accept headers or $format types", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/zip" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitBlobRef" | |
| } | |
| }, | |
| "application/octet-stream" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitBlobRef" | |
| } | |
| }, | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitBlobRef" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "blobs", | |
| "x-ms-vss-method" : "GetBlob", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Blobs/GET__git_repositories__repositoryId__blobs__objectId_.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/cherryPicks" : { | |
| "get" : { | |
| "tags" : [ "Cherry Picks" ], | |
| "description" : "Retrieve information about a cherry pick for a specific branch.", | |
| "operationId" : "Get Cherry Pick For Ref Name", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "ID of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "refName", | |
| "in" : "query", | |
| "description" : "The GitAsyncRefOperationParameters generatedRefName used for the cherry pick operation.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitCherryPick" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "cherryPicks", | |
| "x-ms-vss-method" : "GetCherryPickForRefName", | |
| "x-ms-preview" : true | |
| }, | |
| "post" : { | |
| "tags" : [ "Cherry Picks" ], | |
| "description" : "Cherry pick a specific commit or commits that are associated to a pull request into a new branch.", | |
| "operationId" : "Create", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "ID of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitAsyncRefOperationParameters" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitCherryPick" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "cherryPicks", | |
| "x-ms-vss-method" : "CreateCherryPick", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/cherryPicks/{cherryPickId}" : { | |
| "get" : { | |
| "tags" : [ "Cherry Picks" ], | |
| "description" : "Retrieve information about a cherry pick by cherry pick Id.", | |
| "operationId" : "Get Cherry Pick", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "cherryPickId", | |
| "in" : "path", | |
| "description" : "ID of the cherry pick.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "ID of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitCherryPick" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "cherryPicks", | |
| "x-ms-vss-method" : "GetCherryPick", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/commits" : { | |
| "get" : { | |
| "tags" : [ "Commits" ], | |
| "description" : "Retrieve a list of commits associated with a particular push.", | |
| "operationId" : "Get Push Commits", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The id or friendly name of the repository. To use the friendly name, projectId must also be specified.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pushId", | |
| "in" : "query", | |
| "description" : "The id of the push.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "top", | |
| "in" : "query", | |
| "description" : "The maximum number of commits to return (\"get the top x commits\").", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "skip", | |
| "in" : "query", | |
| "description" : "The number of commits to skip.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "includeLinks", | |
| "in" : "query", | |
| "description" : "Set to false to avoid including REST Url links for resources. Defaults to true.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/GitCommitRef" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "commits", | |
| "x-ms-vss-method" : "GetPushCommits", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Commits/GET__git_repositories__repositoryId__pushes__pushId__commits.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/commits/{commitId}" : { | |
| "get" : { | |
| "tags" : [ "Commits" ], | |
| "description" : "Retrieve a particular commit.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "commitId", | |
| "in" : "path", | |
| "description" : "The id of the commit.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The id or friendly name of the repository. To use the friendly name, projectId must also be specified.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "changeCount", | |
| "in" : "query", | |
| "description" : "The number of changes to include in the result.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitCommit" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "commits", | |
| "x-ms-vss-method" : "GetCommit", | |
| "x-ms-examples" : { | |
| "Get by ID" : { | |
| "$ref" : "./httpExamples/Commits/GET__git_repositories__repositoryId__commits__commitId_.json" | |
| }, | |
| "With limited changes" : { | |
| "$ref" : "./httpExamples/Commits/GET__git_repositories__repositoryId__commits__commitId__changeCount-10.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/commits/{commitId}/changes" : { | |
| "get" : { | |
| "tags" : [ "Commits" ], | |
| "description" : "Retrieve changes for a particular commit.", | |
| "operationId" : "Get Changes", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "commitId", | |
| "in" : "path", | |
| "description" : "The id of the commit.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The id or friendly name of the repository. To use the friendly name, projectId must also be specified.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "top", | |
| "in" : "query", | |
| "description" : "The maximum number of changes to return.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "skip", | |
| "in" : "query", | |
| "description" : "The number of changes to skip.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitCommitChanges" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "changes", | |
| "x-ms-vss-method" : "GetChanges", | |
| "x-ms-examples" : { | |
| "With changes" : { | |
| "$ref" : "./httpExamples/Changes/GET__git_repositories__repositoryId__commits__commitId__changes_top-_top__skip-_skip_.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/commits/{commitId}/statuses" : { | |
| "get" : { | |
| "tags" : [ "Statuses" ], | |
| "description" : "Get statuses associated with the Git commit.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "commitId", | |
| "in" : "path", | |
| "description" : "ID of the Git commit.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "ID of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "top", | |
| "in" : "query", | |
| "description" : "Optional. The number of statuses to retrieve. Default is 1000.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "skip", | |
| "in" : "query", | |
| "description" : "Optional. The number of statuses to ignore. Default is 0. For example, to retrieve results 101-150, set top to 50 and skip to 100.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "latestOnly", | |
| "in" : "query", | |
| "description" : "The flag indicates whether to get only latest statuses grouped by `Context.Name` and `Context.Genre`.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/GitStatus" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code", "vso.code_status" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "statuses", | |
| "x-ms-vss-method" : "GetStatuses", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Statuses/GET__git_repositories__repositoryId__commits__commitId__statuses.json" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "Statuses" ], | |
| "description" : "Create Git commit status.", | |
| "operationId" : "Create", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "commitId", | |
| "in" : "path", | |
| "description" : "ID of the Git commit.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "ID of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Git commit status object to create.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitStatus" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitStatus" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_write", "vso.code_status" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "statuses", | |
| "x-ms-vss-method" : "CreateCommitStatus", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Statuses/POST__git_repositories__repositoryId__commits__commitId__statuses.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/commitsbatch" : { | |
| "post" : { | |
| "tags" : [ "Commits" ], | |
| "description" : "Retrieve git commits for a project matching the search criteria", | |
| "operationId" : "Get Commits Batch", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The name or ID of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "$skip", | |
| "in" : "query", | |
| "description" : "Number of commits to skip.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "$top", | |
| "in" : "query", | |
| "description" : "Maximum number of commits to return.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "includeStatuses", | |
| "in" : "query", | |
| "description" : "True to include additional commit status information.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Search options", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitQueryCommitsCriteria" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/GitCommitRef" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "commitsBatch", | |
| "x-ms-vss-method" : "GetCommitsBatch", | |
| "x-ms-examples" : { | |
| "Commits by a list of commit IDs" : { | |
| "$ref" : "./httpExamples/CommitsBatch/POST__git_repositories__repositoryId__commitsBatch__ids.json" | |
| }, | |
| "Commits between two versions" : { | |
| "$ref" : "./httpExamples/CommitsBatch/POST__git_repositories__repositoryId__commitsBatch2.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/diffs/commits" : { | |
| "get" : { | |
| "tags" : [ "Diffs" ], | |
| "description" : "Find the closest common commit (the merge base) between base and target commits, and get the diff between either the base and target commits or common and target commits.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The name or ID of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "diffCommonCommit", | |
| "in" : "query", | |
| "description" : "If true, diff between common and target commits. If false, diff between base and target commits.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "$top", | |
| "in" : "query", | |
| "description" : "Maximum number of changes to return. Defaults to 100.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "$skip", | |
| "in" : "query", | |
| "description" : "Number of changes to skip", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "baseVersionOptions", | |
| "in" : "query", | |
| "description" : "Version options - Specify additional modifiers to version (e.g Previous)", | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "none", "previousChange", "firstParent" ], | |
| "x-ms-enum" : { | |
| "name" : "GitVersionOptions", | |
| "values" : [ { | |
| "value" : "none", | |
| "description" : "Not specified" | |
| }, { | |
| "value" : "previousChange", | |
| "description" : "Commit that changed item prior to the current version" | |
| }, { | |
| "value" : "firstParent", | |
| "description" : "First parent of commit (HEAD^)" | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "GitVersionOptions", | |
| "values" : [ { | |
| "value" : "none", | |
| "description" : "Not specified" | |
| }, { | |
| "value" : "previousChange", | |
| "description" : "Commit that changed item prior to the current version" | |
| }, { | |
| "value" : "firstParent", | |
| "description" : "First parent of commit (HEAD^)" | |
| } ] | |
| } | |
| }, { | |
| "name" : "baseVersion", | |
| "in" : "query", | |
| "description" : "Version string identifier (name of tag/branch, SHA1 of commit)", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "baseVersionType", | |
| "in" : "query", | |
| "description" : "Version type (branch, tag, or commit). Determines how Id is interpreted", | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "branch", "tag", "commit" ], | |
| "x-ms-enum" : { | |
| "name" : "GitVersionType", | |
| "values" : [ { | |
| "value" : "branch", | |
| "description" : "Interpret the version as a branch name" | |
| }, { | |
| "value" : "tag", | |
| "description" : "Interpret the version as a tag name" | |
| }, { | |
| "value" : "commit", | |
| "description" : "Interpret the version as a commit ID (SHA1)" | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "GitVersionType", | |
| "values" : [ { | |
| "value" : "branch", | |
| "description" : "Interpret the version as a branch name" | |
| }, { | |
| "value" : "tag", | |
| "description" : "Interpret the version as a tag name" | |
| }, { | |
| "value" : "commit", | |
| "description" : "Interpret the version as a commit ID (SHA1)" | |
| } ] | |
| } | |
| }, { | |
| "name" : "targetVersionOptions", | |
| "in" : "query", | |
| "description" : "Version options - Specify additional modifiers to version (e.g Previous)", | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "none", "previousChange", "firstParent" ], | |
| "x-ms-enum" : { | |
| "name" : "GitVersionOptions", | |
| "values" : [ { | |
| "value" : "none", | |
| "description" : "Not specified" | |
| }, { | |
| "value" : "previousChange", | |
| "description" : "Commit that changed item prior to the current version" | |
| }, { | |
| "value" : "firstParent", | |
| "description" : "First parent of commit (HEAD^)" | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "GitVersionOptions", | |
| "values" : [ { | |
| "value" : "none", | |
| "description" : "Not specified" | |
| }, { | |
| "value" : "previousChange", | |
| "description" : "Commit that changed item prior to the current version" | |
| }, { | |
| "value" : "firstParent", | |
| "description" : "First parent of commit (HEAD^)" | |
| } ] | |
| } | |
| }, { | |
| "name" : "targetVersion", | |
| "in" : "query", | |
| "description" : "Version string identifier (name of tag/branch, SHA1 of commit)", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "targetVersionType", | |
| "in" : "query", | |
| "description" : "Version type (branch, tag, or commit). Determines how Id is interpreted", | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "branch", "tag", "commit" ], | |
| "x-ms-enum" : { | |
| "name" : "GitVersionType", | |
| "values" : [ { | |
| "value" : "branch", | |
| "description" : "Interpret the version as a branch name" | |
| }, { | |
| "value" : "tag", | |
| "description" : "Interpret the version as a tag name" | |
| }, { | |
| "value" : "commit", | |
| "description" : "Interpret the version as a commit ID (SHA1)" | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "GitVersionType", | |
| "values" : [ { | |
| "value" : "branch", | |
| "description" : "Interpret the version as a branch name" | |
| }, { | |
| "value" : "tag", | |
| "description" : "Interpret the version as a tag name" | |
| }, { | |
| "value" : "commit", | |
| "description" : "Interpret the version as a commit ID (SHA1)" | |
| } ] | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitCommitDiffs" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "commitDiffs", | |
| "x-ms-vss-method" : "GetCommitDiffs", | |
| "x-ms-examples" : { | |
| "Between commit IDs" : { | |
| "$ref" : "./httpExamples/CommitDiffs/GET__git_repositories__repositoryId__diffs_commits_baseVersionType-_baseVersionType_.json" | |
| }, | |
| "Between branches" : { | |
| "$ref" : "./httpExamples/CommitDiffs/GET__git_repositories__repositoryId__diffs_commits_targetVersion-_targetVersion__baseVersion-_baseVersion_.json" | |
| }, | |
| "A page at a time" : { | |
| "$ref" : "./httpExamples/CommitDiffs/GET__git_repositories__repositoryId__diffs_commits_targetVersion-_targetVersion__baseVersion-_baseVersion___top-_top___skip-_skip_.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/importRequests" : { | |
| "get" : { | |
| "tags" : [ "Import Requests" ], | |
| "description" : "Retrieve import requests for a repository.", | |
| "operationId" : "Query", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The name or ID of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "includeAbandoned", | |
| "in" : "query", | |
| "description" : "True to include abandoned import requests in the results.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/GitImportRequest" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "importRequests", | |
| "x-ms-vss-method" : "QueryImportRequests", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "By repository ID" : { | |
| "$ref" : "./httpExamples/ImportRequests/GET__git_repositories__repositoryId__importRequests.json" | |
| }, | |
| "By repository ID with abandoned requests" : { | |
| "$ref" : "./httpExamples/ImportRequests/GET__git_repositories__repositoryId__importRequests_includeAbandoned-True.json" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "Import Requests" ], | |
| "description" : "Create an import request.", | |
| "operationId" : "Create", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The name or ID of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "The import request to create.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitImportRequest" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitImportRequest" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "importRequests", | |
| "x-ms-vss-method" : "CreateImportRequest", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/ImportRequests/POST__git_repositories__repositoryId__importRequests.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/importRequests/{importRequestId}" : { | |
| "get" : { | |
| "tags" : [ "Import Requests" ], | |
| "description" : "Retrieve a particular import request.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The name or ID of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "importRequestId", | |
| "in" : "path", | |
| "description" : "The unique identifier for the import request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitImportRequest" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "importRequests", | |
| "x-ms-vss-method" : "GetImportRequest", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/ImportRequests/GET__git_repositories__repositoryId__importRequests__importRequestId_.json" | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "Import Requests" ], | |
| "description" : "Retry or abandon a failed import request.\n\nThere can only be one active import request associated with a repository. Marking a failed import request abandoned makes it inactive.", | |
| "operationId" : "Update", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The name or ID of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "importRequestId", | |
| "in" : "path", | |
| "description" : "The unique identifier for the import request to update.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "The updated version of the import request. Currently, the only change allowed is setting the Status to Queued or Abandoned.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitImportRequest" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitImportRequest" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "importRequests", | |
| "x-ms-vss-method" : "UpdateImportRequest", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "Retry or abandon a failed import request" : { | |
| "$ref" : "./httpExamples/ImportRequests/PATCH__git_repositories__repositoryId__importRequests__importRequestId_.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/items" : { | |
| "get" : { | |
| "tags" : [ "Items" ], | |
| "description" : "Get Item Metadata and/or Content for a collection of items. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The name or ID of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "scopePath", | |
| "in" : "query", | |
| "description" : "The path scope. The default is null.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "recursionLevel", | |
| "in" : "query", | |
| "description" : "The recursion level of this request. The default is 'none', no recursion.", | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "none", "oneLevel", "oneLevelPlusNestedEmptyFolders", "full" ], | |
| "x-ms-enum" : { | |
| "name" : "VersionControlRecursionType", | |
| "values" : [ { | |
| "value" : "none", | |
| "description" : "Only return the specified item." | |
| }, { | |
| "value" : "oneLevel", | |
| "description" : "Return the specified item and its direct children." | |
| }, { | |
| "value" : "oneLevelPlusNestedEmptyFolders", | |
| "description" : "Return the specified item and its direct children, as well as recursive chains of nested child folders that only contain a single folder." | |
| }, { | |
| "value" : "full", | |
| "description" : "Return specified item and all descendants" | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "VersionControlRecursionType", | |
| "values" : [ { | |
| "value" : "none", | |
| "description" : "Only return the specified item." | |
| }, { | |
| "value" : "oneLevel", | |
| "description" : "Return the specified item and its direct children." | |
| }, { | |
| "value" : "oneLevelPlusNestedEmptyFolders", | |
| "description" : "Return the specified item and its direct children, as well as recursive chains of nested child folders that only contain a single folder." | |
| }, { | |
| "value" : "full", | |
| "description" : "Return specified item and all descendants" | |
| } ] | |
| } | |
| }, { | |
| "name" : "includeContentMetadata", | |
| "in" : "query", | |
| "description" : "Set to true to include content metadata. Default is false.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "latestProcessedChange", | |
| "in" : "query", | |
| "description" : "Set to true to include the lastest changes. Default is false.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "download", | |
| "in" : "query", | |
| "description" : "Set to true to download the response as a file. Default is false.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "includeLinks", | |
| "in" : "query", | |
| "description" : "Set to true to include links to items. Default is false.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "$format", | |
| "in" : "query", | |
| "description" : "If specified, this overrides the HTTP Accept request header to return either 'json' or 'zip'. If $format is specified, then api-version should also be specified as a query parameter.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "versionDescriptor.versionOptions", | |
| "in" : "query", | |
| "description" : "Version options - Specify additional modifiers to version (e.g Previous)", | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "none", "previousChange", "firstParent" ], | |
| "x-ms-enum" : { | |
| "name" : "GitVersionOptions", | |
| "values" : [ { | |
| "value" : "none", | |
| "description" : "Not specified" | |
| }, { | |
| "value" : "previousChange", | |
| "description" : "Commit that changed item prior to the current version" | |
| }, { | |
| "value" : "firstParent", | |
| "description" : "First parent of commit (HEAD^)" | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "GitVersionOptions", | |
| "values" : [ { | |
| "value" : "none", | |
| "description" : "Not specified" | |
| }, { | |
| "value" : "previousChange", | |
| "description" : "Commit that changed item prior to the current version" | |
| }, { | |
| "value" : "firstParent", | |
| "description" : "First parent of commit (HEAD^)" | |
| } ] | |
| } | |
| }, { | |
| "name" : "versionDescriptor.version", | |
| "in" : "query", | |
| "description" : "Version string identifier (name of tag/branch, SHA1 of commit)", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "versionDescriptor.versionType", | |
| "in" : "query", | |
| "description" : "Version type (branch, tag, or commit). Determines how Id is interpreted", | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "branch", "tag", "commit" ], | |
| "x-ms-enum" : { | |
| "name" : "GitVersionType", | |
| "values" : [ { | |
| "value" : "branch", | |
| "description" : "Interpret the version as a branch name" | |
| }, { | |
| "value" : "tag", | |
| "description" : "Interpret the version as a tag name" | |
| }, { | |
| "value" : "commit", | |
| "description" : "Interpret the version as a commit ID (SHA1)" | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "GitVersionType", | |
| "values" : [ { | |
| "value" : "branch", | |
| "description" : "Interpret the version as a branch name" | |
| }, { | |
| "value" : "tag", | |
| "description" : "Interpret the version as a tag name" | |
| }, { | |
| "value" : "commit", | |
| "description" : "Interpret the version as a commit ID (SHA1)" | |
| } ] | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/GitItem" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "items", | |
| "x-ms-vss-method" : "GetItems", | |
| "x-ms-examples" : { | |
| "For a path" : { | |
| "$ref" : "./httpExamples/Items/GET__git_repositories__repositoryId__items_scopePath-_folderPath_.json" | |
| }, | |
| "Single level of recursion" : { | |
| "$ref" : "./httpExamples/Items/GET__git_repositories__repositoryId__items_scopePath-_folderPath__recursionLevel-OneLevel.json" | |
| }, | |
| "Full recursion and with content metadata" : { | |
| "$ref" : "./httpExamples/Items/GET__git_repositories__repositoryId__items_scopePath-_folderPath__recursionLevel-Full_includeContentMetadata-true.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/itemsbatch" : { | |
| "post" : { | |
| "tags" : [ "Items" ], | |
| "description" : "Post for retrieving a creating a batch out of a set of items in a repo / project given a list of paths or a long path", | |
| "operationId" : "Get Items Batch", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The name or ID of the repository", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Request data attributes: ItemDescriptors, IncludeContentMetadata, LatestProcessedChange, IncludeLinks. ItemDescriptors: Collection of items to fetch, including path, version, and recursion level. IncludeContentMetadata: Whether to include metadata for all items LatestProcessedChange: Whether to include shallow ref to commit that last changed each item. IncludeLinks: Whether to include the _links field on the shallow references.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitItemRequestData" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "type" : "array" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "itemsBatch", | |
| "x-ms-vss-method" : "GetItemsBatch", | |
| "x-ms-examples" : { | |
| "Multiple items" : { | |
| "$ref" : "./httpExamples/ItemsBatch/POST__git_repositories__repositoryId__itemsBatch.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullrequestquery" : { | |
| "post" : { | |
| "tags" : [ "Pull Request Query" ], | |
| "description" : "This API is used to find what pull requests are related to a given commit. It can be used to either find the pull request that created a particular merge commit or it can be used to find all pull requests that have ever merged a particular commit. The input is a list of queries which each contain a list of commits. For each commit that you search against, you will get back a dictionary of commit -> pull requests.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "ID of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "The list of queries to perform.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitPullRequestQuery" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitPullRequestQuery" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "pullRequestQuery", | |
| "x-ms-vss-method" : "GetPullRequestQuery" | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullrequests" : { | |
| "get" : { | |
| "tags" : [ "Pull Requests" ], | |
| "description" : "Retrieve all pull requests matching a specified criteria.", | |
| "operationId" : "Get Pull Requests", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request's target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "searchCriteria.includeLinks", | |
| "in" : "query", | |
| "description" : "Whether to include the _links field on the shallow references", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "searchCriteria.sourceRefName", | |
| "in" : "query", | |
| "description" : "If set, search for pull requests from this branch.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "searchCriteria.sourceRepositoryId", | |
| "in" : "query", | |
| "description" : "If set, search for pull requests whose source branch is in this repository.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "searchCriteria.targetRefName", | |
| "in" : "query", | |
| "description" : "If set, search for pull requests into this branch.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "searchCriteria.status", | |
| "in" : "query", | |
| "description" : "If set, search for pull requests that are in this state. Defaults to Active if unset.", | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "notSet", "active", "abandoned", "completed", "all" ], | |
| "x-ms-enum" : { | |
| "name" : "PullRequestStatus", | |
| "values" : [ { | |
| "value" : "notSet", | |
| "description" : "Status not set. Default state." | |
| }, { | |
| "value" : "active", | |
| "description" : "Pull request is active." | |
| }, { | |
| "value" : "abandoned", | |
| "description" : "Pull request is abandoned." | |
| }, { | |
| "value" : "completed", | |
| "description" : "Pull request is completed." | |
| }, { | |
| "value" : "all", | |
| "description" : "Used in pull request search criterias to include all statuses." | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "PullRequestStatus", | |
| "values" : [ { | |
| "value" : "notSet", | |
| "description" : "Status not set. Default state." | |
| }, { | |
| "value" : "active", | |
| "description" : "Pull request is active." | |
| }, { | |
| "value" : "abandoned", | |
| "description" : "Pull request is abandoned." | |
| }, { | |
| "value" : "completed", | |
| "description" : "Pull request is completed." | |
| }, { | |
| "value" : "all", | |
| "description" : "Used in pull request search criterias to include all statuses." | |
| } ] | |
| } | |
| }, { | |
| "name" : "searchCriteria.reviewerId", | |
| "in" : "query", | |
| "description" : "If set, search for pull requests that have this identity as a reviewer.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "searchCriteria.creatorId", | |
| "in" : "query", | |
| "description" : "If set, search for pull requests that were created by this identity.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "searchCriteria.repositoryId", | |
| "in" : "query", | |
| "description" : "If set, search for pull requests whose target branch is in this repository.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "maxCommentLength", | |
| "in" : "query", | |
| "description" : "Not used.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "$skip", | |
| "in" : "query", | |
| "description" : "The number of pull requests to ignore. For example, to retrieve results 101-150, set top to 50 and skip to 100.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "$top", | |
| "in" : "query", | |
| "description" : "The number of pull requests to retrieve.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/GitPullRequest" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "pullRequests", | |
| "x-ms-vss-method" : "GetPullRequests", | |
| "x-ms-examples" : { | |
| "Pull requests by repository" : { | |
| "$ref" : "./httpExamples/PullRequests/GET__git_repositories__repositoryId__pullRequests.json" | |
| }, | |
| "Just completed pull requests" : { | |
| "$ref" : "./httpExamples/PullRequests/GET__git_repositories__repositoryId__pullRequests_status-completed.json" | |
| }, | |
| "Targeting a specific branch" : { | |
| "$ref" : "./httpExamples/PullRequests/GET__git_repositories__repositoryId__pullRequests_targetRefName-refs_heads_master.json" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "Pull Requests" ], | |
| "description" : "Create a pull request.", | |
| "operationId" : "Create", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request's target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "supportsIterations", | |
| "in" : "query", | |
| "description" : "If true, subsequent pushes to the pull request will be individually reviewable. Set this to false for large pull requests for performance reasons if this functionality is not needed.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "The pull request to create.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitPullRequest" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitPullRequest" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_write" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "pullRequests", | |
| "x-ms-vss-method" : "CreatePullRequest", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/PullRequests/POST__git_repositories__repositoryId__pullRequests.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullrequests/{pullRequestId}" : { | |
| "get" : { | |
| "tags" : [ "Pull Requests" ], | |
| "description" : "Retrieve a pull request.", | |
| "operationId" : "Get Pull Request", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request's target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "The ID of the pull request to retrieve.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "maxCommentLength", | |
| "in" : "query", | |
| "description" : "Not used.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "$skip", | |
| "in" : "query", | |
| "description" : "Not used.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "$top", | |
| "in" : "query", | |
| "description" : "Not used.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "includeCommits", | |
| "in" : "query", | |
| "description" : "If true, the pull request will be returned with the associated commits.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "includeWorkItemRefs", | |
| "in" : "query", | |
| "description" : "If true, the pull request will be returned with the associated work item references.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitPullRequest" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "pullRequests", | |
| "x-ms-vss-method" : "GetPullRequest" | |
| }, | |
| "patch" : { | |
| "tags" : [ "Pull Requests" ], | |
| "description" : "Update a pull request.\n\nThese are the properties that can be updated with the API:\n - Status\n - Title\n - Description\n - CompletionOptions\n - MergeOptions\n - AutoCompleteSetBy.Id\n - TargetRefName (when the PR retargeting feature is enabled)\n Attempting to update other properties outside of this list will either cause the server to throw an `InvalidArgumentValueException`,\n or to silently ignore the update.", | |
| "operationId" : "Update", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request's target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "The ID of the pull request to retrieve.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "The pull request content to update.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitPullRequest" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitPullRequest" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_write" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "pullRequests", | |
| "x-ms-vss-method" : "UpdatePullRequest", | |
| "x-ms-examples" : { | |
| "Update title" : { | |
| "$ref" : "./httpExamples/PullRequests/PATCH__git_repositories__repositoryId__pullRequests__pullRequestId_.json" | |
| }, | |
| "Update description" : { | |
| "$ref" : "./httpExamples/PullRequests/PATCH__git_repositories__repositoryId__pullRequests__pullRequestId_2.json" | |
| }, | |
| "Enable auto-completion and set other completion options" : { | |
| "$ref" : "./httpExamples/PullRequests/PATCH__git_repositories__repositoryId__pullRequests__autoCompletePullRequestId_.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/attachments" : { | |
| "get" : { | |
| "tags" : [ "Pull Request Attachments" ], | |
| "description" : "Get a list of files attached to a given pull request.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request’s target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/Attachment" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "pullRequestAttachments", | |
| "x-ms-vss-method" : "GetAttachments", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/attachments/{fileName}" : { | |
| "get" : { | |
| "tags" : [ "Pull Request Attachments" ], | |
| "description" : "Get the file content of a pull request attachment.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "fileName", | |
| "in" : "path", | |
| "description" : "The name of the attachment.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request’s target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/octet-stream" : { | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "Stream" | |
| } | |
| }, | |
| "application/zip" : { | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "Stream" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "pullRequestAttachments", | |
| "x-ms-vss-method" : "GetAttachment", | |
| "x-ms-preview" : true | |
| }, | |
| "post" : { | |
| "tags" : [ "Pull Request Attachments" ], | |
| "description" : "Attach a new file to a pull request.", | |
| "operationId" : "Create", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "fileName", | |
| "in" : "path", | |
| "description" : "The name of the file.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request’s target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Stream to upload", | |
| "content" : { | |
| "application/octet-stream" : { | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "Stream" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "201" : { | |
| "description" : "Created", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Attachment" | |
| } | |
| } | |
| } | |
| }, | |
| "202" : { | |
| "description" : "Accepted", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Attachment" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_write" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "pullRequestAttachments", | |
| "x-ms-vss-method" : "CreateAttachment", | |
| "x-ms-preview" : true | |
| }, | |
| "delete" : { | |
| "tags" : [ "Pull Request Attachments" ], | |
| "description" : "Delete a pull request attachment.", | |
| "operationId" : "Delete", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "fileName", | |
| "in" : "path", | |
| "description" : "The name of the attachment to delete.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request’s target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_write" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "pullRequestAttachments", | |
| "x-ms-vss-method" : "DeleteAttachment", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/commits" : { | |
| "get" : { | |
| "tags" : [ "Pull Request Commits" ], | |
| "description" : "Get the commits for the specified pull request.", | |
| "operationId" : "Get Pull Request Commits", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "ID or name of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/GitCommitRef" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "pullRequestCommits", | |
| "x-ms-vss-method" : "GetPullRequestCommits" | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/iterations" : { | |
| "get" : { | |
| "tags" : [ "Pull Request Iterations" ], | |
| "description" : "Get the list of iterations for the specified pull request.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "ID or name of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "includeCommits", | |
| "in" : "query", | |
| "description" : "If true, include the commits associated with each iteration in the response.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/GitPullRequestIteration" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "pullRequestIterations", | |
| "x-ms-vss-method" : "GetPullRequestIterations" | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/iterations/{iterationId}" : { | |
| "get" : { | |
| "tags" : [ "Pull Request Iterations" ], | |
| "description" : "Get the specified iteration for a pull request.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "ID or name of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "iterationId", | |
| "in" : "path", | |
| "description" : "ID of the pull request iteration to return.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitPullRequestIteration" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "pullRequestIterations", | |
| "x-ms-vss-method" : "GetPullRequestIteration" | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/iterations/{iterationId}/changes" : { | |
| "get" : { | |
| "tags" : [ "Pull Request Iteration Changes" ], | |
| "description" : "Retrieve the changes made in a pull request between two iterations.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request's target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "iterationId", | |
| "in" : "path", | |
| "description" : "ID of the pull request iteration. <br /> Iteration IDs are zero-based with zero indicating the common commit between the source and target branches. Iteration one is the head of the source branch at the time the pull request is created and subsequent iterations are created when there are pushes to the source branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "$top", | |
| "in" : "query", | |
| "description" : "Optional. The number of changes to retrieve. The default value is 100 and the maximum value is 2000.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "$skip", | |
| "in" : "query", | |
| "description" : "Optional. The number of changes to ignore. For example, to retrieve changes 101-150, set top 50 and skip to 100.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "$compareTo", | |
| "in" : "query", | |
| "description" : "ID of the pull request iteration to compare against. The default value is zero which indicates the comparison is made against the common commit between the source and target branches", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitPullRequestIterationChanges" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "pullRequestIterationChanges", | |
| "x-ms-vss-method" : "GetPullRequestIterationChanges", | |
| "x-ms-examples" : { | |
| "Changes in a specific iteration" : { | |
| "$ref" : "./httpExamples/PullRequestIterationChanges/GET__git_repositories__repositoryId__pullRequests__pullRequestId__iterations__iterationId__changes.json" | |
| }, | |
| "Changes since an earlier iteration" : { | |
| "$ref" : "./httpExamples/PullRequestIterationChanges/GET__git_repositories__repositoryId__pullRequests__pullRequestId__iterations__iterationId__changes__compareTo.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/iterations/{iterationId}/commits" : { | |
| "get" : { | |
| "tags" : [ "Pull Request Commits" ], | |
| "description" : "Get the commits for the specified iteration of a pull request.", | |
| "operationId" : "Get Pull Request Iteration Commits", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "ID or name of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "iterationId", | |
| "in" : "path", | |
| "description" : "ID of the iteration from which to get the commits.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/GitCommitRef" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "pullRequestCommits", | |
| "x-ms-vss-method" : "GetPullRequestIterationCommits" | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/iterations/{iterationId}/statuses" : { | |
| "get" : { | |
| "tags" : [ "Pull Request Iteration Statuses" ], | |
| "description" : "Get all the statuses associated with a pull request iteration.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request’s target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "iterationId", | |
| "in" : "path", | |
| "description" : "ID of the pull request iteration.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/GitPullRequestStatus" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code", "vso.code_status" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "pullRequestIterationStatuses", | |
| "x-ms-vss-method" : "GetPullRequestIterationStatuses", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/PullRequestIterationStatuses/GET_git_pullRequestStatuses_iterationStatuses.json" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "Pull Request Iteration Statuses" ], | |
| "description" : "Create a pull request status on the iteration. This operation will have the same result as Create status on pull request with specified iteration ID in the request body.\n\nThe only required field for the status is `Context.Name` that uniquely identifies the status.\nNote that `iterationId` in the request body is optional since `iterationId` can be specified in the URL.\nA conflict between `iterationId` in the URL and `iterationId` in the request body will result in status code 400.", | |
| "operationId" : "Create", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request’s target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "iterationId", | |
| "in" : "path", | |
| "description" : "ID of the pull request iteration.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Pull request status to create.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitPullRequestStatus" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitPullRequestStatus" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_write", "vso.code_status" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "pullRequestIterationStatuses", | |
| "x-ms-vss-method" : "CreatePullRequestIterationStatus", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/PullRequestIterationStatuses/POST_git_pullRequestStatuses_iterationStatus.json" | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "Pull Request Iteration Statuses" ], | |
| "description" : "Update pull request iteration statuses collection. The only supported operation type is `remove`.\n\nThis operation allows to delete multiple statuses in one call.\nThe path of the `remove` operation should refer to the ID of the pull request status.\nFor example `path=\"/1\"` refers to the pull request status with ID 1.", | |
| "operationId" : "Update", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request’s target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "iterationId", | |
| "in" : "path", | |
| "description" : "ID of the pull request iteration.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Operations to apply to the pull request statuses in JSON Patch format.", | |
| "content" : { | |
| "application/json-patch+json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/JsonPatchDocument" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_write", "vso.code_status" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "pullRequestIterationStatuses", | |
| "x-ms-vss-method" : "UpdatePullRequestIterationStatuses", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/PullRequestIterationStatuses/PATCH_git_pullRequestStatuses_iterationStatuses.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/iterations/{iterationId}/statuses/{statusId}" : { | |
| "get" : { | |
| "tags" : [ "Pull Request Iteration Statuses" ], | |
| "description" : "Get the specific pull request iteration status by ID. The status ID is unique within the pull request across all iterations.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request’s target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "iterationId", | |
| "in" : "path", | |
| "description" : "ID of the pull request iteration.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "statusId", | |
| "in" : "path", | |
| "description" : "ID of the pull request status.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitPullRequestStatus" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code", "vso.code_status" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "pullRequestIterationStatuses", | |
| "x-ms-vss-method" : "GetPullRequestIterationStatus", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/PullRequestIterationStatuses/GET_git_pullRequestStatuses_iterationStatus.json" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "Pull Request Iteration Statuses" ], | |
| "description" : "Delete pull request iteration status.\n\nYou can remove multiple statuses in one call by using Update operation.", | |
| "operationId" : "Delete", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request’s target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "iterationId", | |
| "in" : "path", | |
| "description" : "ID of the pull request iteration.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "statusId", | |
| "in" : "path", | |
| "description" : "ID of the pull request status.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_write", "vso.code_status" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "pullRequestIterationStatuses", | |
| "x-ms-vss-method" : "DeletePullRequestIterationStatus", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/PullRequestIterationStatuses/DELETE_git_pullRequestStatuses_iterationStatus.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/labels" : { | |
| "get" : { | |
| "tags" : [ "Pull Request Labels" ], | |
| "description" : "Get all the labels assigned to a pull request.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request’s target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "projectId", | |
| "in" : "query", | |
| "description" : "Project ID or project name.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/WebApiTagDefinition" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "pullRequestLabels", | |
| "x-ms-vss-method" : "GetPullRequestLabels", | |
| "x-ms-preview" : true | |
| }, | |
| "post" : { | |
| "tags" : [ "Pull Request Labels" ], | |
| "description" : "Create a label for a specified pull request. The only required field is the name of the new label.", | |
| "operationId" : "Create", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request’s target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "projectId", | |
| "in" : "query", | |
| "description" : "Project ID or project name.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Label to assign to the pull request.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/WebApiCreateTagRequestData" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/WebApiTagDefinition" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_write" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "pullRequestLabels", | |
| "x-ms-vss-method" : "CreatePullRequestLabel", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/labels/{labelIdOrName}" : { | |
| "get" : { | |
| "tags" : [ "Pull Request Labels" ], | |
| "description" : "Retrieves a single label that has been assigned to a pull request.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request’s target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "labelIdOrName", | |
| "in" : "path", | |
| "description" : "The name or ID of the label requested.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "projectId", | |
| "in" : "query", | |
| "description" : "Project ID or project name.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/WebApiTagDefinition" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "pullRequestLabels", | |
| "x-ms-vss-method" : "GetPullRequestLabel", | |
| "x-ms-preview" : true | |
| }, | |
| "delete" : { | |
| "tags" : [ "Pull Request Labels" ], | |
| "description" : "Removes a label from the set of those assigned to the pull request.", | |
| "operationId" : "Delete", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request’s target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "labelIdOrName", | |
| "in" : "path", | |
| "description" : "The name or ID of the label requested.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "projectId", | |
| "in" : "query", | |
| "description" : "Project ID or project name.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_write" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "pullRequestLabels", | |
| "x-ms-vss-method" : "DeletePullRequestLabels", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/properties" : { | |
| "get" : { | |
| "tags" : [ "Pull Request Properties" ], | |
| "description" : "Get external properties of the pull request.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request’s target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/PropertiesCollection" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "pullRequestProperties", | |
| "x-ms-vss-method" : "GetPullRequestProperties", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/PullRequestProperties/GetPullRequestProperties.json" | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "Pull Request Properties" ], | |
| "description" : "Create or update pull request external properties. The patch operation can be `add`, `replace` or `remove`. For `add` operation, the path can be empty. If the path is empty, the value must be a list of key value pairs. For `replace` operation, the path cannot be empty. If the path does not exist, the property will be added to the collection. For `remove` operation, the path cannot be empty. If the path does not exist, no action will be performed.", | |
| "operationId" : "Update", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request’s target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Properties to add, replace or remove in JSON Patch format.", | |
| "content" : { | |
| "application/json-patch+json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/JsonPatchDocument" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/PropertiesCollection" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_write" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "pullRequestProperties", | |
| "x-ms-vss-method" : "UpdatePullRequestProperties", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "Add properties" : { | |
| "$ref" : "./httpExamples/PullRequestProperties/AddPullRequestProperties.json" | |
| }, | |
| "Remove and replace properties" : { | |
| "$ref" : "./httpExamples/PullRequestProperties/RemoveAndReplacePullRequestProperties.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/reviewers" : { | |
| "get" : { | |
| "tags" : [ "Pull Request Reviewers" ], | |
| "description" : "Retrieve the reviewers for a pull request", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request’s target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/IdentityRefWithVote" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "pullRequestReviewers", | |
| "x-ms-vss-method" : "GetPullRequestReviewers", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/PullRequestReviewers/GET__git_repositories__repositoryId__pullRequests__pullRequestId__reviewers.json" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "Pull Request Reviewers" ], | |
| "description" : "Add reviewers to a pull request.", | |
| "operationId" : "Create Pull Request Reviewers", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request’s target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Reviewers to add to the pull request.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/IdentityRef" | |
| } | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/IdentityRefWithVote" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_write" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "pullRequestReviewers", | |
| "x-ms-vss-method" : "CreatePullRequestReviewers" | |
| }, | |
| "patch" : { | |
| "tags" : [ "Pull Request Reviewers" ], | |
| "description" : "Reset the votes of multiple reviewers on a pull request. NOTE: This endpoint only supports updating votes, but does not support updating required reviewers (use policy) or display names.", | |
| "operationId" : "Update", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request’s target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "IDs of the reviewers whose votes will be reset to zero", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/IdentityRefWithVote" | |
| } | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_write" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "pullRequestReviewers", | |
| "x-ms-vss-method" : "UpdatePullRequestReviewers" | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/reviewers/{reviewerId}" : { | |
| "get" : { | |
| "tags" : [ "Pull Request Reviewers" ], | |
| "description" : "Retrieve information about a particular reviewer on a pull request", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request’s target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "reviewerId", | |
| "in" : "path", | |
| "description" : "ID of the reviewer.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/IdentityRefWithVote" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "pullRequestReviewers", | |
| "x-ms-vss-method" : "GetPullRequestReviewer", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/PullRequestReviewers/GET__git_repositories__repositoryId__pullRequests__pullRequestId__reviewers__additionalReviewerId_.json" | |
| } | |
| } | |
| }, | |
| "put" : { | |
| "tags" : [ "Pull Request Reviewers" ], | |
| "description" : "Add a reviewer to a pull request or cast a vote.", | |
| "operationId" : "Create Pull Request Reviewer", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request’s target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "reviewerId", | |
| "in" : "path", | |
| "description" : "ID of the reviewer.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Reviewer's vote.<br />If the reviewer's ID is included here, it must match the reviewerID parameter.<br />Reviewers can set their own vote with this method. When adding other reviewers, vote must be set to zero.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/IdentityRefWithVote" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/IdentityRefWithVote" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_write" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "pullRequestReviewers", | |
| "x-ms-vss-method" : "CreatePullRequestReviewer", | |
| "x-ms-examples" : { | |
| "Set vote" : { | |
| "$ref" : "./httpExamples/PullRequestReviewers/PUT__git_repositories__repositoryId__pullRequests__pullRequestId__reviewers__initialReviewerId_.json" | |
| }, | |
| "Add a reviewer" : { | |
| "$ref" : "./httpExamples/PullRequestReviewers/PUT__git_repositories__repositoryId__pullRequests__pullRequestId__reviewers__additionalReviewerId_.json" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "Pull Request Reviewers" ], | |
| "description" : "Remove a reviewer from a pull request.", | |
| "operationId" : "Delete", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request’s target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "reviewerId", | |
| "in" : "path", | |
| "description" : "ID of the reviewer to remove.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_write" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "pullRequestReviewers", | |
| "x-ms-vss-method" : "DeletePullRequestReviewer", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/PullRequestReviewers/DELETE__git_repositories__repositoryId__pullRequests__pullRequestId__reviewers__additionalReviewerId_.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/share" : { | |
| "post" : { | |
| "tags" : [ "Pull Request Share" ], | |
| "description" : "Sends an e-mail notification about a specific pull request to a set of recipients", | |
| "operationId" : "Share Pull Request", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "ID of the git repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/ShareNotificationContext" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_write" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "pullRequestShare", | |
| "x-ms-vss-method" : "SharePullRequest", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/statuses" : { | |
| "get" : { | |
| "tags" : [ "Pull Request Statuses" ], | |
| "description" : "Get all the statuses associated with a pull request.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request’s target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/GitPullRequestStatus" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code", "vso.code_status" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "pullRequestStatuses", | |
| "x-ms-vss-method" : "GetPullRequestStatuses", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/PullRequestStatuses/GET_git_pullRequestStatuses_statuses.json" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "Pull Request Statuses" ], | |
| "description" : "Create a pull request status.\n\nThe only required field for the status is `Context.Name` that uniquely identifies the status.\nNote that you can specify iterationId in the request body to post the status on the iteration.", | |
| "operationId" : "Create", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request’s target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Pull request status to create.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitPullRequestStatus" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitPullRequestStatus" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_write", "vso.code_status" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "pullRequestStatuses", | |
| "x-ms-vss-method" : "CreatePullRequestStatus", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "On pull request" : { | |
| "$ref" : "./httpExamples/PullRequestStatuses/POST_git_pullRequestStatuses_status.json" | |
| }, | |
| "On iteration" : { | |
| "$ref" : "./httpExamples/PullRequestStatuses/POST_git_pullRequestStatuses_statusIterationInBody.json" | |
| }, | |
| "With properties" : { | |
| "$ref" : "./httpExamples/PullRequestStatuses/POST_git_pullRequestStatuses_statusWithProperties.json" | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "Pull Request Statuses" ], | |
| "description" : "Update pull request statuses collection. The only supported operation type is `remove`.\n\nThis operation allows to delete multiple statuses in one call.\nThe path of the `remove` operation should refer to the ID of the pull request status.\nFor example `path=\"/1\"` refers to the pull request status with ID 1.", | |
| "operationId" : "Update", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request’s target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Operations to apply to the pull request statuses in JSON Patch format.", | |
| "content" : { | |
| "application/json-patch+json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/JsonPatchDocument" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_write", "vso.code_status" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "pullRequestStatuses", | |
| "x-ms-vss-method" : "UpdatePullRequestStatuses", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/PullRequestStatuses/PATCH_git_pullRequestStatuses_statuses.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/statuses/{statusId}" : { | |
| "get" : { | |
| "tags" : [ "Pull Request Statuses" ], | |
| "description" : "Get the specific pull request status by ID. The status ID is unique within the pull request across all iterations.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request’s target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "statusId", | |
| "in" : "path", | |
| "description" : "ID of the pull request status.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitPullRequestStatus" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code", "vso.code_status" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "pullRequestStatuses", | |
| "x-ms-vss-method" : "GetPullRequestStatus", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/PullRequestStatuses/GET_git_pullRequestStatuses_status.json" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "Pull Request Statuses" ], | |
| "description" : "Delete pull request status.\n\nYou can remove multiple statuses in one call by using Update operation.", | |
| "operationId" : "Delete", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request’s target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "statusId", | |
| "in" : "path", | |
| "description" : "ID of the pull request status.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_write", "vso.code_status" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "pullRequestStatuses", | |
| "x-ms-vss-method" : "DeletePullRequestStatus", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/PullRequestStatuses/DELETE_git_pullRequestStatuses_status.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/threads" : { | |
| "get" : { | |
| "tags" : [ "Pull Request Threads" ], | |
| "description" : "Retrieve all threads in a pull request.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request's target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "$iteration", | |
| "in" : "query", | |
| "description" : "If specified, thread positions will be tracked using this iteration as the right side of the diff.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "$baseIteration", | |
| "in" : "query", | |
| "description" : "If specified, thread positions will be tracked using this iteration as the left side of the diff.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/GitPullRequestCommentThread" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "pullRequestThreads", | |
| "x-ms-vss-method" : "GetThreads", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/PullRequestThreads/GET__git_repositories__repositoryId__pullRequests__pullRequestId__threads.json" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "Pull Request Threads" ], | |
| "description" : "Create a thread in a pull request.", | |
| "operationId" : "Create", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "Repository ID of the pull request's target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "The thread to create. Thread must contain at least one comment.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitPullRequestCommentThread" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitPullRequestCommentThread" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_write" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "pullRequestThreads", | |
| "x-ms-vss-method" : "CreateThread", | |
| "x-ms-examples" : { | |
| "Comment on the pull request" : { | |
| "$ref" : "./httpExamples/PullRequestThreads/POST__git_repositories__repositoryId__pullRequests__pullRequestId__threads.json" | |
| }, | |
| "Comment on a specific file in the pull request" : { | |
| "$ref" : "./httpExamples/PullRequestThreads/POST__git_repositories__repositoryId__pullRequests__pullRequestId__threads2.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/threads/{threadId}" : { | |
| "get" : { | |
| "tags" : [ "Pull Request Threads" ], | |
| "description" : "Retrieve a thread in a pull request.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request's target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "threadId", | |
| "in" : "path", | |
| "description" : "ID of the thread.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "$iteration", | |
| "in" : "query", | |
| "description" : "If specified, thread position will be tracked using this iteration as the right side of the diff.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "$baseIteration", | |
| "in" : "query", | |
| "description" : "If specified, thread position will be tracked using this iteration as the left side of the diff.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitPullRequestCommentThread" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "pullRequestThreads", | |
| "x-ms-vss-method" : "GetPullRequestThread" | |
| }, | |
| "patch" : { | |
| "tags" : [ "Pull Request Threads" ], | |
| "description" : "Update a thread in a pull request.", | |
| "operationId" : "Update", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request's target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "threadId", | |
| "in" : "path", | |
| "description" : "ID of the thread to update.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "The thread content that should be updated.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitPullRequestCommentThread" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitPullRequestCommentThread" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_write" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "pullRequestThreads", | |
| "x-ms-vss-method" : "UpdateThread" | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/threads/{threadId}/comments" : { | |
| "get" : { | |
| "tags" : [ "Pull Request Thread Comments" ], | |
| "description" : "Retrieve all comments associated with a specific thread in a pull request.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request's target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "threadId", | |
| "in" : "path", | |
| "description" : "ID of the thread.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/Comment" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "pullRequestThreadComments", | |
| "x-ms-vss-method" : "GetComments" | |
| }, | |
| "post" : { | |
| "tags" : [ "Pull Request Thread Comments" ], | |
| "description" : "Create a comment on a specific thread in a pull request.", | |
| "operationId" : "Create", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request's target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "threadId", | |
| "in" : "path", | |
| "description" : "ID of the thread that the desired comment is in.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "The comment to create.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Comment" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Comment" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_write" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "pullRequestThreadComments", | |
| "x-ms-vss-method" : "CreateComment", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/PullRequestThreadComments/POST__git_repositories__repositoryId__pullRequests__pullRequestId__threads__threadId__comments.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/threads/{threadId}/comments/{commentId}" : { | |
| "get" : { | |
| "tags" : [ "Pull Request Thread Comments" ], | |
| "description" : "Retrieve a comment associated with a specific thread in a pull request.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request's target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "threadId", | |
| "in" : "path", | |
| "description" : "ID of the thread that the desired comment is in.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "commentId", | |
| "in" : "path", | |
| "description" : "ID of the comment.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Comment" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "pullRequestThreadComments", | |
| "x-ms-vss-method" : "GetComment" | |
| }, | |
| "delete" : { | |
| "tags" : [ "Pull Request Thread Comments" ], | |
| "description" : "Delete a comment associated with a specific thread in a pull request.", | |
| "operationId" : "Delete", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request's target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "threadId", | |
| "in" : "path", | |
| "description" : "ID of the thread that the desired comment is in.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "commentId", | |
| "in" : "path", | |
| "description" : "ID of the comment.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_write" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "pullRequestThreadComments", | |
| "x-ms-vss-method" : "DeleteComment", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/PullRequestThreadComments/DELETE__git_repositories__repositoryId__pullRequests__pullRequestId__threads__threadId__comments__commentId_.json" | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "Pull Request Thread Comments" ], | |
| "description" : "Update a comment associated with a specific thread in a pull request.", | |
| "operationId" : "Update", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request's target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "threadId", | |
| "in" : "path", | |
| "description" : "ID of the thread that the desired comment is in.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "commentId", | |
| "in" : "path", | |
| "description" : "ID of the comment to update.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "The comment content that should be updated.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Comment" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Comment" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_write" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "pullRequestThreadComments", | |
| "x-ms-vss-method" : "UpdateComment" | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/threads/{threadId}/comments/{commentId}/likes" : { | |
| "get" : { | |
| "tags" : [ "Pull Request Comment Likes" ], | |
| "description" : "Get likes for a comment.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request's target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "threadId", | |
| "in" : "path", | |
| "description" : "The ID of the thread that contains the comment.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "commentId", | |
| "in" : "path", | |
| "description" : "The ID of the comment.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/IdentityRef" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "pullRequestCommentLikes", | |
| "x-ms-vss-method" : "GetLikes", | |
| "x-ms-preview" : true | |
| }, | |
| "post" : { | |
| "tags" : [ "Pull Request Comment Likes" ], | |
| "description" : "Add a like on a comment.", | |
| "operationId" : "Create", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request's target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "threadId", | |
| "in" : "path", | |
| "description" : "The ID of the thread that contains the comment.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "commentId", | |
| "in" : "path", | |
| "description" : "The ID of the comment.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_write" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "pullRequestCommentLikes", | |
| "x-ms-vss-method" : "CreateLike", | |
| "x-ms-preview" : true | |
| }, | |
| "delete" : { | |
| "tags" : [ "Pull Request Comment Likes" ], | |
| "description" : "Delete a like on a comment.", | |
| "operationId" : "Delete", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The repository ID of the pull request's target branch.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "threadId", | |
| "in" : "path", | |
| "description" : "The ID of the thread that contains the comment.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "commentId", | |
| "in" : "path", | |
| "description" : "The ID of the comment.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_write" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "pullRequestCommentLikes", | |
| "x-ms-vss-method" : "DeleteLike", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/workitems" : { | |
| "get" : { | |
| "tags" : [ "Pull Request Work Items" ], | |
| "description" : "Retrieve a list of work items associated with a pull request.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "ID or name of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pullRequestId", | |
| "in" : "path", | |
| "description" : "ID of the pull request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/ResourceRef" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "pullRequestWorkItems", | |
| "x-ms-vss-method" : "GetPullRequestWorkItemRefs" | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/pushes" : { | |
| "get" : { | |
| "tags" : [ "Pushes" ], | |
| "description" : "Retrieves pushes associated with the specified repository.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The name or ID of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "$skip", | |
| "in" : "query", | |
| "description" : "Number of pushes to skip.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "$top", | |
| "in" : "query", | |
| "description" : "Number of pushes to return.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "searchCriteria.includeLinks", | |
| "in" : "query", | |
| "description" : "Whether to include the _links field on the shallow references", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "searchCriteria.includeRefUpdates", | |
| "in" : "query", | |
| "description" : "Search criteria attributes: fromDate, toDate, pusherId, refName, includeRefUpdates or includeLinks. fromDate: Start date to search from. toDate: End date to search to. pusherId: Identity of the person who submitted the push. refName: Branch name to consider. includeRefUpdates: If true, include the list of refs that were updated by the push. includeLinks: Whether to include the _links field on the shallow references.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "searchCriteria.refName", | |
| "in" : "query", | |
| "description" : "Search criteria attributes: fromDate, toDate, pusherId, refName, includeRefUpdates or includeLinks. fromDate: Start date to search from. toDate: End date to search to. pusherId: Identity of the person who submitted the push. refName: Branch name to consider. includeRefUpdates: If true, include the list of refs that were updated by the push. includeLinks: Whether to include the _links field on the shallow references.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "searchCriteria.pusherId", | |
| "in" : "query", | |
| "description" : "Search criteria attributes: fromDate, toDate, pusherId, refName, includeRefUpdates or includeLinks. fromDate: Start date to search from. toDate: End date to search to. pusherId: Identity of the person who submitted the push. refName: Branch name to consider. includeRefUpdates: If true, include the list of refs that were updated by the push. includeLinks: Whether to include the _links field on the shallow references.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "searchCriteria.toDate", | |
| "in" : "query", | |
| "description" : "Search criteria attributes: fromDate, toDate, pusherId, refName, includeRefUpdates or includeLinks. fromDate: Start date to search from. toDate: End date to search to. pusherId: Identity of the person who submitted the push. refName: Branch name to consider. includeRefUpdates: If true, include the list of refs that were updated by the push. includeLinks: Whether to include the _links field on the shallow references.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "date-time" | |
| } | |
| }, { | |
| "name" : "searchCriteria.fromDate", | |
| "in" : "query", | |
| "description" : "Search criteria attributes: fromDate, toDate, pusherId, refName, includeRefUpdates or includeLinks. fromDate: Start date to search from. toDate: End date to search to. pusherId: Identity of the person who submitted the push. refName: Branch name to consider. includeRefUpdates: If true, include the list of refs that were updated by the push. includeLinks: Whether to include the _links field on the shallow references.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "date-time" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/GitPush" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "pushes", | |
| "x-ms-vss-method" : "GetPushes", | |
| "x-ms-examples" : { | |
| "By repository ID" : { | |
| "$ref" : "./httpExamples/pushes/GET__git_repositories__repositoryId__pushes.json" | |
| }, | |
| "In a date range" : { | |
| "$ref" : "./httpExamples/pushes/GET__git_repositories__repositoryId__pushes_fromDate-_fromDate__toDate-_toDate_.json" | |
| }, | |
| "By who submitted the pushes" : { | |
| "$ref" : "./httpExamples/pushes/GET__git_repositories__repositoryId__pushes_pusherId-_pusherId_.json" | |
| }, | |
| "A page at a time" : { | |
| "$ref" : "./httpExamples/pushes/GET__git_repositories__repositoryId__pushes__skip-_skip___top-_top_.json" | |
| }, | |
| "For a particular branch, including ref updates" : { | |
| "$ref" : "./httpExamples/pushes/GET__git_repositories__repositoryId__pushes_refName-_refName__includeRefUpdates-true.json" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "Pushes" ], | |
| "description" : "Push changes to the repository.", | |
| "operationId" : "Create", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The name or ID of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitPush" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitPush" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_write" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "pushes", | |
| "x-ms-vss-method" : "CreatePush", | |
| "x-ms-examples" : { | |
| "Initial commit (Create a new branch)" : { | |
| "$ref" : "./httpExamples/pushes/POST__git_repositories__tempRepoId__pushes.json" | |
| }, | |
| "Add a text file" : { | |
| "$ref" : "./httpExamples/pushes/POST__git_repositories__tempRepoId__pushes2.json" | |
| }, | |
| "Add a binary file" : { | |
| "$ref" : "./httpExamples/pushes/POST__git_repositories__tempRepoId__pushes3.json" | |
| }, | |
| "Update a file" : { | |
| "$ref" : "./httpExamples/pushes/POST__git_repositories__tempRepoId__pushes4.json" | |
| }, | |
| "Delete a file" : { | |
| "$ref" : "./httpExamples/pushes/POST__git_repositories__tempRepoId__pushes5.json" | |
| }, | |
| "Rename a file" : { | |
| "$ref" : "./httpExamples/pushes/POST__git_repositories__tempRepoId__pushes6.json" | |
| }, | |
| "Move a file" : { | |
| "$ref" : "./httpExamples/pushes/POST__git_repositories__tempRepoId__pushes7.json" | |
| }, | |
| "Update a file in a new branch" : { | |
| "$ref" : "./httpExamples/pushes/POST__git_repositories__tempRepoId__pushes8.json" | |
| }, | |
| "Multiple changes" : { | |
| "$ref" : "./httpExamples/pushes/POST__git_repositories__tempRepoId__pushes9.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/pushes/{pushId}" : { | |
| "get" : { | |
| "tags" : [ "Pushes" ], | |
| "description" : "Retrieves a particular push.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The name or ID of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "pushId", | |
| "in" : "path", | |
| "description" : "ID of the push.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "includeCommits", | |
| "in" : "query", | |
| "description" : "The number of commits to include in the result.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "includeRefUpdates", | |
| "in" : "query", | |
| "description" : "If true, include the list of refs that were updated by the push.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitPush" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "pushes", | |
| "x-ms-vss-method" : "GetPush", | |
| "x-ms-examples" : { | |
| "Just the push" : { | |
| "$ref" : "./httpExamples/pushes/GET__git_repositories__repositoryId__pushes__pushId_.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/refs" : { | |
| "get" : { | |
| "tags" : [ "Refs" ], | |
| "description" : "Queries the provided repository for its refs and returns them.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The name or ID of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "filter", | |
| "in" : "query", | |
| "description" : "[optional] A filter to apply to the refs (starts with).", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "includeLinks", | |
| "in" : "query", | |
| "description" : "[optional] Specifies if referenceLinks should be included in the result. default is false.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "includeStatuses", | |
| "in" : "query", | |
| "description" : "[optional] Includes up to the first 1000 commit statuses for each ref. The default value is false.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "includeMyBranches", | |
| "in" : "query", | |
| "description" : "[optional] Includes only branches that the user owns, the branches the user favorites, and the default branch. The default value is false. Cannot be combined with the filter parameter.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "latestStatusesOnly", | |
| "in" : "query", | |
| "description" : "[optional] True to include only the tip commit status for each ref. This option requires `includeStatuses` to be true. The default value is false.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "peelTags", | |
| "in" : "query", | |
| "description" : "[optional] Annotated tags will populate the PeeledObjectId property. default is false.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "filterContains", | |
| "in" : "query", | |
| "description" : "[optional] A filter to apply to the refs (contains).", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "$top", | |
| "in" : "query", | |
| "description" : "[optional] Maximum number of refs to return. It cannot be bigger than 1000. If it is not provided but continuationToken is, top will default to 100.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "continuationToken", | |
| "in" : "query", | |
| "description" : "The continuation token used for pagination.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/GitRef" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "refs", | |
| "x-ms-vss-method" : "GetRefs", | |
| "x-ms-examples" : { | |
| "Refs" : { | |
| "$ref" : "./httpExamples/refs/GET__git_repositories__repositoryId__refs.json" | |
| }, | |
| "Refs heads" : { | |
| "$ref" : "./httpExamples/refs/GET__git_repositories__repositoryId__refs_heads.json" | |
| }, | |
| "Refs heads statuses" : { | |
| "$ref" : "./httpExamples/refs/GET__git_repositories__repositoryId__refs_heads_statuses.json" | |
| }, | |
| "Refs tags" : { | |
| "$ref" : "./httpExamples/refs/GET__git_repositories__repositoryId__refs_tags.json" | |
| }, | |
| "Refs heads that contain a word" : { | |
| "$ref" : "./httpExamples/refs/GET__git_repositories__repositoryId__refs_heads_contains_replacer.json" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "Refs" ], | |
| "description" : "Creating, updating, or deleting refs(branches).\n\nUpdating a ref means making it point at a different commit than it used to. You must specify both the old and new commit to avoid race conditions.", | |
| "operationId" : "Update Refs", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The name or ID of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "projectId", | |
| "in" : "query", | |
| "description" : "ID or name of the team project. Optional if specifying an ID for repository.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "List of ref updates to attempt to perform", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/GitRefUpdate" | |
| } | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/GitRefUpdateResult" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_write" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "refs", | |
| "x-ms-vss-method" : "UpdateRefs", | |
| "x-ms-examples" : { | |
| "Create/Update/Delete a ref by repositoryId" : { | |
| "$ref" : "./httpExamples/refs/POST__git_repositories__repositoryId__refs.json" | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "Refs" ], | |
| "description" : "Lock or Unlock a branch.", | |
| "operationId" : "Update Ref", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The name or ID of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "filter", | |
| "in" : "query", | |
| "description" : "The name of the branch to lock/unlock", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "projectId", | |
| "in" : "query", | |
| "description" : "ID or name of the team project. Optional if specifying an ID for repository.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "The ref update action (lock/unlock) to perform", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitRefUpdate" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitRef" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_write" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "refs", | |
| "x-ms-vss-method" : "UpdateRef", | |
| "x-ms-examples" : { | |
| "Lock/unlock branch" : { | |
| "$ref" : "./httpExamples/refs/PATCH__git_repositories__repositoryId__refs.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/reverts" : { | |
| "get" : { | |
| "tags" : [ "Reverts" ], | |
| "description" : "Retrieve information about a revert operation for a specific branch.", | |
| "operationId" : "Get Revert For Ref Name", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "ID of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "refName", | |
| "in" : "query", | |
| "description" : "The GitAsyncRefOperationParameters generatedRefName used for the revert operation.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitRevert" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "reverts", | |
| "x-ms-vss-method" : "GetRevertForRefName", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Reverts/GetRevert.json" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "Reverts" ], | |
| "description" : "Starts the operation to create a new branch which reverts changes introduced by either a specific commit or commits that are associated to a pull request.", | |
| "operationId" : "Create", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "ID of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitAsyncRefOperationParameters" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitRevert" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "reverts", | |
| "x-ms-vss-method" : "CreateRevert", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Reverts/CreateRevert.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/reverts/{revertId}" : { | |
| "get" : { | |
| "tags" : [ "Reverts" ], | |
| "description" : "Retrieve information about a revert operation by revert Id.", | |
| "operationId" : "Get Revert", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "revertId", | |
| "in" : "path", | |
| "description" : "ID of the revert operation.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "ID of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitRevert" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "reverts", | |
| "x-ms-vss-method" : "GetRevert", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/stats/branches" : { | |
| "get" : { | |
| "tags" : [ "Stats" ], | |
| "description" : "Retrieve statistics about all branches within a repository.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "The name or ID of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "baseVersionDescriptor.versionOptions", | |
| "in" : "query", | |
| "description" : "Version options - Specify additional modifiers to version (e.g Previous)", | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "none", "previousChange", "firstParent" ], | |
| "x-ms-enum" : { | |
| "name" : "GitVersionOptions", | |
| "values" : [ { | |
| "value" : "none", | |
| "description" : "Not specified" | |
| }, { | |
| "value" : "previousChange", | |
| "description" : "Commit that changed item prior to the current version" | |
| }, { | |
| "value" : "firstParent", | |
| "description" : "First parent of commit (HEAD^)" | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "GitVersionOptions", | |
| "values" : [ { | |
| "value" : "none", | |
| "description" : "Not specified" | |
| }, { | |
| "value" : "previousChange", | |
| "description" : "Commit that changed item prior to the current version" | |
| }, { | |
| "value" : "firstParent", | |
| "description" : "First parent of commit (HEAD^)" | |
| } ] | |
| } | |
| }, { | |
| "name" : "baseVersionDescriptor.version", | |
| "in" : "query", | |
| "description" : "Version string identifier (name of tag/branch, SHA1 of commit)", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "baseVersionDescriptor.versionType", | |
| "in" : "query", | |
| "description" : "Version type (branch, tag, or commit). Determines how Id is interpreted", | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "branch", "tag", "commit" ], | |
| "x-ms-enum" : { | |
| "name" : "GitVersionType", | |
| "values" : [ { | |
| "value" : "branch", | |
| "description" : "Interpret the version as a branch name" | |
| }, { | |
| "value" : "tag", | |
| "description" : "Interpret the version as a tag name" | |
| }, { | |
| "value" : "commit", | |
| "description" : "Interpret the version as a commit ID (SHA1)" | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "GitVersionType", | |
| "values" : [ { | |
| "value" : "branch", | |
| "description" : "Interpret the version as a branch name" | |
| }, { | |
| "value" : "tag", | |
| "description" : "Interpret the version as a tag name" | |
| }, { | |
| "value" : "commit", | |
| "description" : "Interpret the version as a commit ID (SHA1)" | |
| } ] | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/GitBranchStats" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "branchStats", | |
| "x-ms-vss-method" : "GetBranches", | |
| "x-ms-examples" : { | |
| "For all branches" : { | |
| "$ref" : "./httpExamples/BranchStats/GET__git_repositories__repositoryId__stats_branches.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/suggestions" : { | |
| "get" : { | |
| "tags" : [ "Suggestions" ], | |
| "description" : "Retrieve a pull request suggestion for a particular repository or team project.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "ID of the git repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/GitSuggestion" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "suggestions", | |
| "x-ms-vss-method" : "GetSuggestions", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryId}/trees/{sha1}" : { | |
| "get" : { | |
| "tags" : [ "Trees" ], | |
| "description" : "The Tree endpoint returns the collection of objects underneath the specified tree. Trees are folders in a Git repository.\n\nRepositories have both a name and an identifier. Identifiers are globally unique, but several projects may contain a repository of the same name. You don't need to include the project if you specify a repository by ID. However, if you specify a repository by name, you must also specify the project (by name or ID.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryId", | |
| "in" : "path", | |
| "description" : "Repository Id.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "sha1", | |
| "in" : "path", | |
| "description" : "SHA1 hash of the tree object.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "projectId", | |
| "in" : "query", | |
| "description" : "Project Id.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "recursive", | |
| "in" : "query", | |
| "description" : "Search recursively. Include trees underneath this tree. Default is false.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "fileName", | |
| "in" : "query", | |
| "description" : "Name to use if a .zip file is returned. Default is the object ID.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "$format", | |
| "in" : "query", | |
| "description" : "Use \"zip\". Defaults to the MIME type set in the Accept header.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/zip" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitTreeRef" | |
| } | |
| }, | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitTreeRef" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "trees", | |
| "x-ms-vss-method" : "GetTree", | |
| "x-ms-examples" : { | |
| "Non-recursive Example" : { | |
| "$ref" : "./httpExamples/Trees/GET__git_repositories__repositoryId__trees__objectId_.json" | |
| }, | |
| "Recursive Example" : { | |
| "$ref" : "./httpExamples/Trees/GET__git_repositories__repositoryId__trees__objectId__recursive-true.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryNameOrId}/commits/{commitId}/mergebases" : { | |
| "get" : { | |
| "tags" : [ "Merge Bases" ], | |
| "description" : "Find the merge bases of two commits, optionally across forks. If otherRepositoryId is not specified, the merge bases will only be calculated within the context of the local repositoryNameOrId.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryNameOrId", | |
| "in" : "path", | |
| "description" : "ID or name of the local repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "commitId", | |
| "in" : "path", | |
| "description" : "First commit, usually the tip of the target branch of the potential merge.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "otherCommitId", | |
| "in" : "query", | |
| "description" : "Other commit, usually the tip of the source branch of the potential merge.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "otherCollectionId", | |
| "in" : "query", | |
| "description" : "The collection ID where otherCommitId lives.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "otherRepositoryId", | |
| "in" : "query", | |
| "description" : "The repository ID where otherCommitId lives.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/GitCommitRef" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "mergeBases", | |
| "x-ms-vss-method" : "GetMergeBases", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryNameOrId}/forks/{collectionId}" : { | |
| "get" : { | |
| "tags" : [ "Forks" ], | |
| "description" : "Retrieve all forks of a repository in the collection.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryNameOrId", | |
| "in" : "path", | |
| "description" : "The name or ID of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "collectionId", | |
| "in" : "path", | |
| "description" : "Team project collection ID.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "includeLinks", | |
| "in" : "query", | |
| "description" : "True to include links.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/GitRepositoryRef" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "forks", | |
| "x-ms-vss-method" : "GetForks", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryNameOrId}/forkSyncRequests" : { | |
| "get" : { | |
| "tags" : [ "Forks" ], | |
| "description" : "Retrieve all requested fork sync operations on this repository.", | |
| "operationId" : "Get Fork Sync Requests", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryNameOrId", | |
| "in" : "path", | |
| "description" : "The name or ID of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "includeAbandoned", | |
| "in" : "query", | |
| "description" : "True to include abandoned requests.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "includeLinks", | |
| "in" : "query", | |
| "description" : "True to include links.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/GitForkSyncRequest" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "forkSyncRequests", | |
| "x-ms-vss-method" : "GetForkSyncRequests", | |
| "x-ms-preview" : true | |
| }, | |
| "post" : { | |
| "tags" : [ "Forks" ], | |
| "description" : "Request that another repository's refs be fetched into this one.", | |
| "operationId" : "Create", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryNameOrId", | |
| "in" : "path", | |
| "description" : "The name or ID of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "includeLinks", | |
| "in" : "query", | |
| "description" : "True to include links", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Source repository and ref mapping.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitForkSyncRequestParameters" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitForkSyncRequest" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code_write" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "forkSyncRequests", | |
| "x-ms-vss-method" : "CreateForkSyncRequest", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/{project}/_apis/git/repositories/{repositoryNameOrId}/forkSyncRequests/{forkSyncOperationId}" : { | |
| "get" : { | |
| "tags" : [ "Forks" ], | |
| "description" : "Get a specific fork sync operation's details.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "repositoryNameOrId", | |
| "in" : "path", | |
| "description" : "The name or ID of the repository.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "forkSyncOperationId", | |
| "in" : "path", | |
| "description" : "OperationId of the sync request.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "project", | |
| "in" : "path", | |
| "description" : "Project ID or project name", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "includeLinks", | |
| "in" : "query", | |
| "description" : "True to include links.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GitForkSyncRequest" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.code" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "forkSyncRequests", | |
| "x-ms-vss-method" : "GetForkSyncRequest", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/graph/descriptors/{storageKey}" : { | |
| "get" : { | |
| "tags" : [ "Descriptors" ], | |
| "description" : "Resolve a storage key to a descriptor", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "storageKey", | |
| "in" : "path", | |
| "description" : "Storage key of the subject (user, group, scope, etc.) to resolve", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GraphDescriptorResult" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.graph" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "descriptors", | |
| "x-ms-vss-method" : "GetDescriptor", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Descriptors/GetDescriptorById.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/graph/groups" : { | |
| "get" : { | |
| "tags" : [ "Groups" ], | |
| "description" : "Gets a list of all groups in the current scope (usually organization or account).\n\nThe optional parameters are used to filter down the returned results. Returned results are in no guaranteed order.\n\n Since the list of groups may be large, results are returned in pages of groups. If there are more results\n than can be returned in a single page, the result set will containt a continuation token for retrieval of the\n next set of results.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "scopeDescriptor", | |
| "in" : "query", | |
| "description" : "Specify a non-default scope (collection, project) to search for groups.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "subjectTypes", | |
| "in" : "query", | |
| "description" : "A comma separated list of user subject subtypes to reduce the retrieved results, e.g. Microsoft.IdentityModel.Claims.ClaimsIdentity", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "array (string)" | |
| } | |
| }, { | |
| "name" : "continuationToken", | |
| "in" : "query", | |
| "description" : "An opaque data blob that allows the next page of data to resume immediately after where the previous page ended. The only reliable way to know if there is more data left is the presence of a continuation token.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "headers" : { | |
| "X-MS-ContinuationToken" : { | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/GraphGroup" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.graph" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "groups", | |
| "x-ms-vss-method" : "ListGroups", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Groups/GetAllGroups.json" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "Groups" ], | |
| "description" : "Create a new VSTS group or materialize an existing AAD group.\n\nThe body of the request must be a derived type of GraphGroupCreationContext:\n * GraphGroupVstsCreationContext - Create a new VSTS group that is not backed by an external provider.\n * GraphGroupMailAddressCreationContext - Create a new group using the mail address as a reference to an existing group from an external AD or AAD backed provider.\n * GraphGroupOriginIdCreationContext - Create a new group using the OriginID as a reference to a group from an external AD or AAD backed provider.\n\n Optionally, you can add the newly created group as a member of an existing VSTS group and/or specify a custom storage key for the group.", | |
| "operationId" : "Create", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "scopeDescriptor", | |
| "in" : "query", | |
| "description" : "A descriptor referencing the scope (collection, project) in which the group should be created. If omitted, will be created in the scope of the enclosing account or organization. Valid only for VSTS groups.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "groupDescriptors", | |
| "in" : "query", | |
| "description" : "A comma separated list of descriptors referencing groups you want the graph group to join", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "array (string)" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "The subset of the full graph group used to uniquely find the graph subject in an external provider.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GraphGroupCreationContext" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GraphGroup" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.graph_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "groups", | |
| "x-ms-vss-method" : "CreateGroup", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "Create a Group at the account level" : { | |
| "$ref" : "./httpExamples/Groups/CreateGroup.json" | |
| }, | |
| "Create a Group at the project level" : { | |
| "$ref" : "./httpExamples/Groups/CreateGroupInProject.json" | |
| }, | |
| "Add an AAD Group by OID" : { | |
| "$ref" : "./httpExamples/Groups/MaterializeAADGroupByOID.json" | |
| }, | |
| "Add an AAD Group as member of a group" : { | |
| "$ref" : "./httpExamples/Groups/MaterializeAADGroupByOIDAsMember.json" | |
| }, | |
| "Add an AAD Group with a custom storage key" : { | |
| "$ref" : "./httpExamples/Groups/MaterializeAADGroupByOIDWithStorageKey.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/graph/groups/{groupDescriptor}" : { | |
| "get" : { | |
| "tags" : [ "Groups" ], | |
| "description" : "Get a group by its descriptor.\n\nThe group will be returned even if it has been deleted from the account or has had all its memberships\ndeleted.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "groupDescriptor", | |
| "in" : "path", | |
| "description" : "The descriptor of the desired graph group.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GraphGroup" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.graph" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "groups", | |
| "x-ms-vss-method" : "GetGroup", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Groups/GetGroup-AddRemoveAADGroupByOID.json" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "Groups" ], | |
| "description" : "Removes a VSTS group from all of its parent groups.\n\nThe group will still be visible, but membership\n checks for the group, and all descendants which derive membership through it, will return false.”", | |
| "operationId" : "Delete", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "groupDescriptor", | |
| "in" : "path", | |
| "description" : "The descriptor of the group to delete.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.graph_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "groups", | |
| "x-ms-vss-method" : "DeleteGroup", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Groups/DeleteGroup.json" | |
| } | |
| } | |
| }, | |
| "patch" : { | |
| "tags" : [ "Groups" ], | |
| "description" : "Update the properties of a VSTS group.\n\nCurrently limited to only changing the description and account name.", | |
| "operationId" : "Update", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "groupDescriptor", | |
| "in" : "path", | |
| "description" : "The descriptor of the group to modify.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "The JSON+Patch document containing the fields to alter.", | |
| "content" : { | |
| "application/json-patch+json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/JsonPatchDocument" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GraphGroup" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.graph_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "groups", | |
| "x-ms-vss-method" : "UpdateGroup", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Groups/UpdateGroup.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/graph/Memberships/{subjectDescriptor}" : { | |
| "get" : { | |
| "tags" : [ "Memberships" ], | |
| "description" : "Get all the memberships where this descriptor is a member in the relationship.\n\nThe default value for direction is 'up' meaning return all memberships where the subject is a member (e.g. all groups the subject is a member of).\n Alternatively, passing the direction as 'down' will return all memberships where the subject is a container (e.g. all members of the subject group).", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "subjectDescriptor", | |
| "in" : "path", | |
| "description" : "Fetch all direct memberships of this descriptor.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "direction", | |
| "in" : "query", | |
| "description" : "Defaults to Up.", | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "unknown", "down", "up" ], | |
| "x-ms-enum" : { | |
| "name" : "GraphTraversalDirection", | |
| "values" : [ { | |
| "value" : "unknown", | |
| "description" : "" | |
| }, { | |
| "value" : "down", | |
| "description" : "" | |
| }, { | |
| "value" : "up", | |
| "description" : "" | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "GraphTraversalDirection", | |
| "values" : [ { | |
| "value" : "unknown", | |
| "description" : "" | |
| }, { | |
| "value" : "down", | |
| "description" : "" | |
| }, { | |
| "value" : "up", | |
| "description" : "" | |
| } ] | |
| } | |
| }, { | |
| "name" : "depth", | |
| "in" : "query", | |
| "description" : "The maximum number of edges to traverse up or down the membership tree. Currently the only supported value is '1'.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/GraphMembership" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.graph" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "membershipsBatch", | |
| "x-ms-vss-method" : "ListMemberships", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "All members of a group" : { | |
| "$ref" : "./httpExamples/MembershipsBatch/BatchGetMembershipsGroupDown.json" | |
| }, | |
| "All groups for a user" : { | |
| "$ref" : "./httpExamples/MembershipsBatch/BatchGetMembershipsUserUp.json" | |
| }, | |
| "All groups for a group" : { | |
| "$ref" : "./httpExamples/MembershipsBatch/BatchGetMembershipsVSTSGroupUp.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/graph/memberships/{subjectDescriptor}/{containerDescriptor}" : { | |
| "get" : { | |
| "tags" : [ "Memberships" ], | |
| "description" : "Get a membership relationship between a container and subject.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "subjectDescriptor", | |
| "in" : "path", | |
| "description" : "A descriptor to the child subject in the relationship.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "containerDescriptor", | |
| "in" : "path", | |
| "description" : "A descriptor to the container in the relationship.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GraphMembership" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.graph" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "memberships", | |
| "x-ms-vss-method" : "GetMembership", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "For a User" : { | |
| "$ref" : "./httpExamples/Memberships/GetMembershipUser.json" | |
| }, | |
| "For a Group" : { | |
| "$ref" : "./httpExamples/Memberships/GetMembershipVSTSGroup.json" | |
| } | |
| } | |
| }, | |
| "put" : { | |
| "tags" : [ "Memberships" ], | |
| "description" : "Create a new membership between a container and subject.", | |
| "operationId" : "Add", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "subjectDescriptor", | |
| "in" : "path", | |
| "description" : "A descriptor to a group or user that can be the child subject in the relationship.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "containerDescriptor", | |
| "in" : "path", | |
| "description" : "A descriptor to a group that can be the container in the relationship.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GraphMembership" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.graph_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "memberships", | |
| "x-ms-vss-method" : "AddMembership", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Memberships/CreateMembershipVSTSGroup.json" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "Memberships" ], | |
| "description" : "Deletes a membership between a container and subject.", | |
| "operationId" : "Remove Membership", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "subjectDescriptor", | |
| "in" : "path", | |
| "description" : "A descriptor to a group or user that is the child subject in the relationship.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "containerDescriptor", | |
| "in" : "path", | |
| "description" : "A descriptor to a group that is the container in the relationship.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.graph_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "memberships", | |
| "x-ms-vss-method" : "RemoveMembership", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Memberships/DeleteMembershipUser.json" | |
| } | |
| } | |
| }, | |
| "head" : { | |
| "tags" : [ "Memberships" ], | |
| "description" : "Check to see if a membership relationship between a container and subject exists.", | |
| "operationId" : "Check Membership Existence", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "subjectDescriptor", | |
| "in" : "path", | |
| "description" : "The group or user that is a child subject of the relationship.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "containerDescriptor", | |
| "in" : "path", | |
| "description" : "The group that is the container in the relationship.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.graph" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "memberships", | |
| "x-ms-vss-method" : "CheckMembershipExistence", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Memberships/CheckMembershipExistenceUser.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/graph/membershipstates/{subjectDescriptor}" : { | |
| "get" : { | |
| "tags" : [ "Membership States" ], | |
| "description" : "Check whether a subject is active or inactive.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "subjectDescriptor", | |
| "in" : "path", | |
| "description" : "Descriptor of the subject (user, group, scope, etc.) to check state of", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GraphMembershipState" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.graph" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "membershipStates", | |
| "x-ms-vss-method" : "GetMembershipState", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/MembershipStates/GetMembershipStateBySubjectDescriptor.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/graph/storagekeys/{subjectDescriptor}" : { | |
| "get" : { | |
| "tags" : [ "Storage Keys" ], | |
| "description" : "Resolve a descriptor to a storage key.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "subjectDescriptor", | |
| "in" : "path", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GraphStorageKeyResult" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.graph" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "storageKeys", | |
| "x-ms-vss-method" : "GetStorageKey", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/StorageKeys/GetStorageKeyBySubjectDescriptor.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/graph/subjectlookup" : { | |
| "post" : { | |
| "tags" : [ "Subject Lookup" ], | |
| "description" : "Resolve descriptors to users, groups or scopes (Subjects) in a batch.", | |
| "operationId" : "Lookup Subjects", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "A list of descriptors that specifies a subset of subjects to retrieve. Each descriptor uniquely identifies the subject across all instance scopes, but only at a single point in time.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GraphSubjectLookup" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "object", | |
| "additionalProperties" : { | |
| "$ref" : "#/components/schemas/GraphSubject" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.graph" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "subjectLookup", | |
| "x-ms-vss-method" : "LookupSubjects", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/SubjectLookup/LookupSubjects.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/graph/users" : { | |
| "get" : { | |
| "tags" : [ "Users" ], | |
| "description" : "Get a list of all users in a given scope.\n\nSince the list of users may be large, results are returned in pages of users. If there are more results\n than can be returned in a single page, the result set will containt a continuation token for retrieval of the\n next set of results.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "subjectTypes", | |
| "in" : "query", | |
| "description" : "A comma separated list of user subject subtypes to reduce the retrieved results, e.g. msa’, ‘aad’, ‘svc’ (service identity), ‘imp’ (imported identity), etc.", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "array (string)" | |
| } | |
| }, { | |
| "name" : "continuationToken", | |
| "in" : "query", | |
| "description" : "An opaque data blob that allows the next page of data to resume immediately after where the previous page ended. The only reliable way to know if there is more data left is the presence of a continuation token.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "headers" : { | |
| "X-MS-ContinuationToken" : { | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } | |
| }, | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/GraphUser" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.graph" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "users", | |
| "x-ms-vss-method" : "ListUsers", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Users/GetAllUsers.json" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "Users" ], | |
| "description" : "Materialize an existing AAD or MSA user into the VSTS account.\n\nNOTE: Created users are not active in an account unless they have been explicitly assigned a parent group at creation time or have signed in\n and been autolicensed through AAD group memberships.\n\n Adding a user to an account is required before the user can be added to VSTS groups or assigned an asset.\n\n The body of the request must be a derived type of GraphUserCreationContext:\n * GraphUserMailAddressCreationContext - Create a new user using the mail address as a reference to an existing user from an external AD or AAD backed provider.\n * GraphUserOriginIdCreationContext - Create a new user using the OriginID as a reference to an existing user from an external AD or AAD backed provider.\n * GraphUserPrincipalNameCreationContext - Create a new user using the principal name as a reference to an existing user from an external AD or AAD backed provider.\n\n If the user to be added corresponds to a user that was previously deleted, then that user will be restored.\n\n Optionally, you can add the newly created user as a member of an existing VSTS group and/or specify a custom storage key for the user.", | |
| "operationId" : "Create", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "groupDescriptors", | |
| "in" : "query", | |
| "description" : "A comma separated list of descriptors of groups you want the graph user to join", | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "array (string)" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "The subset of the full graph user used to uniquely find the graph subject in an external provider.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GraphUserCreationContext" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GraphUser" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.graph_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "users", | |
| "x-ms-vss-method" : "CreateUser", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "Add an AAD user by UPN" : { | |
| "$ref" : "./httpExamples/Users/CreateUserAAD.json" | |
| }, | |
| "Add a MSA user by UPN" : { | |
| "$ref" : "./httpExamples/Users/CreateUserMSA.json" | |
| }, | |
| "Add an AAD user by OID" : { | |
| "$ref" : "./httpExamples/Users/MaterializeAADUserByOID.json" | |
| }, | |
| "Add an AAD user as member of a group" : { | |
| "$ref" : "./httpExamples/Users/MaterializeAADUserByOIDAsMember.json" | |
| }, | |
| "Add an AAD user with a custom storage key" : { | |
| "$ref" : "./httpExamples/Users/MaterializeAADUserByOIDWithStorageKey.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/graph/users/{userDescriptor}" : { | |
| "get" : { | |
| "tags" : [ "Users" ], | |
| "description" : "Get a user by its descriptor.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "userDescriptor", | |
| "in" : "path", | |
| "description" : "The descriptor of the desired user.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GraphUser" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.graph" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "users", | |
| "x-ms-vss-method" : "GetUser", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Users/GetUserAAD.json" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "Users" ], | |
| "description" : "Disables a user.\n\nCalls to GET .../users/{userDescriptor} will return the user with disabled marked true. Other GET calls, which may return multiple\n users, can control whether or not deleted users should be returned using the disabled flag, which defaults to false.", | |
| "operationId" : "Delete", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "userDescriptor", | |
| "in" : "path", | |
| "description" : "The descriptor of the user to delete.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.graph_manage" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "users", | |
| "x-ms-vss-method" : "DeleteUser", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Users/DeleteUserAAD.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/graph/Users/{userDescriptor}/providerinfo" : { | |
| "get" : { | |
| "tags" : [ "Provider Info" ], | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "userDescriptor", | |
| "in" : "path", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GraphProviderInfo" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.graph" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "providerInfo", | |
| "x-ms-vss-method" : "GetProviderInfo", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/hooks/consumers" : { | |
| "get" : { | |
| "tags" : [ "Consumers" ], | |
| "description" : "Get a list of available service hook consumer services. Optionally filter by consumers that support at least one event type from the specific publisher.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "publisherId", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/Consumer" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "consumers", | |
| "x-ms-vss-method" : "ListConsumers", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Consumers/GET__hooks_consumers.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/hooks/consumers/{consumerId}" : { | |
| "get" : { | |
| "tags" : [ "Consumers" ], | |
| "description" : "Get a specific consumer service. Optionally filter out consumer actions that do not support any event types for the specified publisher.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "consumerId", | |
| "in" : "path", | |
| "description" : "ID for a consumer.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "publisherId", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Consumer" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "consumers", | |
| "x-ms-vss-method" : "GetConsumer", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Consumers/GET__hooks_consumers__consumerId_.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/hooks/consumers/{consumerId}/actions" : { | |
| "get" : { | |
| "tags" : [ "Consumers" ], | |
| "description" : "Get a list of consumer actions for a specific consumer.", | |
| "operationId" : "List Consumer Actions", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "consumerId", | |
| "in" : "path", | |
| "description" : "ID for a consumer.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "publisherId", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/ConsumerAction" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "actions", | |
| "x-ms-vss-method" : "ListConsumerActions", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Actions/GET__hooks_consumers__consumerId__actions.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/hooks/consumers/{consumerId}/actions/{consumerActionId}" : { | |
| "get" : { | |
| "tags" : [ "Consumers" ], | |
| "description" : "Get details about a specific consumer action.", | |
| "operationId" : "Get Consumer Action", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "consumerId", | |
| "in" : "path", | |
| "description" : "ID for a consumer.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "consumerActionId", | |
| "in" : "path", | |
| "description" : "ID for a consumerActionId.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "publisherId", | |
| "in" : "query", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/ConsumerAction" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "actions", | |
| "x-ms-vss-method" : "GetConsumerAction", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Actions/GET__hooks_consumers__consumerId__actions__consumerActionId_.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/hooks/notificationsquery" : { | |
| "post" : { | |
| "tags" : [ "Notifications" ], | |
| "description" : "Query for notifications. A notification includes details about the event, the request to and the response from the consumer service.", | |
| "operationId" : "Query", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/NotificationsQuery" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/NotificationsQuery" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "notificationsQuery", | |
| "x-ms-vss-method" : "QueryNotifications" | |
| } | |
| }, | |
| "/{organization}/_apis/hooks/publishers" : { | |
| "get" : { | |
| "tags" : [ "Publishers" ], | |
| "description" : "Get a list of publishers.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/Publisher" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "publishers", | |
| "x-ms-vss-method" : "ListPublishers", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Publishers/GET__hooks_publishers.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/hooks/publishers/{publisherId}" : { | |
| "get" : { | |
| "tags" : [ "Publishers" ], | |
| "description" : "Get a specific service hooks publisher.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "publisherId", | |
| "in" : "path", | |
| "description" : "ID for a publisher.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Publisher" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "publishers", | |
| "x-ms-vss-method" : "GetPublisher" | |
| } | |
| }, | |
| "/{organization}/_apis/hooks/publishers/{publisherId}/eventtypes" : { | |
| "get" : { | |
| "tags" : [ "Publishers" ], | |
| "description" : "Get the event types for a specific publisher.", | |
| "operationId" : "List Event Types", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "publisherId", | |
| "in" : "path", | |
| "description" : "ID for a publisher.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/EventTypeDescriptor" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "eventTypes", | |
| "x-ms-vss-method" : "ListEventTypes", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/EventTypes/GET__hooks_publishers__publisherId__eventTypes.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/hooks/publishers/{publisherId}/eventtypes/{eventTypeId}" : { | |
| "get" : { | |
| "tags" : [ "Publishers" ], | |
| "description" : "Get a specific event type.", | |
| "operationId" : "Get Event Type", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "publisherId", | |
| "in" : "path", | |
| "description" : "ID for a publisher.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "eventTypeId", | |
| "in" : "path", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/EventTypeDescriptor" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "eventTypes", | |
| "x-ms-vss-method" : "GetEventType", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/EventTypes/GET__hooks_publishers__publisherId__eventTypes__eventTypeId_.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/hooks/publishers/{publisherId}/inputValuesQuery" : { | |
| "post" : { | |
| "tags" : [ "Publishers" ], | |
| "operationId" : "Query Input Values", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "publisherId", | |
| "in" : "path", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/InputValuesQuery" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/InputValuesQuery" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "publisherInputValuesQuery", | |
| "x-ms-vss-method" : "QueryInputValues" | |
| } | |
| }, | |
| "/{organization}/_apis/hooks/publishersquery" : { | |
| "post" : { | |
| "tags" : [ "Publishers" ], | |
| "description" : "Query for service hook publishers.", | |
| "operationId" : "Query Publishers", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/PublishersQuery" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/PublishersQuery" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "publishersQuery", | |
| "x-ms-vss-method" : "QueryPublishers" | |
| } | |
| }, | |
| "/{organization}/_apis/hooks/subscriptions" : { | |
| "get" : { | |
| "tags" : [ "Subscriptions" ], | |
| "description" : "Get a list of subscriptions.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "publisherId", | |
| "in" : "query", | |
| "description" : "ID for a subscription.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "eventType", | |
| "in" : "query", | |
| "description" : "Maximum number of notifications to return. Default is 100.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "consumerId", | |
| "in" : "query", | |
| "description" : "ID for a consumer.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "consumerActionId", | |
| "in" : "query", | |
| "description" : "ID for a consumerActionId.", | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/Subscription" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "subscriptions", | |
| "x-ms-vss-method" : "ListSubscriptions", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Subscriptions/GET__hooks_subscriptions_.json" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "Subscriptions" ], | |
| "description" : "Create a subscription.", | |
| "operationId" : "Create", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "Subscription to be created.", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Subscription" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Subscription" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "subscriptions", | |
| "x-ms-vss-method" : "CreateSubscription", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Subscriptions/PUT__hooks_subscriptions__newSubscriptionId_.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/hooks/subscriptions/{subscriptionId}" : { | |
| "get" : { | |
| "tags" : [ "Subscriptions" ], | |
| "description" : "Get a specific service hooks subscription.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "subscriptionId", | |
| "in" : "path", | |
| "description" : "ID for a subscription.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Subscription" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "subscriptions", | |
| "x-ms-vss-method" : "GetSubscription", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Subscriptions/GET__hooks_subscriptions__subscriptionId_.json" | |
| } | |
| } | |
| }, | |
| "put" : { | |
| "tags" : [ "Subscriptions" ], | |
| "description" : "Update a subscription. <param name=\"subscriptionId\">ID for a subscription that you wish to update.</param>", | |
| "operationId" : "Replace Subscription", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "subscriptionId", | |
| "in" : "path", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid", | |
| "x-ms-required" : false | |
| }, | |
| "x-ms-required" : false | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Subscription" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Subscription" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "subscriptions", | |
| "x-ms-vss-method" : "ReplaceSubscription", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Subscriptions/POST__hooks_subscriptions.json" | |
| } | |
| } | |
| }, | |
| "delete" : { | |
| "tags" : [ "Subscriptions" ], | |
| "description" : "Delete a specific service hooks subscription.", | |
| "operationId" : "Delete", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "subscriptionId", | |
| "in" : "path", | |
| "description" : "ID for a subscription.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "subscriptions", | |
| "x-ms-vss-method" : "DeleteSubscription", | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/Subscriptions/DELETE__hooks_subscriptions__newSubscriptionId_.json" | |
| } | |
| } | |
| } | |
| }, | |
| "/{organization}/_apis/hooks/subscriptions/{subscriptionId}/diagnostics" : { | |
| "get" : { | |
| "tags" : [ "Diagnostics" ], | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "subscriptionId", | |
| "in" : "path", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/SubscriptionDiagnostics" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "diagnostics", | |
| "x-ms-vss-method" : "GetSubscriptionDiagnostics", | |
| "x-ms-preview" : true | |
| }, | |
| "put" : { | |
| "tags" : [ "Diagnostics" ], | |
| "operationId" : "Update", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "subscriptionId", | |
| "in" : "path", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/UpdateSubscripitonDiagnosticsParameters" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/SubscriptionDiagnostics" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "diagnostics", | |
| "x-ms-vss-method" : "UpdateSubscriptionDiagnostics", | |
| "x-ms-preview" : true | |
| } | |
| }, | |
| "/{organization}/_apis/hooks/subscriptions/{subscriptionId}/notifications" : { | |
| "get" : { | |
| "tags" : [ "Notifications" ], | |
| "description" : "Get a list of notifications for a specific subscription. A notification includes details about the event, the request to and the response from the consumer service.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "subscriptionId", | |
| "in" : "path", | |
| "description" : "ID for a subscription.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "maxResults", | |
| "in" : "query", | |
| "description" : "Maximum number of notifications to return. Default is **100**.", | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "status", | |
| "in" : "query", | |
| "description" : "Get only notifications with this status.", | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "queued", "processing", "requestInProgress", "completed" ], | |
| "x-ms-enum" : { | |
| "name" : "NotificationStatus", | |
| "values" : [ { | |
| "value" : "queued", | |
| "description" : "The notification has been queued" | |
| }, { | |
| "value" : "processing", | |
| "description" : "The notification has been dequeued and has begun processing." | |
| }, { | |
| "value" : "requestInProgress", | |
| "description" : "The consumer action has processed the notification. The request is in progress." | |
| }, { | |
| "value" : "completed", | |
| "description" : "The request completed" | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "NotificationStatus", | |
| "values" : [ { | |
| "value" : "queued", | |
| "description" : "The notification has been queued" | |
| }, { | |
| "value" : "processing", | |
| "description" : "The notification has been dequeued and has begun processing." | |
| }, { | |
| "value" : "requestInProgress", | |
| "description" : "The consumer action has processed the notification. The request is in progress." | |
| }, { | |
| "value" : "completed", | |
| "description" : "The request completed" | |
| } ] | |
| } | |
| }, { | |
| "name" : "result", | |
| "in" : "query", | |
| "description" : "Get only notifications with this result type.", | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "pending", "succeeded", "failed", "filtered" ], | |
| "x-ms-enum" : { | |
| "name" : "NotificationResult", | |
| "values" : [ { | |
| "value" : "pending", | |
| "description" : "The notification has not yet completed" | |
| }, { | |
| "value" : "succeeded", | |
| "description" : "The notification was sent successfully" | |
| }, { | |
| "value" : "failed", | |
| "description" : "The notification failed to be sent successfully to the consumer" | |
| }, { | |
| "value" : "filtered", | |
| "description" : "The notification was filtered by the Delivery Job" | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "NotificationResult", | |
| "values" : [ { | |
| "value" : "pending", | |
| "description" : "The notification has not yet completed" | |
| }, { | |
| "value" : "succeeded", | |
| "description" : "The notification was sent successfully" | |
| }, { | |
| "value" : "failed", | |
| "description" : "The notification failed to be sent successfully to the consumer" | |
| }, { | |
| "value" : "filtered", | |
| "description" : "The notification was filtered by the Delivery Job" | |
| } ] | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/Notification" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "notifications", | |
| "x-ms-vss-method" : "GetNotifications" | |
| } | |
| }, | |
| "/{organization}/_apis/hooks/subscriptions/{subscriptionId}/notifications/{notificationId}" : { | |
| "get" : { | |
| "tags" : [ "Notifications" ], | |
| "description" : "Get a specific notification for a subscription.", | |
| "operationId" : "Get", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "subscriptionId", | |
| "in" : "path", | |
| "description" : "ID for a subscription.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string", | |
| "format" : "uuid" | |
| } | |
| }, { | |
| "name" : "notificationId", | |
| "in" : "path", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "integer", | |
| "format" : "int32" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Notification" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "notifications", | |
| "x-ms-vss-method" : "GetNotification" | |
| } | |
| }, | |
| "/{organization}/_apis/hooks/subscriptionsquery" : { | |
| "post" : { | |
| "tags" : [ "Subscriptions" ], | |
| "description" : "Query for service hook subscriptions.", | |
| "operationId" : "Create Subscriptions Query", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/SubscriptionsQuery" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/SubscriptionsQuery" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "subscriptionsQuery", | |
| "x-ms-vss-method" : "CreateSubscriptionsQuery" | |
| } | |
| }, | |
| "/{organization}/_apis/hooks/testnotifications" : { | |
| "post" : { | |
| "tags" : [ "Notifications" ], | |
| "description" : "Sends a test notification. This is useful for verifying the configuration of an updated or new service hooks subscription.", | |
| "operationId" : "Create", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "useRealData", | |
| "in" : "query", | |
| "description" : "Only allow testing with real data in existing subscriptions.", | |
| "schema" : { | |
| "type" : "boolean" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Notification" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/Notification" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "x-ms-docs-override-version" : "5.0", | |
| "x-ms-vss-resource" : "testNotifications", | |
| "x-ms-vss-method" : "CreateTestNotification" | |
| } | |
| }, | |
| "/{organization}/_apis/groupentitlements" : { | |
| "get" : { | |
| "tags" : [ "Group Entitlements" ], | |
| "description" : "Get the group entitlements for an account.", | |
| "operationId" : "List", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "responses" : { | |
| "200" : { | |
| "description" : "successful operation", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "type" : "array", | |
| "items" : { | |
| "$ref" : "#/components/schemas/GroupEntitlement" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "security" : [ { | |
| "oauth2" : [ "vso.memberentitlementmanagement" ] | |
| } ], | |
| "x-ms-docs-override-version" : "5.0-preview.1", | |
| "x-ms-vss-resource" : "groupEntitlements", | |
| "x-ms-vss-method" : "GetGroupEntitlements", | |
| "x-ms-preview" : true, | |
| "x-ms-examples" : { | |
| "" : { | |
| "$ref" : "./httpExamples/GroupEntitlements/GET__memberEntitlementManagement_GroupEntitlements.json" | |
| } | |
| } | |
| }, | |
| "post" : { | |
| "tags" : [ "Group Entitlements" ], | |
| "description" : "Create a group entitlement with license rule, extension rule.", | |
| "operationId" : "Add", | |
| "parameters" : [ { | |
| "name" : "organization", | |
| "in" : "path", | |
| "description" : "The name of the Azure DevOps organization.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| }, { | |
| "name" : "ruleOption", | |
| "in" : "query", | |
| "description" : "RuleOption [ApplyGroupRule/TestApplyGroupRule] - specifies if the rules defined in group entitlement should be created and applied to it’s members (default option) or just be tested", | |
| "schema" : { | |
| "type" : "string", | |
| "enum" : [ "applyGroupRule", "testApplyGroupRule" ], | |
| "x-ms-enum" : { | |
| "name" : "RuleOption", | |
| "values" : [ { | |
| "value" : "applyGroupRule", | |
| "description" : "" | |
| }, { | |
| "value" : "testApplyGroupRule", | |
| "description" : "" | |
| } ] | |
| } | |
| }, | |
| "x-ms-enum" : { | |
| "name" : "RuleOption", | |
| "values" : [ { | |
| "value" : "applyGroupRule", | |
| "description" : "" | |
| }, { | |
| "value" : "testApplyGroupRule", | |
| "description" : "" | |
| } ] | |
| } | |
| }, { | |
| "name" : "api-version", | |
| "in" : "query", | |
| "description" : "Version of the API to use. This should be set to '5.0-preview.1' to use this version of the api.", | |
| "required" : true, | |
| "schema" : { | |
| "type" : "string" | |
| } | |
| } ], | |
| "requestBody" : { | |
| "description" : "GroupEntitlement object specifying License Rule, Extensions Rule for the group. Based on the rules the members of the group will be given licenses and extensions. The Group Entitlement can be used to add the group to another project level groups", | |
| "content" : { | |
| "application/json" : { | |
| "schema" : { | |
| "$ref" : "#/components/schemas/GroupEntitlement" | |
| } | |
| } | |
| }, | |
| "required" : true | |
| }, | |
| "responses" : { | |
| "201" : { | |
| "description" : "Created", | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment