{ "id": "@itentialopensource/adapter-azure_devops", "type": "Adapter", "export": "AzureDevops", "title": "Azure_devops", "src": "adapter.js", "roles": [ "admin" ], "methods": [ { "name": "iapUpdateAdapterConfiguration", "summary": "Updates the adapter configuration", "description": "Updates the adapter configuration file with the provided changes", "input": [ { "name": "configFile", "type": "string", "info": "The name of the file to change", "required": true, "schema": { "title": "configFile", "type": "string" } }, { "name": "changes", "type": "object", "info": "JSON object containing the configuration changes", "required": true, "schema": { "title": "changes", "type": "object" } }, { "name": "entity", "type": "string", "info": "The entity in which the changes are being made", "required": false, "schema": { "title": "entity", "type": "string" } }, { "name": "type", "type": "string", "info": "The type of file to change - action, schema, or mock", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "action", "type": "string", "info": "The action to be changed", "required": false, "schema": { "title": "action", "type": "string" } }, { "name": "replace", "type": "boolean", "info": "True to replace entire mock data, false to merge/append", "required": false, "schema": { "title": "replace", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUpdateAdapterConfiguration" }, "task": true }, { "name": "iapSuspendAdapter", "summary": "Suspends the adapter", "description": "Suspends the adapter", "input": [ { "name": "mode", "type": "enum", "enumerals": [ "pause", "error" ], "info": "How incoming requests are handled. Defaults to 'pause'", "description": "How incoming requests are handled. Defaults to 'pause'", "schema": { "title": "mode", "type": "string" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapSuspendAdapter" }, "task": true }, { "name": "iapUnsuspendAdapter", "summary": "Unsuspends the adapter", "description": "Unsuspends the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUnsuspendAdapter" }, "task": true }, { "name": "iapGetAdapterQueue", "summary": "Return the requests that are waiting in the queue if throttling is enabled", "description": "Return the requests that are waiting in the queue if throttling is enabled", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter queue", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetAdapterQueue" }, "task": true }, { "name": "iapFindAdapterPath", "summary": "Provides the ability to see if a particular API path is supported by the adapter", "description": "Provides the ability to see if a particular API path is supported by the adapter", "input": [ { "name": "apiPath", "type": "string", "info": "The API Path you want to check - make sure to not include base path and version", "description": "The API Path you want to check - make sure to not include base path and version", "schema": { "title": "apiPath", "type": "string" }, "required": true } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapFindAdapterPath" }, "task": true }, { "name": "iapTroubleshootAdapter", "summary": "Runs troubleshoot script for adapter", "description": "Runs troubleshoot script for adapter", "input": [ { "name": "props", "type": "object", "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}", "required": true, "schema": { "title": "props", "type": "object" } }, { "name": "persistFlag", "type": "boolean", "info": "Whether the input properties should be saved", "required": true, "schema": { "title": "persistFlag", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapTroubleshootAdapter" }, "task": true }, { "name": "iapRunAdapterHealthcheck", "summary": "Runs healthcheck script for adapter", "description": "Runs healthcheck script for adapter", "input": [], "output": { "name": "result", "type": "boolean", "description": "Whether healthcheck passed or failed", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterHealthcheck" }, "task": true }, { "name": "iapRunAdapterConnectivity", "summary": "Runs connectivity check script for adapter", "description": "Runs connectivity check script for adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterConnectivity" }, "task": true }, { "name": "iapRunAdapterBasicGet", "summary": "Runs basicGet script for adapter", "description": "Runs basicGet script for adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterBasicGet" }, "task": true }, { "name": "iapMoveAdapterEntitiesToDB", "summary": "Moves entities from an adapter into the IAP database", "description": "Moves entities from an adapter into the IAP database", "input": [], "output": { "name": "res", "type": "object", "description": "A JSON Object containing status, code and the response from the mongo transaction", "schema": { "title": "res", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapMoveAdapterEntitiesToDB" }, "task": true }, { "name": "iapDeactivateTasks", "summary": "Deactivate the inputted tasks", "description": "Deactivate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to deactivate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapDeactivateTasks" }, "task": true }, { "name": "iapActivateTasks", "summary": "Activate the inputted tasks", "description": "activate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to activate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapActivateTasks" }, "task": true }, { "name": "iapPopulateEntityCache", "summary": "Populate the cache for the given entities", "description": "Populate the cache for the given entities", "input": [ { "name": "entityTypes", "type": "array", "info": "the entity type(s) to populate", "required": true, "schema": { "title": "entityTypes", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapPopulateEntityCache" }, "task": true }, { "name": "iapRetrieveEntitiesCache", "summary": "Retrieves data from cache for specified entity type", "description": "Retrieves data from cache for specified entity type", "input": [ { "name": "entityType", "type": "string", "info": "entity of which to retrieve", "required": true, "schema": { "title": "entityType", "type": "string" } }, { "name": "options", "type": "object", "info": "settings of which data to return and how to return it", "required": false, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRetrieveEntitiesCache" }, "task": true }, { "name": "getDevice", "summary": "Get the Appliance", "description": "Get the Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevice" }, "task": false }, { "name": "getDevicesFiltered", "summary": "Get Appliances that match the filter", "description": "Get Appliances that match the filter", "input": [ { "name": "options", "type": "object", "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }", "required": true, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevicesFiltered" }, "task": false }, { "name": "isAlive", "summary": "Checks the status for the provided Appliance", "description": "Checks the status for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "boolean", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/isAlive" }, "task": false }, { "name": "getConfig", "summary": "Gets a config for the provided Appliance", "description": "Gets a config for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } }, { "name": "format", "type": "string", "info": "The format to be returned - this is ignored as we always return json", "required": false, "schema": { "title": "format", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getConfig" }, "task": false }, { "name": "iapGetDeviceCount", "summary": "Gets a device count from the system", "description": "Gets a device count from the system", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetDeviceCount" }, "task": false }, { "name": "iapExpandedGenericAdapterRequest", "summary": "Makes the requested generic call with additional options", "description": "Makes the requested generic call with additional options via metadata", "input": [ { "name": "metadata", "type": "object", "info": "metadata for the call (optional)", "description": "metadata for the call - allows for many enhancements (optional)", "schema": { "title": "metadata", "type": "object" }, "required": false }, { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": false }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": false }, { "name": "pathVars", "type": "object", "info": "the parameters to be put within the url path (optional)", "description": "the parameters to be put within the url path (optional)", "schema": { "title": "pathVars", "type": "object" }, "required": false }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapExpandedGenericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequest", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequestNoBasePath", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequestNoBasePath" }, "task": true }, { "name": "iapRunAdapterLint", "summary": "Run the adapter lint script to return the results", "description": "Run the adapter lint script to return the results", "input": [], "output": { "name": "result", "type": "string", "description": "A string containing the run results", "schema": { "title": "result", "type": "string" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterLint" }, "task": true }, { "name": "iapRunAdapterTests", "summary": "Run the adapter test scripts (baseunit and unit) to return the results", "description": "Run the adapter test scripts (baseunit and unit) to return the results", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterTests" }, "task": true }, { "name": "iapGetAdapterInventory", "summary": "Provide inventory information abbout the adapter", "description": "Provide inventory information abbout the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapGetAdapterInventory" }, "task": true }, { "name": "pipelinesCreate", "summary": "Create a pipeline.", "description": "Create a pipeline.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": "Input parameters.: {\"configuration\": \"undefined\", \"folder\": \"string\", \"name\": \"string\"}", "required": true, "schema": { "description": "Parameters to create a pipeline.", "type": "object", "properties": { "configuration": { "description": "Configuration parameters of the pipeline.", "body": { "description": "Configuration parameters of the pipeline.", "type": "object", "properties": { "type": { "description": "Type of configuration.", "enum": [ "unknown", "yaml", "designerJson", "justInTime", "designerHyphenJson" ], "x-ms-enum": { "name": "ConfigurationType", "values": [ { "value": "unknown", "description": "Unknown type." }, { "value": "yaml", "description": "YAML." }, { "value": "designerJson", "description": "Designer JSON." }, { "value": "justInTime", "description": "Just-in-time." }, { "value": "designerHyphenJson", "description": "Designer-JSON." } ] } } } } }, "folder": { "description": "Folder of the pipeline.", "type": "string" }, "name": { "description": "Name of the pipeline.", "type": "string" } } } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '6.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "Definition of a pipeline.", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "folder": { "description": "Pipeline folder", "type": "string" }, "id": { "description": "Pipeline ID", "type": "integer" }, "name": { "description": "Pipeline name", "type": "string" }, "revision": { "description": "Revision number", "type": "integer" } } } ], "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "configuration": { "description": "", "type": "object", "properties": { "type": { "enum": [ "unknown", "yaml", "designerJson", "justInTime", "designerHyphenJson" ], "x-ms-enum": { "name": "ConfigurationType", "values": [ { "value": "unknown", "description": "Unknown type." }, { "value": "yaml", "description": "YAML." }, { "value": "designerJson", "description": "Designer JSON." }, { "value": "justInTime", "description": "Just-in-time." }, { "value": "designerHyphenJson", "description": "Designer-JSON." } ] } } } }, "url": { "description": "URL of the pipeline", "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pipelinesCreate" }, "task": true }, { "name": "pipelinesList", "summary": "Get a list of pipelines.", "description": "Get a list of pipelines.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "orderBy", "type": "string", "info": "A sort expression. Defaults to \"name asc\": string", "required": false, "schema": { "title": "orderBy", "type": "string" } }, { "name": "top", "type": "number", "info": "The maximum number of pipelines to return: 123", "required": false, "schema": { "title": "top", "type": "number" } }, { "name": "continuationToken", "type": "string", "info": "A continuation token from a previous request, to retrieve the next page of results: string", "required": false, "schema": { "title": "continuationToken", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '6.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "Definition of a pipeline.", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "folder": { "description": "Pipeline folder", "type": "string" }, "id": { "description": "Pipeline ID", "type": "integer" }, "name": { "description": "Pipeline name", "type": "string" }, "revision": { "description": "Revision number", "type": "integer" } } } ], "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "configuration": { "description": "", "type": "object", "properties": { "type": { "enum": [ "unknown", "yaml", "designerJson", "justInTime", "designerHyphenJson" ], "x-ms-enum": { "name": "ConfigurationType", "values": [ { "value": "unknown", "description": "Unknown type." }, { "value": "yaml", "description": "YAML." }, { "value": "designerJson", "description": "Designer JSON." }, { "value": "justInTime", "description": "Just-in-time." }, { "value": "designerHyphenJson", "description": "Designer-JSON." } ] } } } }, "url": { "description": "URL of the pipeline", "type": "string" } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pipelinesList" }, "task": true }, { "name": "pipelinesGet", "summary": "Gets a pipeline, optionally at the specified version", "description": "Gets a pipeline, optionally at the specified version", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "pipelineId", "type": "number", "info": "The pipeline ID: 123", "required": true, "schema": { "title": "pipelineId", "type": "number" } }, { "name": "pipelineVersion", "type": "number", "info": "The pipeline version: 123", "required": false, "schema": { "title": "pipelineVersion", "type": "number" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '6.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "Definition of a pipeline.", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "folder": { "description": "Pipeline folder", "type": "string" }, "id": { "description": "Pipeline ID", "type": "integer" }, "name": { "description": "Pipeline name", "type": "string" }, "revision": { "description": "Revision number", "type": "integer" } } } ], "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "configuration": { "description": "", "type": "object", "properties": { "type": { "enum": [ "unknown", "yaml", "designerJson", "justInTime", "designerHyphenJson" ], "x-ms-enum": { "name": "ConfigurationType", "values": [ { "value": "unknown", "description": "Unknown type." }, { "value": "yaml", "description": "YAML." }, { "value": "designerJson", "description": "Designer JSON." }, { "value": "justInTime", "description": "Just-in-time." }, { "value": "designerHyphenJson", "description": "Designer-JSON." } ] } } } }, "url": { "description": "URL of the pipeline", "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pipelinesGet" }, "task": true }, { "name": "previewPreview", "summary": "Queues a dry run of the pipeline and returns an object containing the final yaml.", "description": "Queues a dry run of the pipeline and returns an object containing the final yaml.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": "Optional additional parameters for this run.: {\"previewRun\": \"boolean\", \"resources\": \"undefined\", \"stagesToSkip\": \"array\", \"templateParameters\": \"object\", \"variables\": \"object\", \"yamlOverride\": \"string\"}", "required": true, "schema": { "description": "Settings which influence pipeline runs.", "type": "object", "properties": { "previewRun": { "description": "If true, don't actually create a new run. Instead, return the final YAML document after parsing templates.", "type": "boolean" }, "resources": { "description": "The resources the run requires.", "body": { "description": "", "type": "object", "properties": { "builds": { "type": "object", "additionalProperties": { "description": "", "type": "object", "properties": { "version": { "type": "string" } } } }, "containers": { "type": "object", "additionalProperties": { "description": "", "type": "object", "properties": { "version": { "type": "string" } } } }, "packages": { "type": "object", "additionalProperties": { "description": "", "type": "object", "properties": { "version": { "type": "string" } } } }, "pipelines": { "type": "object", "additionalProperties": { "description": "", "type": "object", "properties": { "version": { "type": "string" } } } }, "repositories": { "type": "object", "additionalProperties": { "description": "", "type": "object", "properties": { "refName": { "type": "string" }, "token": { "description": "This is the security token to use when connecting to the repository.", "type": "string" }, "tokenType": { "description": "Optional. This is the type of the token given. If not provided, a type of \"Bearer\" is assumed. Note: Use \"Basic\" for a PAT token.", "type": "string" }, "version": { "type": "string" } } } } } } }, "stagesToSkip": { "type": "array", "items": { "type": "string" } }, "templateParameters": { "type": "object", "additionalProperties": { "type": "string" } }, "variables": { "type": "object", "additionalProperties": { "description": "", "type": "object", "properties": { "isSecret": { "type": "boolean" }, "value": { "type": "string" } } } }, "yamlOverride": { "description": "If you use the preview run option, you may optionally supply different YAML. This allows you to preview the final YAML document without committing a changed file.", "type": "string" } } } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "pipelineId", "type": "number", "info": "The pipeline ID.: 123", "required": true, "schema": { "title": "pipelineId", "type": "number" } }, { "name": "pipelineVersion", "type": "number", "info": "The pipeline version.: 123", "required": false, "schema": { "title": "pipelineVersion", "type": "number" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '6.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "", "type": "object", "properties": { "finalYaml": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/previewPreview" }, "task": true }, { "name": "runsList", "summary": "Gets top 10000 runs for a particular pipeline.", "description": "Gets top 10000 runs for a particular pipeline.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "pipelineId", "type": "number", "info": "The pipeline id: 123", "required": true, "schema": { "title": "pipelineId", "type": "number" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '6.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } ], "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "createdDate": { "type": "string" }, "finalYaml": { "type": "string" }, "finishedDate": { "type": "string" }, "pipeline": { "description": "A reference to a Pipeline.", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "folder": { "description": "Pipeline folder", "type": "string" }, "id": { "description": "Pipeline ID", "type": "integer" }, "name": { "description": "Pipeline name", "type": "string" }, "revision": { "description": "Revision number", "type": "integer" } } } ], "properties": { "url": { "type": "string" } } }, "resources": { "description": "", "type": "object", "properties": { "repositories": { "type": "object", "additionalProperties": { "description": "", "type": "object", "properties": { "refName": { "type": "string" }, "repository": { "description": "", "type": "object", "properties": { "type": { "enum": [ "unknown", "gitHub", "azureReposGit", "gitHubEnterprise", "azureReposGitHyphenated" ], "x-ms-enum": { "name": "RepositoryType", "values": [ { "value": "unknown", "description": "" }, { "value": "gitHub", "description": "" }, { "value": "azureReposGit", "description": "" }, { "value": "gitHubEnterprise", "description": "" }, { "value": "azureReposGitHyphenated", "description": "" } ] } } } }, "version": { "type": "string" } } } } } }, "result": { "enum": [ "unknown", "succeeded", "failed", "canceled" ], "x-ms-enum": { "name": "RunResult", "values": [ { "value": "unknown", "description": "" }, { "value": "succeeded", "description": "" }, { "value": "failed", "description": "" }, { "value": "canceled", "description": "" } ] } }, "state": { "enum": [ "unknown", "inProgress", "canceling", "completed" ], "x-ms-enum": { "name": "RunState", "values": [ { "value": "unknown", "description": "" }, { "value": "inProgress", "description": "" }, { "value": "canceling", "description": "" }, { "value": "completed", "description": "" } ] } }, "url": { "type": "string" }, "variables": { "type": "object", "additionalProperties": { "description": "", "type": "object", "properties": { "isSecret": { "type": "boolean" }, "value": { "type": "string" } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/runsList" }, "task": true }, { "name": "runsRunPipeline", "summary": "Runs a pipeline.", "description": "Runs a pipeline.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": "Optional additional parameters for this run.: {\"previewRun\": \"boolean\", \"resources\": \"undefined\", \"stagesToSkip\": \"array\", \"templateParameters\": \"object\", \"variables\": \"object\", \"yamlOverride\": \"string\"}", "required": true, "schema": { "description": "Settings which influence pipeline runs.", "type": "object", "properties": { "previewRun": { "description": "If true, don't actually create a new run. Instead, return the final YAML document after parsing templates.", "type": "boolean" }, "resources": { "description": "The resources the run requires.", "body": { "description": "", "type": "object", "properties": { "builds": { "type": "object", "additionalProperties": { "description": "", "type": "object", "properties": { "version": { "type": "string" } } } }, "containers": { "type": "object", "additionalProperties": { "description": "", "type": "object", "properties": { "version": { "type": "string" } } } }, "packages": { "type": "object", "additionalProperties": { "description": "", "type": "object", "properties": { "version": { "type": "string" } } } }, "pipelines": { "type": "object", "additionalProperties": { "description": "", "type": "object", "properties": { "version": { "type": "string" } } } }, "repositories": { "type": "object", "additionalProperties": { "description": "", "type": "object", "properties": { "refName": { "type": "string" }, "token": { "description": "This is the security token to use when connecting to the repository.", "type": "string" }, "tokenType": { "description": "Optional. This is the type of the token given. If not provided, a type of \"Bearer\" is assumed. Note: Use \"Basic\" for a PAT token.", "type": "string" }, "version": { "type": "string" } } } } } } }, "stagesToSkip": { "type": "array", "items": { "type": "string" } }, "templateParameters": { "type": "object", "additionalProperties": { "type": "string" } }, "variables": { "type": "object", "additionalProperties": { "description": "", "type": "object", "properties": { "isSecret": { "type": "boolean" }, "value": { "type": "string" } } } }, "yamlOverride": { "description": "If you use the preview run option, you may optionally supply different YAML. This allows you to preview the final YAML document without committing a changed file.", "type": "string" } } } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "pipelineId", "type": "number", "info": "The pipeline ID.: 123", "required": true, "schema": { "title": "pipelineId", "type": "number" } }, { "name": "pipelineVersion", "type": "number", "info": "The pipeline version.: 123", "required": false, "schema": { "title": "pipelineVersion", "type": "number" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '6.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } ], "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "createdDate": { "type": "string" }, "finalYaml": { "type": "string" }, "finishedDate": { "type": "string" }, "pipeline": { "description": "A reference to a Pipeline.", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "folder": { "description": "Pipeline folder", "type": "string" }, "id": { "description": "Pipeline ID", "type": "integer" }, "name": { "description": "Pipeline name", "type": "string" }, "revision": { "description": "Revision number", "type": "integer" } } } ], "properties": { "url": { "type": "string" } } }, "resources": { "description": "", "type": "object", "properties": { "repositories": { "type": "object", "additionalProperties": { "description": "", "type": "object", "properties": { "refName": { "type": "string" }, "repository": { "description": "", "type": "object", "properties": { "type": { "enum": [ "unknown", "gitHub", "azureReposGit", "gitHubEnterprise", "azureReposGitHyphenated" ], "x-ms-enum": { "name": "RepositoryType", "values": [ { "value": "unknown", "description": "" }, { "value": "gitHub", "description": "" }, { "value": "azureReposGit", "description": "" }, { "value": "gitHubEnterprise", "description": "" }, { "value": "azureReposGitHyphenated", "description": "" } ] } } } }, "version": { "type": "string" } } } } } }, "result": { "enum": [ "unknown", "succeeded", "failed", "canceled" ], "x-ms-enum": { "name": "RunResult", "values": [ { "value": "unknown", "description": "" }, { "value": "succeeded", "description": "" }, { "value": "failed", "description": "" }, { "value": "canceled", "description": "" } ] } }, "state": { "enum": [ "unknown", "inProgress", "canceling", "completed" ], "x-ms-enum": { "name": "RunState", "values": [ { "value": "unknown", "description": "" }, { "value": "inProgress", "description": "" }, { "value": "canceling", "description": "" }, { "value": "completed", "description": "" } ] } }, "url": { "type": "string" }, "variables": { "type": "object", "additionalProperties": { "description": "", "type": "object", "properties": { "isSecret": { "type": "boolean" }, "value": { "type": "string" } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/runsRunPipeline" }, "task": true }, { "name": "runsGet", "summary": "Gets a run for a particular pipeline.", "description": "Gets a run for a particular pipeline.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "pipelineId", "type": "number", "info": "The pipeline id: 123", "required": true, "schema": { "title": "pipelineId", "type": "number" } }, { "name": "runId", "type": "number", "info": "The run id: 123", "required": true, "schema": { "title": "runId", "type": "number" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '6.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } ], "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "createdDate": { "type": "string" }, "finalYaml": { "type": "string" }, "finishedDate": { "type": "string" }, "pipeline": { "description": "A reference to a Pipeline.", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "folder": { "description": "Pipeline folder", "type": "string" }, "id": { "description": "Pipeline ID", "type": "integer" }, "name": { "description": "Pipeline name", "type": "string" }, "revision": { "description": "Revision number", "type": "integer" } } } ], "properties": { "url": { "type": "string" } } }, "resources": { "description": "", "type": "object", "properties": { "repositories": { "type": "object", "additionalProperties": { "description": "", "type": "object", "properties": { "refName": { "type": "string" }, "repository": { "description": "", "type": "object", "properties": { "type": { "enum": [ "unknown", "gitHub", "azureReposGit", "gitHubEnterprise", "azureReposGitHyphenated" ], "x-ms-enum": { "name": "RepositoryType", "values": [ { "value": "unknown", "description": "" }, { "value": "gitHub", "description": "" }, { "value": "azureReposGit", "description": "" }, { "value": "gitHubEnterprise", "description": "" }, { "value": "azureReposGitHyphenated", "description": "" } ] } } } }, "version": { "type": "string" } } } } } }, "result": { "enum": [ "unknown", "succeeded", "failed", "canceled" ], "x-ms-enum": { "name": "RunResult", "values": [ { "value": "unknown", "description": "" }, { "value": "succeeded", "description": "" }, { "value": "failed", "description": "" }, { "value": "canceled", "description": "" } ] } }, "state": { "enum": [ "unknown", "inProgress", "canceling", "completed" ], "x-ms-enum": { "name": "RunState", "values": [ { "value": "unknown", "description": "" }, { "value": "inProgress", "description": "" }, { "value": "canceling", "description": "" }, { "value": "completed", "description": "" } ] } }, "url": { "type": "string" }, "variables": { "type": "object", "additionalProperties": { "description": "", "type": "object", "properties": { "isSecret": { "type": "boolean" }, "value": { "type": "string" } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/runsGet" }, "task": true }, { "name": "artifactsGet", "summary": "Get a specific artifact from a pipeline run", "description": "Get a specific artifact from a pipeline run", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "pipelineId", "type": "number", "info": "ID of the pipeline.: 123", "required": true, "schema": { "title": "pipelineId", "type": "number" } }, { "name": "runId", "type": "number", "info": "ID of the run of that pipeline.: 123", "required": true, "schema": { "title": "runId", "type": "number" } }, { "name": "artifactName", "type": "string", "info": "Name of the artifact.: string", "required": true, "schema": { "title": "artifactName", "type": "string" } }, { "name": "expand", "type": "string", "info": "Expand options. Default is None.: Must be one of [none, signedContent]", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '6.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "Artifacts are collections of files produced by a pipeline. Use artifacts to share files between stages in a pipeline or between different pipelines.", "type": "object", "properties": { "name": { "description": "The name of the artifact.", "type": "string" }, "signedContent": { "description": "Signed url for downloading this artifact", "body": { "description": "A signed url allowing limited-time anonymous access to private resources.", "type": "object", "properties": { "signatureExpires": { "description": "Timestamp when access expires.", "type": "string" }, "url": { "description": "The URL to allow access to.", "type": "string" } } } }, "url": { "description": "Self-referential url", "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/artifactsGet" }, "task": true }, { "name": "logsList", "summary": "Get a list of logs from a pipeline run.", "description": "Get a list of logs from a pipeline run.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "pipelineId", "type": "number", "info": "ID of the pipeline.: 123", "required": true, "schema": { "title": "pipelineId", "type": "number" } }, { "name": "runId", "type": "number", "info": "ID of the run of that pipeline.: 123", "required": true, "schema": { "title": "runId", "type": "number" } }, { "name": "expand", "type": "string", "info": "Expand options. Default is None.: Must be one of [none, signedContent]", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '6.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "A collection of logs.", "type": "object", "properties": { "logs": { "description": "The list of logs.", "type": "array", "items": { "description": "Log for a pipeline.", "type": "object", "properties": { "createdOn": { "description": "The date and time the log was created.", "type": "string" }, "id": { "description": "The ID of the log.", "type": "integer" }, "lastChangedOn": { "description": "The date and time the log was last changed.", "type": "string" }, "lineCount": { "description": "The number of lines in the log.", "type": "integer" }, "signedContent": { "description": "A signed url allowing limited-time anonymous access to private resources.", "type": "object", "properties": { "signatureExpires": { "description": "Timestamp when access expires.", "type": "string" }, "url": { "description": "The URL to allow access to.", "type": "string" } } }, "url": { "type": "string" } } } }, "signedContent": { "description": "A signed url allowing limited-time anonymous access to private resources.", "type": "object", "properties": { "signatureExpires": { "description": "Timestamp when access expires.", "type": "string" }, "url": { "description": "The URL to allow access to.", "type": "string" } } }, "url": { "description": "URL of the log.", "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/logsList" }, "task": true }, { "name": "logsGet", "summary": "Get a specific log from a pipeline run", "description": "Get a specific log from a pipeline run", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "pipelineId", "type": "number", "info": "ID of the pipeline.: 123", "required": true, "schema": { "title": "pipelineId", "type": "number" } }, { "name": "runId", "type": "number", "info": "ID of the run of that pipeline.: 123", "required": true, "schema": { "title": "runId", "type": "number" } }, { "name": "logId", "type": "number", "info": "ID of the log.: 123", "required": true, "schema": { "title": "logId", "type": "number" } }, { "name": "expand", "type": "string", "info": "Expand options. Default is None.: Must be one of [none, signedContent]", "required": false, "schema": { "title": "expand", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '6.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "description": "Log for a pipeline.", "type": "object", "properties": { "createdOn": { "description": "The date and time the log was created.", "type": "string" }, "id": { "description": "The ID of the log.", "type": "integer" }, "lastChangedOn": { "description": "The date and time the log was last changed.", "type": "string" }, "lineCount": { "description": "The number of lines in the log.", "type": "integer" }, "signedContent": { "description": "A signed url allowing limited-time anonymous access to private resources.", "type": "object", "properties": { "signatureExpires": { "description": "Timestamp when access expires.", "type": "string" }, "url": { "description": "The URL to allow access to.", "type": "string" } } }, "url": { "type": "string" } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/logsGet" }, "task": true }, { "name": "repositoriesGetDeletedRepositories", "summary": "Retrieve deleted git repositories.", "description": "Retrieve deleted git repositories.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "", "type": "object", "properties": { "createdDate": { "type": "string" }, "deletedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "deletedDate": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/repositoriesGetDeletedRepositories" }, "task": true }, { "name": "repositoriesGetRecycleBinRepositories", "summary": "Retrieve soft-deleted git repositories from the recycle bin.", "description": "Retrieve soft-deleted git repositories from the recycle bin.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "", "type": "object", "properties": { "createdDate": { "type": "string" }, "deletedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "deletedDate": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/repositoriesGetRecycleBinRepositories" }, "task": true }, { "name": "repositoriesDeleteRepositoryFromRecycleBin", "summary": "Destroy (hard delete) a soft-deleted Git repository.", "description": "Destroy (hard delete) a soft-deleted Git repository.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The ID of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/repositoriesDeleteRepositoryFromRecycleBin" }, "task": true }, { "name": "repositoriesRestoreRepositoryFromRecycleBin", "summary": "Recover a soft-deleted Git repository. Recently deleted repositories go into a soft-delete state fo", "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.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"deleted\": \"boolean\"}", "required": true, "schema": { "description": "", "type": "object", "properties": { "deleted": { "description": "Setting to false will undo earlier deletion and restore the repository.", "type": "boolean" } } } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The ID of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/repositoriesRestoreRepositoryFromRecycleBin" }, "task": true }, { "name": "repositoriesCreate", "summary": "Create a git repository in a team project.", "description": "Create a git repository in a team project.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": "Specify the repo name, team project and/or parent repository. Team project information can be omitted from gitRepositoryToCreate if the request is project-scoped (i.e., i...(description truncated): {\"name\": \"string\", \"parentRepository\": {\"collection\": {\"id\": \"string\", \"name\": \"string\", \"url\": \"string\"}, \"id\": \"string\", \"isFork\": \"boolean\", \"name\": \"string\", \"project\": {\"abbreviation\": \"string\", \"defaultTeamImageUrl\": \"string\", \"description\": \"string\", \"id\": \"string\", \"lastUpdateTime\": \"string\", \"name\": \"string\", \"revision\": 123, \"state\": \"undefined\", \"url\": \"string\", \"visibility\": \"undefined\"}, \"remoteUrl\": \"string\", \"sshUrl\": \"string\", \"url\": \"string\"}, \"project\": {\"abbreviation\": \"string\", \"defaultTeamImageUrl\": \"string\", \"description\": \"string\", \"id\": \"string\", \"lastUpdateTime\": \"string\", \"name\": \"string\", \"revision\": 123, \"state\": \"undefined\", \"url\": \"string\", \"visibility\": \"undefined\"}}", "required": true, "schema": { "description": "", "type": "object", "properties": { "name": { "type": "string" }, "parentRepository": { "description": "", "type": "object", "properties": { "collection": { "description": "Reference object for a TeamProjectCollection.", "type": "object", "properties": { "id": { "description": "Collection Id.", "type": "string" }, "name": { "description": "Collection Name.", "type": "string" }, "url": { "description": "Collection REST Url.", "type": "string" } } }, "id": { "type": "string" }, "isFork": { "description": "True if the repository was created as a fork", "type": "boolean" }, "name": { "type": "string" }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "sshUrl": { "type": "string" }, "url": { "type": "string" } } }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } } } } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "sourceRef", "type": "string", "info": "[optional] Specify the source refs to use while creating a fork repo: string", "required": false, "schema": { "title": "sourceRef", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/repositoriesCreate" }, "task": true }, { "name": "repositoriesList", "summary": "Retrieve git repositories.", "description": "Retrieve git repositories.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "includeLinks", "type": "boolean", "info": "[optional] True to include reference links. The default value is false.: boolean", "required": false, "schema": { "title": "includeLinks", "type": "boolean" } }, { "name": "includeAllUrls", "type": "boolean", "info": "[optional] True to include all remote URLs. The default value is false.: boolean", "required": false, "schema": { "title": "includeAllUrls", "type": "boolean" } }, { "name": "includeHidden", "type": "boolean", "info": "[optional] True to include hidden repositories. The default value is false.: boolean", "required": false, "schema": { "title": "includeHidden", "type": "boolean" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "defaultBranch": { "type": "string" }, "id": { "type": "string" }, "isDisabled": { "description": "True if the repository is disabled. False otherwise.", "type": "boolean" }, "isFork": { "description": "True if the repository was created as a fork.", "type": "boolean" }, "name": { "type": "string" }, "parentRepository": { "description": "", "type": "object", "properties": { "collection": { "description": "Reference object for a TeamProjectCollection.", "type": "object", "properties": { "id": { "description": "Collection Id.", "type": "string" }, "name": { "description": "Collection Name.", "type": "string" }, "url": { "description": "Collection REST Url.", "type": "string" } } }, "id": { "type": "string" }, "isFork": { "description": "True if the repository was created as a fork", "type": "boolean" }, "name": { "type": "string" }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "sshUrl": { "type": "string" }, "url": { "type": "string" } } }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "size": { "description": "Compressed size (bytes) of the repository.", "type": "integer" }, "sshUrl": { "type": "string" }, "url": { "type": "string" }, "validRemoteUrls": { "type": "array", "items": { "type": "string" } }, "webUrl": { "type": "string" } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/repositoriesList" }, "task": true }, { "name": "repositoriesDelete", "summary": "Delete a git repository", "description": "Delete a git repository", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The ID of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/repositoriesDelete" }, "task": true }, { "name": "repositoriesGetRepository", "summary": "Retrieve a git repository.", "description": "Retrieve a git repository.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The name or ID of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/repositoriesGetRepository" }, "task": true }, { "name": "repositoriesUpdate", "summary": "Updates the Git repository with either a new repo name or a new default branch.", "description": "Updates the Git repository with either a new repo name or a new default branch.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": "Specify a new repo name or a new default branch of the repository: {\"_links\": {\"links\": \"object\"}, \"defaultBranch\": \"string\", \"id\": \"string\", \"isDisabled\": \"boolean\", \"isFork\": \"boolean\", \"name\": \"string\", \"parentRepository\": {\"collection\": {\"id\": \"string\", \"name\": \"string\", \"url\": \"string\"}, \"id\": \"string\", \"isFork\": \"boolean\", \"name\": \"string\", \"project\": {\"abbreviation\": \"string\", \"defaultTeamImageUrl\": \"string\", \"description\": \"string\", \"id\": \"string\", \"lastUpdateTime\": \"string\", \"name\": \"string\", \"revision\": 123, \"state\": \"undefined\", \"url\": \"string\", \"visibility\": \"undefined\"}, \"remoteUrl\": \"string\", \"sshUrl\": \"string\", \"url\": \"string\"}, \"project\": {\"abbreviation\": \"string\", \"defaultTeamImageUrl\": \"string\", \"description\": \"string\", \"id\": \"string\", \"lastUpdateTime\": \"string\", \"name\": \"string\", \"revision\": 123, \"state\": \"undefined\", \"url\": \"string\", \"visibility\": \"undefined\"}, \"remoteUrl\": \"string\", \"size\": 123, \"sshUrl\": \"string\", \"url\": \"string\", \"validRemoteUrls\": \"array\", \"webUrl\": \"string\"}", "required": true, "schema": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "defaultBranch": { "type": "string" }, "id": { "type": "string" }, "isDisabled": { "description": "True if the repository is disabled. False otherwise.", "type": "boolean" }, "isFork": { "description": "True if the repository was created as a fork.", "type": "boolean" }, "name": { "type": "string" }, "parentRepository": { "description": "", "type": "object", "properties": { "collection": { "description": "Reference object for a TeamProjectCollection.", "type": "object", "properties": { "id": { "description": "Collection Id.", "type": "string" }, "name": { "description": "Collection Name.", "type": "string" }, "url": { "description": "Collection REST Url.", "type": "string" } } }, "id": { "type": "string" }, "isFork": { "description": "True if the repository was created as a fork", "type": "boolean" }, "name": { "type": "string" }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "sshUrl": { "type": "string" }, "url": { "type": "string" } } }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "size": { "description": "Compressed size (bytes) of the repository.", "type": "integer" }, "sshUrl": { "type": "string" }, "url": { "type": "string" }, "validRemoteUrls": { "type": "array", "items": { "type": "string" } }, "webUrl": { "type": "string" } } } }, { "name": "repositoryId", "type": "string", "info": "The ID of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/repositoriesUpdate" }, "task": true }, { "name": "refsFavoritesCreate", "summary": "Creates a ref favorite", "description": "Creates a ref favorite", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": "The ref favorite to create.: {\"_links\": {\"links\": \"object\"}, \"id\": 123, \"identityId\": \"string\", \"name\": \"string\", \"repositoryId\": \"string\", \"type\": \"undefined\", \"url\": \"string\"}", "required": true, "schema": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "id": { "type": "integer" }, "identityId": { "type": "string" }, "name": { "type": "string" }, "repositoryId": { "type": "string" }, "type": { "enum": [ "invalid", "folder", "ref" ], "x-ms-enum": { "name": "RefFavoriteType", "values": [ { "value": "invalid", "description": "" }, { "value": "folder", "description": "" }, { "value": "ref", "description": "" } ] } }, "url": { "type": "string" } } } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/refsFavoritesCreate" }, "task": true }, { "name": "refsFavoritesList", "summary": "Gets the refs favorites for a repo and an identity.", "description": "Gets the refs favorites for a repo and an identity.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The id of the repository.: string", "required": false, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "identityId", "type": "string", "info": "The id of the identity whose favorites are to be retrieved. If null, the requesting identity is used.: string", "required": false, "schema": { "title": "identityId", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "id": { "type": "integer" }, "identityId": { "type": "string" }, "name": { "type": "string" }, "repositoryId": { "type": "string" }, "type": { "enum": [ "invalid", "folder", "ref" ], "x-ms-enum": { "name": "RefFavoriteType", "values": [ { "value": "invalid", "description": "" }, { "value": "folder", "description": "" }, { "value": "ref", "description": "" } ] } }, "url": { "type": "string" } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/refsFavoritesList" }, "task": true }, { "name": "refsFavoritesDelete", "summary": "Deletes the refs favorite specified", "description": "Deletes the refs favorite specified", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "favoriteId", "type": "number", "info": "The Id of the ref favorite to delete.: 123", "required": true, "schema": { "title": "favoriteId", "type": "number" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/refsFavoritesDelete" }, "task": true }, { "name": "refsFavoritesGet", "summary": "Gets the refs favorite for a favorite Id.", "description": "Gets the refs favorite for a favorite Id.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "favoriteId", "type": "number", "info": "The Id of the requested ref favorite.: 123", "required": true, "schema": { "title": "favoriteId", "type": "number" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/refsFavoritesGet" }, "task": true }, { "name": "policyConfigurationsGet", "summary": "Retrieve a list of policy configurations by a given set of scope/filtering criteria.\n\nBelow is a sh", "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...(description truncated)", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The repository id.: string", "required": false, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "refName", "type": "string", "info": "The fully-qualified Git ref name (e.g. refs/heads/master).: string", "required": false, "schema": { "title": "refName", "type": "string" } }, { "name": "policyType", "type": "string", "info": "The policy type filter.: string", "required": false, "schema": { "title": "policyType", "type": "string" } }, { "name": "top", "type": "number", "info": "Maximum number of policies to return.: 123", "required": false, "schema": { "title": "top", "type": "number" } }, { "name": "continuationToken", "type": "string", "info": "Pass a policy configuration ID to fetch the next page of results, up to top number of results, for this endpoint.: string", "required": false, "schema": { "title": "continuationToken", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "The full policy configuration with settings.", "type": "object", "allOf": [ { "description": "A particular revision for a policy configuration.", "type": "object", "allOf": [ { "description": "Policy configuration reference.", "type": "object", "properties": { "id": { "description": "The policy configuration ID.", "type": "integer" }, "type": { "description": "Policy type reference.", "type": "object", "properties": { "displayName": { "description": "Display name of the policy type.", "type": "string" }, "id": { "description": "The policy type ID.", "type": "string" }, "url": { "description": "The URL where the policy type can be retrieved.", "type": "string" } } }, "url": { "description": "The URL where the policy configuration can be retrieved.", "type": "string" } } } ], "properties": { "revision": { "description": "The policy configuration revision ID.", "type": "integer" } } } ], "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "createdDate": { "description": "The date and time when the policy was created.", "type": "string" }, "isBlocking": { "description": "Indicates whether the policy is blocking.", "type": "boolean" }, "isDeleted": { "description": "Indicates whether the policy has been (soft) deleted.", "type": "boolean" }, "isEnabled": { "description": "Indicates whether the policy is enabled.", "type": "boolean" }, "isEnterpriseManaged": { "description": "If set, this policy requires \"Manage Enterprise Policies\" permission to create, edit, or delete.", "type": "boolean" }, "settings": { "description": "The policy configuration settings.", "type": "string" } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/policyConfigurationsGet" }, "task": true }, { "name": "pullRequestsGetPullRequestsByProject", "summary": "Retrieve all pull requests matching a specified criteria.\n\nPlease note that description field will", "description": "Retrieve all pull requests matching a specified criteria.\n\nPlease note that description field will be truncated up to 400 symbols in the result.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "searchCriteriaCreatorId", "type": "string", "info": "If set, search for pull requests that were created by this identity.: string", "required": false, "schema": { "title": "searchCriteriaCreatorId", "type": "string" } }, { "name": "searchCriteriaIncludeLinks", "type": "boolean", "info": "Whether to include the _links field on the shallow references: boolean", "required": false, "schema": { "title": "searchCriteriaIncludeLinks", "type": "boolean" } }, { "name": "searchCriteriaRepositoryId", "type": "string", "info": "If set, search for pull requests whose target branch is in this repository.: string", "required": false, "schema": { "title": "searchCriteriaRepositoryId", "type": "string" } }, { "name": "searchCriteriaReviewerId", "type": "string", "info": "If set, search for pull requests that have this identity as a reviewer.: string", "required": false, "schema": { "title": "searchCriteriaReviewerId", "type": "string" } }, { "name": "searchCriteriaSourceRefName", "type": "string", "info": "If set, search for pull requests from this branch.: string", "required": false, "schema": { "title": "searchCriteriaSourceRefName", "type": "string" } }, { "name": "searchCriteriaSourceRepositoryId", "type": "string", "info": "If set, search for pull requests whose source branch is in this repository.: string", "required": false, "schema": { "title": "searchCriteriaSourceRepositoryId", "type": "string" } }, { "name": "searchCriteriaStatus", "type": "string", "info": "If set, search for pull requests that are in this state. Defaults to Active if unset.: Must be one of [notSet, active, abandoned, completed, all]", "required": false, "schema": { "title": "searchCriteriaStatus", "type": "string" } }, { "name": "searchCriteriaTargetRefName", "type": "string", "info": "If set, search for pull requests into this branch.: string", "required": false, "schema": { "title": "searchCriteriaTargetRefName", "type": "string" } }, { "name": "maxCommentLength", "type": "number", "info": "Not used.: 123", "required": false, "schema": { "title": "maxCommentLength", "type": "number" } }, { "name": "skip", "type": "number", "info": "The number of pull requests to ignore. For example, to retrieve results 101-150, set top to 50 and skip to 100.: 123", "required": false, "schema": { "title": "skip", "type": "number" } }, { "name": "top", "type": "number", "info": "The number of pull requests to retrieve.: 123", "required": false, "schema": { "title": "top", "type": "number" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "Represents all the data associated with a pull request.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "artifactId": { "description": "A string which uniquely identifies this pull request. To generate an artifact ID for a pull request, use this template: ```vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}```", "type": "string" }, "autoCompleteSetBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "closedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "closedDate": { "description": "The date when the pull request was closed (completed, abandoned, or merged externally).", "type": "string" }, "codeReviewId": { "description": "The code review ID of the pull request. Used internally.", "type": "integer" }, "commits": { "description": "The commits contained in the pull request.", "type": "array", "items": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } } }, "completionOptions": { "description": "Preferences about how the pull request should be completed.", "type": "object", "properties": { "autoCompleteIgnoreConfigIds": { "description": "List of any policy configuration Id's which auto-complete should not wait for. Only applies to optional policies (isBlocking == false). Auto-complete always waits for required policies (isBlocking == true).", "type": "array", "items": { "type": "integer" } }, "bypassPolicy": { "description": "If true, policies will be explicitly bypassed while the pull request is completed.", "type": "boolean" }, "bypassReason": { "description": "If policies are bypassed, this reason is stored as to why bypass was used.", "type": "string" }, "deleteSourceBranch": { "description": "If true, the source branch of the pull request will be deleted after completion.", "type": "boolean" }, "mergeCommitMessage": { "description": "If set, this will be used as the commit message of the merge commit.", "type": "string" }, "mergeStrategy": { "description": "Specify the strategy used to merge the pull request during completion. If MergeStrategy is not set to any value, a no-FF merge will be created if SquashMerge == false. If MergeStrategy is not set to any value, the pull request commits will be squashed if SquashMerge == true. The SquashMerge property is deprecated. It is recommended that you explicitly set MergeStrategy in all cases. If an explicit value is provided for MergeStrategy, the SquashMerge property will be ignored.", "enum": [ "noFastForward", "squash", "rebase", "rebaseMerge" ], "x-ms-enum": { "name": "GitPullRequestMergeStrategy", "values": [ { "value": "noFastForward", "description": "A two-parent, no-fast-forward merge. The source branch is unchanged. This is the default behavior." }, { "value": "squash", "description": "Put all changes from the pull request into a single-parent commit." }, { "value": "rebase", "description": "Rebase the source branch on top of the target branch HEAD commit, and fast-forward the target branch. The source branch is updated during the rebase operation." }, { "value": "rebaseMerge", "description": "Rebase the source branch on top of the target branch HEAD commit, and create a two-parent, no-fast-forward merge. The source branch is updated during the rebase operation." } ] } }, "squashMerge": { "description": "SquashMerge is deprecated. You should explicitly set the value of MergeStrategy. If MergeStrategy is set to any value, the SquashMerge value will be ignored. If MergeStrategy is not set, the merge strategy will be no-fast-forward if this flag is false, or squash if true.", "type": "boolean" }, "transitionWorkItems": { "description": "If true, we will attempt to transition any work items linked to the pull request into the next logical state (i.e. Active -> Resolved)", "type": "boolean" }, "triggeredByAutoComplete": { "description": "If true, the current completion attempt was triggered via auto-complete. Used internally.", "type": "boolean" } } }, "completionQueueTime": { "description": "The most recent date at which the pull request entered the queue to be completed. Used internally.", "type": "string" }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "The date when the pull request was created.", "type": "string" }, "description": { "description": "The description of the pull request.", "type": "string" }, "forkSource": { "description": "Information about a fork ref.", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "creator": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "isLocked": { "type": "boolean" }, "isLockedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "name": { "type": "string" }, "objectId": { "type": "string" }, "peeledObjectId": { "type": "string" }, "statuses": { "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "type": "string" } } } ], "properties": { "repository": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "defaultBranch": { "type": "string" }, "id": { "type": "string" }, "isDisabled": { "description": "True if the repository is disabled. False otherwise.", "type": "boolean" }, "isFork": { "description": "True if the repository was created as a fork.", "type": "boolean" }, "name": { "type": "string" }, "parentRepository": { "description": "", "type": "object", "properties": { "collection": { "description": "Reference object for a TeamProjectCollection.", "type": "object", "properties": { "id": { "description": "Collection Id.", "type": "string" }, "name": { "description": "Collection Name.", "type": "string" }, "url": { "description": "Collection REST Url.", "type": "string" } } }, "id": { "type": "string" }, "isFork": { "description": "True if the repository was created as a fork", "type": "boolean" }, "name": { "type": "string" }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "sshUrl": { "type": "string" }, "url": { "type": "string" } } }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "size": { "description": "Compressed size (bytes) of the repository.", "type": "integer" }, "sshUrl": { "type": "string" }, "url": { "type": "string" }, "validRemoteUrls": { "type": "array", "items": { "type": "string" } }, "webUrl": { "type": "string" } } } } }, "hasMultipleMergeBases": { "description": "Multiple mergebases warning", "type": "boolean" }, "isDraft": { "description": "Draft / WIP pull request.", "type": "boolean" }, "labels": { "description": "The labels associated with the pull request.", "type": "array", "items": { "description": "The representation of a tag definition which is sent across the wire.", "type": "object", "properties": { "active": { "description": "Whether or not the tag definition is active.", "type": "boolean" }, "id": { "description": "ID of the tag definition.", "type": "string" }, "name": { "description": "The name of the tag definition.", "type": "string" }, "url": { "description": "Resource URL for the Tag Definition.", "type": "string" } } } }, "lastMergeCommit": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } }, "lastMergeSourceCommit": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } }, "lastMergeTargetCommit": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } }, "mergeFailureMessage": { "description": "If set, pull request merge failed for this reason.", "type": "string" }, "mergeFailureType": { "description": "The type of failure (if any) of the pull request merge.", "enum": [ "none", "unknown", "caseSensitive", "objectTooLarge" ], "x-ms-enum": { "name": "PullRequestMergeFailureType", "values": [ { "value": "none", "description": "Type is not set. Default type." }, { "value": "unknown", "description": "Pull request merge failure type unknown." }, { "value": "caseSensitive", "description": "Pull request merge failed due to case mismatch." }, { "value": "objectTooLarge", "description": "Pull request merge failed due to an object being too large." } ] } }, "mergeId": { "description": "The ID of the job used to run the pull request merge. Used internally.", "type": "string" }, "mergeOptions": { "description": "The options which are used when a pull request merge is created.", "type": "object", "properties": { "conflictAuthorshipCommits": { "description": "If true, conflict resolutions applied during the merge will be put in separate commits to preserve authorship info for git blame, etc.", "type": "boolean" }, "detectRenameFalsePositives": { "type": "boolean" }, "disableRenames": { "description": "If true, rename detection will not be performed during the merge.", "type": "boolean" } } }, "mergeStatus": { "description": "The current status of the pull request merge.", "enum": [ "notSet", "queued", "conflicts", "succeeded", "rejectedByPolicy", "failure" ], "x-ms-enum": { "name": "PullRequestAsyncStatus", "values": [ { "value": "notSet", "description": "Status is not set. Default state." }, { "value": "queued", "description": "Pull request merge is queued." }, { "value": "conflicts", "description": "Pull request merge failed due to conflicts." }, { "value": "succeeded", "description": "Pull request merge succeeded." }, { "value": "rejectedByPolicy", "description": "Pull request merge rejected by policy." }, { "value": "failure", "description": "Pull request merge failed." } ] } }, "pullRequestId": { "description": "The ID of the pull request.", "type": "integer" }, "remoteUrl": { "description": "Used internally.", "type": "string" }, "repository": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "defaultBranch": { "type": "string" }, "id": { "type": "string" }, "isDisabled": { "description": "True if the repository is disabled. False otherwise.", "type": "boolean" }, "isFork": { "description": "True if the repository was created as a fork.", "type": "boolean" }, "name": { "type": "string" }, "parentRepository": { "description": "", "type": "object", "properties": { "collection": { "description": "Reference object for a TeamProjectCollection.", "type": "object", "properties": { "id": { "description": "Collection Id.", "type": "string" }, "name": { "description": "Collection Name.", "type": "string" }, "url": { "description": "Collection REST Url.", "type": "string" } } }, "id": { "type": "string" }, "isFork": { "description": "True if the repository was created as a fork", "type": "boolean" }, "name": { "type": "string" }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "sshUrl": { "type": "string" }, "url": { "type": "string" } } }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "size": { "description": "Compressed size (bytes) of the repository.", "type": "integer" }, "sshUrl": { "type": "string" }, "url": { "type": "string" }, "validRemoteUrls": { "type": "array", "items": { "type": "string" } }, "webUrl": { "type": "string" } } }, "reviewers": { "description": "A list of reviewers on the pull request along with the state of their votes.", "type": "array", "items": { "description": "Identity information including a vote on a pull request.", "type": "object", "allOf": [ { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } } ], "properties": { "hasDeclined": { "description": "Indicates if this reviewer has declined to review this pull request.", "type": "boolean" }, "isFlagged": { "description": "Indicates if this reviewer is flagged for attention on this pull request.", "type": "boolean" }, "isRequired": { "description": "Indicates if this is a required reviewer for this pull request.
Branches can have policies that require particular reviewers are required for pull requests.", "type": "boolean" }, "reviewerUrl": { "description": "URL to retrieve information about this identity", "type": "string" }, "vote": { "description": "Vote on a pull request:
10 - approved 5 - approved with suggestions 0 - no vote -5 - waiting for author -10 - rejected", "type": "integer" }, "votedFor": { "description": "Groups or teams that that this reviewer contributed to.
Groups and teams can be reviewers on pull requests but can not vote directly. When a member of the group or team votes, that vote is rolled up into the group or team vote. VotedFor is a list of such votes.", "type": "array", "items": { "description": "Identity information including a vote on a pull request.", "type": "object", "allOf": [ { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } } ], "properties": { "hasDeclined": { "description": "Indicates if this reviewer has declined to review this pull request.", "type": "boolean" }, "isFlagged": { "description": "Indicates if this reviewer is flagged for attention on this pull request.", "type": "boolean" }, "isRequired": { "description": "Indicates if this is a required reviewer for this pull request.
Branches can have policies that require particular reviewers are required for pull requests.", "type": "boolean" }, "reviewerUrl": { "description": "URL to retrieve information about this identity", "type": "string" }, "vote": { "description": "Vote on a pull request:
10 - approved 5 - approved with suggestions 0 - no vote -5 - waiting for author -10 - rejected", "type": "integer" }, "votedFor": { "description": "Groups or teams that that this reviewer contributed to.
Groups and teams can be reviewers on pull requests but can not vote directly. When a member of the group or team votes, that vote is rolled up into the group or team vote. VotedFor is a list of such votes.", "type": "array", "items": { "type": "object" } } } } } } } }, "sourceRefName": { "description": "The name of the source branch of the pull request.", "type": "string" }, "status": { "description": "The status of the pull request.", "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 criteria to include all statuses." } ] } }, "supportsIterations": { "description": "If true, this pull request supports multiple iterations. Iteration support means individual pushes to the source branch of the pull request can be reviewed and comments left in one iteration will be tracked across future iterations.", "type": "boolean" }, "targetRefName": { "description": "The name of the target branch of the pull request.", "type": "string" }, "title": { "description": "The title of the pull request.", "type": "string" }, "url": { "description": "Used internally.", "type": "string" }, "workItemRefs": { "description": "Any work item references associated with this pull request.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestsGetPullRequestsByProject" }, "task": true }, { "name": "pullRequestsGetPullRequestById", "summary": "Retrieve a pull request.", "description": "Retrieve a pull request.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "The ID of the pull request to retrieve.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestsGetPullRequestById" }, "task": true }, { "name": "pullRequestsCreate", "summary": "Create a pull request.", "description": "Create a pull request.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": "The pull request to create.: {\"_links\": {\"links\": \"object\"}, \"artifactId\": \"string\", \"autoCompleteSetBy\": {\"directoryAlias\": \"string\", \"id\": \"string\", \"imageUrl\": \"string\", \"inactive\": \"boolean\", \"isAadIdentity\": \"boolean\", \"isContainer\": \"boolean\", \"isDeletedInOrigin\": \"boolean\", \"profileUrl\": \"string\", \"uniqueName\": \"string\"}, \"closedBy\": {\"directoryAlias\": \"string\", \"id\": \"string\", \"imageUrl\": \"string\", \"inactive\": \"boolean\", \"isAadIdentity\": \"boolean\", \"isContainer\": \"boolean\", \"isDeletedInOrigin\": \"boolean\", \"profileUrl\": \"string\", \"uniqueName\": \"string\"}, \"closedDate\": \"string\", \"codeReviewId\": 123, \"commits\": [{\"_links\": {\"links\": \"object\"}, \"author\": {\"date\": \"string\", \"email\": \"string\", \"imageUrl\": \"string\", \"name\": \"string\"}, \"changeCounts\": }, \"changes\": [{\"changeId\": 123, \"newContentTemplate\": {\"name\": \"string\", \"type\": \"string\"}, \"originalPath\": \"string\"}], \"comment\": \"string\", \"commentTruncated\": \"boolean\", \"commitId\": \"string\", \"committer\": {\"date\": \"string\", \"email\": \"string\", \"imageUrl\": \"string\", \"name\": \"string\"}, \"parents\": \"array\", \"push\": {\"_links\": {\"links\": \"object\"}, \"date\": \"string\", \"pushedBy\": {\"directoryAlias\": \"string\", \"id\": \"string\", \"imageUrl\": \"string\", \"inactive\": \"boolean\", \"isAadIdentity\": \"boolean\", \"isContainer\": \"boolean\", \"isDeletedInOrigin\": \"boolean\", \"profileUrl\": \"string\", \"uniqueName\": \"string\"}, \"pushId\": 123, \"url\": \"string\"}, \"remoteUrl\": \"string\", \"statuses\": [{\"_links\": {\"links\": \"object\"}, \"context\": {\"genre\": \"string\", \"name\": \"string\"}, \"createdBy\": {\"directoryAlias\": \"string\", \"id\": \"string\", \"imageUrl\": \"string\", \"inactive\": \"boolean\", \"isAadIdentity\": \"boolean\", \"isContainer\": \"boolean\", \"isDeletedInOrigin\": \"boolean\", \"profileUrl\": \"string\", \"uniqueName\": \"string\"}, \"creationDate\": \"string\", \"description\": \"string\", \"id\": 123, \"state\": \"undefined\", \"targetUrl\": \"string\", \"updatedDate\": \"string\"}], \"url\": \"string\", \"workItems\": [{\"id\": \"string\", \"url\": \"string\"}]}], \"completionOptions\": {\"autoCompleteIgnoreConfigIds\": \"array\", \"bypassPolicy\": \"boolean\", \"bypassReason\": \"string\", \"deleteSourceBranch\": \"boolean\", \"mergeCommitMessage\": \"string\", \"mergeStrategy\": \"undefined\", \"squashMerge\": \"boolean\", \"transitionWorkItems\": \"boolean\", \"triggeredByAutoComplete\": \"boolean\"}, \"completionQueueTime\": \"string\", \"createdBy\": {\"directoryAlias\": \"string\", \"id\": \"string\", \"imageUrl\": \"string\", \"inactive\": \"boolean\", \"isAadIdentity\": \"boolean\", \"isContainer\": \"boolean\", \"isDeletedInOrigin\": \"boolean\", \"profileUrl\": \"string\", \"uniqueName\": \"string\"}, \"creationDate\": \"string\", \"description\": \"string\", \"forkSource\": {\"repository\": {\"_links\": {\"links\": \"object\"}, \"defaultBranch\": \"string\", \"id\": \"string\", \"isDisabled\": \"boolean\", \"isFork\": \"boolean\", \"name\": \"string\", \"parentRepository\": {\"collection\": {\"id\": \"string\", \"name\": \"string\", \"url\": \"string\"}, \"id\": \"string\", \"isFork\": \"boolean\", \"name\": \"string\", \"project\": {\"abbreviation\": \"string\", \"defaultTeamImageUrl\": \"string\", \"description\": \"string\", \"id\": \"string\", \"lastUpdateTime\": \"string\", \"name\": \"string\", \"revision\": 123, \"state\": \"undefined\", \"url\": \"string\", \"visibility\": \"undefined\"}, \"remoteUrl\": \"string\", \"sshUrl\": \"string\", \"url\": \"string\"}, \"project\": {\"abbreviation\": \"string\", \"defaultTeamImageUrl\": \"string\", \"description\": \"string\", \"id\": \"string\", \"lastUpdateTime\": \"string\", \"name\": \"string\", \"revision\": 123, \"state\": \"undefined\", \"url\": \"string\", \"visibility\": \"undefined\"}, \"remoteUrl\": \"string\", \"size\": 123, \"sshUrl\": \"string\", \"url\": \"string\", \"validRemoteUrls\": \"array\", \"webUrl\": \"string\"}}, \"hasMultipleMergeBases\": \"boolean\", \"isDraft\": \"boolean\", \"labels\": [{\"active\": \"boolean\", \"id\": \"string\", \"name\": \"string\", \"url\": \"string\"}], \"lastMergeCommit\": {\"_links\": {\"links\": \"object\"}, \"author\": {\"date\": \"string\", \"email\": \"string\", \"imageUrl\": \"string\", \"name\": \"string\"}, \"changeCounts\": }, \"changes\": [{\"changeId\": 123, \"newContentTemplate\": {\"name\": \"string\", \"type\": \"string\"}, \"originalPath\": \"string\"}], \"comment\": \"string\", \"commentTruncated\": \"boolean\", \"commitId\": \"string\", \"committer\": {\"date\": \"string\", \"email\": \"string\", \"imageUrl\": \"string\", \"name\": \"string\"}, \"parents\": \"array\", \"push\": {\"_links\": {\"links\": \"object\"}, \"date\": \"string\", \"pushedBy\": {\"directoryAlias\": \"string\", \"id\": \"string\", \"imageUrl\": \"string\", \"inactive\": \"boolean\", \"isAadIdentity\": \"boolean\", \"isContainer\": \"boolean\", \"isDeletedInOrigin\": \"boolean\", \"profileUrl\": \"string\", \"uniqueName\": \"string\"}, \"pushId\": 123, \"url\": \"string\"}, \"remoteUrl\": \"string\", \"statuses\": [{\"_links\": {\"links\": \"object\"}, \"context\": {\"genre\": \"string\", \"name\": \"string\"}, \"createdBy\": {\"directoryAlias\": \"string\", \"id\": \"string\", \"imageUrl\": \"string\", \"inactive\": \"boolean\", \"isAadIdentity\": \"boolean\", \"isContainer\": \"boolean\", \"isDeletedInOrigin\": \"boolean\", \"profileUrl\": \"string\", \"uniqueName\": \"string\"}, \"creationDate\": \"string\", \"description\": \"string\", \"id\": 123, \"state\": \"undefined\", \"targetUrl\": \"string\", \"updatedDate\": \"string\"}], \"url\": \"string\", \"workItems\": [{\"id\": \"string\", \"url\": \"string\"}]}, \"lastMergeSourceCommit\": {\"_links\": {\"links\": \"object\"}, \"author\": {\"date\": \"string\", \"email\": \"string\", \"imageUrl\": \"string\", \"name\": \"string\"}, \"changeCounts\": }, \"changes\": [{\"changeId\": 123, \"newContentTemplate\": {\"name\": \"string\", \"type\": \"string\"}, \"originalPath\": \"string\"}], \"comment\": \"string\", \"commentTruncated\": \"boolean\", \"commitId\": \"string\", \"committer\": {\"date\": \"string\", \"email\": \"string\", \"imageUrl\": \"string\", \"name\": \"string\"}, \"parents\": \"array\", \"push\": {\"_links\": {\"links\": \"object\"}, \"date\": \"string\", \"pushedBy\": {\"directoryAlias\": \"string\", \"id\": \"string\", \"imageUrl\": \"string\", \"inactive\": \"boolean\", \"isAadIdentity\": \"boolean\", \"isContainer\": \"boolean\", \"isDeletedInOrigin\": \"boolean\", \"profileUrl\": \"string\", \"uniqueName\": \"string\"}, \"pushId\": 123, \"url\": \"string\"}, \"remoteUrl\": \"string\", \"statuses\": [{\"_links\": {\"links\": \"object\"}, \"context\": {\"genre\": \"string\", \"name\": \"string\"}, \"createdBy\": {\"directoryAlias\": \"string\", \"id\": \"string\", \"imageUrl\": \"string\", \"inactive\": \"boolean\", \"isAadIdentity\": \"boolean\", \"isContainer\": \"boolean\", \"isDeletedInOrigin\": \"boolean\", \"profileUrl\": \"string\", \"uniqueName\": \"string\"}, \"creationDate\": \"string\", \"description\": \"string\", \"id\": 123, \"state\": \"undefined\", \"targetUrl\": \"string\", \"updatedDate\": \"string\"}], \"url\": \"string\", \"workItems\": [{\"id\": \"string\", \"url\": \"string\"}]}, \"lastMergeTargetCommit\": {\"_links\": {\"links\": \"object\"}, \"author\": {\"date\": \"string\", \"email\": \"string\", \"imageUrl\": \"string\", \"name\": \"string\"}, \"changeCounts\": }, \"changes\": [{\"changeId\": 123, \"newContentTemplate\": {\"name\": \"string\", \"type\": \"string\"}, \"originalPath\": \"string\"}], \"comment\": \"string\", \"commentTruncated\": \"boolean\", \"commitId\": \"string\", \"committer\": {\"date\": \"string\", \"email\": \"string\", \"imageUrl\": \"string\", \"name\": \"string\"}, \"parents\": \"array\", \"push\": {\"_links\": {\"links\": \"object\"}, \"date\": \"string\", \"pushedBy\": {\"directoryAlias\": \"string\", \"id\": \"string\", \"imageUrl\": \"string\", \"inactive\": \"boolean\", \"isAadIdentity\": \"boolean\", \"isContainer\": \"boolean\", \"isDeletedInOrigin\": \"boolean\", \"profileUrl\": \"string\", \"uniqueName\": \"string\"}, \"pushId\": 123, \"url\": \"string\"}, \"remoteUrl\": \"string\", \"statuses\": [{\"_links\": {\"links\": \"object\"}, \"context\": {\"genre\": \"string\", \"name\": \"string\"}, \"createdBy\": {\"directoryAlias\": \"string\", \"id\": \"string\", \"imageUrl\": \"string\", \"inactive\": \"boolean\", \"isAadIdentity\": \"boolean\", \"isContainer\": \"boolean\", \"isDeletedInOrigin\": \"boolean\", \"profileUrl\": \"string\", \"uniqueName\": \"string\"}, \"creationDate\": \"string\", \"description\": \"string\", \"id\": 123, \"state\": \"undefined\", \"targetUrl\": \"string\", \"updatedDate\": \"string\"}], \"url\": \"string\", \"workItems\": [{\"id\": \"string\", \"url\": \"string\"}]}, \"mergeFailureMessage\": \"string\", \"mergeFailureType\": \"undefined\", \"mergeId\": \"string\", \"mergeOptions\": {\"conflictAuthorshipCommits\": \"boolean\", \"detectRenameFalsePositives\": \"boolean\", \"disableRenames\": \"boolean\"}, \"mergeStatus\": \"undefined\", \"pullRequestId\": 123, \"remoteUrl\": \"string\", \"repository\": {\"_links\": {\"links\": \"object\"}, \"defaultBranch\": \"string\", \"id\": \"string\", \"isDisabled\": \"boolean\", \"isFork\": \"boolean\", \"name\": \"string\", \"parentRepository\": {\"collection\": {\"id\": \"string\", \"name\": \"string\", \"url\": \"string\"}, \"id\": \"string\", \"isFork\": \"boolean\", \"name\": \"string\", \"project\": {\"abbreviation\": \"string\", \"defaultTeamImageUrl\": \"string\", \"description\": \"string\", \"id\": \"string\", \"lastUpdateTime\": \"string\", \"name\": \"string\", \"revision\": 123, \"state\": \"undefined\", \"url\": \"string\", \"visibility\": \"undefined\"}, \"remoteUrl\": \"string\", \"sshUrl\": \"string\", \"url\": \"string\"}, \"project\": {\"abbreviation\": \"string\", \"defaultTeamImageUrl\": \"string\", \"description\": \"string\", \"id\": \"string\", \"lastUpdateTime\": \"string\", \"name\": \"string\", \"revision\": 123, \"state\": \"undefined\", \"url\": \"string\", \"visibility\": \"undefined\"}, \"remoteUrl\": \"string\", \"size\": 123, \"sshUrl\": \"string\", \"url\": \"string\", \"validRemoteUrls\": \"array\", \"webUrl\": \"string\"}, \"reviewers\": [{\"hasDeclined\": \"boolean\", \"isFlagged\": \"boolean\", \"isRequired\": \"boolean\", \"reviewerUrl\": \"string\", \"vote\": 123, \"votedFor\": [{\"hasDeclined\": \"boolean\", \"isFlagged\": \"boolean\", \"isRequired\": \"boolean\", \"reviewerUrl\": \"string\", \"vote\": 123, \"votedFor\": \"array\"}]}], \"sourceRefName\": \"string\", \"status\": \"undefined\", \"supportsIterations\": \"boolean\", \"targetRefName\": \"string\", \"title\": \"string\", \"url\": \"string\", \"workItemRefs\": [{\"id\": \"string\", \"url\": \"string\"}]}", "required": true, "schema": { "description": "Represents all the data associated with a pull request.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "artifactId": { "description": "A string which uniquely identifies this pull request. To generate an artifact ID for a pull request, use this template: ```vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}```", "type": "string" }, "autoCompleteSetBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "closedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "closedDate": { "description": "The date when the pull request was closed (completed, abandoned, or merged externally).", "type": "string" }, "codeReviewId": { "description": "The code review ID of the pull request. Used internally.", "type": "integer" }, "commits": { "description": "The commits contained in the pull request.", "type": "array", "items": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } } }, "completionOptions": { "description": "Preferences about how the pull request should be completed.", "type": "object", "properties": { "autoCompleteIgnoreConfigIds": { "description": "List of any policy configuration Id's which auto-complete should not wait for. Only applies to optional policies (isBlocking == false). Auto-complete always waits for required policies (isBlocking == true).", "type": "array", "items": { "type": "integer" } }, "bypassPolicy": { "description": "If true, policies will be explicitly bypassed while the pull request is completed.", "type": "boolean" }, "bypassReason": { "description": "If policies are bypassed, this reason is stored as to why bypass was used.", "type": "string" }, "deleteSourceBranch": { "description": "If true, the source branch of the pull request will be deleted after completion.", "type": "boolean" }, "mergeCommitMessage": { "description": "If set, this will be used as the commit message of the merge commit.", "type": "string" }, "mergeStrategy": { "description": "Specify the strategy used to merge the pull request during completion. If MergeStrategy is not set to any value, a no-FF merge will be created if SquashMerge == false. If MergeStrategy is not set to any value, the pull request commits will be squashed if SquashMerge == true. The SquashMerge property is deprecated. It is recommended that you explicitly set MergeStrategy in all cases. If an explicit value is provided for MergeStrategy, the SquashMerge property will be ignored.", "enum": [ "noFastForward", "squash", "rebase", "rebaseMerge" ], "x-ms-enum": { "name": "GitPullRequestMergeStrategy", "values": [ { "value": "noFastForward", "description": "A two-parent, no-fast-forward merge. The source branch is unchanged. This is the default behavior." }, { "value": "squash", "description": "Put all changes from the pull request into a single-parent commit." }, { "value": "rebase", "description": "Rebase the source branch on top of the target branch HEAD commit, and fast-forward the target branch. The source branch is updated during the rebase operation." }, { "value": "rebaseMerge", "description": "Rebase the source branch on top of the target branch HEAD commit, and create a two-parent, no-fast-forward merge. The source branch is updated during the rebase operation." } ] } }, "squashMerge": { "description": "SquashMerge is deprecated. You should explicitly set the value of MergeStrategy. If MergeStrategy is set to any value, the SquashMerge value will be ignored. If MergeStrategy is not set, the merge strategy will be no-fast-forward if this flag is false, or squash if true.", "type": "boolean" }, "transitionWorkItems": { "description": "If true, we will attempt to transition any work items linked to the pull request into the next logical state (i.e. Active -> Resolved)", "type": "boolean" }, "triggeredByAutoComplete": { "description": "If true, the current completion attempt was triggered via auto-complete. Used internally.", "type": "boolean" } } }, "completionQueueTime": { "description": "The most recent date at which the pull request entered the queue to be completed. Used internally.", "type": "string" }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "The date when the pull request was created.", "type": "string" }, "description": { "description": "The description of the pull request.", "type": "string" }, "forkSource": { "description": "Information about a fork ref.", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "creator": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "isLocked": { "type": "boolean" }, "isLockedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "name": { "type": "string" }, "objectId": { "type": "string" }, "peeledObjectId": { "type": "string" }, "statuses": { "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "type": "string" } } } ], "properties": { "repository": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "defaultBranch": { "type": "string" }, "id": { "type": "string" }, "isDisabled": { "description": "True if the repository is disabled. False otherwise.", "type": "boolean" }, "isFork": { "description": "True if the repository was created as a fork.", "type": "boolean" }, "name": { "type": "string" }, "parentRepository": { "description": "", "type": "object", "properties": { "collection": { "description": "Reference object for a TeamProjectCollection.", "type": "object", "properties": { "id": { "description": "Collection Id.", "type": "string" }, "name": { "description": "Collection Name.", "type": "string" }, "url": { "description": "Collection REST Url.", "type": "string" } } }, "id": { "type": "string" }, "isFork": { "description": "True if the repository was created as a fork", "type": "boolean" }, "name": { "type": "string" }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "sshUrl": { "type": "string" }, "url": { "type": "string" } } }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "size": { "description": "Compressed size (bytes) of the repository.", "type": "integer" }, "sshUrl": { "type": "string" }, "url": { "type": "string" }, "validRemoteUrls": { "type": "array", "items": { "type": "string" } }, "webUrl": { "type": "string" } } } } }, "hasMultipleMergeBases": { "description": "Multiple mergebases warning", "type": "boolean" }, "isDraft": { "description": "Draft / WIP pull request.", "type": "boolean" }, "labels": { "description": "The labels associated with the pull request.", "type": "array", "items": { "description": "The representation of a tag definition which is sent across the wire.", "type": "object", "properties": { "active": { "description": "Whether or not the tag definition is active.", "type": "boolean" }, "id": { "description": "ID of the tag definition.", "type": "string" }, "name": { "description": "The name of the tag definition.", "type": "string" }, "url": { "description": "Resource URL for the Tag Definition.", "type": "string" } } } }, "lastMergeCommit": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } }, "lastMergeSourceCommit": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } }, "lastMergeTargetCommit": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } }, "mergeFailureMessage": { "description": "If set, pull request merge failed for this reason.", "type": "string" }, "mergeFailureType": { "description": "The type of failure (if any) of the pull request merge.", "enum": [ "none", "unknown", "caseSensitive", "objectTooLarge" ], "x-ms-enum": { "name": "PullRequestMergeFailureType", "values": [ { "value": "none", "description": "Type is not set. Default type." }, { "value": "unknown", "description": "Pull request merge failure type unknown." }, { "value": "caseSensitive", "description": "Pull request merge failed due to case mismatch." }, { "value": "objectTooLarge", "description": "Pull request merge failed due to an object being too large." } ] } }, "mergeId": { "description": "The ID of the job used to run the pull request merge. Used internally.", "type": "string" }, "mergeOptions": { "description": "The options which are used when a pull request merge is created.", "type": "object", "properties": { "conflictAuthorshipCommits": { "description": "If true, conflict resolutions applied during the merge will be put in separate commits to preserve authorship info for git blame, etc.", "type": "boolean" }, "detectRenameFalsePositives": { "type": "boolean" }, "disableRenames": { "description": "If true, rename detection will not be performed during the merge.", "type": "boolean" } } }, "mergeStatus": { "description": "The current status of the pull request merge.", "enum": [ "notSet", "queued", "conflicts", "succeeded", "rejectedByPolicy", "failure" ], "x-ms-enum": { "name": "PullRequestAsyncStatus", "values": [ { "value": "notSet", "description": "Status is not set. Default state." }, { "value": "queued", "description": "Pull request merge is queued." }, { "value": "conflicts", "description": "Pull request merge failed due to conflicts." }, { "value": "succeeded", "description": "Pull request merge succeeded." }, { "value": "rejectedByPolicy", "description": "Pull request merge rejected by policy." }, { "value": "failure", "description": "Pull request merge failed." } ] } }, "pullRequestId": { "description": "The ID of the pull request.", "type": "integer" }, "remoteUrl": { "description": "Used internally.", "type": "string" }, "repository": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "defaultBranch": { "type": "string" }, "id": { "type": "string" }, "isDisabled": { "description": "True if the repository is disabled. False otherwise.", "type": "boolean" }, "isFork": { "description": "True if the repository was created as a fork.", "type": "boolean" }, "name": { "type": "string" }, "parentRepository": { "description": "", "type": "object", "properties": { "collection": { "description": "Reference object for a TeamProjectCollection.", "type": "object", "properties": { "id": { "description": "Collection Id.", "type": "string" }, "name": { "description": "Collection Name.", "type": "string" }, "url": { "description": "Collection REST Url.", "type": "string" } } }, "id": { "type": "string" }, "isFork": { "description": "True if the repository was created as a fork", "type": "boolean" }, "name": { "type": "string" }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "sshUrl": { "type": "string" }, "url": { "type": "string" } } }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "size": { "description": "Compressed size (bytes) of the repository.", "type": "integer" }, "sshUrl": { "type": "string" }, "url": { "type": "string" }, "validRemoteUrls": { "type": "array", "items": { "type": "string" } }, "webUrl": { "type": "string" } } }, "reviewers": { "description": "A list of reviewers on the pull request along with the state of their votes.", "type": "array", "items": { "description": "Identity information including a vote on a pull request.", "type": "object", "allOf": [ { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } } ], "properties": { "hasDeclined": { "description": "Indicates if this reviewer has declined to review this pull request.", "type": "boolean" }, "isFlagged": { "description": "Indicates if this reviewer is flagged for attention on this pull request.", "type": "boolean" }, "isRequired": { "description": "Indicates if this is a required reviewer for this pull request.
Branches can have policies that require particular reviewers are required for pull requests.", "type": "boolean" }, "reviewerUrl": { "description": "URL to retrieve information about this identity", "type": "string" }, "vote": { "description": "Vote on a pull request:
10 - approved 5 - approved with suggestions 0 - no vote -5 - waiting for author -10 - rejected", "type": "integer" }, "votedFor": { "description": "Groups or teams that that this reviewer contributed to.
Groups and teams can be reviewers on pull requests but can not vote directly. When a member of the group or team votes, that vote is rolled up into the group or team vote. VotedFor is a list of such votes.", "type": "array", "items": { "description": "Identity information including a vote on a pull request.", "type": "object", "allOf": [ { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } } ], "properties": { "hasDeclined": { "description": "Indicates if this reviewer has declined to review this pull request.", "type": "boolean" }, "isFlagged": { "description": "Indicates if this reviewer is flagged for attention on this pull request.", "type": "boolean" }, "isRequired": { "description": "Indicates if this is a required reviewer for this pull request.
Branches can have policies that require particular reviewers are required for pull requests.", "type": "boolean" }, "reviewerUrl": { "description": "URL to retrieve information about this identity", "type": "string" }, "vote": { "description": "Vote on a pull request:
10 - approved 5 - approved with suggestions 0 - no vote -5 - waiting for author -10 - rejected", "type": "integer" }, "votedFor": { "description": "Groups or teams that that this reviewer contributed to.
Groups and teams can be reviewers on pull requests but can not vote directly. When a member of the group or team votes, that vote is rolled up into the group or team vote. VotedFor is a list of such votes.", "type": "array", "items": { "type": "object" } } } } } } } }, "sourceRefName": { "description": "The name of the source branch of the pull request.", "type": "string" }, "status": { "description": "The status of the pull request.", "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 criteria to include all statuses." } ] } }, "supportsIterations": { "description": "If true, this pull request supports multiple iterations. Iteration support means individual pushes to the source branch of the pull request can be reviewed and comments left in one iteration will be tracked across future iterations.", "type": "boolean" }, "targetRefName": { "description": "The name of the target branch of the pull request.", "type": "string" }, "title": { "description": "The title of the pull request.", "type": "string" }, "url": { "description": "Used internally.", "type": "string" }, "workItemRefs": { "description": "Any work item references associated with this pull request.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request's target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "supportsIterations", "type": "boolean", "info": "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...(description truncated): boolean", "required": false, "schema": { "title": "supportsIterations", "type": "boolean" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestsCreate" }, "task": true }, { "name": "pullRequestsGetPullRequests", "summary": "Retrieve all pull requests matching a specified criteria.\n\nPlease note that description field will", "description": "Retrieve all pull requests matching a specified criteria.\n\nPlease note that description field will be truncated up to 400 symbols in the result.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request's target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "searchCriteriaCreatorId", "type": "string", "info": "If set, search for pull requests that were created by this identity.: string", "required": false, "schema": { "title": "searchCriteriaCreatorId", "type": "string" } }, { "name": "searchCriteriaIncludeLinks", "type": "boolean", "info": "Whether to include the _links field on the shallow references: boolean", "required": false, "schema": { "title": "searchCriteriaIncludeLinks", "type": "boolean" } }, { "name": "searchCriteriaRepositoryId", "type": "string", "info": "If set, search for pull requests whose target branch is in this repository.: string", "required": false, "schema": { "title": "searchCriteriaRepositoryId", "type": "string" } }, { "name": "searchCriteriaReviewerId", "type": "string", "info": "If set, search for pull requests that have this identity as a reviewer.: string", "required": false, "schema": { "title": "searchCriteriaReviewerId", "type": "string" } }, { "name": "searchCriteriaSourceRefName", "type": "string", "info": "If set, search for pull requests from this branch.: string", "required": false, "schema": { "title": "searchCriteriaSourceRefName", "type": "string" } }, { "name": "searchCriteriaSourceRepositoryId", "type": "string", "info": "If set, search for pull requests whose source branch is in this repository.: string", "required": false, "schema": { "title": "searchCriteriaSourceRepositoryId", "type": "string" } }, { "name": "searchCriteriaStatus", "type": "string", "info": "If set, search for pull requests that are in this state. Defaults to Active if unset.: Must be one of [notSet, active, abandoned, completed, all]", "required": false, "schema": { "title": "searchCriteriaStatus", "type": "string" } }, { "name": "searchCriteriaTargetRefName", "type": "string", "info": "If set, search for pull requests into this branch.: string", "required": false, "schema": { "title": "searchCriteriaTargetRefName", "type": "string" } }, { "name": "maxCommentLength", "type": "number", "info": "Not used.: 123", "required": false, "schema": { "title": "maxCommentLength", "type": "number" } }, { "name": "skip", "type": "number", "info": "The number of pull requests to ignore. For example, to retrieve results 101-150, set top to 50 and skip to 100.: 123", "required": false, "schema": { "title": "skip", "type": "number" } }, { "name": "top", "type": "number", "info": "The number of pull requests to retrieve.: 123", "required": false, "schema": { "title": "top", "type": "number" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "Represents all the data associated with a pull request.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "artifactId": { "description": "A string which uniquely identifies this pull request. To generate an artifact ID for a pull request, use this template: ```vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}```", "type": "string" }, "autoCompleteSetBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "closedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "closedDate": { "description": "The date when the pull request was closed (completed, abandoned, or merged externally).", "type": "string" }, "codeReviewId": { "description": "The code review ID of the pull request. Used internally.", "type": "integer" }, "commits": { "description": "The commits contained in the pull request.", "type": "array", "items": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } } }, "completionOptions": { "description": "Preferences about how the pull request should be completed.", "type": "object", "properties": { "autoCompleteIgnoreConfigIds": { "description": "List of any policy configuration Id's which auto-complete should not wait for. Only applies to optional policies (isBlocking == false). Auto-complete always waits for required policies (isBlocking == true).", "type": "array", "items": { "type": "integer" } }, "bypassPolicy": { "description": "If true, policies will be explicitly bypassed while the pull request is completed.", "type": "boolean" }, "bypassReason": { "description": "If policies are bypassed, this reason is stored as to why bypass was used.", "type": "string" }, "deleteSourceBranch": { "description": "If true, the source branch of the pull request will be deleted after completion.", "type": "boolean" }, "mergeCommitMessage": { "description": "If set, this will be used as the commit message of the merge commit.", "type": "string" }, "mergeStrategy": { "description": "Specify the strategy used to merge the pull request during completion. If MergeStrategy is not set to any value, a no-FF merge will be created if SquashMerge == false. If MergeStrategy is not set to any value, the pull request commits will be squashed if SquashMerge == true. The SquashMerge property is deprecated. It is recommended that you explicitly set MergeStrategy in all cases. If an explicit value is provided for MergeStrategy, the SquashMerge property will be ignored.", "enum": [ "noFastForward", "squash", "rebase", "rebaseMerge" ], "x-ms-enum": { "name": "GitPullRequestMergeStrategy", "values": [ { "value": "noFastForward", "description": "A two-parent, no-fast-forward merge. The source branch is unchanged. This is the default behavior." }, { "value": "squash", "description": "Put all changes from the pull request into a single-parent commit." }, { "value": "rebase", "description": "Rebase the source branch on top of the target branch HEAD commit, and fast-forward the target branch. The source branch is updated during the rebase operation." }, { "value": "rebaseMerge", "description": "Rebase the source branch on top of the target branch HEAD commit, and create a two-parent, no-fast-forward merge. The source branch is updated during the rebase operation." } ] } }, "squashMerge": { "description": "SquashMerge is deprecated. You should explicitly set the value of MergeStrategy. If MergeStrategy is set to any value, the SquashMerge value will be ignored. If MergeStrategy is not set, the merge strategy will be no-fast-forward if this flag is false, or squash if true.", "type": "boolean" }, "transitionWorkItems": { "description": "If true, we will attempt to transition any work items linked to the pull request into the next logical state (i.e. Active -> Resolved)", "type": "boolean" }, "triggeredByAutoComplete": { "description": "If true, the current completion attempt was triggered via auto-complete. Used internally.", "type": "boolean" } } }, "completionQueueTime": { "description": "The most recent date at which the pull request entered the queue to be completed. Used internally.", "type": "string" }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "The date when the pull request was created.", "type": "string" }, "description": { "description": "The description of the pull request.", "type": "string" }, "forkSource": { "description": "Information about a fork ref.", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "creator": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "isLocked": { "type": "boolean" }, "isLockedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "name": { "type": "string" }, "objectId": { "type": "string" }, "peeledObjectId": { "type": "string" }, "statuses": { "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "type": "string" } } } ], "properties": { "repository": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "defaultBranch": { "type": "string" }, "id": { "type": "string" }, "isDisabled": { "description": "True if the repository is disabled. False otherwise.", "type": "boolean" }, "isFork": { "description": "True if the repository was created as a fork.", "type": "boolean" }, "name": { "type": "string" }, "parentRepository": { "description": "", "type": "object", "properties": { "collection": { "description": "Reference object for a TeamProjectCollection.", "type": "object", "properties": { "id": { "description": "Collection Id.", "type": "string" }, "name": { "description": "Collection Name.", "type": "string" }, "url": { "description": "Collection REST Url.", "type": "string" } } }, "id": { "type": "string" }, "isFork": { "description": "True if the repository was created as a fork", "type": "boolean" }, "name": { "type": "string" }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "sshUrl": { "type": "string" }, "url": { "type": "string" } } }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "size": { "description": "Compressed size (bytes) of the repository.", "type": "integer" }, "sshUrl": { "type": "string" }, "url": { "type": "string" }, "validRemoteUrls": { "type": "array", "items": { "type": "string" } }, "webUrl": { "type": "string" } } } } }, "hasMultipleMergeBases": { "description": "Multiple mergebases warning", "type": "boolean" }, "isDraft": { "description": "Draft / WIP pull request.", "type": "boolean" }, "labels": { "description": "The labels associated with the pull request.", "type": "array", "items": { "description": "The representation of a tag definition which is sent across the wire.", "type": "object", "properties": { "active": { "description": "Whether or not the tag definition is active.", "type": "boolean" }, "id": { "description": "ID of the tag definition.", "type": "string" }, "name": { "description": "The name of the tag definition.", "type": "string" }, "url": { "description": "Resource URL for the Tag Definition.", "type": "string" } } } }, "lastMergeCommit": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } }, "lastMergeSourceCommit": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } }, "lastMergeTargetCommit": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } }, "mergeFailureMessage": { "description": "If set, pull request merge failed for this reason.", "type": "string" }, "mergeFailureType": { "description": "The type of failure (if any) of the pull request merge.", "enum": [ "none", "unknown", "caseSensitive", "objectTooLarge" ], "x-ms-enum": { "name": "PullRequestMergeFailureType", "values": [ { "value": "none", "description": "Type is not set. Default type." }, { "value": "unknown", "description": "Pull request merge failure type unknown." }, { "value": "caseSensitive", "description": "Pull request merge failed due to case mismatch." }, { "value": "objectTooLarge", "description": "Pull request merge failed due to an object being too large." } ] } }, "mergeId": { "description": "The ID of the job used to run the pull request merge. Used internally.", "type": "string" }, "mergeOptions": { "description": "The options which are used when a pull request merge is created.", "type": "object", "properties": { "conflictAuthorshipCommits": { "description": "If true, conflict resolutions applied during the merge will be put in separate commits to preserve authorship info for git blame, etc.", "type": "boolean" }, "detectRenameFalsePositives": { "type": "boolean" }, "disableRenames": { "description": "If true, rename detection will not be performed during the merge.", "type": "boolean" } } }, "mergeStatus": { "description": "The current status of the pull request merge.", "enum": [ "notSet", "queued", "conflicts", "succeeded", "rejectedByPolicy", "failure" ], "x-ms-enum": { "name": "PullRequestAsyncStatus", "values": [ { "value": "notSet", "description": "Status is not set. Default state." }, { "value": "queued", "description": "Pull request merge is queued." }, { "value": "conflicts", "description": "Pull request merge failed due to conflicts." }, { "value": "succeeded", "description": "Pull request merge succeeded." }, { "value": "rejectedByPolicy", "description": "Pull request merge rejected by policy." }, { "value": "failure", "description": "Pull request merge failed." } ] } }, "pullRequestId": { "description": "The ID of the pull request.", "type": "integer" }, "remoteUrl": { "description": "Used internally.", "type": "string" }, "repository": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "defaultBranch": { "type": "string" }, "id": { "type": "string" }, "isDisabled": { "description": "True if the repository is disabled. False otherwise.", "type": "boolean" }, "isFork": { "description": "True if the repository was created as a fork.", "type": "boolean" }, "name": { "type": "string" }, "parentRepository": { "description": "", "type": "object", "properties": { "collection": { "description": "Reference object for a TeamProjectCollection.", "type": "object", "properties": { "id": { "description": "Collection Id.", "type": "string" }, "name": { "description": "Collection Name.", "type": "string" }, "url": { "description": "Collection REST Url.", "type": "string" } } }, "id": { "type": "string" }, "isFork": { "description": "True if the repository was created as a fork", "type": "boolean" }, "name": { "type": "string" }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "sshUrl": { "type": "string" }, "url": { "type": "string" } } }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "size": { "description": "Compressed size (bytes) of the repository.", "type": "integer" }, "sshUrl": { "type": "string" }, "url": { "type": "string" }, "validRemoteUrls": { "type": "array", "items": { "type": "string" } }, "webUrl": { "type": "string" } } }, "reviewers": { "description": "A list of reviewers on the pull request along with the state of their votes.", "type": "array", "items": { "description": "Identity information including a vote on a pull request.", "type": "object", "allOf": [ { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } } ], "properties": { "hasDeclined": { "description": "Indicates if this reviewer has declined to review this pull request.", "type": "boolean" }, "isFlagged": { "description": "Indicates if this reviewer is flagged for attention on this pull request.", "type": "boolean" }, "isRequired": { "description": "Indicates if this is a required reviewer for this pull request.
Branches can have policies that require particular reviewers are required for pull requests.", "type": "boolean" }, "reviewerUrl": { "description": "URL to retrieve information about this identity", "type": "string" }, "vote": { "description": "Vote on a pull request:
10 - approved 5 - approved with suggestions 0 - no vote -5 - waiting for author -10 - rejected", "type": "integer" }, "votedFor": { "description": "Groups or teams that that this reviewer contributed to.
Groups and teams can be reviewers on pull requests but can not vote directly. When a member of the group or team votes, that vote is rolled up into the group or team vote. VotedFor is a list of such votes.", "type": "array", "items": { "description": "Identity information including a vote on a pull request.", "type": "object", "allOf": [ { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } } ], "properties": { "hasDeclined": { "description": "Indicates if this reviewer has declined to review this pull request.", "type": "boolean" }, "isFlagged": { "description": "Indicates if this reviewer is flagged for attention on this pull request.", "type": "boolean" }, "isRequired": { "description": "Indicates if this is a required reviewer for this pull request.
Branches can have policies that require particular reviewers are required for pull requests.", "type": "boolean" }, "reviewerUrl": { "description": "URL to retrieve information about this identity", "type": "string" }, "vote": { "description": "Vote on a pull request:
10 - approved 5 - approved with suggestions 0 - no vote -5 - waiting for author -10 - rejected", "type": "integer" }, "votedFor": { "description": "Groups or teams that that this reviewer contributed to.
Groups and teams can be reviewers on pull requests but can not vote directly. When a member of the group or team votes, that vote is rolled up into the group or team vote. VotedFor is a list of such votes.", "type": "array", "items": { "type": "object" } } } } } } } }, "sourceRefName": { "description": "The name of the source branch of the pull request.", "type": "string" }, "status": { "description": "The status of the pull request.", "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 criteria to include all statuses." } ] } }, "supportsIterations": { "description": "If true, this pull request supports multiple iterations. Iteration support means individual pushes to the source branch of the pull request can be reviewed and comments left in one iteration will be tracked across future iterations.", "type": "boolean" }, "targetRefName": { "description": "The name of the target branch of the pull request.", "type": "string" }, "title": { "description": "The title of the pull request.", "type": "string" }, "url": { "description": "Used internally.", "type": "string" }, "workItemRefs": { "description": "Any work item references associated with this pull request.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestsGetPullRequests" }, "task": true }, { "name": "pullRequestsGetPullRequest", "summary": "Retrieve a pull request.", "description": "Retrieve a pull request.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request's target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "The ID of the pull request to retrieve.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "maxCommentLength", "type": "number", "info": "Not used.: 123", "required": false, "schema": { "title": "maxCommentLength", "type": "number" } }, { "name": "skip", "type": "number", "info": "Not used.: 123", "required": false, "schema": { "title": "skip", "type": "number" } }, { "name": "top", "type": "number", "info": "Not used.: 123", "required": false, "schema": { "title": "top", "type": "number" } }, { "name": "includeCommits", "type": "boolean", "info": "If true, the pull request will be returned with the associated commits.: boolean", "required": false, "schema": { "title": "includeCommits", "type": "boolean" } }, { "name": "includeWorkItemRefs", "type": "boolean", "info": "If true, the pull request will be returned with the associated work item references.: boolean", "required": false, "schema": { "title": "includeWorkItemRefs", "type": "boolean" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestsGetPullRequest" }, "task": true }, { "name": "pullRequestsUpdate", "summary": "Update a pull request\n\nThese are the properties that can be updated with the API:\n - Status\n - Titl", "description": "Update a pull request\n\nThese are the properties that can be updated with the API:\n - Status\n - Title\n - Description (up to 4000 characters)\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.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": "The pull request content that should be updated.: {\"_links\": {\"links\": \"object\"}, \"artifactId\": \"string\", \"autoCompleteSetBy\": {\"directoryAlias\": \"string\", \"id\": \"string\", \"imageUrl\": \"string\", \"inactive\": \"boolean\", \"isAadIdentity\": \"boolean\", \"isContainer\": \"boolean\", \"isDeletedInOrigin\": \"boolean\", \"profileUrl\": \"string\", \"uniqueName\": \"string\"}, \"closedBy\": {\"directoryAlias\": \"string\", \"id\": \"string\", \"imageUrl\": \"string\", \"inactive\": \"boolean\", \"isAadIdentity\": \"boolean\", \"isContainer\": \"boolean\", \"isDeletedInOrigin\": \"boolean\", \"profileUrl\": \"string\", \"uniqueName\": \"string\"}, \"closedDate\": \"string\", \"codeReviewId\": 123, \"commits\": [{\"_links\": {\"links\": \"object\"}, \"author\": {\"date\": \"string\", \"email\": \"string\", \"imageUrl\": \"string\", \"name\": \"string\"}, \"changeCounts\": }, \"changes\": [{\"changeId\": 123, \"newContentTemplate\": {\"name\": \"string\", \"type\": \"string\"}, \"originalPath\": \"string\"}], \"comment\": \"string\", \"commentTruncated\": \"boolean\", \"commitId\": \"string\", \"committer\": {\"date\": \"string\", \"email\": \"string\", \"imageUrl\": \"string\", \"name\": \"string\"}, \"parents\": \"array\", \"push\": {\"_links\": {\"links\": \"object\"}, \"date\": \"string\", \"pushedBy\": {\"directoryAlias\": \"string\", \"id\": \"string\", \"imageUrl\": \"string\", \"inactive\": \"boolean\", \"isAadIdentity\": \"boolean\", \"isContainer\": \"boolean\", \"isDeletedInOrigin\": \"boolean\", \"profileUrl\": \"string\", \"uniqueName\": \"string\"}, \"pushId\": 123, \"url\": \"string\"}, \"remoteUrl\": \"string\", \"statuses\": [{\"_links\": {\"links\": \"object\"}, \"context\": {\"genre\": \"string\", \"name\": \"string\"}, \"createdBy\": {\"directoryAlias\": \"string\", \"id\": \"string\", \"imageUrl\": \"string\", \"inactive\": \"boolean\", \"isAadIdentity\": \"boolean\", \"isContainer\": \"boolean\", \"isDeletedInOrigin\": \"boolean\", \"profileUrl\": \"string\", \"uniqueName\": \"string\"}, \"creationDate\": \"string\", \"description\": \"string\", \"id\": 123, \"state\": \"undefined\", \"targetUrl\": \"string\", \"updatedDate\": \"string\"}], \"url\": \"string\", \"workItems\": [{\"id\": \"string\", \"url\": \"string\"}]}], \"completionOptions\": {\"autoCompleteIgnoreConfigIds\": \"array\", \"bypassPolicy\": \"boolean\", \"bypassReason\": \"string\", \"deleteSourceBranch\": \"boolean\", \"mergeCommitMessage\": \"string\", \"mergeStrategy\": \"undefined\", \"squashMerge\": \"boolean\", \"transitionWorkItems\": \"boolean\", \"triggeredByAutoComplete\": \"boolean\"}, \"completionQueueTime\": \"string\", \"createdBy\": {\"directoryAlias\": \"string\", \"id\": \"string\", \"imageUrl\": \"string\", \"inactive\": \"boolean\", \"isAadIdentity\": \"boolean\", \"isContainer\": \"boolean\", \"isDeletedInOrigin\": \"boolean\", \"profileUrl\": \"string\", \"uniqueName\": \"string\"}, \"creationDate\": \"string\", \"description\": \"string\", \"forkSource\": {\"repository\": {\"_links\": {\"links\": \"object\"}, \"defaultBranch\": \"string\", \"id\": \"string\", \"isDisabled\": \"boolean\", \"isFork\": \"boolean\", \"name\": \"string\", \"parentRepository\": {\"collection\": {\"id\": \"string\", \"name\": \"string\", \"url\": \"string\"}, \"id\": \"string\", \"isFork\": \"boolean\", \"name\": \"string\", \"project\": {\"abbreviation\": \"string\", \"defaultTeamImageUrl\": \"string\", \"description\": \"string\", \"id\": \"string\", \"lastUpdateTime\": \"string\", \"name\": \"string\", \"revision\": 123, \"state\": \"undefined\", \"url\": \"string\", \"visibility\": \"undefined\"}, \"remoteUrl\": \"string\", \"sshUrl\": \"string\", \"url\": \"string\"}, \"project\": {\"abbreviation\": \"string\", \"defaultTeamImageUrl\": \"string\", \"description\": \"string\", \"id\": \"string\", \"lastUpdateTime\": \"string\", \"name\": \"string\", \"revision\": 123, \"state\": \"undefined\", \"url\": \"string\", \"visibility\": \"undefined\"}, \"remoteUrl\": \"string\", \"size\": 123, \"sshUrl\": \"string\", \"url\": \"string\", \"validRemoteUrls\": \"array\", \"webUrl\": \"string\"}}, \"hasMultipleMergeBases\": \"boolean\", \"isDraft\": \"boolean\", \"labels\": [{\"active\": \"boolean\", \"id\": \"string\", \"name\": \"string\", \"url\": \"string\"}], \"lastMergeCommit\": {\"_links\": {\"links\": \"object\"}, \"author\": {\"date\": \"string\", \"email\": \"string\", \"imageUrl\": \"string\", \"name\": \"string\"}, \"changeCounts\": }, \"changes\": [{\"changeId\": 123, \"newContentTemplate\": {\"name\": \"string\", \"type\": \"string\"}, \"originalPath\": \"string\"}], \"comment\": \"string\", \"commentTruncated\": \"boolean\", \"commitId\": \"string\", \"committer\": {\"date\": \"string\", \"email\": \"string\", \"imageUrl\": \"string\", \"name\": \"string\"}, \"parents\": \"array\", \"push\": {\"_links\": {\"links\": \"object\"}, \"date\": \"string\", \"pushedBy\": {\"directoryAlias\": \"string\", \"id\": \"string\", \"imageUrl\": \"string\", \"inactive\": \"boolean\", \"isAadIdentity\": \"boolean\", \"isContainer\": \"boolean\", \"isDeletedInOrigin\": \"boolean\", \"profileUrl\": \"string\", \"uniqueName\": \"string\"}, \"pushId\": 123, \"url\": \"string\"}, \"remoteUrl\": \"string\", \"statuses\": [{\"_links\": {\"links\": \"object\"}, \"context\": {\"genre\": \"string\", \"name\": \"string\"}, \"createdBy\": {\"directoryAlias\": \"string\", \"id\": \"string\", \"imageUrl\": \"string\", \"inactive\": \"boolean\", \"isAadIdentity\": \"boolean\", \"isContainer\": \"boolean\", \"isDeletedInOrigin\": \"boolean\", \"profileUrl\": \"string\", \"uniqueName\": \"string\"}, \"creationDate\": \"string\", \"description\": \"string\", \"id\": 123, \"state\": \"undefined\", \"targetUrl\": \"string\", \"updatedDate\": \"string\"}], \"url\": \"string\", \"workItems\": [{\"id\": \"string\", \"url\": \"string\"}]}, \"lastMergeSourceCommit\": {\"_links\": {\"links\": \"object\"}, \"author\": {\"date\": \"string\", \"email\": \"string\", \"imageUrl\": \"string\", \"name\": \"string\"}, \"changeCounts\": }, \"changes\": [{\"changeId\": 123, \"newContentTemplate\": {\"name\": \"string\", \"type\": \"string\"}, \"originalPath\": \"string\"}], \"comment\": \"string\", \"commentTruncated\": \"boolean\", \"commitId\": \"string\", \"committer\": {\"date\": \"string\", \"email\": \"string\", \"imageUrl\": \"string\", \"name\": \"string\"}, \"parents\": \"array\", \"push\": {\"_links\": {\"links\": \"object\"}, \"date\": \"string\", \"pushedBy\": {\"directoryAlias\": \"string\", \"id\": \"string\", \"imageUrl\": \"string\", \"inactive\": \"boolean\", \"isAadIdentity\": \"boolean\", \"isContainer\": \"boolean\", \"isDeletedInOrigin\": \"boolean\", \"profileUrl\": \"string\", \"uniqueName\": \"string\"}, \"pushId\": 123, \"url\": \"string\"}, \"remoteUrl\": \"string\", \"statuses\": [{\"_links\": {\"links\": \"object\"}, \"context\": {\"genre\": \"string\", \"name\": \"string\"}, \"createdBy\": {\"directoryAlias\": \"string\", \"id\": \"string\", \"imageUrl\": \"string\", \"inactive\": \"boolean\", \"isAadIdentity\": \"boolean\", \"isContainer\": \"boolean\", \"isDeletedInOrigin\": \"boolean\", \"profileUrl\": \"string\", \"uniqueName\": \"string\"}, \"creationDate\": \"string\", \"description\": \"string\", \"id\": 123, \"state\": \"undefined\", \"targetUrl\": \"string\", \"updatedDate\": \"string\"}], \"url\": \"string\", \"workItems\": [{\"id\": \"string\", \"url\": \"string\"}]}, \"lastMergeTargetCommit\": {\"_links\": {\"links\": \"object\"}, \"author\": {\"date\": \"string\", \"email\": \"string\", \"imageUrl\": \"string\", \"name\": \"string\"}, \"changeCounts\": }, \"changes\": [{\"changeId\": 123, \"newContentTemplate\": {\"name\": \"string\", \"type\": \"string\"}, \"originalPath\": \"string\"}], \"comment\": \"string\", \"commentTruncated\": \"boolean\", \"commitId\": \"string\", \"committer\": {\"date\": \"string\", \"email\": \"string\", \"imageUrl\": \"string\", \"name\": \"string\"}, \"parents\": \"array\", \"push\": {\"_links\": {\"links\": \"object\"}, \"date\": \"string\", \"pushedBy\": {\"directoryAlias\": \"string\", \"id\": \"string\", \"imageUrl\": \"string\", \"inactive\": \"boolean\", \"isAadIdentity\": \"boolean\", \"isContainer\": \"boolean\", \"isDeletedInOrigin\": \"boolean\", \"profileUrl\": \"string\", \"uniqueName\": \"string\"}, \"pushId\": 123, \"url\": \"string\"}, \"remoteUrl\": \"string\", \"statuses\": [{\"_links\": {\"links\": \"object\"}, \"context\": {\"genre\": \"string\", \"name\": \"string\"}, \"createdBy\": {\"directoryAlias\": \"string\", \"id\": \"string\", \"imageUrl\": \"string\", \"inactive\": \"boolean\", \"isAadIdentity\": \"boolean\", \"isContainer\": \"boolean\", \"isDeletedInOrigin\": \"boolean\", \"profileUrl\": \"string\", \"uniqueName\": \"string\"}, \"creationDate\": \"string\", \"description\": \"string\", \"id\": 123, \"state\": \"undefined\", \"targetUrl\": \"string\", \"updatedDate\": \"string\"}], \"url\": \"string\", \"workItems\": [{\"id\": \"string\", \"url\": \"string\"}]}, \"mergeFailureMessage\": \"string\", \"mergeFailureType\": \"undefined\", \"mergeId\": \"string\", \"mergeOptions\": {\"conflictAuthorshipCommits\": \"boolean\", \"detectRenameFalsePositives\": \"boolean\", \"disableRenames\": \"boolean\"}, \"mergeStatus\": \"undefined\", \"pullRequestId\": 123, \"remoteUrl\": \"string\", \"repository\": {\"_links\": {\"links\": \"object\"}, \"defaultBranch\": \"string\", \"id\": \"string\", \"isDisabled\": \"boolean\", \"isFork\": \"boolean\", \"name\": \"string\", \"parentRepository\": {\"collection\": {\"id\": \"string\", \"name\": \"string\", \"url\": \"string\"}, \"id\": \"string\", \"isFork\": \"boolean\", \"name\": \"string\", \"project\": {\"abbreviation\": \"string\", \"defaultTeamImageUrl\": \"string\", \"description\": \"string\", \"id\": \"string\", \"lastUpdateTime\": \"string\", \"name\": \"string\", \"revision\": 123, \"state\": \"undefined\", \"url\": \"string\", \"visibility\": \"undefined\"}, \"remoteUrl\": \"string\", \"sshUrl\": \"string\", \"url\": \"string\"}, \"project\": {\"abbreviation\": \"string\", \"defaultTeamImageUrl\": \"string\", \"description\": \"string\", \"id\": \"string\", \"lastUpdateTime\": \"string\", \"name\": \"string\", \"revision\": 123, \"state\": \"undefined\", \"url\": \"string\", \"visibility\": \"undefined\"}, \"remoteUrl\": \"string\", \"size\": 123, \"sshUrl\": \"string\", \"url\": \"string\", \"validRemoteUrls\": \"array\", \"webUrl\": \"string\"}, \"reviewers\": [{\"hasDeclined\": \"boolean\", \"isFlagged\": \"boolean\", \"isRequired\": \"boolean\", \"reviewerUrl\": \"string\", \"vote\": 123, \"votedFor\": [{\"hasDeclined\": \"boolean\", \"isFlagged\": \"boolean\", \"isRequired\": \"boolean\", \"reviewerUrl\": \"string\", \"vote\": 123, \"votedFor\": \"array\"}]}], \"sourceRefName\": \"string\", \"status\": \"undefined\", \"supportsIterations\": \"boolean\", \"targetRefName\": \"string\", \"title\": \"string\", \"url\": \"string\", \"workItemRefs\": [{\"id\": \"string\", \"url\": \"string\"}]}", "required": true, "schema": { "description": "Represents all the data associated with a pull request.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "artifactId": { "description": "A string which uniquely identifies this pull request. To generate an artifact ID for a pull request, use this template: ```vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}```", "type": "string" }, "autoCompleteSetBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "closedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "closedDate": { "description": "The date when the pull request was closed (completed, abandoned, or merged externally).", "type": "string" }, "codeReviewId": { "description": "The code review ID of the pull request. Used internally.", "type": "integer" }, "commits": { "description": "The commits contained in the pull request.", "type": "array", "items": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } } }, "completionOptions": { "description": "Preferences about how the pull request should be completed.", "type": "object", "properties": { "autoCompleteIgnoreConfigIds": { "description": "List of any policy configuration Id's which auto-complete should not wait for. Only applies to optional policies (isBlocking == false). Auto-complete always waits for required policies (isBlocking == true).", "type": "array", "items": { "type": "integer" } }, "bypassPolicy": { "description": "If true, policies will be explicitly bypassed while the pull request is completed.", "type": "boolean" }, "bypassReason": { "description": "If policies are bypassed, this reason is stored as to why bypass was used.", "type": "string" }, "deleteSourceBranch": { "description": "If true, the source branch of the pull request will be deleted after completion.", "type": "boolean" }, "mergeCommitMessage": { "description": "If set, this will be used as the commit message of the merge commit.", "type": "string" }, "mergeStrategy": { "description": "Specify the strategy used to merge the pull request during completion. If MergeStrategy is not set to any value, a no-FF merge will be created if SquashMerge == false. If MergeStrategy is not set to any value, the pull request commits will be squashed if SquashMerge == true. The SquashMerge property is deprecated. It is recommended that you explicitly set MergeStrategy in all cases. If an explicit value is provided for MergeStrategy, the SquashMerge property will be ignored.", "enum": [ "noFastForward", "squash", "rebase", "rebaseMerge" ], "x-ms-enum": { "name": "GitPullRequestMergeStrategy", "values": [ { "value": "noFastForward", "description": "A two-parent, no-fast-forward merge. The source branch is unchanged. This is the default behavior." }, { "value": "squash", "description": "Put all changes from the pull request into a single-parent commit." }, { "value": "rebase", "description": "Rebase the source branch on top of the target branch HEAD commit, and fast-forward the target branch. The source branch is updated during the rebase operation." }, { "value": "rebaseMerge", "description": "Rebase the source branch on top of the target branch HEAD commit, and create a two-parent, no-fast-forward merge. The source branch is updated during the rebase operation." } ] } }, "squashMerge": { "description": "SquashMerge is deprecated. You should explicitly set the value of MergeStrategy. If MergeStrategy is set to any value, the SquashMerge value will be ignored. If MergeStrategy is not set, the merge strategy will be no-fast-forward if this flag is false, or squash if true.", "type": "boolean" }, "transitionWorkItems": { "description": "If true, we will attempt to transition any work items linked to the pull request into the next logical state (i.e. Active -> Resolved)", "type": "boolean" }, "triggeredByAutoComplete": { "description": "If true, the current completion attempt was triggered via auto-complete. Used internally.", "type": "boolean" } } }, "completionQueueTime": { "description": "The most recent date at which the pull request entered the queue to be completed. Used internally.", "type": "string" }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "The date when the pull request was created.", "type": "string" }, "description": { "description": "The description of the pull request.", "type": "string" }, "forkSource": { "description": "Information about a fork ref.", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "creator": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "isLocked": { "type": "boolean" }, "isLockedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "name": { "type": "string" }, "objectId": { "type": "string" }, "peeledObjectId": { "type": "string" }, "statuses": { "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "type": "string" } } } ], "properties": { "repository": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "defaultBranch": { "type": "string" }, "id": { "type": "string" }, "isDisabled": { "description": "True if the repository is disabled. False otherwise.", "type": "boolean" }, "isFork": { "description": "True if the repository was created as a fork.", "type": "boolean" }, "name": { "type": "string" }, "parentRepository": { "description": "", "type": "object", "properties": { "collection": { "description": "Reference object for a TeamProjectCollection.", "type": "object", "properties": { "id": { "description": "Collection Id.", "type": "string" }, "name": { "description": "Collection Name.", "type": "string" }, "url": { "description": "Collection REST Url.", "type": "string" } } }, "id": { "type": "string" }, "isFork": { "description": "True if the repository was created as a fork", "type": "boolean" }, "name": { "type": "string" }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "sshUrl": { "type": "string" }, "url": { "type": "string" } } }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "size": { "description": "Compressed size (bytes) of the repository.", "type": "integer" }, "sshUrl": { "type": "string" }, "url": { "type": "string" }, "validRemoteUrls": { "type": "array", "items": { "type": "string" } }, "webUrl": { "type": "string" } } } } }, "hasMultipleMergeBases": { "description": "Multiple mergebases warning", "type": "boolean" }, "isDraft": { "description": "Draft / WIP pull request.", "type": "boolean" }, "labels": { "description": "The labels associated with the pull request.", "type": "array", "items": { "description": "The representation of a tag definition which is sent across the wire.", "type": "object", "properties": { "active": { "description": "Whether or not the tag definition is active.", "type": "boolean" }, "id": { "description": "ID of the tag definition.", "type": "string" }, "name": { "description": "The name of the tag definition.", "type": "string" }, "url": { "description": "Resource URL for the Tag Definition.", "type": "string" } } } }, "lastMergeCommit": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } }, "lastMergeSourceCommit": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } }, "lastMergeTargetCommit": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } }, "mergeFailureMessage": { "description": "If set, pull request merge failed for this reason.", "type": "string" }, "mergeFailureType": { "description": "The type of failure (if any) of the pull request merge.", "enum": [ "none", "unknown", "caseSensitive", "objectTooLarge" ], "x-ms-enum": { "name": "PullRequestMergeFailureType", "values": [ { "value": "none", "description": "Type is not set. Default type." }, { "value": "unknown", "description": "Pull request merge failure type unknown." }, { "value": "caseSensitive", "description": "Pull request merge failed due to case mismatch." }, { "value": "objectTooLarge", "description": "Pull request merge failed due to an object being too large." } ] } }, "mergeId": { "description": "The ID of the job used to run the pull request merge. Used internally.", "type": "string" }, "mergeOptions": { "description": "The options which are used when a pull request merge is created.", "type": "object", "properties": { "conflictAuthorshipCommits": { "description": "If true, conflict resolutions applied during the merge will be put in separate commits to preserve authorship info for git blame, etc.", "type": "boolean" }, "detectRenameFalsePositives": { "type": "boolean" }, "disableRenames": { "description": "If true, rename detection will not be performed during the merge.", "type": "boolean" } } }, "mergeStatus": { "description": "The current status of the pull request merge.", "enum": [ "notSet", "queued", "conflicts", "succeeded", "rejectedByPolicy", "failure" ], "x-ms-enum": { "name": "PullRequestAsyncStatus", "values": [ { "value": "notSet", "description": "Status is not set. Default state." }, { "value": "queued", "description": "Pull request merge is queued." }, { "value": "conflicts", "description": "Pull request merge failed due to conflicts." }, { "value": "succeeded", "description": "Pull request merge succeeded." }, { "value": "rejectedByPolicy", "description": "Pull request merge rejected by policy." }, { "value": "failure", "description": "Pull request merge failed." } ] } }, "pullRequestId": { "description": "The ID of the pull request.", "type": "integer" }, "remoteUrl": { "description": "Used internally.", "type": "string" }, "repository": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "defaultBranch": { "type": "string" }, "id": { "type": "string" }, "isDisabled": { "description": "True if the repository is disabled. False otherwise.", "type": "boolean" }, "isFork": { "description": "True if the repository was created as a fork.", "type": "boolean" }, "name": { "type": "string" }, "parentRepository": { "description": "", "type": "object", "properties": { "collection": { "description": "Reference object for a TeamProjectCollection.", "type": "object", "properties": { "id": { "description": "Collection Id.", "type": "string" }, "name": { "description": "Collection Name.", "type": "string" }, "url": { "description": "Collection REST Url.", "type": "string" } } }, "id": { "type": "string" }, "isFork": { "description": "True if the repository was created as a fork", "type": "boolean" }, "name": { "type": "string" }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "sshUrl": { "type": "string" }, "url": { "type": "string" } } }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "size": { "description": "Compressed size (bytes) of the repository.", "type": "integer" }, "sshUrl": { "type": "string" }, "url": { "type": "string" }, "validRemoteUrls": { "type": "array", "items": { "type": "string" } }, "webUrl": { "type": "string" } } }, "reviewers": { "description": "A list of reviewers on the pull request along with the state of their votes.", "type": "array", "items": { "description": "Identity information including a vote on a pull request.", "type": "object", "allOf": [ { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } } ], "properties": { "hasDeclined": { "description": "Indicates if this reviewer has declined to review this pull request.", "type": "boolean" }, "isFlagged": { "description": "Indicates if this reviewer is flagged for attention on this pull request.", "type": "boolean" }, "isRequired": { "description": "Indicates if this is a required reviewer for this pull request.
Branches can have policies that require particular reviewers are required for pull requests.", "type": "boolean" }, "reviewerUrl": { "description": "URL to retrieve information about this identity", "type": "string" }, "vote": { "description": "Vote on a pull request:
10 - approved 5 - approved with suggestions 0 - no vote -5 - waiting for author -10 - rejected", "type": "integer" }, "votedFor": { "description": "Groups or teams that that this reviewer contributed to.
Groups and teams can be reviewers on pull requests but can not vote directly. When a member of the group or team votes, that vote is rolled up into the group or team vote. VotedFor is a list of such votes.", "type": "array", "items": { "description": "Identity information including a vote on a pull request.", "type": "object", "allOf": [ { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } } ], "properties": { "hasDeclined": { "description": "Indicates if this reviewer has declined to review this pull request.", "type": "boolean" }, "isFlagged": { "description": "Indicates if this reviewer is flagged for attention on this pull request.", "type": "boolean" }, "isRequired": { "description": "Indicates if this is a required reviewer for this pull request.
Branches can have policies that require particular reviewers are required for pull requests.", "type": "boolean" }, "reviewerUrl": { "description": "URL to retrieve information about this identity", "type": "string" }, "vote": { "description": "Vote on a pull request:
10 - approved 5 - approved with suggestions 0 - no vote -5 - waiting for author -10 - rejected", "type": "integer" }, "votedFor": { "description": "Groups or teams that that this reviewer contributed to.
Groups and teams can be reviewers on pull requests but can not vote directly. When a member of the group or team votes, that vote is rolled up into the group or team vote. VotedFor is a list of such votes.", "type": "array", "items": { "type": "object" } } } } } } } }, "sourceRefName": { "description": "The name of the source branch of the pull request.", "type": "string" }, "status": { "description": "The status of the pull request.", "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 criteria to include all statuses." } ] } }, "supportsIterations": { "description": "If true, this pull request supports multiple iterations. Iteration support means individual pushes to the source branch of the pull request can be reviewed and comments left in one iteration will be tracked across future iterations.", "type": "boolean" }, "targetRefName": { "description": "The name of the target branch of the pull request.", "type": "string" }, "title": { "description": "The title of the pull request.", "type": "string" }, "url": { "description": "Used internally.", "type": "string" }, "workItemRefs": { "description": "Any work item references associated with this pull request.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request's target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request to update.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestsUpdate" }, "task": true }, { "name": "annotatedTagsCreate", "summary": "Create an annotated tag.\n\nRepositories have both a name and an identifier. Identifiers are globally", "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).", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": "Object containing details of tag to be created.: {\"message\": \"string\", \"name\": \"string\", \"objectId\": \"string\", \"taggedBy\": {\"date\": \"string\", \"email\": \"string\", \"imageUrl\": \"string\", \"name\": \"string\"}, \"taggedObject\": {\"objectId\": \"string\", \"objectType\": \"undefined\"}, \"url\": \"string\"}", "required": true, "schema": { "description": "A Git annotated tag.", "type": "object", "properties": { "message": { "description": "The tagging Message", "type": "string" }, "name": { "description": "The name of the annotated tag.", "type": "string" }, "objectId": { "description": "The objectId (Sha1Id) of the tag.", "type": "string" }, "taggedBy": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "taggedObject": { "description": "Git object identifier and type information.", "type": "object", "properties": { "objectId": { "description": "Object Id (Sha1Id).", "type": "string" }, "objectType": { "description": "Type of object (Commit, Tree, Blob, Tag)", "enum": [ "bad", "commit", "tree", "blob", "tag", "ext2", "ofsDelta", "refDelta" ], "x-ms-enum": { "name": "GitObjectType", "values": [ { "value": "bad", "description": "" }, { "value": "commit", "description": "" }, { "value": "tree", "description": "" }, { "value": "blob", "description": "" }, { "value": "tag", "description": "" }, { "value": "ext2", "description": "" }, { "value": "ofsDelta", "description": "" }, { "value": "refDelta", "description": "" } ] } } } }, "url": { "type": "string" } } } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "ID or name of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/annotatedTagsCreate" }, "task": true }, { "name": "annotatedTagsGet", "summary": "Get an annotated tag.\n\nRepositories have both a name and an identifier. Identifiers are globally un", "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).", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "ID or name of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "objectId", "type": "string", "info": "ObjectId (Sha1Id) of tag to get.: string", "required": true, "schema": { "title": "objectId", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/annotatedTagsGet" }, "task": true }, { "name": "blobsGetBlobsZip", "summary": "Gets one or more blobs in a zip file download.", "description": "Gets one or more blobs in a zip file download.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "array", "info": "Blob IDs (SHA1 hashes) to be returned in the zip file.: array", "required": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "repositoryId", "type": "string", "info": "The name or ID of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "filename", "type": "string", "info": ": string", "required": false, "schema": { "title": "filename", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/blobsGetBlobsZip" }, "task": true }, { "name": "blobsGetBlob", "summary": "Get a single blob.\n\nRepositories have both a name and an identifier. Identifiers are globally uniqu", "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).", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The name or ID of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "sha1", "type": "string", "info": "SHA1 hash of the file. You can get the SHA1 of a file using the \"Git/Items/Get Item\" endpoint.: string", "required": true, "schema": { "title": "sha1", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "download", "type": "boolean", "info": "If true, prompt for a download rather than rendering in a browser. Note: this value defaults to true if $format is zip: boolean", "required": false, "schema": { "title": "download", "type": "boolean" } }, { "name": "fileName", "type": "string", "info": "Provide a fileName to use for a download.: string", "required": false, "schema": { "title": "fileName", "type": "string" } }, { "name": "format", "type": "string", "info": "Options: json, zip, text, octetstream. If not set, defaults to the MIME type set in the Accept header.: string", "required": false, "schema": { "title": "format", "type": "string" } }, { "name": "resolveLfs", "type": "boolean", "info": "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: boolean", "required": false, "schema": { "title": "resolveLfs", "type": "boolean" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/blobsGetBlob" }, "task": true }, { "name": "cherryPicksCreate", "summary": "Cherry pick a specific commit or commits that are associated to a pull request into a new branch.", "description": "Cherry pick a specific commit or commits that are associated to a pull request into a new branch.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"generatedRefName\": \"string\", \"ontoRefName\": \"string\", \"repository\": {\"_links\": {\"links\": \"object\"}, \"defaultBranch\": \"string\", \"id\": \"string\", \"isDisabled\": \"boolean\", \"isFork\": \"boolean\", \"name\": \"string\", \"parentRepository\": {\"collection\": {\"id\": \"string\", \"name\": \"string\", \"url\": \"string\"}, \"id\": \"string\", \"isFork\": \"boolean\", \"name\": \"string\", \"project\": {\"abbreviation\": \"string\", \"defaultTeamImageUrl\": \"string\", \"description\": \"string\", \"id\": \"string\", \"lastUpdateTime\": \"string\", \"name\": \"string\", \"revision\": 123, \"state\": \"undefined\", \"url\": \"string\", \"visibility\": \"undefined\"}, \"remoteUrl\": \"string\", \"sshUrl\": \"string\", \"url\": \"string\"}, \"project\": {\"abbreviation\": \"string\", \"defaultTeamImageUrl\": \"string\", \"description\": \"string\", \"id\": \"string\", \"lastUpdateTime\": \"string\", \"name\": \"string\", \"revision\": 123, \"state\": \"undefined\", \"url\": \"string\", \"visibility\": \"undefined\"}, \"remoteUrl\": \"string\", \"size\": 123, \"sshUrl\": \"string\", \"url\": \"string\", \"validRemoteUrls\": \"array\", \"webUrl\": \"string\"}, \"source\": {\"commitList\": [{\"_links\": {\"links\": \"object\"}, \"author\": {\"date\": \"string\", \"email\": \"string\", \"imageUrl\": \"string\", \"name\": \"string\"}, \"changeCounts\": }, \"changes\": [{\"changeId\": 123, \"newContentTemplate\": {\"name\": \"string\", \"type\": \"string\"}, \"originalPath\": \"string\"}], \"comment\": \"string\", \"commentTruncated\": \"boolean\", \"commitId\": \"string\", \"committer\": {\"date\": \"string\", \"email\": \"string\", \"imageUrl\": \"string\", \"name\": \"string\"}, \"parents\": \"array\", \"push\": {\"_links\": {\"links\": \"object\"}, \"date\": \"string\", \"pushedBy\": {\"directoryAlias\": \"string\", \"id\": \"string\", \"imageUrl\": \"string\", \"inactive\": \"boolean\", \"isAadIdentity\": \"boolean\", \"isContainer\": \"boolean\", \"isDeletedInOrigin\": \"boolean\", \"profileUrl\": \"string\", \"uniqueName\": \"string\"}, \"pushId\": 123, \"url\": \"string\"}, \"remoteUrl\": \"string\", \"statuses\": [{\"_links\": {\"links\": \"object\"}, \"context\": {\"genre\": \"string\", \"name\": \"string\"}, \"createdBy\": {\"directoryAlias\": \"string\", \"id\": \"string\", \"imageUrl\": \"string\", \"inactive\": \"boolean\", \"isAadIdentity\": \"boolean\", \"isContainer\": \"boolean\", \"isDeletedInOrigin\": \"boolean\", \"profileUrl\": \"string\", \"uniqueName\": \"string\"}, \"creationDate\": \"string\", \"description\": \"string\", \"id\": 123, \"state\": \"undefined\", \"targetUrl\": \"string\", \"updatedDate\": \"string\"}], \"url\": \"string\", \"workItems\": [{\"id\": \"string\", \"url\": \"string\"}]}], \"pullRequestId\": 123}}", "required": true, "schema": { "description": "Parameters that are provided in the request body when requesting to cherry pick or revert.", "type": "object", "properties": { "generatedRefName": { "description": "Proposed target branch name for the cherry pick or revert operation.", "type": "string" }, "ontoRefName": { "description": "The target branch for the cherry pick or revert operation.", "type": "string" }, "repository": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "defaultBranch": { "type": "string" }, "id": { "type": "string" }, "isDisabled": { "description": "True if the repository is disabled. False otherwise.", "type": "boolean" }, "isFork": { "description": "True if the repository was created as a fork.", "type": "boolean" }, "name": { "type": "string" }, "parentRepository": { "description": "", "type": "object", "properties": { "collection": { "description": "Reference object for a TeamProjectCollection.", "type": "object", "properties": { "id": { "description": "Collection Id.", "type": "string" }, "name": { "description": "Collection Name.", "type": "string" }, "url": { "description": "Collection REST Url.", "type": "string" } } }, "id": { "type": "string" }, "isFork": { "description": "True if the repository was created as a fork", "type": "boolean" }, "name": { "type": "string" }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "sshUrl": { "type": "string" }, "url": { "type": "string" } } }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "size": { "description": "Compressed size (bytes) of the repository.", "type": "integer" }, "sshUrl": { "type": "string" }, "url": { "type": "string" }, "validRemoteUrls": { "type": "array", "items": { "type": "string" } }, "webUrl": { "type": "string" } } }, "source": { "description": "GitAsyncRefOperationSource specifies the pull request or list of commits to use when making a cherry pick and revert operation request. Only one should be provided.", "type": "object", "properties": { "commitList": { "description": "A list of commits to cherry pick or revert", "type": "array", "items": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } } }, "pullRequestId": { "description": "Id of the pull request to cherry pick or revert", "type": "integer" } } } } } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "ID of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/cherryPicksCreate" }, "task": true }, { "name": "cherryPicksGetCherryPickForRefName", "summary": "Retrieve information about a cherry pick operation for a specific branch. This operation is expensi", "description": "Retrieve information about a cherry pick operation for a specific branch. This operation is expensive due to the underlying object structure, so this API only looks at the 1000 most recent cherry pick operations.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "ID of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "refName", "type": "string", "info": "The GitAsyncRefOperationParameters generatedRefName used for the cherry pick operation.: string", "required": true, "schema": { "title": "refName", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/cherryPicksGetCherryPickForRefName" }, "task": true }, { "name": "cherryPicksGetCherryPick", "summary": "Retrieve information about a cherry pick operation by cherry pick Id.", "description": "Retrieve information about a cherry pick operation by cherry pick Id.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "cherryPickId", "type": "number", "info": "ID of the cherry pick.: 123", "required": true, "schema": { "title": "cherryPickId", "type": "number" } }, { "name": "repositoryId", "type": "string", "info": "ID of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/cherryPicksGetCherryPick" }, "task": true }, { "name": "commitsGetPushCommits", "summary": "Retrieve a list of commits associated with a particular push.", "description": "Retrieve a list of commits associated with a particular push.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The id or friendly name of the repository. To use the friendly name, projectId must also be specified.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pushId", "type": "number", "info": "The id of the push.: 123", "required": true, "schema": { "title": "pushId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "top", "type": "number", "info": "The maximum number of commits to return (\"get the top x commits\").: 123", "required": false, "schema": { "title": "top", "type": "number" } }, { "name": "skip", "type": "number", "info": "The number of commits to skip.: 123", "required": false, "schema": { "title": "skip", "type": "number" } }, { "name": "includeLinks", "type": "boolean", "info": "Set to false to avoid including REST Url links for resources. Defaults to true.: boolean", "required": false, "schema": { "title": "includeLinks", "type": "boolean" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/commitsGetPushCommits" }, "task": true }, { "name": "commitsGet", "summary": "Retrieve a particular commit.", "description": "Retrieve a particular commit.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "commitId", "type": "string", "info": "The id of the commit.: string", "required": true, "schema": { "title": "commitId", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The id or friendly name of the repository. To use the friendly name, projectId must also be specified.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "changeCount", "type": "number", "info": "The number of changes to include in the result.: 123", "required": false, "schema": { "title": "changeCount", "type": "number" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/commitsGet" }, "task": true }, { "name": "commitsGetCommits", "summary": "Retrieve git commits for a project.", "description": "Retrieve git commits for a project.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The id or friendly name of the repository. To use the friendly name, projectId must also be specified.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": false, "schema": { "title": "project", "type": "string" } }, { "name": "skip", "type": "number", "info": "Number of entries to skip", "required": false, "schema": { "title": "skip", "type": "number" } }, { "name": "top", "type": "number", "info": "Maximum number of entries to retrieve", "required": false, "schema": { "title": "top", "type": "number" } }, { "name": "searchCriteriaAuthor", "type": "string", "info": "Alias or display name of the author", "required": false, "schema": { "title": "searchCriteriaAuthor", "type": "string" } }, { "name": "searchCriteriaCompareVersionVersion", "type": "string", "info": "Version string identifier (name of tag/branch, SHA1 of commit)", "required": false, "schema": { "title": "searchCriteriaCompareVersionVersion", "type": "string" } }, { "name": "searchCriteriaCompareVersionVersionOptions", "type": "string", "info": "Version options - Specify additional modifiers to version (e.g Previous)", "required": false, "schema": { "title": "searchCriteriaCompareVersionVersionOptions", "type": "string" } }, { "name": "searchCriteriaCompareVersionVersionType", "type": "string", "info": "Version type (branch, tag, or commit). Determines how Id is interpreted", "required": false, "schema": { "title": "searchCriteriaCompareVersionVersionType", "type": "string" } }, { "name": "searchCriteriaExcludeDeletes", "type": "boolean", "info": "Only applies when an itemPath is specified. This determines whether to exclude delete entries of the specified path.", "required": false, "schema": { "title": "searchCriteriaExcludeDeletes", "type": "boolean" } }, { "name": "searchCriteriaFromCommitId", "type": "string", "info": "If provided, a lower bound for filtering commits alphabetically", "required": false, "schema": { "title": "searchCriteriaFromCommitId", "type": "string" } }, { "name": "searchCriteriaFromDate", "type": "string", "info": "If provided, only include history entries created after this date (string)", "required": false, "schema": { "title": "searchCriteriaFromDate", "type": "string" } }, { "name": "searchCriteriaHistoryMode", "type": "string", "info": "What Git history mode should be used. This only applies to the search criteria when Ids = null and an itemPath is specified.", "required": false, "schema": { "title": "searchCriteriaHistoryMode", "type": "string" } }, { "name": "searchCriteriaIds", "type": "array", "info": "If provided, specifies the exact commit ids of the commits to fetch. May not be combined with other parameters.", "required": false, "schema": { "title": "searchCriteriaIds", "type": "array" } }, { "name": "searchCriteriaIncludeLinks", "type": "boolean", "info": "Whether to include the _links field on the shallow references", "required": false, "schema": { "title": "searchCriteriaIncludeLinks", "type": "boolean" } }, { "name": "searchCriteriaIncludePushData", "type": "boolean", "info": "Whether to include the push information", "required": false, "schema": { "title": "searchCriteriaIncludePushData", "type": "boolean" } }, { "name": "searchCriteriaIncludeUserImageUrl", "type": "boolean", "info": "Whether to include the image Url for committers and authors", "required": false, "schema": { "title": "searchCriteriaIncludeUserImageUrl", "type": "boolean" } }, { "name": "searchCriteriaIncludeWorkItems", "type": "boolean", "info": "Whether to include linked work items", "required": false, "schema": { "title": "searchCriteriaIncludeWorkItems", "type": "boolean" } }, { "name": "searchCriteriaItemPath", "type": "string", "info": "Path of item to search under", "required": false, "schema": { "title": "searchCriteriaItemPath", "type": "string" } }, { "name": "searchCriteriaItemVersionVersion", "type": "string", "info": "Version string identifier (name of tag/branch, SHA1 of commit)", "required": false, "schema": { "title": "searchCriteriaItemVersionVersion", "type": "string" } }, { "name": "searchCriteriaItemVersionVersionOptions", "type": "string", "info": "Version options - Specify additional modifiers to version (e.g Previous)", "required": false, "schema": { "title": "searchCriteriaItemVersionVersionOptions", "type": "string" } }, { "name": "searchCriteriaItemVersionVersionType", "type": "string", "info": "Version type (branch, tag, or commit). Determines how Id is interpreted", "required": false, "schema": { "title": "searchCriteriaItemVersionVersionType", "type": "string" } }, { "name": "searchCriteriaShowOldestCommitsFirst", "type": "boolean", "info": "If enabled, this option will ignore the itemVersion and compareVersion parameters", "required": false, "schema": { "title": "searchCriteriaShowOldestCommitsFirst", "type": "boolean" } }, { "name": "searchCriteriaToCommitId", "type": "string", "info": "If provided, an upper bound for filtering commits alphabetically", "required": false, "schema": { "title": "searchCriteriaToCommitId", "type": "string" } }, { "name": "searchCriteriaToDate", "type": "string", "info": "If provided, only include history entries created before this date (string)", "required": false, "schema": { "title": "searchCriteriaToDate", "type": "string" } }, { "name": "searchCriteriaUser", "type": "string", "info": "Alias or display name of the committer", "required": false, "schema": { "title": "searchCriteriaUser", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/commitsGet" }, "task": true }, { "name": "commitsGetChanges", "summary": "Retrieve changes for a particular commit.", "description": "Retrieve changes for a particular commit.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "commitId", "type": "string", "info": "The id of the commit.: string", "required": true, "schema": { "title": "commitId", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The id or friendly name of the repository. To use the friendly name, projectId must also be specified.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "top", "type": "number", "info": "The maximum number of changes to return.: 123", "required": false, "schema": { "title": "top", "type": "number" } }, { "name": "skip", "type": "number", "info": "The number of changes to skip.: 123", "required": false, "schema": { "title": "skip", "type": "number" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/commitsGetChanges" }, "task": true }, { "name": "commitsGetCommitsBatch", "summary": "Retrieve git commits for a project matching the search criteria", "description": "Retrieve git commits for a project matching the search criteria", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": "Search options: {\"$skip\": 123, \"$top\": 123, \"author\": \"string\", \"compareVersion\": {\"version\": \"string\", \"versionOptions\": \"undefined\", \"versionType\": \"undefined\"}, \"excludeDeletes\": \"boolean\", \"fromCommitId\": \"string\", \"fromDate\": \"string\", \"historyMode\": \"undefined\", \"ids\": \"array\", \"includeLinks\": \"boolean\", \"includePushData\": \"boolean\", \"includeUserImageUrl\": \"boolean\", \"includeWorkItems\": \"boolean\", \"itemPath\": \"string\", \"itemVersion\": {\"version\": \"string\", \"versionOptions\": \"undefined\", \"versionType\": \"undefined\"}, \"showOldestCommitsFirst\": \"boolean\", \"toCommitId\": \"string\", \"toDate\": \"string\", \"user\": \"string\"}", "required": true, "schema": { "description": "", "type": "object", "properties": { "$skip": { "description": "Number of entries to skip", "type": "integer" }, "$top": { "description": "Maximum number of entries to retrieve", "type": "integer" }, "author": { "description": "Alias or display name of the author", "type": "string" }, "compareVersion": { "description": "", "type": "object", "properties": { "version": { "description": "Version string identifier (name of tag/branch, SHA1 of commit)", "type": "string" }, "versionOptions": { "description": "Version options - Specify additional modifiers to version (e.g Previous)", "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^)" } ] } }, "versionType": { "description": "Version type (branch, tag, or commit). Determines how Id is interpreted", "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)" } ] } } } }, "excludeDeletes": { "description": "Only applies when an itemPath is specified. This determines whether to exclude delete entries of the specified path.", "type": "boolean" }, "fromCommitId": { "description": "If provided, a lower bound for filtering commits alphabetically", "type": "string" }, "fromDate": { "description": "If provided, only include history entries created after this date (string)", "type": "string" }, "historyMode": { "description": "What Git history mode should be used. This only applies to the search criteria when Ids = null and an itemPath is specified.", "enum": [ "simplifiedHistory", "firstParent", "fullHistory", "fullHistorySimplifyMerges" ], "x-ms-enum": { "name": "GitHistoryMode", "values": [ { "value": "simplifiedHistory", "description": "The history mode used by `git log`. This is the default." }, { "value": "firstParent", "description": "The history mode used by `git log --first-parent`" }, { "value": "fullHistory", "description": "The history mode used by `git log --full-history`" }, { "value": "fullHistorySimplifyMerges", "description": "The history mode used by `git log --full-history --simplify-merges`" } ] } }, "ids": { "description": "If provided, specifies the exact commit ids of the commits to fetch. May not be combined with other parameters.", "type": "array", "items": { "type": "string" } }, "includeLinks": { "description": "Whether to include the _links field on the shallow references", "type": "boolean" }, "includePushData": { "description": "Whether to include the push information", "type": "boolean" }, "includeUserImageUrl": { "description": "Whether to include the image Url for committers and authors", "type": "boolean" }, "includeWorkItems": { "description": "Whether to include linked work items", "type": "boolean" }, "itemPath": { "description": "Path of item to search under", "type": "string" }, "itemVersion": { "description": "", "type": "object", "properties": { "version": { "description": "Version string identifier (name of tag/branch, SHA1 of commit)", "type": "string" }, "versionOptions": { "description": "Version options - Specify additional modifiers to version (e.g Previous)", "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^)" } ] } }, "versionType": { "description": "Version type (branch, tag, or commit). Determines how Id is interpreted", "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)" } ] } } } }, "showOldestCommitsFirst": { "description": "If enabled, this option will ignore the itemVersion and compareVersion parameters", "type": "boolean" }, "toCommitId": { "description": "If provided, an upper bound for filtering commits alphabetically", "type": "string" }, "toDate": { "description": "If provided, only include history entries created before this date (string)", "type": "string" }, "user": { "description": "Alias or display name of the committer", "type": "string" } } } }, { "name": "repositoryId", "type": "string", "info": "The name or ID of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "skip", "type": "number", "info": "Number of commits to skip.: 123", "required": false, "schema": { "title": "skip", "type": "number" } }, { "name": "top", "type": "number", "info": "Maximum number of commits to return.: 123", "required": false, "schema": { "title": "top", "type": "number" } }, { "name": "includeStatuses", "type": "boolean", "info": "True to include additional commit status information.: boolean", "required": false, "schema": { "title": "includeStatuses", "type": "boolean" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/commitsGetCommitsBatch" }, "task": true }, { "name": "statusesCreate", "summary": "Create Git commit status.", "description": "Create Git commit status.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": "Git commit status object to create.: {\"_links\": {\"links\": \"object\"}, \"context\": {\"genre\": \"string\", \"name\": \"string\"}, \"createdBy\": {\"directoryAlias\": \"string\", \"id\": \"string\", \"imageUrl\": \"string\", \"inactive\": \"boolean\", \"isAadIdentity\": \"boolean\", \"isContainer\": \"boolean\", \"isDeletedInOrigin\": \"boolean\", \"profileUrl\": \"string\", \"uniqueName\": \"string\"}, \"creationDate\": \"string\", \"description\": \"string\", \"id\": 123, \"state\": \"undefined\", \"targetUrl\": \"string\", \"updatedDate\": \"string\"}", "required": true, "schema": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, { "name": "commitId", "type": "string", "info": "ID of the Git commit.: string", "required": true, "schema": { "title": "commitId", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "ID of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/statusesCreate" }, "task": true }, { "name": "statusesList", "summary": "Get statuses associated with the Git commit.", "description": "Get statuses associated with the Git commit.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "commitId", "type": "string", "info": "ID of the Git commit.: string", "required": true, "schema": { "title": "commitId", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "ID of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "top", "type": "number", "info": "Optional. The number of statuses to retrieve. Default is 1000.: 123", "required": false, "schema": { "title": "top", "type": "number" } }, { "name": "skip", "type": "number", "info": "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.: 123", "required": false, "schema": { "title": "skip", "type": "number" } }, { "name": "latestOnly", "type": "boolean", "info": "The flag indicates whether to get only latest statuses grouped by `Context.Name` and `Context.Genre`.: boolean", "required": false, "schema": { "title": "latestOnly", "type": "boolean" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/statusesList" }, "task": true }, { "name": "diffsGet", "summary": "Find the closest common commit (the merge base) between base and target commits, and get the diff b", "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.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The name or ID of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "diffCommonCommit", "type": "boolean", "info": "If true, diff between common and target commits. If false, diff between base and target commits.: boolean", "required": false, "schema": { "title": "diffCommonCommit", "type": "boolean" } }, { "name": "top", "type": "number", "info": "Maximum number of changes to return. Defaults to 100.: 123", "required": false, "schema": { "title": "top", "type": "number" } }, { "name": "skip", "type": "number", "info": "Number of changes to skip: 123", "required": false, "schema": { "title": "skip", "type": "number" } }, { "name": "baseVersion", "type": "string", "info": "Version string identifier (name of tag/branch, SHA1 of commit): string", "required": false, "schema": { "title": "baseVersion", "type": "string" } }, { "name": "baseVersionOptions", "type": "string", "info": "Version options - Specify additional modifiers to version (e.g Previous): Must be one of [none, previousChange, firstParent]", "required": false, "schema": { "title": "baseVersionOptions", "type": "string" } }, { "name": "baseVersionType", "type": "string", "info": "Version type (branch, tag, or commit). Determines how Id is interpreted: Must be one of [branch, tag, commit]", "required": false, "schema": { "title": "baseVersionType", "type": "string" } }, { "name": "targetVersion", "type": "string", "info": "Version string identifier (name of tag/branch, SHA1 of commit): string", "required": false, "schema": { "title": "targetVersion", "type": "string" } }, { "name": "targetVersionOptions", "type": "string", "info": "Version options - Specify additional modifiers to version (e.g Previous): Must be one of [none, previousChange, firstParent]", "required": false, "schema": { "title": "targetVersionOptions", "type": "string" } }, { "name": "targetVersionType", "type": "string", "info": "Version type (branch, tag, or commit). Determines how Id is interpreted: Must be one of [branch, tag, commit]", "required": false, "schema": { "title": "targetVersionType", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/diffsGet" }, "task": true }, { "name": "importRequestsCreate", "summary": "Create an import request.", "description": "Create an import request.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": "The import request to create.: {\"_links\": {\"links\": \"object\"}, \"detailedStatus\": {\"allSteps\": \"array\", \"currentStep\": 123, \"errorMessage\": \"string\"}, \"importRequestId\": 123, \"parameters\": {\"deleteServiceEndpointAfterImportIsDone\": \"boolean\", \"gitSource\": {\"overwrite\": \"boolean\", \"url\": \"string\"}, \"serviceEndpointId\": \"string\", \"tfvcSource\": {\"importHistory\": \"boolean\", \"importHistoryDurationInDays\": 123, \"path\": \"string\"}}, \"repository\": {\"_links\": {\"links\": \"object\"}, \"defaultBranch\": \"string\", \"id\": \"string\", \"isDisabled\": \"boolean\", \"isFork\": \"boolean\", \"name\": \"string\", \"parentRepository\": {\"collection\": {\"id\": \"string\", \"name\": \"string\", \"url\": \"string\"}, \"id\": \"string\", \"isFork\": \"boolean\", \"name\": \"string\", \"project\": {\"abbreviation\": \"string\", \"defaultTeamImageUrl\": \"string\", \"description\": \"string\", \"id\": \"string\", \"lastUpdateTime\": \"string\", \"name\": \"string\", \"revision\": 123, \"state\": \"undefined\", \"url\": \"string\", \"visibility\": \"undefined\"}, \"remoteUrl\": \"string\", \"sshUrl\": \"string\", \"url\": \"string\"}, \"project\": {\"abbreviation\": \"string\", \"defaultTeamImageUrl\": \"string\", \"description\": \"string\", \"id\": \"string\", \"lastUpdateTime\": \"string\", \"name\": \"string\", \"revision\": 123, \"state\": \"undefined\", \"url\": \"string\", \"visibility\": \"undefined\"}, \"remoteUrl\": \"string\", \"size\": 123, \"sshUrl\": \"string\", \"url\": \"string\", \"validRemoteUrls\": \"array\", \"webUrl\": \"string\"}, \"status\": \"undefined\", \"url\": \"string\"}", "required": true, "schema": { "description": "A request to import data from a remote source control system.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "detailedStatus": { "description": "Additional status information about an import request.", "type": "object", "properties": { "allSteps": { "description": "All valid steps for the import process", "type": "array", "items": { "type": "string" } }, "currentStep": { "description": "Index into AllSteps for the current step", "type": "integer" }, "errorMessage": { "description": "Error message if the operation failed.", "type": "string" } } }, "importRequestId": { "description": "The unique identifier for this import request.", "type": "integer" }, "parameters": { "description": "Parameters for creating an import request", "type": "object", "properties": { "deleteServiceEndpointAfterImportIsDone": { "description": "Option to delete service endpoint when import is done", "type": "boolean" }, "gitSource": { "description": "Parameter for creating a git import request when source is Git version control", "type": "object", "properties": { "overwrite": { "description": "Tells if this is a sync request or not", "type": "boolean" }, "url": { "description": "Url for the source repo", "type": "string" } } }, "serviceEndpointId": { "description": "Service Endpoint for connection to external endpoint", "type": "string" }, "tfvcSource": { "description": "Parameter for creating a git import request when source is tfvc version control", "type": "object", "properties": { "importHistory": { "description": "Set true to import History, false otherwise", "type": "boolean" }, "importHistoryDurationInDays": { "description": "Get history for last n days (max allowed value is 180 days)", "type": "integer" }, "path": { "description": "Path which we want to import (this can be copied from Path Control in Explorer)", "type": "string" } } } } }, "repository": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "defaultBranch": { "type": "string" }, "id": { "type": "string" }, "isDisabled": { "description": "True if the repository is disabled. False otherwise.", "type": "boolean" }, "isFork": { "description": "True if the repository was created as a fork.", "type": "boolean" }, "name": { "type": "string" }, "parentRepository": { "description": "", "type": "object", "properties": { "collection": { "description": "Reference object for a TeamProjectCollection.", "type": "object", "properties": { "id": { "description": "Collection Id.", "type": "string" }, "name": { "description": "Collection Name.", "type": "string" }, "url": { "description": "Collection REST Url.", "type": "string" } } }, "id": { "type": "string" }, "isFork": { "description": "True if the repository was created as a fork", "type": "boolean" }, "name": { "type": "string" }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "sshUrl": { "type": "string" }, "url": { "type": "string" } } }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "size": { "description": "Compressed size (bytes) of the repository.", "type": "integer" }, "sshUrl": { "type": "string" }, "url": { "type": "string" }, "validRemoteUrls": { "type": "array", "items": { "type": "string" } }, "webUrl": { "type": "string" } } }, "status": { "description": "Current status of the import.", "enum": [ "queued", "inProgress", "completed", "failed", "abandoned" ], "x-ms-enum": { "name": "GitAsyncOperationStatus", "values": [ { "value": "queued", "description": "The operation is waiting in a queue and has not yet started." }, { "value": "inProgress", "description": "The operation is currently in progress." }, { "value": "completed", "description": "The operation has completed." }, { "value": "failed", "description": "The operation has failed. Check for an error message." }, { "value": "abandoned", "description": "The operation has been abandoned." } ] } }, "url": { "description": "A link back to this import request resource.", "type": "string" } } } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The name or ID of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/importRequestsCreate" }, "task": true }, { "name": "importRequestsQuery", "summary": "Retrieve import requests for a repository.", "description": "Retrieve import requests for a repository.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The name or ID of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "includeAbandoned", "type": "boolean", "info": "True to include abandoned import requests in the results.: boolean", "required": false, "schema": { "title": "includeAbandoned", "type": "boolean" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "A request to import data from a remote source control system.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "detailedStatus": { "description": "Additional status information about an import request.", "type": "object", "properties": { "allSteps": { "description": "All valid steps for the import process", "type": "array", "items": { "type": "string" } }, "currentStep": { "description": "Index into AllSteps for the current step", "type": "integer" }, "errorMessage": { "description": "Error message if the operation failed.", "type": "string" } } }, "importRequestId": { "description": "The unique identifier for this import request.", "type": "integer" }, "parameters": { "description": "Parameters for creating an import request", "type": "object", "properties": { "deleteServiceEndpointAfterImportIsDone": { "description": "Option to delete service endpoint when import is done", "type": "boolean" }, "gitSource": { "description": "Parameter for creating a git import request when source is Git version control", "type": "object", "properties": { "overwrite": { "description": "Tells if this is a sync request or not", "type": "boolean" }, "url": { "description": "Url for the source repo", "type": "string" } } }, "serviceEndpointId": { "description": "Service Endpoint for connection to external endpoint", "type": "string" }, "tfvcSource": { "description": "Parameter for creating a git import request when source is tfvc version control", "type": "object", "properties": { "importHistory": { "description": "Set true to import History, false otherwise", "type": "boolean" }, "importHistoryDurationInDays": { "description": "Get history for last n days (max allowed value is 180 days)", "type": "integer" }, "path": { "description": "Path which we want to import (this can be copied from Path Control in Explorer)", "type": "string" } } } } }, "repository": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "defaultBranch": { "type": "string" }, "id": { "type": "string" }, "isDisabled": { "description": "True if the repository is disabled. False otherwise.", "type": "boolean" }, "isFork": { "description": "True if the repository was created as a fork.", "type": "boolean" }, "name": { "type": "string" }, "parentRepository": { "description": "", "type": "object", "properties": { "collection": { "description": "Reference object for a TeamProjectCollection.", "type": "object", "properties": { "id": { "description": "Collection Id.", "type": "string" }, "name": { "description": "Collection Name.", "type": "string" }, "url": { "description": "Collection REST Url.", "type": "string" } } }, "id": { "type": "string" }, "isFork": { "description": "True if the repository was created as a fork", "type": "boolean" }, "name": { "type": "string" }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "sshUrl": { "type": "string" }, "url": { "type": "string" } } }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "size": { "description": "Compressed size (bytes) of the repository.", "type": "integer" }, "sshUrl": { "type": "string" }, "url": { "type": "string" }, "validRemoteUrls": { "type": "array", "items": { "type": "string" } }, "webUrl": { "type": "string" } } }, "status": { "description": "Current status of the import.", "enum": [ "queued", "inProgress", "completed", "failed", "abandoned" ], "x-ms-enum": { "name": "GitAsyncOperationStatus", "values": [ { "value": "queued", "description": "The operation is waiting in a queue and has not yet started." }, { "value": "inProgress", "description": "The operation is currently in progress." }, { "value": "completed", "description": "The operation has completed." }, { "value": "failed", "description": "The operation has failed. Check for an error message." }, { "value": "abandoned", "description": "The operation has been abandoned." } ] } }, "url": { "description": "A link back to this import request resource.", "type": "string" } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/importRequestsQuery" }, "task": true }, { "name": "importRequestsGet", "summary": "Retrieve a particular import request.", "description": "Retrieve a particular import request.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The name or ID of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "importRequestId", "type": "number", "info": "The unique identifier for the import request.: 123", "required": true, "schema": { "title": "importRequestId", "type": "number" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/importRequestsGet" }, "task": true }, { "name": "importRequestsUpdate", "summary": "Retry or abandon a failed import request.\n\nThere can only be one active import request associated w", "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.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": "The updated version of the import request. Currently, the only change allowed is setting the Status to Queued or Abandoned.: {\"_links\": {\"links\": \"object\"}, \"detailedStatus\": {\"allSteps\": \"array\", \"currentStep\": 123, \"errorMessage\": \"string\"}, \"importRequestId\": 123, \"parameters\": {\"deleteServiceEndpointAfterImportIsDone\": \"boolean\", \"gitSource\": {\"overwrite\": \"boolean\", \"url\": \"string\"}, \"serviceEndpointId\": \"string\", \"tfvcSource\": {\"importHistory\": \"boolean\", \"importHistoryDurationInDays\": 123, \"path\": \"string\"}}, \"repository\": {\"_links\": {\"links\": \"object\"}, \"defaultBranch\": \"string\", \"id\": \"string\", \"isDisabled\": \"boolean\", \"isFork\": \"boolean\", \"name\": \"string\", \"parentRepository\": {\"collection\": {\"id\": \"string\", \"name\": \"string\", \"url\": \"string\"}, \"id\": \"string\", \"isFork\": \"boolean\", \"name\": \"string\", \"project\": {\"abbreviation\": \"string\", \"defaultTeamImageUrl\": \"string\", \"description\": \"string\", \"id\": \"string\", \"lastUpdateTime\": \"string\", \"name\": \"string\", \"revision\": 123, \"state\": \"undefined\", \"url\": \"string\", \"visibility\": \"undefined\"}, \"remoteUrl\": \"string\", \"sshUrl\": \"string\", \"url\": \"string\"}, \"project\": {\"abbreviation\": \"string\", \"defaultTeamImageUrl\": \"string\", \"description\": \"string\", \"id\": \"string\", \"lastUpdateTime\": \"string\", \"name\": \"string\", \"revision\": 123, \"state\": \"undefined\", \"url\": \"string\", \"visibility\": \"undefined\"}, \"remoteUrl\": \"string\", \"size\": 123, \"sshUrl\": \"string\", \"url\": \"string\", \"validRemoteUrls\": \"array\", \"webUrl\": \"string\"}, \"status\": \"undefined\", \"url\": \"string\"}", "required": true, "schema": { "description": "A request to import data from a remote source control system.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "detailedStatus": { "description": "Additional status information about an import request.", "type": "object", "properties": { "allSteps": { "description": "All valid steps for the import process", "type": "array", "items": { "type": "string" } }, "currentStep": { "description": "Index into AllSteps for the current step", "type": "integer" }, "errorMessage": { "description": "Error message if the operation failed.", "type": "string" } } }, "importRequestId": { "description": "The unique identifier for this import request.", "type": "integer" }, "parameters": { "description": "Parameters for creating an import request", "type": "object", "properties": { "deleteServiceEndpointAfterImportIsDone": { "description": "Option to delete service endpoint when import is done", "type": "boolean" }, "gitSource": { "description": "Parameter for creating a git import request when source is Git version control", "type": "object", "properties": { "overwrite": { "description": "Tells if this is a sync request or not", "type": "boolean" }, "url": { "description": "Url for the source repo", "type": "string" } } }, "serviceEndpointId": { "description": "Service Endpoint for connection to external endpoint", "type": "string" }, "tfvcSource": { "description": "Parameter for creating a git import request when source is tfvc version control", "type": "object", "properties": { "importHistory": { "description": "Set true to import History, false otherwise", "type": "boolean" }, "importHistoryDurationInDays": { "description": "Get history for last n days (max allowed value is 180 days)", "type": "integer" }, "path": { "description": "Path which we want to import (this can be copied from Path Control in Explorer)", "type": "string" } } } } }, "repository": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "defaultBranch": { "type": "string" }, "id": { "type": "string" }, "isDisabled": { "description": "True if the repository is disabled. False otherwise.", "type": "boolean" }, "isFork": { "description": "True if the repository was created as a fork.", "type": "boolean" }, "name": { "type": "string" }, "parentRepository": { "description": "", "type": "object", "properties": { "collection": { "description": "Reference object for a TeamProjectCollection.", "type": "object", "properties": { "id": { "description": "Collection Id.", "type": "string" }, "name": { "description": "Collection Name.", "type": "string" }, "url": { "description": "Collection REST Url.", "type": "string" } } }, "id": { "type": "string" }, "isFork": { "description": "True if the repository was created as a fork", "type": "boolean" }, "name": { "type": "string" }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "sshUrl": { "type": "string" }, "url": { "type": "string" } } }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "size": { "description": "Compressed size (bytes) of the repository.", "type": "integer" }, "sshUrl": { "type": "string" }, "url": { "type": "string" }, "validRemoteUrls": { "type": "array", "items": { "type": "string" } }, "webUrl": { "type": "string" } } }, "status": { "description": "Current status of the import.", "enum": [ "queued", "inProgress", "completed", "failed", "abandoned" ], "x-ms-enum": { "name": "GitAsyncOperationStatus", "values": [ { "value": "queued", "description": "The operation is waiting in a queue and has not yet started." }, { "value": "inProgress", "description": "The operation is currently in progress." }, { "value": "completed", "description": "The operation has completed." }, { "value": "failed", "description": "The operation has failed. Check for an error message." }, { "value": "abandoned", "description": "The operation has been abandoned." } ] } }, "url": { "description": "A link back to this import request resource.", "type": "string" } } } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The name or ID of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "importRequestId", "type": "number", "info": "The unique identifier for the import request to update.: 123", "required": true, "schema": { "title": "importRequestId", "type": "number" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/importRequestsUpdate" }, "task": true }, { "name": "itemsList", "summary": "Get Item Metadata and/or Content for a collection of items. The download parameter is to indicate w", "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.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The name or ID of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "itemPath", "type": "string", "info": "The item path.", "required": false, "schema": { "title": "itemPath", "type": "string" } }, { "name": "scopePath", "type": "string", "info": "The path scope. The default is null.: string", "required": false, "schema": { "title": "scopePath", "type": "string" } }, { "name": "recursionLevel", "type": "string", "info": "The recursion level of this request. The default is 'none', no recursion.: Must be one of [none, oneLevel, oneLevelPlusNestedEmptyFolders, full]", "required": false, "schema": { "title": "recursionLevel", "type": "string" } }, { "name": "includeContentMetadata", "type": "boolean", "info": "Set to true to include content metadata. Default is false.: boolean", "required": false, "schema": { "title": "includeContentMetadata", "type": "boolean" } }, { "name": "latestProcessedChange", "type": "boolean", "info": "Set to true to include the latest changes. Default is false.: boolean", "required": false, "schema": { "title": "latestProcessedChange", "type": "boolean" } }, { "name": "download", "type": "boolean", "info": "Set to true to download the response as a file. Default is false.: boolean", "required": false, "schema": { "title": "download", "type": "boolean" } }, { "name": "includeLinks", "type": "boolean", "info": "Set to true to include links to items. Default is false.: boolean", "required": false, "schema": { "title": "includeLinks", "type": "boolean" } }, { "name": "includeContent", "type": "boolean", "info": "Set to true to include item content when requesting json. Default is false.", "required": false, "schema": { "title": "includeContent", "type": "boolean" } }, { "name": "resolveLfs", "type": "boolean", "info": "Set to true to resolve Git LFS pointer files to return actual content from Git LFS. Default is false.", "required": false, "schema": { "title": "resolveLfs", "type": "boolean" } }, { "name": "format", "type": "string", "info": "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 quer...(description truncated): string", "required": false, "schema": { "title": "format", "type": "string" } }, { "name": "versionDescriptorVersion", "type": "string", "info": "Version string identifier (name of tag/branch, SHA1 of commit): string", "required": false, "schema": { "title": "versionDescriptorVersion", "type": "string" } }, { "name": "versionDescriptorVersionOptions", "type": "string", "info": "Version options - Specify additional modifiers to version (e.g Previous): Must be one of [none, previousChange, firstParent]", "required": false, "schema": { "title": "versionDescriptorVersionOptions", "type": "string" } }, { "name": "versionDescriptorVersionType", "type": "string", "info": "Version type (branch, tag, or commit). Determines how Id is interpreted: Must be one of [branch, tag, commit]", "required": false, "schema": { "title": "versionDescriptorVersionType", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "content": { "type": "string" }, "contentMetadata": { "description": "", "type": "object", "properties": { "contentType": { "type": "string" }, "encoding": { "type": "integer" }, "extension": { "type": "string" }, "fileName": { "type": "string" }, "isBinary": { "type": "boolean" }, "isImage": { "type": "boolean" }, "vsLink": { "type": "string" } } }, "isFolder": { "type": "boolean" }, "isSymLink": { "type": "boolean" }, "path": { "type": "string" }, "url": { "type": "string" } } } ], "properties": { "commitId": { "description": "SHA1 of commit item was fetched at", "type": "string" }, "gitObjectType": { "description": "Type of object (Commit, Tree, Blob, Tag, ...)", "enum": [ "bad", "commit", "tree", "blob", "tag", "ext2", "ofsDelta", "refDelta" ], "x-ms-enum": { "name": "GitObjectType", "values": [ { "value": "bad", "description": "" }, { "value": "commit", "description": "" }, { "value": "tree", "description": "" }, { "value": "blob", "description": "" }, { "value": "tag", "description": "" }, { "value": "ext2", "description": "" }, { "value": "ofsDelta", "description": "" }, { "value": "refDelta", "description": "" } ] } }, "latestProcessedChange": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } }, "objectId": { "description": "Git object id", "type": "string" }, "originalObjectId": { "description": "Git object id", "type": "string" } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/itemsList" }, "task": true }, { "name": "itemsGetItemsBatch", "summary": "Post for retrieving a creating a batch out of a set of items in a repo / project given a list of pa", "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", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": "Request data attributes: ItemDescriptors, IncludeContentMetadata, LatestProcessedChange, IncludeLinks. ItemDescriptors: Collection of items to fetch, including path, vers...(description truncated): {\"includeContentMetadata\": \"boolean\", \"includeLinks\": \"boolean\", \"itemDescriptors\": [{\"path\": \"string\", \"recursionLevel\": \"undefined\", \"version\": \"string\", \"versionOptions\": \"undefined\", \"versionType\": \"undefined\"}], \"latestProcessedChange\": \"boolean\"}", "required": true, "schema": { "description": "", "type": "object", "properties": { "includeContentMetadata": { "description": "Whether to include metadata for all items", "type": "boolean" }, "includeLinks": { "description": "Whether to include the _links field on the shallow references", "type": "boolean" }, "itemDescriptors": { "description": "Collection of items to fetch, including path, version, and recursion level", "type": "array", "items": { "description": "", "type": "object", "properties": { "path": { "description": "Path to item", "type": "string" }, "recursionLevel": { "description": "Specifies whether to include children (OneLevel), all descendants (Full), or None", "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" } ] } }, "version": { "description": "Version string (interpretation based on VersionType defined in subclass", "type": "string" }, "versionOptions": { "description": "Version modifiers (e.g. previous)", "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^)" } ] } }, "versionType": { "description": "How to interpret version (branch,tag,commit)", "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)" } ] } } } } }, "latestProcessedChange": { "description": "Whether to include shallow ref to commit that last changed each item", "type": "boolean" } } } }, { "name": "repositoryId", "type": "string", "info": "The name or ID of the repository: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "type": "array" } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/itemsGetItemsBatch" }, "task": true }, { "name": "pullRequestQueryGet", "summary": "This API is used to find what pull requests are related to a given commit. It can be used to eithe", "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.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": "The list of queries to perform.: {\"queries\": [{\"items\": \"array\", \"type\": \"undefined\"}], \"results\": \"array\"}", "required": true, "schema": { "description": "A set of pull request queries and their results.", "type": "object", "properties": { "queries": { "description": "The queries to perform.", "type": "array", "items": { "description": "Pull request query input parameters.", "type": "object", "properties": { "items": { "description": "The list of commit IDs to search for.", "type": "array", "items": { "type": "string" } }, "type": { "description": "The type of query to perform.", "enum": [ "notSet", "lastMergeCommit", "commit" ], "x-ms-enum": { "name": "GitPullRequestQueryType", "values": [ { "value": "notSet", "description": "No query type set." }, { "value": "lastMergeCommit", "description": "Search for pull requests that created the supplied merge commits." }, { "value": "commit", "description": "Search for pull requests that merged the supplied commits." } ] } } } } }, "results": { "description": "The results of the queries. This matches the QueryInputs list so Results[n] are the results of QueryInputs[n]. Each entry in the list is a dictionary of commit->pull requests.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "array", "items": { "description": "Represents all the data associated with a pull request.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "artifactId": { "description": "A string which uniquely identifies this pull request. To generate an artifact ID for a pull request, use this template: ```vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}```", "type": "string" }, "autoCompleteSetBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "closedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "closedDate": { "description": "The date when the pull request was closed (completed, abandoned, or merged externally).", "type": "string" }, "codeReviewId": { "description": "The code review ID of the pull request. Used internally.", "type": "integer" }, "commits": { "description": "The commits contained in the pull request.", "type": "array", "items": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } } }, "completionOptions": { "description": "Preferences about how the pull request should be completed.", "type": "object", "properties": { "autoCompleteIgnoreConfigIds": { "description": "List of any policy configuration Id's which auto-complete should not wait for. Only applies to optional policies (isBlocking == false). Auto-complete always waits for required policies (isBlocking == true).", "type": "array", "items": { "type": "integer" } }, "bypassPolicy": { "description": "If true, policies will be explicitly bypassed while the pull request is completed.", "type": "boolean" }, "bypassReason": { "description": "If policies are bypassed, this reason is stored as to why bypass was used.", "type": "string" }, "deleteSourceBranch": { "description": "If true, the source branch of the pull request will be deleted after completion.", "type": "boolean" }, "mergeCommitMessage": { "description": "If set, this will be used as the commit message of the merge commit.", "type": "string" }, "mergeStrategy": { "description": "Specify the strategy used to merge the pull request during completion. If MergeStrategy is not set to any value, a no-FF merge will be created if SquashMerge == false. If MergeStrategy is not set to any value, the pull request commits will be squashed if SquashMerge == true. The SquashMerge property is deprecated. It is recommended that you explicitly set MergeStrategy in all cases. If an explicit value is provided for MergeStrategy, the SquashMerge property will be ignored.", "enum": [ "noFastForward", "squash", "rebase", "rebaseMerge" ], "x-ms-enum": { "name": "GitPullRequestMergeStrategy", "values": [ { "value": "noFastForward", "description": "A two-parent, no-fast-forward merge. The source branch is unchanged. This is the default behavior." }, { "value": "squash", "description": "Put all changes from the pull request into a single-parent commit." }, { "value": "rebase", "description": "Rebase the source branch on top of the target branch HEAD commit, and fast-forward the target branch. The source branch is updated during the rebase operation." }, { "value": "rebaseMerge", "description": "Rebase the source branch on top of the target branch HEAD commit, and create a two-parent, no-fast-forward merge. The source branch is updated during the rebase operation." } ] } }, "squashMerge": { "description": "SquashMerge is deprecated. You should explicitly set the value of MergeStrategy. If MergeStrategy is set to any value, the SquashMerge value will be ignored. If MergeStrategy is not set, the merge strategy will be no-fast-forward if this flag is false, or squash if true.", "type": "boolean" }, "transitionWorkItems": { "description": "If true, we will attempt to transition any work items linked to the pull request into the next logical state (i.e. Active -> Resolved)", "type": "boolean" }, "triggeredByAutoComplete": { "description": "If true, the current completion attempt was triggered via auto-complete. Used internally.", "type": "boolean" } } }, "completionQueueTime": { "description": "The most recent date at which the pull request entered the queue to be completed. Used internally.", "type": "string" }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "The date when the pull request was created.", "type": "string" }, "description": { "description": "The description of the pull request.", "type": "string" }, "forkSource": { "description": "Information about a fork ref.", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "creator": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "isLocked": { "type": "boolean" }, "isLockedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "name": { "type": "string" }, "objectId": { "type": "string" }, "peeledObjectId": { "type": "string" }, "statuses": { "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "type": "string" } } } ], "properties": { "repository": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "defaultBranch": { "type": "string" }, "id": { "type": "string" }, "isDisabled": { "description": "True if the repository is disabled. False otherwise.", "type": "boolean" }, "isFork": { "description": "True if the repository was created as a fork.", "type": "boolean" }, "name": { "type": "string" }, "parentRepository": { "description": "", "type": "object", "properties": { "collection": { "description": "Reference object for a TeamProjectCollection.", "type": "object", "properties": { "id": { "description": "Collection Id.", "type": "string" }, "name": { "description": "Collection Name.", "type": "string" }, "url": { "description": "Collection REST Url.", "type": "string" } } }, "id": { "type": "string" }, "isFork": { "description": "True if the repository was created as a fork", "type": "boolean" }, "name": { "type": "string" }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "sshUrl": { "type": "string" }, "url": { "type": "string" } } }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "size": { "description": "Compressed size (bytes) of the repository.", "type": "integer" }, "sshUrl": { "type": "string" }, "url": { "type": "string" }, "validRemoteUrls": { "type": "array", "items": { "type": "string" } }, "webUrl": { "type": "string" } } } } }, "hasMultipleMergeBases": { "description": "Multiple mergebases warning", "type": "boolean" }, "isDraft": { "description": "Draft / WIP pull request.", "type": "boolean" }, "labels": { "description": "The labels associated with the pull request.", "type": "array", "items": { "description": "The representation of a tag definition which is sent across the wire.", "type": "object", "properties": { "active": { "description": "Whether or not the tag definition is active.", "type": "boolean" }, "id": { "description": "ID of the tag definition.", "type": "string" }, "name": { "description": "The name of the tag definition.", "type": "string" }, "url": { "description": "Resource URL for the Tag Definition.", "type": "string" } } } }, "lastMergeCommit": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } }, "lastMergeSourceCommit": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } }, "lastMergeTargetCommit": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } }, "mergeFailureMessage": { "description": "If set, pull request merge failed for this reason.", "type": "string" }, "mergeFailureType": { "description": "The type of failure (if any) of the pull request merge.", "enum": [ "none", "unknown", "caseSensitive", "objectTooLarge" ], "x-ms-enum": { "name": "PullRequestMergeFailureType", "values": [ { "value": "none", "description": "Type is not set. Default type." }, { "value": "unknown", "description": "Pull request merge failure type unknown." }, { "value": "caseSensitive", "description": "Pull request merge failed due to case mismatch." }, { "value": "objectTooLarge", "description": "Pull request merge failed due to an object being too large." } ] } }, "mergeId": { "description": "The ID of the job used to run the pull request merge. Used internally.", "type": "string" }, "mergeOptions": { "description": "The options which are used when a pull request merge is created.", "type": "object", "properties": { "conflictAuthorshipCommits": { "description": "If true, conflict resolutions applied during the merge will be put in separate commits to preserve authorship info for git blame, etc.", "type": "boolean" }, "detectRenameFalsePositives": { "type": "boolean" }, "disableRenames": { "description": "If true, rename detection will not be performed during the merge.", "type": "boolean" } } }, "mergeStatus": { "description": "The current status of the pull request merge.", "enum": [ "notSet", "queued", "conflicts", "succeeded", "rejectedByPolicy", "failure" ], "x-ms-enum": { "name": "PullRequestAsyncStatus", "values": [ { "value": "notSet", "description": "Status is not set. Default state." }, { "value": "queued", "description": "Pull request merge is queued." }, { "value": "conflicts", "description": "Pull request merge failed due to conflicts." }, { "value": "succeeded", "description": "Pull request merge succeeded." }, { "value": "rejectedByPolicy", "description": "Pull request merge rejected by policy." }, { "value": "failure", "description": "Pull request merge failed." } ] } }, "pullRequestId": { "description": "The ID of the pull request.", "type": "integer" }, "remoteUrl": { "description": "Used internally.", "type": "string" }, "repository": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "defaultBranch": { "type": "string" }, "id": { "type": "string" }, "isDisabled": { "description": "True if the repository is disabled. False otherwise.", "type": "boolean" }, "isFork": { "description": "True if the repository was created as a fork.", "type": "boolean" }, "name": { "type": "string" }, "parentRepository": { "description": "", "type": "object", "properties": { "collection": { "description": "Reference object for a TeamProjectCollection.", "type": "object", "properties": { "id": { "description": "Collection Id.", "type": "string" }, "name": { "description": "Collection Name.", "type": "string" }, "url": { "description": "Collection REST Url.", "type": "string" } } }, "id": { "type": "string" }, "isFork": { "description": "True if the repository was created as a fork", "type": "boolean" }, "name": { "type": "string" }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "sshUrl": { "type": "string" }, "url": { "type": "string" } } }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "size": { "description": "Compressed size (bytes) of the repository.", "type": "integer" }, "sshUrl": { "type": "string" }, "url": { "type": "string" }, "validRemoteUrls": { "type": "array", "items": { "type": "string" } }, "webUrl": { "type": "string" } } }, "reviewers": { "description": "A list of reviewers on the pull request along with the state of their votes.", "type": "array", "items": { "description": "Identity information including a vote on a pull request.", "type": "object", "allOf": [ { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } } ], "properties": { "hasDeclined": { "description": "Indicates if this reviewer has declined to review this pull request.", "type": "boolean" }, "isFlagged": { "description": "Indicates if this reviewer is flagged for attention on this pull request.", "type": "boolean" }, "isRequired": { "description": "Indicates if this is a required reviewer for this pull request.
Branches can have policies that require particular reviewers are required for pull requests.", "type": "boolean" }, "reviewerUrl": { "description": "URL to retrieve information about this identity", "type": "string" }, "vote": { "description": "Vote on a pull request:
10 - approved 5 - approved with suggestions 0 - no vote -5 - waiting for author -10 - rejected", "type": "integer" }, "votedFor": { "description": "Groups or teams that that this reviewer contributed to.
Groups and teams can be reviewers on pull requests but can not vote directly. When a member of the group or team votes, that vote is rolled up into the group or team vote. VotedFor is a list of such votes.", "type": "array", "items": { "description": "Identity information including a vote on a pull request.", "type": "object", "allOf": [ { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } } ], "properties": { "hasDeclined": { "description": "Indicates if this reviewer has declined to review this pull request.", "type": "boolean" }, "isFlagged": { "description": "Indicates if this reviewer is flagged for attention on this pull request.", "type": "boolean" }, "isRequired": { "description": "Indicates if this is a required reviewer for this pull request.
Branches can have policies that require particular reviewers are required for pull requests.", "type": "boolean" }, "reviewerUrl": { "description": "URL to retrieve information about this identity", "type": "string" }, "vote": { "description": "Vote on a pull request:
10 - approved 5 - approved with suggestions 0 - no vote -5 - waiting for author -10 - rejected", "type": "integer" }, "votedFor": { "description": "Groups or teams that that this reviewer contributed to.
Groups and teams can be reviewers on pull requests but can not vote directly. When a member of the group or team votes, that vote is rolled up into the group or team vote. VotedFor is a list of such votes.", "type": "array", "items": { "type": "object" } } } } } } } }, "sourceRefName": { "description": "The name of the source branch of the pull request.", "type": "string" }, "status": { "description": "The status of the pull request.", "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 criteria to include all statuses." } ] } }, "supportsIterations": { "description": "If true, this pull request supports multiple iterations. Iteration support means individual pushes to the source branch of the pull request can be reviewed and comments left in one iteration will be tracked across future iterations.", "type": "boolean" }, "targetRefName": { "description": "The name of the target branch of the pull request.", "type": "string" }, "title": { "description": "The title of the pull request.", "type": "string" }, "url": { "description": "Used internally.", "type": "string" }, "workItemRefs": { "description": "Any work item references associated with this pull request.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } } } } } } } }, { "name": "repositoryId", "type": "string", "info": "ID of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestQueryGet" }, "task": true }, { "name": "pullRequestAttachmentsList", "summary": "Get a list of files attached to a given pull request.", "description": "Get a list of files attached to a given pull request.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request’s target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "Meta data for a file attached to an artifact.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "contentHash": { "description": "Content hash of on-disk representation of file content. Its calculated by the server by using SHA1 hash function.", "type": "string" }, "createdDate": { "description": "The time the attachment was uploaded.", "type": "string" }, "description": { "description": "The description of the attachment.", "type": "string" }, "displayName": { "description": "The display name of the attachment. Can't be null or empty.", "type": "string" }, "id": { "description": "Id of the attachment.", "type": "integer" }, "properties": { "description": "The class represents a property bag as a collection of key-value pairs. Values of all primitive types (any type with a `TypeCode != TypeCode.Object`) except for `DBNull` are accepted. Values of type Byte[], Int32, Double, DateType and String preserve their type, other primitives are retuned as a String. Byte[] expected as base64 encoded string.", "type": "object", "properties": { "count": { "description": "The count of properties in the collection.", "type": "integer" }, "item": { "type": "object" }, "keys": { "description": "The set of keys in the collection.", "type": "array", "items": { "type": "string" } }, "values": { "description": "The set of values in the collection.", "type": "array", "items": { "type": "string" } } } }, "url": { "description": "The url to download the content of the attachment.", "type": "string" } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestAttachmentsList" }, "task": true }, { "name": "pullRequestAttachmentsCreate", "summary": "Attach a new file to a pull request.", "description": "Attach a new file to a pull request.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "string", "info": "Stream to upload: string", "required": true, "schema": { "type": "string" } }, { "name": "fileName", "type": "string", "info": "The name of the file.: string", "required": true, "schema": { "title": "fileName", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request’s target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestAttachmentsCreate" }, "task": true }, { "name": "pullRequestAttachmentsDelete", "summary": "Delete a pull request attachment.", "description": "Delete a pull request attachment.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "fileName", "type": "string", "info": "The name of the attachment to delete.: string", "required": true, "schema": { "title": "fileName", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request’s target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestAttachmentsDelete" }, "task": true }, { "name": "pullRequestAttachmentsGet", "summary": "Get the file content of a pull request attachment.", "description": "Get the file content of a pull request attachment.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "fileName", "type": "string", "info": "The name of the attachment.: string", "required": true, "schema": { "title": "fileName", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request’s target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestAttachmentsGet" }, "task": true }, { "name": "pullRequestCommitsGetPullRequestCommits", "summary": "Get the commits for the specified pull request.", "description": "Get the commits for the specified pull request.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "ID or name of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "top", "type": "number", "info": "Maximum number of commits to return.: 123", "required": false, "schema": { "title": "top", "type": "number" } }, { "name": "continuationToken", "type": "string", "info": "The continuation token used for pagination.: string", "required": false, "schema": { "title": "continuationToken", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestCommitsGetPullRequestCommits" }, "task": true }, { "name": "pullRequestCommitsGetPullRequestIterationCommits", "summary": "Get the commits for the specified iteration of a pull request.", "description": "Get the commits for the specified iteration of a pull request.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "ID or name of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "iterationId", "type": "number", "info": "ID of the iteration from which to get the commits.: 123", "required": true, "schema": { "title": "iterationId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "top", "type": "number", "info": "Maximum number of commits to return. The maximum number of commits that can be returned per batch is 500.: 123", "required": false, "schema": { "title": "top", "type": "number" } }, { "name": "skip", "type": "number", "info": "Number of commits to skip.: 123", "required": false, "schema": { "title": "skip", "type": "number" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestCommitsGetPullRequestIterationCommits" }, "task": true }, { "name": "pullRequestIterationsList", "summary": "Get the list of iterations for the specified pull request.", "description": "Get the list of iterations for the specified pull request.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "ID or name of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "includeCommits", "type": "boolean", "info": "If true, include the commits associated with each iteration in the response.: boolean", "required": false, "schema": { "title": "includeCommits", "type": "boolean" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "Provides properties that describe a Git pull request iteration. Iterations are created as a result of creating and pushing updates to a pull request.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "changeList": { "description": "Changes included with the pull request iteration.", "type": "array", "items": { "description": "Change made in a pull request.", "type": "object", "allOf": [ { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } ], "properties": { "changeTrackingId": { "description": "ID used to track files through multiple changes.", "type": "integer" } } } }, "commits": { "description": "The commits included with the pull request iteration.", "type": "array", "items": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } } }, "commonRefCommit": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } }, "createdDate": { "description": "The creation date of the pull request iteration.", "type": "string" }, "description": { "description": "Description of the pull request iteration.", "type": "string" }, "hasMoreCommits": { "description": "Indicates if the Commits property contains a truncated list of commits in this pull request iteration.", "type": "boolean" }, "id": { "description": "ID of the pull request iteration. Iterations are created as a result of creating and pushing updates to a pull request.", "type": "integer" }, "newTargetRefName": { "description": "If the iteration reason is Retarget, this is the refName of the new target", "type": "string" }, "oldTargetRefName": { "description": "If the iteration reason is Retarget, this is the original target refName", "type": "string" }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "reason": { "description": "The reason for which the pull request iteration was created.", "enum": [ "push", "forcePush", "create", "rebase", "unknown", "retarget" ], "x-ms-enum": { "name": "IterationReason", "values": [ { "value": "push", "description": "" }, { "value": "forcePush", "description": "" }, { "value": "create", "description": "" }, { "value": "rebase", "description": "" }, { "value": "unknown", "description": "" }, { "value": "retarget", "description": "" } ] } }, "sourceRefCommit": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } }, "targetRefCommit": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } }, "updatedDate": { "description": "The updated date of the pull request iteration.", "type": "string" } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestIterationsList" }, "task": true }, { "name": "pullRequestIterationsGet", "summary": "Get the specified iteration for a pull request.", "description": "Get the specified iteration for a pull request.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "ID or name of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "iterationId", "type": "number", "info": "ID of the pull request iteration to return.: 123", "required": true, "schema": { "title": "iterationId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestIterationsGet" }, "task": true }, { "name": "pullRequestIterationChangesGet", "summary": "Retrieve the changes made in a pull request between two iterations.", "description": "Retrieve the changes made in a pull request between two iterations.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request's target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "iterationId", "type": "number", "info": "ID of the pull request iteration. Iteration one is the head of the source branch at the time the pull request is created and subsequent iterations are created when ther...(description truncated): 123", "required": true, "schema": { "title": "iterationId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "top", "type": "number", "info": "Optional. The number of changes to retrieve. The default value is 100 and the maximum value is 2000.: 123", "required": false, "schema": { "title": "top", "type": "number" } }, { "name": "skip", "type": "number", "info": "Optional. The number of changes to ignore. For example, to retrieve changes 101-150, set top 50 and skip to 100.: 123", "required": false, "schema": { "title": "skip", "type": "number" } }, { "name": "compareTo", "type": "number", "info": "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 ta...(description truncated): 123", "required": false, "schema": { "title": "compareTo", "type": "number" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestIterationChangesGet" }, "task": true }, { "name": "pullRequestIterationStatusesCreate", "summary": "Create a pull request status on the iteration. This operation will have the same result as Create s", "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.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": "Pull request status to create.: {\"iterationId\": 123, \"properties\": {\"count\": 123, \"item\": \"object\", \"keys\": \"array\", \"values\": \"array\"}}", "required": true, "schema": { "description": "This class contains the metadata of a service/extension posting pull request status. Status can be associated with a pull request or an iteration.", "type": "object", "allOf": [ { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } ], "properties": { "iterationId": { "description": "ID of the iteration to associate status with. Minimum value is 1.", "type": "integer" }, "properties": { "description": "The class represents a property bag as a collection of key-value pairs. Values of all primitive types (any type with a `TypeCode != TypeCode.Object`) except for `DBNull` are accepted. Values of type Byte[], Int32, Double, DateType and String preserve their type, other primitives are retuned as a String. Byte[] expected as base64 encoded string.", "type": "object", "properties": { "count": { "description": "The count of properties in the collection.", "type": "integer" }, "item": { "type": "object" }, "keys": { "description": "The set of keys in the collection.", "type": "array", "items": { "type": "string" } }, "values": { "description": "The set of values in the collection.", "type": "array", "items": { "type": "string" } } } } } } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request’s target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "iterationId", "type": "number", "info": "ID of the pull request iteration.: 123", "required": true, "schema": { "title": "iterationId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestIterationStatusesCreate" }, "task": true }, { "name": "pullRequestIterationStatusesList", "summary": "Get all the statuses associated with a pull request iteration.", "description": "Get all the statuses associated with a pull request iteration.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request’s target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "iterationId", "type": "number", "info": "ID of the pull request iteration.: 123", "required": true, "schema": { "title": "iterationId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting pull request status. Status can be associated with a pull request or an iteration.", "type": "object", "allOf": [ { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } ], "properties": { "iterationId": { "description": "ID of the iteration to associate status with. Minimum value is 1.", "type": "integer" }, "properties": { "description": "The class represents a property bag as a collection of key-value pairs. Values of all primitive types (any type with a `TypeCode != TypeCode.Object`) except for `DBNull` are accepted. Values of type Byte[], Int32, Double, DateType and String preserve their type, other primitives are retuned as a String. Byte[] expected as base64 encoded string.", "type": "object", "properties": { "count": { "description": "The count of properties in the collection.", "type": "integer" }, "item": { "type": "object" }, "keys": { "description": "The set of keys in the collection.", "type": "array", "items": { "type": "string" } }, "values": { "description": "The set of values in the collection.", "type": "array", "items": { "type": "string" } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestIterationStatusesList" }, "task": true }, { "name": "pullRequestIterationStatusesUpdate", "summary": "Update pull request iteration statuses collection. The only supported operation type is `remove`.\n\n", "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.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": "Operations to apply to the pull request statuses in JSON Patch format.: }", "required": true, "schema": { "description": "The JSON model for JSON Patch Operations", "type": "object", "allOf": [ { "type": "array", "items": { "description": "The JSON model for a JSON Patch operation", "type": "object", "properties": { "from": { "description": "The path to copy from for the Move/Copy operation.", "type": "string" }, "op": { "description": "The patch operation", "enum": [ "add", "remove", "replace", "move", "copy", "test" ], "x-ms-enum": { "name": "Operation", "values": [ { "value": "add", "description": "" }, { "value": "remove", "description": "" }, { "value": "replace", "description": "" }, { "value": "move", "description": "" }, { "value": "copy", "description": "" }, { "value": "test", "description": "" } ] } }, "path": { "description": "The path for the operation. In the case of an array, a zero based index can be used to specify the position in the array (e.g. /biscuits/0/name). The \"-\" character can be used instead of an index to insert at the end of the array (e.g. /biscuits/-).", "type": "string" }, "value": { "description": "The value for the operation. This is either a primitive or a JToken.", "type": "object" } } } } ], "properties": {} } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request’s target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "iterationId", "type": "number", "info": "ID of the pull request iteration.: 123", "required": true, "schema": { "title": "iterationId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestIterationStatusesUpdate" }, "task": true }, { "name": "pullRequestIterationStatusesDelete", "summary": "Delete pull request iteration status.\n\nYou can remove multiple statuses in one call by using Update", "description": "Delete pull request iteration status.\n\nYou can remove multiple statuses in one call by using Update operation.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request’s target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "iterationId", "type": "number", "info": "ID of the pull request iteration.: 123", "required": true, "schema": { "title": "iterationId", "type": "number" } }, { "name": "statusId", "type": "number", "info": "ID of the pull request status.: 123", "required": true, "schema": { "title": "statusId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestIterationStatusesDelete" }, "task": true }, { "name": "pullRequestIterationStatusesGet", "summary": "Get the specific pull request iteration status by ID. The status ID is unique within the pull reque", "description": "Get the specific pull request iteration status by ID. The status ID is unique within the pull request across all iterations.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request’s target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "iterationId", "type": "number", "info": "ID of the pull request iteration.: 123", "required": true, "schema": { "title": "iterationId", "type": "number" } }, { "name": "statusId", "type": "number", "info": "ID of the pull request status.: 123", "required": true, "schema": { "title": "statusId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestIterationStatusesGet" }, "task": true }, { "name": "pullRequestLabelsCreate", "summary": "Create a label for a specified pull request. The only required field is the name of the new label.", "description": "Create a label for a specified pull request. The only required field is the name of the new label.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": "Label to assign to the pull request.: {\"name\": \"string\"}", "required": true, "schema": { "description": "The representation of data needed to create a tag definition which is sent across the wire.", "type": "object", "properties": { "name": { "description": "Name of the tag definition that will be created.", "type": "string" } } } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request’s target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "projectId", "type": "string", "info": "Project ID or project name.: string", "required": false, "schema": { "title": "projectId", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestLabelsCreate" }, "task": true }, { "name": "pullRequestLabelsList", "summary": "Get all the labels assigned to a pull request.", "description": "Get all the labels assigned to a pull request.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request’s target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "projectId", "type": "string", "info": "Project ID or project name.: string", "required": false, "schema": { "title": "projectId", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "The representation of a tag definition which is sent across the wire.", "type": "object", "properties": { "active": { "description": "Whether or not the tag definition is active.", "type": "boolean" }, "id": { "description": "ID of the tag definition.", "type": "string" }, "name": { "description": "The name of the tag definition.", "type": "string" }, "url": { "description": "Resource URL for the Tag Definition.", "type": "string" } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestLabelsList" }, "task": true }, { "name": "pullRequestLabelsDelete", "summary": "Removes a label from the set of those assigned to the pull request.", "description": "Removes a label from the set of those assigned to the pull request.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request’s target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "labelIdOrName", "type": "string", "info": "The name or ID of the label requested.: string", "required": true, "schema": { "title": "labelIdOrName", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "projectId", "type": "string", "info": "Project ID or project name.: string", "required": false, "schema": { "title": "projectId", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestLabelsDelete" }, "task": true }, { "name": "pullRequestLabelsGet", "summary": "Retrieves a single label that has been assigned to a pull request.", "description": "Retrieves a single label that has been assigned to a pull request.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request’s target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "labelIdOrName", "type": "string", "info": "The name or ID of the label requested.: string", "required": true, "schema": { "title": "labelIdOrName", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "projectId", "type": "string", "info": "Project ID or project name.: string", "required": false, "schema": { "title": "projectId", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestLabelsGet" }, "task": true }, { "name": "pullRequestPropertiesList", "summary": "Get external properties of the pull request.", "description": "Get external properties of the pull request.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request’s target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestPropertiesList" }, "task": true }, { "name": "pullRequestPropertiesUpdate", "summary": "Create or update pull request external properties. The patch operation can be `add`, `replace` or `", "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.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": "Properties to add, replace or remove in JSON Patch format.: }", "required": true, "schema": { "description": "The JSON model for JSON Patch Operations", "type": "object", "allOf": [ { "type": "array", "items": { "description": "The JSON model for a JSON Patch operation", "type": "object", "properties": { "from": { "description": "The path to copy from for the Move/Copy operation.", "type": "string" }, "op": { "description": "The patch operation", "enum": [ "add", "remove", "replace", "move", "copy", "test" ], "x-ms-enum": { "name": "Operation", "values": [ { "value": "add", "description": "" }, { "value": "remove", "description": "" }, { "value": "replace", "description": "" }, { "value": "move", "description": "" }, { "value": "copy", "description": "" }, { "value": "test", "description": "" } ] } }, "path": { "description": "The path for the operation. In the case of an array, a zero based index can be used to specify the position in the array (e.g. /biscuits/0/name). The \"-\" character can be used instead of an index to insert at the end of the array (e.g. /biscuits/-).", "type": "string" }, "value": { "description": "The value for the operation. This is either a primitive or a JToken.", "type": "object" } } } } ], "properties": {} } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request’s target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestPropertiesUpdate" }, "task": true }, { "name": "pullRequestReviewersCreatePullRequestReviewers", "summary": "Add reviewers to a pull request.", "description": "Add reviewers to a pull request.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "array", "info": "Reviewers to add to the pull request.: array", "required": true, "schema": { "type": "array", "items": { "type": "object" } } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request's target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "Identity information including a vote on a pull request.", "type": "object", "allOf": [ { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } } ], "properties": { "hasDeclined": { "description": "Indicates if this reviewer has declined to review this pull request.", "type": "boolean" }, "isFlagged": { "description": "Indicates if this reviewer is flagged for attention on this pull request.", "type": "boolean" }, "isRequired": { "description": "Indicates if this is a required reviewer for this pull request.
Branches can have policies that require particular reviewers are required for pull requests.", "type": "boolean" }, "reviewerUrl": { "description": "URL to retrieve information about this identity", "type": "string" }, "vote": { "description": "Vote on a pull request:
10 - approved 5 - approved with suggestions 0 - no vote -5 - waiting for author -10 - rejected", "type": "integer" }, "votedFor": { "description": "Groups or teams that that this reviewer contributed to.
Groups and teams can be reviewers on pull requests but can not vote directly. When a member of the group or team votes, that vote is rolled up into the group or team vote. VotedFor is a list of such votes.", "type": "array", "items": { "description": "Identity information including a vote on a pull request.", "type": "object", "allOf": [ { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } } ], "properties": { "hasDeclined": { "description": "Indicates if this reviewer has declined to review this pull request.", "type": "boolean" }, "isFlagged": { "description": "Indicates if this reviewer is flagged for attention on this pull request.", "type": "boolean" }, "isRequired": { "description": "Indicates if this is a required reviewer for this pull request.
Branches can have policies that require particular reviewers are required for pull requests.", "type": "boolean" }, "reviewerUrl": { "description": "URL to retrieve information about this identity", "type": "string" }, "vote": { "description": "Vote on a pull request:
10 - approved 5 - approved with suggestions 0 - no vote -5 - waiting for author -10 - rejected", "type": "integer" }, "votedFor": { "description": "Groups or teams that that this reviewer contributed to.
Groups and teams can be reviewers on pull requests but can not vote directly. When a member of the group or team votes, that vote is rolled up into the group or team vote. VotedFor is a list of such votes.", "type": "array", "items": { "type": "object" } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestReviewersCreatePullRequestReviewers" }, "task": true }, { "name": "pullRequestReviewersCreateUnmaterializedPullRequestReviewer", "summary": "Add an unmaterialized identity to the reviewers of a pull request.", "description": "Add an unmaterialized identity to the reviewers of a pull request.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": "Reviewer to add to the pull request.: {\"hasDeclined\": \"boolean\", \"isFlagged\": \"boolean\", \"isRequired\": \"boolean\", \"reviewerUrl\": \"string\", \"vote\": 123, \"votedFor\": [{\"hasDeclined\": \"boolean\", \"isFlagged\": \"boolean\", \"isRequired\": \"boolean\", \"reviewerUrl\": \"string\", \"vote\": 123, \"votedFor\": \"array\"}]}", "required": true, "schema": { "description": "Identity information including a vote on a pull request.", "type": "object", "allOf": [ { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } } ], "properties": { "hasDeclined": { "description": "Indicates if this reviewer has declined to review this pull request.", "type": "boolean" }, "isFlagged": { "description": "Indicates if this reviewer is flagged for attention on this pull request.", "type": "boolean" }, "isRequired": { "description": "Indicates if this is a required reviewer for this pull request.
Branches can have policies that require particular reviewers are required for pull requests.", "type": "boolean" }, "reviewerUrl": { "description": "URL to retrieve information about this identity", "type": "string" }, "vote": { "description": "Vote on a pull request:
10 - approved 5 - approved with suggestions 0 - no vote -5 - waiting for author -10 - rejected", "type": "integer" }, "votedFor": { "description": "Groups or teams that that this reviewer contributed to.
Groups and teams can be reviewers on pull requests but can not vote directly. When a member of the group or team votes, that vote is rolled up into the group or team vote. VotedFor is a list of such votes.", "type": "array", "items": { "description": "Identity information including a vote on a pull request.", "type": "object", "allOf": [ { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } } ], "properties": { "hasDeclined": { "description": "Indicates if this reviewer has declined to review this pull request.", "type": "boolean" }, "isFlagged": { "description": "Indicates if this reviewer is flagged for attention on this pull request.", "type": "boolean" }, "isRequired": { "description": "Indicates if this is a required reviewer for this pull request.
Branches can have policies that require particular reviewers are required for pull requests.", "type": "boolean" }, "reviewerUrl": { "description": "URL to retrieve information about this identity", "type": "string" }, "vote": { "description": "Vote on a pull request:
10 - approved 5 - approved with suggestions 0 - no vote -5 - waiting for author -10 - rejected", "type": "integer" }, "votedFor": { "description": "Groups or teams that that this reviewer contributed to.
Groups and teams can be reviewers on pull requests but can not vote directly. When a member of the group or team votes, that vote is rolled up into the group or team vote. VotedFor is a list of such votes.", "type": "array", "items": { "type": "object" } } } } } } } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request's target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestReviewersCreateUnmaterializedPullRequestReviewer" }, "task": true }, { "name": "pullRequestReviewersList", "summary": "Retrieve the reviewers for a pull request", "description": "Retrieve the reviewers for a pull request", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request's target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "Identity information including a vote on a pull request.", "type": "object", "allOf": [ { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } } ], "properties": { "hasDeclined": { "description": "Indicates if this reviewer has declined to review this pull request.", "type": "boolean" }, "isFlagged": { "description": "Indicates if this reviewer is flagged for attention on this pull request.", "type": "boolean" }, "isRequired": { "description": "Indicates if this is a required reviewer for this pull request.
Branches can have policies that require particular reviewers are required for pull requests.", "type": "boolean" }, "reviewerUrl": { "description": "URL to retrieve information about this identity", "type": "string" }, "vote": { "description": "Vote on a pull request:
10 - approved 5 - approved with suggestions 0 - no vote -5 - waiting for author -10 - rejected", "type": "integer" }, "votedFor": { "description": "Groups or teams that that this reviewer contributed to.
Groups and teams can be reviewers on pull requests but can not vote directly. When a member of the group or team votes, that vote is rolled up into the group or team vote. VotedFor is a list of such votes.", "type": "array", "items": { "description": "Identity information including a vote on a pull request.", "type": "object", "allOf": [ { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } } ], "properties": { "hasDeclined": { "description": "Indicates if this reviewer has declined to review this pull request.", "type": "boolean" }, "isFlagged": { "description": "Indicates if this reviewer is flagged for attention on this pull request.", "type": "boolean" }, "isRequired": { "description": "Indicates if this is a required reviewer for this pull request.
Branches can have policies that require particular reviewers are required for pull requests.", "type": "boolean" }, "reviewerUrl": { "description": "URL to retrieve information about this identity", "type": "string" }, "vote": { "description": "Vote on a pull request:
10 - approved 5 - approved with suggestions 0 - no vote -5 - waiting for author -10 - rejected", "type": "integer" }, "votedFor": { "description": "Groups or teams that that this reviewer contributed to.
Groups and teams can be reviewers on pull requests but can not vote directly. When a member of the group or team votes, that vote is rolled up into the group or team vote. VotedFor is a list of such votes.", "type": "array", "items": { "type": "object" } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestReviewersList" }, "task": true }, { "name": "pullRequestReviewersUpdatePullRequestReviewers", "summary": "Reset the votes of multiple reviewers on a pull request. NOTE: This endpoint only supports updatin", "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.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "array", "info": "IDs of the reviewers whose votes will be reset to zero: array", "required": true, "schema": { "type": "array", "items": { "type": "object" } } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request's target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestReviewersUpdatePullRequestReviewers" }, "task": true }, { "name": "pullRequestReviewersCreatePullRequestReviewer", "summary": "Add a reviewer to a pull request or cast a vote.", "description": "Add a reviewer to a pull request or cast a vote.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": "Reviewer's vote. If the reviewer's ID is included here, it must match the reviewerID parameter. Reviewers can set their own vote with this method. When adding other revi...(description truncated): {\"hasDeclined\": \"boolean\", \"isFlagged\": \"boolean\", \"isRequired\": \"boolean\", \"reviewerUrl\": \"string\", \"vote\": 123, \"votedFor\": [{\"hasDeclined\": \"boolean\", \"isFlagged\": \"boolean\", \"isRequired\": \"boolean\", \"reviewerUrl\": \"string\", \"vote\": 123, \"votedFor\": \"array\"}]}", "required": true, "schema": { "description": "Identity information including a vote on a pull request.", "type": "object", "allOf": [ { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } } ], "properties": { "hasDeclined": { "description": "Indicates if this reviewer has declined to review this pull request.", "type": "boolean" }, "isFlagged": { "description": "Indicates if this reviewer is flagged for attention on this pull request.", "type": "boolean" }, "isRequired": { "description": "Indicates if this is a required reviewer for this pull request.
Branches can have policies that require particular reviewers are required for pull requests.", "type": "boolean" }, "reviewerUrl": { "description": "URL to retrieve information about this identity", "type": "string" }, "vote": { "description": "Vote on a pull request:
10 - approved 5 - approved with suggestions 0 - no vote -5 - waiting for author -10 - rejected", "type": "integer" }, "votedFor": { "description": "Groups or teams that that this reviewer contributed to.
Groups and teams can be reviewers on pull requests but can not vote directly. When a member of the group or team votes, that vote is rolled up into the group or team vote. VotedFor is a list of such votes.", "type": "array", "items": { "description": "Identity information including a vote on a pull request.", "type": "object", "allOf": [ { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } } ], "properties": { "hasDeclined": { "description": "Indicates if this reviewer has declined to review this pull request.", "type": "boolean" }, "isFlagged": { "description": "Indicates if this reviewer is flagged for attention on this pull request.", "type": "boolean" }, "isRequired": { "description": "Indicates if this is a required reviewer for this pull request.
Branches can have policies that require particular reviewers are required for pull requests.", "type": "boolean" }, "reviewerUrl": { "description": "URL to retrieve information about this identity", "type": "string" }, "vote": { "description": "Vote on a pull request:
10 - approved 5 - approved with suggestions 0 - no vote -5 - waiting for author -10 - rejected", "type": "integer" }, "votedFor": { "description": "Groups or teams that that this reviewer contributed to.
Groups and teams can be reviewers on pull requests but can not vote directly. When a member of the group or team votes, that vote is rolled up into the group or team vote. VotedFor is a list of such votes.", "type": "array", "items": { "type": "object" } } } } } } } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request's target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "reviewerId", "type": "string", "info": "ID of the reviewer.: string", "required": true, "schema": { "title": "reviewerId", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestReviewersCreatePullRequestReviewer" }, "task": true }, { "name": "pullRequestReviewersDelete", "summary": "Remove a reviewer from a pull request.", "description": "Remove a reviewer from a pull request.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request's target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "reviewerId", "type": "string", "info": "ID of the reviewer to remove.: string", "required": true, "schema": { "title": "reviewerId", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestReviewersDelete" }, "task": true }, { "name": "pullRequestReviewersGet", "summary": "Retrieve information about a particular reviewer on a pull request", "description": "Retrieve information about a particular reviewer on a pull request", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request's target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "reviewerId", "type": "string", "info": "ID of the reviewer.: string", "required": true, "schema": { "title": "reviewerId", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestReviewersGet" }, "task": true }, { "name": "pullRequestReviewersUpdatePullRequestReviewer", "summary": "Edit a reviewer entry. These fields are patchable: isFlagged, hasDeclined", "description": "Edit a reviewer entry. These fields are patchable: isFlagged, hasDeclined", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": "Reviewer data. If the reviewer's ID is included here, it must match the reviewerID parameter.: {\"hasDeclined\": \"boolean\", \"isFlagged\": \"boolean\", \"isRequired\": \"boolean\", \"reviewerUrl\": \"string\", \"vote\": 123, \"votedFor\": [{\"hasDeclined\": \"boolean\", \"isFlagged\": \"boolean\", \"isRequired\": \"boolean\", \"reviewerUrl\": \"string\", \"vote\": 123, \"votedFor\": \"array\"}]}", "required": true, "schema": { "description": "Identity information including a vote on a pull request.", "type": "object", "allOf": [ { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } } ], "properties": { "hasDeclined": { "description": "Indicates if this reviewer has declined to review this pull request.", "type": "boolean" }, "isFlagged": { "description": "Indicates if this reviewer is flagged for attention on this pull request.", "type": "boolean" }, "isRequired": { "description": "Indicates if this is a required reviewer for this pull request.
Branches can have policies that require particular reviewers are required for pull requests.", "type": "boolean" }, "reviewerUrl": { "description": "URL to retrieve information about this identity", "type": "string" }, "vote": { "description": "Vote on a pull request:
10 - approved 5 - approved with suggestions 0 - no vote -5 - waiting for author -10 - rejected", "type": "integer" }, "votedFor": { "description": "Groups or teams that that this reviewer contributed to.
Groups and teams can be reviewers on pull requests but can not vote directly. When a member of the group or team votes, that vote is rolled up into the group or team vote. VotedFor is a list of such votes.", "type": "array", "items": { "description": "Identity information including a vote on a pull request.", "type": "object", "allOf": [ { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } } ], "properties": { "hasDeclined": { "description": "Indicates if this reviewer has declined to review this pull request.", "type": "boolean" }, "isFlagged": { "description": "Indicates if this reviewer is flagged for attention on this pull request.", "type": "boolean" }, "isRequired": { "description": "Indicates if this is a required reviewer for this pull request.
Branches can have policies that require particular reviewers are required for pull requests.", "type": "boolean" }, "reviewerUrl": { "description": "URL to retrieve information about this identity", "type": "string" }, "vote": { "description": "Vote on a pull request:
10 - approved 5 - approved with suggestions 0 - no vote -5 - waiting for author -10 - rejected", "type": "integer" }, "votedFor": { "description": "Groups or teams that that this reviewer contributed to.
Groups and teams can be reviewers on pull requests but can not vote directly. When a member of the group or team votes, that vote is rolled up into the group or team vote. VotedFor is a list of such votes.", "type": "array", "items": { "type": "object" } } } } } } } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request's target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "reviewerId", "type": "string", "info": "ID of the reviewer.: string", "required": true, "schema": { "title": "reviewerId", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestReviewersUpdatePullRequestReviewer" }, "task": true }, { "name": "pullRequestShareSharePullRequest", "summary": "Sends an e-mail notification about a specific pull request to a set of recipients", "description": "Sends an e-mail notification about a specific pull request to a set of recipients", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"message\": \"string\", \"receivers\": [{\"directoryAlias\": \"string\", \"id\": \"string\", \"imageUrl\": \"string\", \"inactive\": \"boolean\", \"isAadIdentity\": \"boolean\", \"isContainer\": \"boolean\", \"isDeletedInOrigin\": \"boolean\", \"profileUrl\": \"string\", \"uniqueName\": \"string\"}]}", "required": true, "schema": { "description": "Context used while sharing a pull request.", "type": "object", "properties": { "message": { "description": "Optional user note or message.", "type": "string" }, "receivers": { "description": "Identities of users who will receive a share notification.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } } } } } }, { "name": "repositoryId", "type": "string", "info": "ID of the git repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestShareSharePullRequest" }, "task": true }, { "name": "pullRequestStatusesCreate", "summary": "Create a pull request status.\n\nThe only required field for the status is `Context.Name` that unique", "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.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": "Pull request status to create.: {\"iterationId\": 123, \"properties\": {\"count\": 123, \"item\": \"object\", \"keys\": \"array\", \"values\": \"array\"}}", "required": true, "schema": { "description": "This class contains the metadata of a service/extension posting pull request status. Status can be associated with a pull request or an iteration.", "type": "object", "allOf": [ { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } ], "properties": { "iterationId": { "description": "ID of the iteration to associate status with. Minimum value is 1.", "type": "integer" }, "properties": { "description": "The class represents a property bag as a collection of key-value pairs. Values of all primitive types (any type with a `TypeCode != TypeCode.Object`) except for `DBNull` are accepted. Values of type Byte[], Int32, Double, DateType and String preserve their type, other primitives are retuned as a String. Byte[] expected as base64 encoded string.", "type": "object", "properties": { "count": { "description": "The count of properties in the collection.", "type": "integer" }, "item": { "type": "object" }, "keys": { "description": "The set of keys in the collection.", "type": "array", "items": { "type": "string" } }, "values": { "description": "The set of values in the collection.", "type": "array", "items": { "type": "string" } } } } } } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request’s target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestStatusesCreate" }, "task": true }, { "name": "pullRequestStatusesList", "summary": "Get all the statuses associated with a pull request.", "description": "Get all the statuses associated with a pull request.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request’s target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting pull request status. Status can be associated with a pull request or an iteration.", "type": "object", "allOf": [ { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } ], "properties": { "iterationId": { "description": "ID of the iteration to associate status with. Minimum value is 1.", "type": "integer" }, "properties": { "description": "The class represents a property bag as a collection of key-value pairs. Values of all primitive types (any type with a `TypeCode != TypeCode.Object`) except for `DBNull` are accepted. Values of type Byte[], Int32, Double, DateType and String preserve their type, other primitives are retuned as a String. Byte[] expected as base64 encoded string.", "type": "object", "properties": { "count": { "description": "The count of properties in the collection.", "type": "integer" }, "item": { "type": "object" }, "keys": { "description": "The set of keys in the collection.", "type": "array", "items": { "type": "string" } }, "values": { "description": "The set of values in the collection.", "type": "array", "items": { "type": "string" } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestStatusesList" }, "task": true }, { "name": "pullRequestStatusesUpdate", "summary": "Update pull request statuses collection. The only supported operation type is `remove`.\n\nThis opera", "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.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": "Operations to apply to the pull request statuses in JSON Patch format.: }", "required": true, "schema": { "description": "The JSON model for JSON Patch Operations", "type": "object", "allOf": [ { "type": "array", "items": { "description": "The JSON model for a JSON Patch operation", "type": "object", "properties": { "from": { "description": "The path to copy from for the Move/Copy operation.", "type": "string" }, "op": { "description": "The patch operation", "enum": [ "add", "remove", "replace", "move", "copy", "test" ], "x-ms-enum": { "name": "Operation", "values": [ { "value": "add", "description": "" }, { "value": "remove", "description": "" }, { "value": "replace", "description": "" }, { "value": "move", "description": "" }, { "value": "copy", "description": "" }, { "value": "test", "description": "" } ] } }, "path": { "description": "The path for the operation. In the case of an array, a zero based index can be used to specify the position in the array (e.g. /biscuits/0/name). The \"-\" character can be used instead of an index to insert at the end of the array (e.g. /biscuits/-).", "type": "string" }, "value": { "description": "The value for the operation. This is either a primitive or a JToken.", "type": "object" } } } } ], "properties": {} } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request’s target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestStatusesUpdate" }, "task": true }, { "name": "pullRequestStatusesDelete", "summary": "Delete pull request status.\n\nYou can remove multiple statuses in one call by using Update operation.", "description": "Delete pull request status.\n\nYou can remove multiple statuses in one call by using Update operation.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request’s target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "statusId", "type": "number", "info": "ID of the pull request status.: 123", "required": true, "schema": { "title": "statusId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestStatusesDelete" }, "task": true }, { "name": "pullRequestStatusesGet", "summary": "Get the specific pull request status by ID. The status ID is unique within the pull request across", "description": "Get the specific pull request status by ID. The status ID is unique within the pull request across all iterations.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request’s target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "statusId", "type": "number", "info": "ID of the pull request status.: 123", "required": true, "schema": { "title": "statusId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestStatusesGet" }, "task": true }, { "name": "pullRequestThreadsCreate", "summary": "Create a thread in a pull request.", "description": "Create a thread in a pull request.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": "The thread to create. Thread must contain at least one comment.: {\"pullRequestThreadContext\": {\"changeTrackingId\": 123, \"iterationContext\": {\"firstComparingIteration\": 123, \"secondComparingIteration\": 123}, \"trackingCriteria\": {\"firstComparingIteration\": 123, \"origFilePath\": \"string\", \"origLeftFileEnd\": {\"line\": 123, \"offset\": 123}, \"origLeftFileStart\": {\"line\": 123, \"offset\": 123}, \"origRightFileEnd\": {\"line\": 123, \"offset\": 123}, \"origRightFileStart\": {\"line\": 123, \"offset\": 123}, \"secondComparingIteration\": 123}}}", "required": true, "schema": { "description": "Represents a comment thread of a pull request. A thread contains meta data about the file it was left on (if any) along with one or more comments (an initial comment and the subsequent replies).", "type": "object", "allOf": [ { "description": "Represents a comment thread of a pull request. A thread contains meta data about the file it was left on along with one or more comments (an initial comment and the subsequent replies).", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "comments": { "description": "A list of the comments.", "type": "array", "items": { "description": "Represents a comment which is one of potentially many in a comment thread.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "commentType": { "description": "The comment type at the time of creation.", "enum": [ "unknown", "text", "codeChange", "system" ], "x-ms-enum": { "name": "CommentType", "values": [ { "value": "unknown", "description": "The comment type is not known." }, { "value": "text", "description": "This is a regular user comment." }, { "value": "codeChange", "description": "The comment comes as a result of a code change." }, { "value": "system", "description": "The comment represents a system message." } ] } }, "content": { "description": "The comment content.", "type": "string" }, "id": { "description": "The comment ID. IDs start at 1 and are unique to a pull request.", "type": "integer" }, "isDeleted": { "description": "Whether or not this comment was soft-deleted.", "type": "boolean" }, "lastContentUpdatedDate": { "description": "The date the comment's content was last updated.", "type": "string" }, "lastUpdatedDate": { "description": "The date the comment was last updated.", "type": "string" }, "parentCommentId": { "description": "The ID of the parent comment. This is used for replies.", "type": "integer" }, "publishedDate": { "description": "The date the comment was first published.", "type": "string" }, "usersLiked": { "description": "A list of the users who have liked this comment.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } } } } } }, "id": { "description": "The comment thread id.", "type": "integer" }, "identities": { "description": "Set of identities related to this thread", "type": "object", "additionalProperties": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } } }, "isDeleted": { "description": "Specify if the thread is deleted which happens when all comments are deleted.", "type": "boolean" }, "lastUpdatedDate": { "description": "The time this thread was last updated.", "type": "string" }, "properties": { "description": "The class represents a property bag as a collection of key-value pairs. Values of all primitive types (any type with a `TypeCode != TypeCode.Object`) except for `DBNull` are accepted. Values of type Byte[], Int32, Double, DateType and String preserve their type, other primitives are retuned as a String. Byte[] expected as base64 encoded string.", "type": "object", "properties": { "count": { "description": "The count of properties in the collection.", "type": "integer" }, "item": { "type": "object" }, "keys": { "description": "The set of keys in the collection.", "type": "array", "items": { "type": "string" } }, "values": { "description": "The set of values in the collection.", "type": "array", "items": { "type": "string" } } } }, "publishedDate": { "description": "The time this thread was published.", "type": "string" }, "status": { "description": "The status of the comment thread.", "enum": [ "unknown", "active", "fixed", "wontFix", "closed", "byDesign", "pending" ], "x-ms-enum": { "name": "CommentThreadStatus", "values": [ { "value": "unknown", "description": "The thread status is unknown." }, { "value": "active", "description": "The thread status is active." }, { "value": "fixed", "description": "The thread status is resolved as fixed." }, { "value": "wontFix", "description": "The thread status is resolved as won't fix." }, { "value": "closed", "description": "The thread status is closed." }, { "value": "byDesign", "description": "The thread status is resolved as by design." }, { "value": "pending", "description": "The thread status is pending." } ] } }, "threadContext": { "description": "", "type": "object", "properties": { "filePath": { "description": "File path relative to the root of the repository. It's up to the client to use any path format.", "type": "string" }, "leftFileEnd": { "description": "", "type": "object", "properties": { "line": { "description": "The line number of a thread's position. Starts at 1.", "type": "integer" }, "offset": { "description": "The character offset of a thread's position inside of a line. Starts at 0.", "type": "integer" } } }, "leftFileStart": { "description": "", "type": "object", "properties": { "line": { "description": "The line number of a thread's position. Starts at 1.", "type": "integer" }, "offset": { "description": "The character offset of a thread's position inside of a line. Starts at 0.", "type": "integer" } } }, "rightFileEnd": { "description": "", "type": "object", "properties": { "line": { "description": "The line number of a thread's position. Starts at 1.", "type": "integer" }, "offset": { "description": "The character offset of a thread's position inside of a line. Starts at 0.", "type": "integer" } } }, "rightFileStart": { "description": "", "type": "object", "properties": { "line": { "description": "The line number of a thread's position. Starts at 1.", "type": "integer" }, "offset": { "description": "The character offset of a thread's position inside of a line. Starts at 0.", "type": "integer" } } } } } } } ], "properties": { "pullRequestThreadContext": { "description": "Comment thread context contains details about what diffs were being viewed at the time of thread creation and whether or not the thread has been tracked from that original diff.", "type": "object", "properties": { "changeTrackingId": { "description": "Used to track a comment across iterations. This value can be found by looking at the iteration's changes list. Must be set for pull requests with iteration support. Otherwise, it's not required for 'legacy' pull requests.", "type": "integer" }, "iterationContext": { "description": "Comment iteration context is used to identify which diff was being viewed when the thread was created.", "type": "object", "properties": { "firstComparingIteration": { "description": "The iteration of the file on the left side of the diff when the thread was created. If this value is equal to SecondComparingIteration, then this version is the common commit between the source and target branches of the pull request.", "type": "integer" }, "secondComparingIteration": { "description": "The iteration of the file on the right side of the diff when the thread was created.", "type": "integer" } } }, "trackingCriteria": { "description": "Comment tracking criteria is used to identify which iteration context the thread has been tracked to (if any) along with some detail about the original position and filename.", "type": "object", "properties": { "firstComparingIteration": { "description": "The iteration of the file on the left side of the diff that the thread will be tracked to. Threads were tracked if this is greater than 0.", "type": "integer" }, "origFilePath": { "description": "Original filepath the thread was created on before tracking. This will be different than the current thread filepath if the file in question was renamed in a later iteration.", "type": "string" }, "origLeftFileEnd": { "description": "", "type": "object", "properties": { "line": { "description": "The line number of a thread's position. Starts at 1.", "type": "integer" }, "offset": { "description": "The character offset of a thread's position inside of a line. Starts at 0.", "type": "integer" } } }, "origLeftFileStart": { "description": "", "type": "object", "properties": { "line": { "description": "The line number of a thread's position. Starts at 1.", "type": "integer" }, "offset": { "description": "The character offset of a thread's position inside of a line. Starts at 0.", "type": "integer" } } }, "origRightFileEnd": { "description": "", "type": "object", "properties": { "line": { "description": "The line number of a thread's position. Starts at 1.", "type": "integer" }, "offset": { "description": "The character offset of a thread's position inside of a line. Starts at 0.", "type": "integer" } } }, "origRightFileStart": { "description": "", "type": "object", "properties": { "line": { "description": "The line number of a thread's position. Starts at 1.", "type": "integer" }, "offset": { "description": "The character offset of a thread's position inside of a line. Starts at 0.", "type": "integer" } } }, "secondComparingIteration": { "description": "The iteration of the file on the right side of the diff that the thread will be tracked to. Threads were tracked if this is greater than 0.", "type": "integer" } } } } } } } }, { "name": "repositoryId", "type": "string", "info": "Repository ID of the pull request's target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestThreadsCreate" }, "task": true }, { "name": "pullRequestThreadsList", "summary": "Retrieve all threads in a pull request.", "description": "Retrieve all threads in a pull request.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request's target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "iteration", "type": "number", "info": "If specified, thread positions will be tracked using this iteration as the right side of the diff.: 123", "required": false, "schema": { "title": "iteration", "type": "number" } }, { "name": "baseIteration", "type": "number", "info": "If specified, thread positions will be tracked using this iteration as the left side of the diff.: 123", "required": false, "schema": { "title": "baseIteration", "type": "number" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "Represents a comment thread of a pull request. A thread contains meta data about the file it was left on (if any) along with one or more comments (an initial comment and the subsequent replies).", "type": "object", "allOf": [ { "description": "Represents a comment thread of a pull request. A thread contains meta data about the file it was left on along with one or more comments (an initial comment and the subsequent replies).", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "comments": { "description": "A list of the comments.", "type": "array", "items": { "description": "Represents a comment which is one of potentially many in a comment thread.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "commentType": { "description": "The comment type at the time of creation.", "enum": [ "unknown", "text", "codeChange", "system" ], "x-ms-enum": { "name": "CommentType", "values": [ { "value": "unknown", "description": "The comment type is not known." }, { "value": "text", "description": "This is a regular user comment." }, { "value": "codeChange", "description": "The comment comes as a result of a code change." }, { "value": "system", "description": "The comment represents a system message." } ] } }, "content": { "description": "The comment content.", "type": "string" }, "id": { "description": "The comment ID. IDs start at 1 and are unique to a pull request.", "type": "integer" }, "isDeleted": { "description": "Whether or not this comment was soft-deleted.", "type": "boolean" }, "lastContentUpdatedDate": { "description": "The date the comment's content was last updated.", "type": "string" }, "lastUpdatedDate": { "description": "The date the comment was last updated.", "type": "string" }, "parentCommentId": { "description": "The ID of the parent comment. This is used for replies.", "type": "integer" }, "publishedDate": { "description": "The date the comment was first published.", "type": "string" }, "usersLiked": { "description": "A list of the users who have liked this comment.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } } } } } }, "id": { "description": "The comment thread id.", "type": "integer" }, "identities": { "description": "Set of identities related to this thread", "type": "object", "additionalProperties": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } } }, "isDeleted": { "description": "Specify if the thread is deleted which happens when all comments are deleted.", "type": "boolean" }, "lastUpdatedDate": { "description": "The time this thread was last updated.", "type": "string" }, "properties": { "description": "The class represents a property bag as a collection of key-value pairs. Values of all primitive types (any type with a `TypeCode != TypeCode.Object`) except for `DBNull` are accepted. Values of type Byte[], Int32, Double, DateType and String preserve their type, other primitives are retuned as a String. Byte[] expected as base64 encoded string.", "type": "object", "properties": { "count": { "description": "The count of properties in the collection.", "type": "integer" }, "item": { "type": "object" }, "keys": { "description": "The set of keys in the collection.", "type": "array", "items": { "type": "string" } }, "values": { "description": "The set of values in the collection.", "type": "array", "items": { "type": "string" } } } }, "publishedDate": { "description": "The time this thread was published.", "type": "string" }, "status": { "description": "The status of the comment thread.", "enum": [ "unknown", "active", "fixed", "wontFix", "closed", "byDesign", "pending" ], "x-ms-enum": { "name": "CommentThreadStatus", "values": [ { "value": "unknown", "description": "The thread status is unknown." }, { "value": "active", "description": "The thread status is active." }, { "value": "fixed", "description": "The thread status is resolved as fixed." }, { "value": "wontFix", "description": "The thread status is resolved as won't fix." }, { "value": "closed", "description": "The thread status is closed." }, { "value": "byDesign", "description": "The thread status is resolved as by design." }, { "value": "pending", "description": "The thread status is pending." } ] } }, "threadContext": { "description": "", "type": "object", "properties": { "filePath": { "description": "File path relative to the root of the repository. It's up to the client to use any path format.", "type": "string" }, "leftFileEnd": { "description": "", "type": "object", "properties": { "line": { "description": "The line number of a thread's position. Starts at 1.", "type": "integer" }, "offset": { "description": "The character offset of a thread's position inside of a line. Starts at 0.", "type": "integer" } } }, "leftFileStart": { "description": "", "type": "object", "properties": { "line": { "description": "The line number of a thread's position. Starts at 1.", "type": "integer" }, "offset": { "description": "The character offset of a thread's position inside of a line. Starts at 0.", "type": "integer" } } }, "rightFileEnd": { "description": "", "type": "object", "properties": { "line": { "description": "The line number of a thread's position. Starts at 1.", "type": "integer" }, "offset": { "description": "The character offset of a thread's position inside of a line. Starts at 0.", "type": "integer" } } }, "rightFileStart": { "description": "", "type": "object", "properties": { "line": { "description": "The line number of a thread's position. Starts at 1.", "type": "integer" }, "offset": { "description": "The character offset of a thread's position inside of a line. Starts at 0.", "type": "integer" } } } } } } } ], "properties": { "pullRequestThreadContext": { "description": "Comment thread context contains details about what diffs were being viewed at the time of thread creation and whether or not the thread has been tracked from that original diff.", "type": "object", "properties": { "changeTrackingId": { "description": "Used to track a comment across iterations. This value can be found by looking at the iteration's changes list. Must be set for pull requests with iteration support. Otherwise, it's not required for 'legacy' pull requests.", "type": "integer" }, "iterationContext": { "description": "Comment iteration context is used to identify which diff was being viewed when the thread was created.", "type": "object", "properties": { "firstComparingIteration": { "description": "The iteration of the file on the left side of the diff when the thread was created. If this value is equal to SecondComparingIteration, then this version is the common commit between the source and target branches of the pull request.", "type": "integer" }, "secondComparingIteration": { "description": "The iteration of the file on the right side of the diff when the thread was created.", "type": "integer" } } }, "trackingCriteria": { "description": "Comment tracking criteria is used to identify which iteration context the thread has been tracked to (if any) along with some detail about the original position and filename.", "type": "object", "properties": { "firstComparingIteration": { "description": "The iteration of the file on the left side of the diff that the thread will be tracked to. Threads were tracked if this is greater than 0.", "type": "integer" }, "origFilePath": { "description": "Original filepath the thread was created on before tracking. This will be different than the current thread filepath if the file in question was renamed in a later iteration.", "type": "string" }, "origLeftFileEnd": { "description": "", "type": "object", "properties": { "line": { "description": "The line number of a thread's position. Starts at 1.", "type": "integer" }, "offset": { "description": "The character offset of a thread's position inside of a line. Starts at 0.", "type": "integer" } } }, "origLeftFileStart": { "description": "", "type": "object", "properties": { "line": { "description": "The line number of a thread's position. Starts at 1.", "type": "integer" }, "offset": { "description": "The character offset of a thread's position inside of a line. Starts at 0.", "type": "integer" } } }, "origRightFileEnd": { "description": "", "type": "object", "properties": { "line": { "description": "The line number of a thread's position. Starts at 1.", "type": "integer" }, "offset": { "description": "The character offset of a thread's position inside of a line. Starts at 0.", "type": "integer" } } }, "origRightFileStart": { "description": "", "type": "object", "properties": { "line": { "description": "The line number of a thread's position. Starts at 1.", "type": "integer" }, "offset": { "description": "The character offset of a thread's position inside of a line. Starts at 0.", "type": "integer" } } }, "secondComparingIteration": { "description": "The iteration of the file on the right side of the diff that the thread will be tracked to. Threads were tracked if this is greater than 0.", "type": "integer" } } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestThreadsList" }, "task": true }, { "name": "pullRequestThreadsGet", "summary": "Retrieve a thread in a pull request.", "description": "Retrieve a thread in a pull request.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request's target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "threadId", "type": "number", "info": "ID of the thread.: 123", "required": true, "schema": { "title": "threadId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "iteration", "type": "number", "info": "If specified, thread position will be tracked using this iteration as the right side of the diff.: 123", "required": false, "schema": { "title": "iteration", "type": "number" } }, { "name": "baseIteration", "type": "number", "info": "If specified, thread position will be tracked using this iteration as the left side of the diff.: 123", "required": false, "schema": { "title": "baseIteration", "type": "number" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestThreadsGet" }, "task": true }, { "name": "pullRequestThreadsUpdate", "summary": "Update a thread in a pull request.", "description": "Update a thread in a pull request.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": "The thread content that should be updated.: {\"pullRequestThreadContext\": {\"changeTrackingId\": 123, \"iterationContext\": {\"firstComparingIteration\": 123, \"secondComparingIteration\": 123}, \"trackingCriteria\": {\"firstComparingIteration\": 123, \"origFilePath\": \"string\", \"origLeftFileEnd\": {\"line\": 123, \"offset\": 123}, \"origLeftFileStart\": {\"line\": 123, \"offset\": 123}, \"origRightFileEnd\": {\"line\": 123, \"offset\": 123}, \"origRightFileStart\": {\"line\": 123, \"offset\": 123}, \"secondComparingIteration\": 123}}}", "required": true, "schema": { "description": "Represents a comment thread of a pull request. A thread contains meta data about the file it was left on (if any) along with one or more comments (an initial comment and the subsequent replies).", "type": "object", "allOf": [ { "description": "Represents a comment thread of a pull request. A thread contains meta data about the file it was left on along with one or more comments (an initial comment and the subsequent replies).", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "comments": { "description": "A list of the comments.", "type": "array", "items": { "description": "Represents a comment which is one of potentially many in a comment thread.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "commentType": { "description": "The comment type at the time of creation.", "enum": [ "unknown", "text", "codeChange", "system" ], "x-ms-enum": { "name": "CommentType", "values": [ { "value": "unknown", "description": "The comment type is not known." }, { "value": "text", "description": "This is a regular user comment." }, { "value": "codeChange", "description": "The comment comes as a result of a code change." }, { "value": "system", "description": "The comment represents a system message." } ] } }, "content": { "description": "The comment content.", "type": "string" }, "id": { "description": "The comment ID. IDs start at 1 and are unique to a pull request.", "type": "integer" }, "isDeleted": { "description": "Whether or not this comment was soft-deleted.", "type": "boolean" }, "lastContentUpdatedDate": { "description": "The date the comment's content was last updated.", "type": "string" }, "lastUpdatedDate": { "description": "The date the comment was last updated.", "type": "string" }, "parentCommentId": { "description": "The ID of the parent comment. This is used for replies.", "type": "integer" }, "publishedDate": { "description": "The date the comment was first published.", "type": "string" }, "usersLiked": { "description": "A list of the users who have liked this comment.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } } } } } }, "id": { "description": "The comment thread id.", "type": "integer" }, "identities": { "description": "Set of identities related to this thread", "type": "object", "additionalProperties": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } } }, "isDeleted": { "description": "Specify if the thread is deleted which happens when all comments are deleted.", "type": "boolean" }, "lastUpdatedDate": { "description": "The time this thread was last updated.", "type": "string" }, "properties": { "description": "The class represents a property bag as a collection of key-value pairs. Values of all primitive types (any type with a `TypeCode != TypeCode.Object`) except for `DBNull` are accepted. Values of type Byte[], Int32, Double, DateType and String preserve their type, other primitives are retuned as a String. Byte[] expected as base64 encoded string.", "type": "object", "properties": { "count": { "description": "The count of properties in the collection.", "type": "integer" }, "item": { "type": "object" }, "keys": { "description": "The set of keys in the collection.", "type": "array", "items": { "type": "string" } }, "values": { "description": "The set of values in the collection.", "type": "array", "items": { "type": "string" } } } }, "publishedDate": { "description": "The time this thread was published.", "type": "string" }, "status": { "description": "The status of the comment thread.", "enum": [ "unknown", "active", "fixed", "wontFix", "closed", "byDesign", "pending" ], "x-ms-enum": { "name": "CommentThreadStatus", "values": [ { "value": "unknown", "description": "The thread status is unknown." }, { "value": "active", "description": "The thread status is active." }, { "value": "fixed", "description": "The thread status is resolved as fixed." }, { "value": "wontFix", "description": "The thread status is resolved as won't fix." }, { "value": "closed", "description": "The thread status is closed." }, { "value": "byDesign", "description": "The thread status is resolved as by design." }, { "value": "pending", "description": "The thread status is pending." } ] } }, "threadContext": { "description": "", "type": "object", "properties": { "filePath": { "description": "File path relative to the root of the repository. It's up to the client to use any path format.", "type": "string" }, "leftFileEnd": { "description": "", "type": "object", "properties": { "line": { "description": "The line number of a thread's position. Starts at 1.", "type": "integer" }, "offset": { "description": "The character offset of a thread's position inside of a line. Starts at 0.", "type": "integer" } } }, "leftFileStart": { "description": "", "type": "object", "properties": { "line": { "description": "The line number of a thread's position. Starts at 1.", "type": "integer" }, "offset": { "description": "The character offset of a thread's position inside of a line. Starts at 0.", "type": "integer" } } }, "rightFileEnd": { "description": "", "type": "object", "properties": { "line": { "description": "The line number of a thread's position. Starts at 1.", "type": "integer" }, "offset": { "description": "The character offset of a thread's position inside of a line. Starts at 0.", "type": "integer" } } }, "rightFileStart": { "description": "", "type": "object", "properties": { "line": { "description": "The line number of a thread's position. Starts at 1.", "type": "integer" }, "offset": { "description": "The character offset of a thread's position inside of a line. Starts at 0.", "type": "integer" } } } } } } } ], "properties": { "pullRequestThreadContext": { "description": "Comment thread context contains details about what diffs were being viewed at the time of thread creation and whether or not the thread has been tracked from that original diff.", "type": "object", "properties": { "changeTrackingId": { "description": "Used to track a comment across iterations. This value can be found by looking at the iteration's changes list. Must be set for pull requests with iteration support. Otherwise, it's not required for 'legacy' pull requests.", "type": "integer" }, "iterationContext": { "description": "Comment iteration context is used to identify which diff was being viewed when the thread was created.", "type": "object", "properties": { "firstComparingIteration": { "description": "The iteration of the file on the left side of the diff when the thread was created. If this value is equal to SecondComparingIteration, then this version is the common commit between the source and target branches of the pull request.", "type": "integer" }, "secondComparingIteration": { "description": "The iteration of the file on the right side of the diff when the thread was created.", "type": "integer" } } }, "trackingCriteria": { "description": "Comment tracking criteria is used to identify which iteration context the thread has been tracked to (if any) along with some detail about the original position and filename.", "type": "object", "properties": { "firstComparingIteration": { "description": "The iteration of the file on the left side of the diff that the thread will be tracked to. Threads were tracked if this is greater than 0.", "type": "integer" }, "origFilePath": { "description": "Original filepath the thread was created on before tracking. This will be different than the current thread filepath if the file in question was renamed in a later iteration.", "type": "string" }, "origLeftFileEnd": { "description": "", "type": "object", "properties": { "line": { "description": "The line number of a thread's position. Starts at 1.", "type": "integer" }, "offset": { "description": "The character offset of a thread's position inside of a line. Starts at 0.", "type": "integer" } } }, "origLeftFileStart": { "description": "", "type": "object", "properties": { "line": { "description": "The line number of a thread's position. Starts at 1.", "type": "integer" }, "offset": { "description": "The character offset of a thread's position inside of a line. Starts at 0.", "type": "integer" } } }, "origRightFileEnd": { "description": "", "type": "object", "properties": { "line": { "description": "The line number of a thread's position. Starts at 1.", "type": "integer" }, "offset": { "description": "The character offset of a thread's position inside of a line. Starts at 0.", "type": "integer" } } }, "origRightFileStart": { "description": "", "type": "object", "properties": { "line": { "description": "The line number of a thread's position. Starts at 1.", "type": "integer" }, "offset": { "description": "The character offset of a thread's position inside of a line. Starts at 0.", "type": "integer" } } }, "secondComparingIteration": { "description": "The iteration of the file on the right side of the diff that the thread will be tracked to. Threads were tracked if this is greater than 0.", "type": "integer" } } } } } } } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request's target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "threadId", "type": "number", "info": "ID of the thread to update.: 123", "required": true, "schema": { "title": "threadId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestThreadsUpdate" }, "task": true }, { "name": "pullRequestThreadCommentsCreate", "summary": "Create a comment on a specific thread in a pull request (up to 500 comments can be created per thre", "description": "Create a comment on a specific thread in a pull request (up to 500 comments can be created per thread).", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": "The comment to create. Comments can be up to 150,000 characters.: {\"_links\": {\"links\": \"object\"}, \"author\": {\"directoryAlias\": \"string\", \"id\": \"string\", \"imageUrl\": \"string\", \"inactive\": \"boolean\", \"isAadIdentity\": \"boolean\", \"isContainer\": \"boolean\", \"isDeletedInOrigin\": \"boolean\", \"profileUrl\": \"string\", \"uniqueName\": \"string\"}, \"commentType\": \"undefined\", \"content\": \"string\", \"id\": 123, \"isDeleted\": \"boolean\", \"lastContentUpdatedDate\": \"string\", \"lastUpdatedDate\": \"string\", \"parentCommentId\": 123, \"publishedDate\": \"string\", \"usersLiked\": [{\"directoryAlias\": \"string\", \"id\": \"string\", \"imageUrl\": \"string\", \"inactive\": \"boolean\", \"isAadIdentity\": \"boolean\", \"isContainer\": \"boolean\", \"isDeletedInOrigin\": \"boolean\", \"profileUrl\": \"string\", \"uniqueName\": \"string\"}]}", "required": true, "schema": { "description": "Represents a comment which is one of potentially many in a comment thread.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "commentType": { "description": "The comment type at the time of creation.", "enum": [ "unknown", "text", "codeChange", "system" ], "x-ms-enum": { "name": "CommentType", "values": [ { "value": "unknown", "description": "The comment type is not known." }, { "value": "text", "description": "This is a regular user comment." }, { "value": "codeChange", "description": "The comment comes as a result of a code change." }, { "value": "system", "description": "The comment represents a system message." } ] } }, "content": { "description": "The comment content.", "type": "string" }, "id": { "description": "The comment ID. IDs start at 1 and are unique to a pull request.", "type": "integer" }, "isDeleted": { "description": "Whether or not this comment was soft-deleted.", "type": "boolean" }, "lastContentUpdatedDate": { "description": "The date the comment's content was last updated.", "type": "string" }, "lastUpdatedDate": { "description": "The date the comment was last updated.", "type": "string" }, "parentCommentId": { "description": "The ID of the parent comment. This is used for replies.", "type": "integer" }, "publishedDate": { "description": "The date the comment was first published.", "type": "string" }, "usersLiked": { "description": "A list of the users who have liked this comment.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } } } } } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request's target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "threadId", "type": "number", "info": "ID of the thread that the desired comment is in.: 123", "required": true, "schema": { "title": "threadId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestThreadCommentsCreate" }, "task": true }, { "name": "pullRequestThreadCommentsList", "summary": "Retrieve all comments associated with a specific thread in a pull request.", "description": "Retrieve all comments associated with a specific thread in a pull request.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request's target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "threadId", "type": "number", "info": "ID of the thread.: 123", "required": true, "schema": { "title": "threadId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "Represents a comment which is one of potentially many in a comment thread.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "commentType": { "description": "The comment type at the time of creation.", "enum": [ "unknown", "text", "codeChange", "system" ], "x-ms-enum": { "name": "CommentType", "values": [ { "value": "unknown", "description": "The comment type is not known." }, { "value": "text", "description": "This is a regular user comment." }, { "value": "codeChange", "description": "The comment comes as a result of a code change." }, { "value": "system", "description": "The comment represents a system message." } ] } }, "content": { "description": "The comment content.", "type": "string" }, "id": { "description": "The comment ID. IDs start at 1 and are unique to a pull request.", "type": "integer" }, "isDeleted": { "description": "Whether or not this comment was soft-deleted.", "type": "boolean" }, "lastContentUpdatedDate": { "description": "The date the comment's content was last updated.", "type": "string" }, "lastUpdatedDate": { "description": "The date the comment was last updated.", "type": "string" }, "parentCommentId": { "description": "The ID of the parent comment. This is used for replies.", "type": "integer" }, "publishedDate": { "description": "The date the comment was first published.", "type": "string" }, "usersLiked": { "description": "A list of the users who have liked this comment.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestThreadCommentsList" }, "task": true }, { "name": "pullRequestThreadCommentsDelete", "summary": "Delete a comment associated with a specific thread in a pull request.", "description": "Delete a comment associated with a specific thread in a pull request.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request's target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "threadId", "type": "number", "info": "ID of the thread that the desired comment is in.: 123", "required": true, "schema": { "title": "threadId", "type": "number" } }, { "name": "commentId", "type": "number", "info": "ID of the comment.: 123", "required": true, "schema": { "title": "commentId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestThreadCommentsDelete" }, "task": true }, { "name": "pullRequestThreadCommentsGet", "summary": "Retrieve a comment associated with a specific thread in a pull request.", "description": "Retrieve a comment associated with a specific thread in a pull request.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request's target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "threadId", "type": "number", "info": "ID of the thread that the desired comment is in.: 123", "required": true, "schema": { "title": "threadId", "type": "number" } }, { "name": "commentId", "type": "number", "info": "ID of the comment.: 123", "required": true, "schema": { "title": "commentId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestThreadCommentsGet" }, "task": true }, { "name": "pullRequestThreadCommentsUpdate", "summary": "Update a comment associated with a specific thread in a pull request.", "description": "Update a comment associated with a specific thread in a pull request.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": "The comment content that should be updated. Comments can be up to 150,000 characters.: {\"_links\": {\"links\": \"object\"}, \"author\": {\"directoryAlias\": \"string\", \"id\": \"string\", \"imageUrl\": \"string\", \"inactive\": \"boolean\", \"isAadIdentity\": \"boolean\", \"isContainer\": \"boolean\", \"isDeletedInOrigin\": \"boolean\", \"profileUrl\": \"string\", \"uniqueName\": \"string\"}, \"commentType\": \"undefined\", \"content\": \"string\", \"id\": 123, \"isDeleted\": \"boolean\", \"lastContentUpdatedDate\": \"string\", \"lastUpdatedDate\": \"string\", \"parentCommentId\": 123, \"publishedDate\": \"string\", \"usersLiked\": [{\"directoryAlias\": \"string\", \"id\": \"string\", \"imageUrl\": \"string\", \"inactive\": \"boolean\", \"isAadIdentity\": \"boolean\", \"isContainer\": \"boolean\", \"isDeletedInOrigin\": \"boolean\", \"profileUrl\": \"string\", \"uniqueName\": \"string\"}]}", "required": true, "schema": { "description": "Represents a comment which is one of potentially many in a comment thread.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "commentType": { "description": "The comment type at the time of creation.", "enum": [ "unknown", "text", "codeChange", "system" ], "x-ms-enum": { "name": "CommentType", "values": [ { "value": "unknown", "description": "The comment type is not known." }, { "value": "text", "description": "This is a regular user comment." }, { "value": "codeChange", "description": "The comment comes as a result of a code change." }, { "value": "system", "description": "The comment represents a system message." } ] } }, "content": { "description": "The comment content.", "type": "string" }, "id": { "description": "The comment ID. IDs start at 1 and are unique to a pull request.", "type": "integer" }, "isDeleted": { "description": "Whether or not this comment was soft-deleted.", "type": "boolean" }, "lastContentUpdatedDate": { "description": "The date the comment's content was last updated.", "type": "string" }, "lastUpdatedDate": { "description": "The date the comment was last updated.", "type": "string" }, "parentCommentId": { "description": "The ID of the parent comment. This is used for replies.", "type": "integer" }, "publishedDate": { "description": "The date the comment was first published.", "type": "string" }, "usersLiked": { "description": "A list of the users who have liked this comment.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } } } } } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request's target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "threadId", "type": "number", "info": "ID of the thread that the desired comment is in.: 123", "required": true, "schema": { "title": "threadId", "type": "number" } }, { "name": "commentId", "type": "number", "info": "ID of the comment to update.: 123", "required": true, "schema": { "title": "commentId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestThreadCommentsUpdate" }, "task": true }, { "name": "pullRequestCommentLikesCreate", "summary": "Add a like on a comment.", "description": "Add a like on a comment.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request's target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "threadId", "type": "number", "info": "The ID of the thread that contains the comment.: 123", "required": true, "schema": { "title": "threadId", "type": "number" } }, { "name": "commentId", "type": "number", "info": "The ID of the comment.: 123", "required": true, "schema": { "title": "commentId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestCommentLikesCreate" }, "task": true }, { "name": "pullRequestCommentLikesDelete", "summary": "Delete a like on a comment.", "description": "Delete a like on a comment.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request's target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "threadId", "type": "number", "info": "The ID of the thread that contains the comment.: 123", "required": true, "schema": { "title": "threadId", "type": "number" } }, { "name": "commentId", "type": "number", "info": "The ID of the comment.: 123", "required": true, "schema": { "title": "commentId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestCommentLikesDelete" }, "task": true }, { "name": "pullRequestCommentLikesList", "summary": "Get likes for a comment.", "description": "Get likes for a comment.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The repository ID of the pull request's target branch.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "threadId", "type": "number", "info": "The ID of the thread that contains the comment.: 123", "required": true, "schema": { "title": "threadId", "type": "number" } }, { "name": "commentId", "type": "number", "info": "The ID of the comment.: 123", "required": true, "schema": { "title": "commentId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestCommentLikesList" }, "task": true }, { "name": "pullRequestWorkItemsList", "summary": "Retrieve a list of work items associated with a pull request.", "description": "Retrieve a list of work items associated with a pull request.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "ID or name of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pullRequestId", "type": "number", "info": "ID of the pull request.: 123", "required": true, "schema": { "title": "pullRequestId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pullRequestWorkItemsList" }, "task": true }, { "name": "pushesCreate", "summary": "Push changes to the repository.", "description": "Push changes to the repository.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"commits\": [{\"_links\": {\"links\": \"object\"}, \"author\": {\"date\": \"string\", \"email\": \"string\", \"imageUrl\": \"string\", \"name\": \"string\"}, \"changeCounts\": }, \"changes\": [{\"changeId\": 123, \"newContentTemplate\": {\"name\": \"string\", \"type\": \"string\"}, \"originalPath\": \"string\"}], \"comment\": \"string\", \"commentTruncated\": \"boolean\", \"commitId\": \"string\", \"committer\": {\"date\": \"string\", \"email\": \"string\", \"imageUrl\": \"string\", \"name\": \"string\"}, \"parents\": \"array\", \"push\": {\"_links\": {\"links\": \"object\"}, \"date\": \"string\", \"pushedBy\": {\"directoryAlias\": \"string\", \"id\": \"string\", \"imageUrl\": \"string\", \"inactive\": \"boolean\", \"isAadIdentity\": \"boolean\", \"isContainer\": \"boolean\", \"isDeletedInOrigin\": \"boolean\", \"profileUrl\": \"string\", \"uniqueName\": \"string\"}, \"pushId\": 123, \"url\": \"string\"}, \"remoteUrl\": \"string\", \"statuses\": [{\"_links\": {\"links\": \"object\"}, \"context\": {\"genre\": \"string\", \"name\": \"string\"}, \"createdBy\": {\"directoryAlias\": \"string\", \"id\": \"string\", \"imageUrl\": \"string\", \"inactive\": \"boolean\", \"isAadIdentity\": \"boolean\", \"isContainer\": \"boolean\", \"isDeletedInOrigin\": \"boolean\", \"profileUrl\": \"string\", \"uniqueName\": \"string\"}, \"creationDate\": \"string\", \"description\": \"string\", \"id\": 123, \"state\": \"undefined\", \"targetUrl\": \"string\", \"updatedDate\": \"string\"}], \"url\": \"string\", \"workItems\": [{\"id\": \"string\", \"url\": \"string\"}]}], \"refUpdates\": [{\"isLocked\": \"boolean\", \"name\": \"string\", \"newObjectId\": \"string\", \"oldObjectId\": \"string\", \"repositoryId\": \"string\"}], \"repository\": {\"_links\": {\"links\": \"object\"}, \"defaultBranch\": \"string\", \"id\": \"string\", \"isDisabled\": \"boolean\", \"isFork\": \"boolean\", \"name\": \"string\", \"parentRepository\": {\"collection\": {\"id\": \"string\", \"name\": \"string\", \"url\": \"string\"}, \"id\": \"string\", \"isFork\": \"boolean\", \"name\": \"string\", \"project\": {\"abbreviation\": \"string\", \"defaultTeamImageUrl\": \"string\", \"description\": \"string\", \"id\": \"string\", \"lastUpdateTime\": \"string\", \"name\": \"string\", \"revision\": 123, \"state\": \"undefined\", \"url\": \"string\", \"visibility\": \"undefined\"}, \"remoteUrl\": \"string\", \"sshUrl\": \"string\", \"url\": \"string\"}, \"project\": {\"abbreviation\": \"string\", \"defaultTeamImageUrl\": \"string\", \"description\": \"string\", \"id\": \"string\", \"lastUpdateTime\": \"string\", \"name\": \"string\", \"revision\": 123, \"state\": \"undefined\", \"url\": \"string\", \"visibility\": \"undefined\"}, \"remoteUrl\": \"string\", \"size\": 123, \"sshUrl\": \"string\", \"url\": \"string\", \"validRemoteUrls\": \"array\", \"webUrl\": \"string\"}}", "required": true, "schema": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } } ], "properties": { "commits": { "type": "array", "items": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Path to item.", "type": "object", "properties": { "path" : { "type" : "string" } } }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } } }, "refUpdates": { "type": "array", "items": { "description": "", "type": "object", "properties": { "isLocked": { "type": "boolean" }, "name": { "type": "string" }, "newObjectId": { "type": "string" }, "oldObjectId": { "type": "string" }, "repositoryId": { "type": "string" } } } }, "repository": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "defaultBranch": { "type": "string" }, "id": { "type": "string" }, "isDisabled": { "description": "True if the repository is disabled. False otherwise.", "type": "boolean" }, "isFork": { "description": "True if the repository was created as a fork.", "type": "boolean" }, "name": { "type": "string" }, "parentRepository": { "description": "", "type": "object", "properties": { "collection": { "description": "Reference object for a TeamProjectCollection.", "type": "object", "properties": { "id": { "description": "Collection Id.", "type": "string" }, "name": { "description": "Collection Name.", "type": "string" }, "url": { "description": "Collection REST Url.", "type": "string" } } }, "id": { "type": "string" }, "isFork": { "description": "True if the repository was created as a fork", "type": "boolean" }, "name": { "type": "string" }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "sshUrl": { "type": "string" }, "url": { "type": "string" } } }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "size": { "description": "Compressed size (bytes) of the repository.", "type": "integer" }, "sshUrl": { "type": "string" }, "url": { "type": "string" }, "validRemoteUrls": { "type": "array", "items": { "type": "string" } }, "webUrl": { "type": "string" } } } } } }, { "name": "repositoryId", "type": "string", "info": "The name or ID of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.2' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pushesCreate" }, "task": true }, { "name": "pushesList", "summary": "Retrieves pushes associated with the specified repository.", "description": "Retrieves pushes associated with the specified repository.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The name or ID of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "skip", "type": "number", "info": "Number of pushes to skip.: 123", "required": false, "schema": { "title": "skip", "type": "number" } }, { "name": "top", "type": "number", "info": "Number of pushes to return.: 123", "required": false, "schema": { "title": "top", "type": "number" } }, { "name": "searchCriteriaFromDate", "type": "string", "info": "Search criteria attributes: fromDate, toDate, pusherId, refName, includeRefUpdates or includeLinks. fromDate: Start date to search from. toDate: End date to search to. pu...(description truncated): string", "required": false, "schema": { "title": "searchCriteriaFromDate", "type": "string" } }, { "name": "searchCriteriaIncludeLinks", "type": "boolean", "info": "Whether to include the _links field on the shallow references: boolean", "required": false, "schema": { "title": "searchCriteriaIncludeLinks", "type": "boolean" } }, { "name": "searchCriteriaIncludeRefUpdates", "type": "boolean", "info": "Search criteria attributes: fromDate, toDate, pusherId, refName, includeRefUpdates or includeLinks. fromDate: Start date to search from. toDate: End date to search to. pu...(description truncated): boolean", "required": false, "schema": { "title": "searchCriteriaIncludeRefUpdates", "type": "boolean" } }, { "name": "searchCriteriaPusherId", "type": "string", "info": "Search criteria attributes: fromDate, toDate, pusherId, refName, includeRefUpdates or includeLinks. fromDate: Start date to search from. toDate: End date to search to. pu...(description truncated): string", "required": false, "schema": { "title": "searchCriteriaPusherId", "type": "string" } }, { "name": "searchCriteriaRefName", "type": "string", "info": "Search criteria attributes: fromDate, toDate, pusherId, refName, includeRefUpdates or includeLinks. fromDate: Start date to search from. toDate: End date to search to. pu...(description truncated): string", "required": false, "schema": { "title": "searchCriteriaRefName", "type": "string" } }, { "name": "searchCriteriaToDate", "type": "string", "info": "Search criteria attributes: fromDate, toDate, pusherId, refName, includeRefUpdates or includeLinks. fromDate: Start date to search from. toDate: End date to search to. pu...(description truncated): string", "required": false, "schema": { "title": "searchCriteriaToDate", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.2' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } } ], "properties": { "commits": { "type": "array", "items": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } } }, "refUpdates": { "type": "array", "items": { "description": "", "type": "object", "properties": { "isLocked": { "type": "boolean" }, "name": { "type": "string" }, "newObjectId": { "type": "string" }, "oldObjectId": { "type": "string" }, "repositoryId": { "type": "string" } } } }, "repository": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "defaultBranch": { "type": "string" }, "id": { "type": "string" }, "isDisabled": { "description": "True if the repository is disabled. False otherwise.", "type": "boolean" }, "isFork": { "description": "True if the repository was created as a fork.", "type": "boolean" }, "name": { "type": "string" }, "parentRepository": { "description": "", "type": "object", "properties": { "collection": { "description": "Reference object for a TeamProjectCollection.", "type": "object", "properties": { "id": { "description": "Collection Id.", "type": "string" }, "name": { "description": "Collection Name.", "type": "string" }, "url": { "description": "Collection REST Url.", "type": "string" } } }, "id": { "type": "string" }, "isFork": { "description": "True if the repository was created as a fork", "type": "boolean" }, "name": { "type": "string" }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "sshUrl": { "type": "string" }, "url": { "type": "string" } } }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "size": { "description": "Compressed size (bytes) of the repository.", "type": "integer" }, "sshUrl": { "type": "string" }, "url": { "type": "string" }, "validRemoteUrls": { "type": "array", "items": { "type": "string" } }, "webUrl": { "type": "string" } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pushesList" }, "task": true }, { "name": "pushesGet", "summary": "Retrieves a particular push.", "description": "Retrieves a particular push.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The name or ID of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "pushId", "type": "number", "info": "ID of the push.: 123", "required": true, "schema": { "title": "pushId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "includeCommits", "type": "number", "info": "The number of commits to include in the result.: 123", "required": false, "schema": { "title": "includeCommits", "type": "number" } }, { "name": "includeRefUpdates", "type": "boolean", "info": "If true, include the list of refs that were updated by the push.: boolean", "required": false, "schema": { "title": "includeRefUpdates", "type": "boolean" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.2' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pushesGet" }, "task": true }, { "name": "refsList", "summary": "Queries the provided repository for its refs and returns them.", "description": "Queries the provided repository for its refs and returns them.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The name or ID of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "filter", "type": "string", "info": "[optional] A filter to apply to the refs (starts with).: string", "required": false, "schema": { "title": "filter", "type": "string" } }, { "name": "includeLinks", "type": "boolean", "info": "[optional] Specifies if referenceLinks should be included in the result. default is false.: boolean", "required": false, "schema": { "title": "includeLinks", "type": "boolean" } }, { "name": "includeStatuses", "type": "boolean", "info": "[optional] Includes up to the first 1000 commit statuses for each ref. The default value is false.: boolean", "required": false, "schema": { "title": "includeStatuses", "type": "boolean" } }, { "name": "includeMyBranches", "type": "boolean", "info": "[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 fil...(description truncated): boolean", "required": false, "schema": { "title": "includeMyBranches", "type": "boolean" } }, { "name": "latestStatusesOnly", "type": "boolean", "info": "[optional] True to include only the tip commit status for each ref. This option requires `includeStatuses` to be true. The default value is false.: boolean", "required": false, "schema": { "title": "latestStatusesOnly", "type": "boolean" } }, { "name": "peelTags", "type": "boolean", "info": "[optional] Annotated tags will populate the PeeledObjectId property. default is false.: boolean", "required": false, "schema": { "title": "peelTags", "type": "boolean" } }, { "name": "filterContains", "type": "string", "info": "[optional] A filter to apply to the refs (contains).: string", "required": false, "schema": { "title": "filterContains", "type": "string" } }, { "name": "top", "type": "number", "info": "[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.: 123", "required": false, "schema": { "title": "top", "type": "number" } }, { "name": "continuationToken", "type": "string", "info": "The continuation token used for pagination.: string", "required": false, "schema": { "title": "continuationToken", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "creator": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "isLocked": { "type": "boolean" }, "isLockedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "name": { "type": "string" }, "objectId": { "type": "string" }, "peeledObjectId": { "type": "string" }, "statuses": { "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "type": "string" } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/refsList" }, "task": true }, { "name": "refsUpdateRef", "summary": "Lock or Unlock a branch.", "description": "Lock or Unlock a branch.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": "The ref update action (lock/unlock) to perform: {\"isLocked\": \"boolean\", \"name\": \"string\", \"newObjectId\": \"string\", \"oldObjectId\": \"string\", \"repositoryId\": \"string\"}", "required": true, "schema": { "description": "", "type": "object", "properties": { "isLocked": { "type": "boolean" }, "name": { "type": "string" }, "newObjectId": { "type": "string" }, "oldObjectId": { "type": "string" }, "repositoryId": { "type": "string" } } } }, { "name": "repositoryId", "type": "string", "info": "The name or ID of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "filter", "type": "string", "info": "The name of the branch to lock/unlock: string", "required": true, "schema": { "title": "filter", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "projectId", "type": "string", "info": "ID or name of the team project. Optional if specifying an ID for repository.: string", "required": false, "schema": { "title": "projectId", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/refsUpdateRef" }, "task": true }, { "name": "refsUpdateRefs", "summary": "Creating, updating, or deleting refs(branches).\n\nUpdating a ref means making it point at a differen", "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.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "array", "info": "List of ref updates to attempt to perform: array", "required": true, "schema": { "type": "array", "items": { "type": "object" } } }, { "name": "repositoryId", "type": "string", "info": "The name or ID of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "projectId", "type": "string", "info": "ID or name of the team project. Optional if specifying an ID for repository.: string", "required": false, "schema": { "title": "projectId", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "", "type": "object", "properties": { "customMessage": { "description": "Custom message for the result object For instance, Reason for failing.", "type": "string" }, "isLocked": { "description": "Whether the ref is locked or not", "type": "boolean" }, "name": { "description": "Ref name", "type": "string" }, "newObjectId": { "description": "New object ID", "type": "string" }, "oldObjectId": { "description": "Old object ID", "type": "string" }, "rejectedBy": { "description": "Name of the plugin that rejected the updated.", "type": "string" }, "repositoryId": { "description": "Repository ID", "type": "string" }, "success": { "description": "True if the ref update succeeded, false otherwise", "type": "boolean" }, "updateStatus": { "description": "Status of the update from the TFS server.", "enum": [ "succeeded", "forcePushRequired", "staleOldObjectId", "invalidRefName", "unprocessed", "unresolvableToCommit", "writePermissionRequired", "manageNotePermissionRequired", "createBranchPermissionRequired", "createTagPermissionRequired", "rejectedByPlugin", "locked", "refNameConflict", "rejectedByPolicy", "succeededNonExistentRef", "succeededCorruptRef" ], "x-ms-enum": { "name": "GitRefUpdateStatus", "values": [ { "value": "succeeded", "description": "Indicates that the ref update request was completed successfully." }, { "value": "forcePushRequired", "description": "Indicates that the ref update request could not be completed because part of the graph would be disconnected by this change, and the caller does not have ForcePush permission on the repository." }, { "value": "staleOldObjectId", "description": "Indicates that the ref update request could not be completed because the old object ID presented in the request was not the object ID of the ref when the database attempted the update. The most likely scenario is that the caller lost a race to update the ref." }, { "value": "invalidRefName", "description": "Indicates that the ref update request could not be completed because the ref name presented in the request was not valid." }, { "value": "unprocessed", "description": "The request was not processed" }, { "value": "unresolvableToCommit", "description": "The ref update request could not be completed because the new object ID for the ref could not be resolved to a commit object (potentially through any number of tags)" }, { "value": "writePermissionRequired", "description": "The ref update request could not be completed because the user lacks write permissions required to write this ref" }, { "value": "manageNotePermissionRequired", "description": "The ref update request could not be completed because the user lacks note creation permissions required to write this note" }, { "value": "createBranchPermissionRequired", "description": "The ref update request could not be completed because the user lacks the permission to create a branch" }, { "value": "createTagPermissionRequired", "description": "The ref update request could not be completed because the user lacks the permission to create a tag" }, { "value": "rejectedByPlugin", "description": "The ref update could not be completed because it was rejected by the plugin." }, { "value": "locked", "description": "The ref update could not be completed because the ref is locked by another user." }, { "value": "refNameConflict", "description": "The ref update could not be completed because, in case-insensitive mode, the ref name conflicts with an existing, differently-cased ref name." }, { "value": "rejectedByPolicy", "description": "The ref update could not be completed because it was rejected by policy." }, { "value": "succeededNonExistentRef", "description": "Indicates that the ref update request was completed successfully, but the ref doesn't actually exist so no changes were made. This should only happen during deletes." }, { "value": "succeededCorruptRef", "description": "Indicates that the ref update request was completed successfully, but the passed-in ref was corrupt - as in, the old object ID was bad. This should only happen during deletes." } ] } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/refsUpdateRefs" }, "task": true }, { "name": "revertsCreate", "summary": "Starts the operation to create a new branch which reverts changes introduced by either a specific c", "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.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"generatedRefName\": \"string\", \"ontoRefName\": \"string\", \"repository\": {\"_links\": {\"links\": \"object\"}, \"defaultBranch\": \"string\", \"id\": \"string\", \"isDisabled\": \"boolean\", \"isFork\": \"boolean\", \"name\": \"string\", \"parentRepository\": {\"collection\": {\"id\": \"string\", \"name\": \"string\", \"url\": \"string\"}, \"id\": \"string\", \"isFork\": \"boolean\", \"name\": \"string\", \"project\": {\"abbreviation\": \"string\", \"defaultTeamImageUrl\": \"string\", \"description\": \"string\", \"id\": \"string\", \"lastUpdateTime\": \"string\", \"name\": \"string\", \"revision\": 123, \"state\": \"undefined\", \"url\": \"string\", \"visibility\": \"undefined\"}, \"remoteUrl\": \"string\", \"sshUrl\": \"string\", \"url\": \"string\"}, \"project\": {\"abbreviation\": \"string\", \"defaultTeamImageUrl\": \"string\", \"description\": \"string\", \"id\": \"string\", \"lastUpdateTime\": \"string\", \"name\": \"string\", \"revision\": 123, \"state\": \"undefined\", \"url\": \"string\", \"visibility\": \"undefined\"}, \"remoteUrl\": \"string\", \"size\": 123, \"sshUrl\": \"string\", \"url\": \"string\", \"validRemoteUrls\": \"array\", \"webUrl\": \"string\"}, \"source\": {\"commitList\": [{\"_links\": {\"links\": \"object\"}, \"author\": {\"date\": \"string\", \"email\": \"string\", \"imageUrl\": \"string\", \"name\": \"string\"}, \"changeCounts\": }, \"changes\": [{\"changeId\": 123, \"newContentTemplate\": {\"name\": \"string\", \"type\": \"string\"}, \"originalPath\": \"string\"}], \"comment\": \"string\", \"commentTruncated\": \"boolean\", \"commitId\": \"string\", \"committer\": {\"date\": \"string\", \"email\": \"string\", \"imageUrl\": \"string\", \"name\": \"string\"}, \"parents\": \"array\", \"push\": {\"_links\": {\"links\": \"object\"}, \"date\": \"string\", \"pushedBy\": {\"directoryAlias\": \"string\", \"id\": \"string\", \"imageUrl\": \"string\", \"inactive\": \"boolean\", \"isAadIdentity\": \"boolean\", \"isContainer\": \"boolean\", \"isDeletedInOrigin\": \"boolean\", \"profileUrl\": \"string\", \"uniqueName\": \"string\"}, \"pushId\": 123, \"url\": \"string\"}, \"remoteUrl\": \"string\", \"statuses\": [{\"_links\": {\"links\": \"object\"}, \"context\": {\"genre\": \"string\", \"name\": \"string\"}, \"createdBy\": {\"directoryAlias\": \"string\", \"id\": \"string\", \"imageUrl\": \"string\", \"inactive\": \"boolean\", \"isAadIdentity\": \"boolean\", \"isContainer\": \"boolean\", \"isDeletedInOrigin\": \"boolean\", \"profileUrl\": \"string\", \"uniqueName\": \"string\"}, \"creationDate\": \"string\", \"description\": \"string\", \"id\": 123, \"state\": \"undefined\", \"targetUrl\": \"string\", \"updatedDate\": \"string\"}], \"url\": \"string\", \"workItems\": [{\"id\": \"string\", \"url\": \"string\"}]}], \"pullRequestId\": 123}}", "required": true, "schema": { "description": "Parameters that are provided in the request body when requesting to cherry pick or revert.", "type": "object", "properties": { "generatedRefName": { "description": "Proposed target branch name for the cherry pick or revert operation.", "type": "string" }, "ontoRefName": { "description": "The target branch for the cherry pick or revert operation.", "type": "string" }, "repository": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "defaultBranch": { "type": "string" }, "id": { "type": "string" }, "isDisabled": { "description": "True if the repository is disabled. False otherwise.", "type": "boolean" }, "isFork": { "description": "True if the repository was created as a fork.", "type": "boolean" }, "name": { "type": "string" }, "parentRepository": { "description": "", "type": "object", "properties": { "collection": { "description": "Reference object for a TeamProjectCollection.", "type": "object", "properties": { "id": { "description": "Collection Id.", "type": "string" }, "name": { "description": "Collection Name.", "type": "string" }, "url": { "description": "Collection REST Url.", "type": "string" } } }, "id": { "type": "string" }, "isFork": { "description": "True if the repository was created as a fork", "type": "boolean" }, "name": { "type": "string" }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "sshUrl": { "type": "string" }, "url": { "type": "string" } } }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "size": { "description": "Compressed size (bytes) of the repository.", "type": "integer" }, "sshUrl": { "type": "string" }, "url": { "type": "string" }, "validRemoteUrls": { "type": "array", "items": { "type": "string" } }, "webUrl": { "type": "string" } } }, "source": { "description": "GitAsyncRefOperationSource specifies the pull request or list of commits to use when making a cherry pick and revert operation request. Only one should be provided.", "type": "object", "properties": { "commitList": { "description": "A list of commits to cherry pick or revert", "type": "array", "items": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } } }, "pullRequestId": { "description": "Id of the pull request to cherry pick or revert", "type": "integer" } } } } } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "ID of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/revertsCreate" }, "task": true }, { "name": "revertsGetRevertForRefName", "summary": "Retrieve information about a revert operation for a specific branch.", "description": "Retrieve information about a revert operation for a specific branch.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "ID of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "refName", "type": "string", "info": "The GitAsyncRefOperationParameters generatedRefName used for the revert operation.: string", "required": true, "schema": { "title": "refName", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/revertsGetRevertForRefName" }, "task": true }, { "name": "revertsGetRevert", "summary": "Retrieve information about a revert operation by revert Id.", "description": "Retrieve information about a revert operation by revert Id.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "revertId", "type": "number", "info": "ID of the revert operation.: 123", "required": true, "schema": { "title": "revertId", "type": "number" } }, { "name": "repositoryId", "type": "string", "info": "ID of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/revertsGetRevert" }, "task": true }, { "name": "statsList", "summary": "Retrieve statistics about all branches within a repository.", "description": "Retrieve statistics about all branches within a repository.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "The name or ID of the repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "baseVersionDescriptorVersion", "type": "string", "info": "Version string identifier (name of tag/branch, SHA1 of commit): string", "required": false, "schema": { "title": "baseVersionDescriptorVersion", "type": "string" } }, { "name": "baseVersionDescriptorVersionOptions", "type": "string", "info": "Version options - Specify additional modifiers to version (e.g Previous): Must be one of [none, previousChange, firstParent]", "required": false, "schema": { "title": "baseVersionDescriptorVersionOptions", "type": "string" } }, { "name": "baseVersionDescriptorVersionType", "type": "string", "info": "Version type (branch, tag, or commit). Determines how Id is interpreted: Must be one of [branch, tag, commit]", "required": false, "schema": { "title": "baseVersionDescriptorVersionType", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "Ahead and behind counts for a particular ref.", "type": "object", "properties": { "aheadCount": { "description": "Number of commits ahead.", "type": "integer" }, "behindCount": { "description": "Number of commits behind.", "type": "integer" }, "commit": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } }, "isBaseVersion": { "description": "True if this is the result for the base version.", "type": "boolean" }, "name": { "description": "Name of the ref.", "type": "string" } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/statsList" }, "task": true }, { "name": "suggestionsList", "summary": "Retrieve a pull request suggestion for a particular repository or team project.", "description": "Retrieve a pull request suggestion for a particular repository or team project.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "ID of the git repository.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "An object describing the git suggestion. Git suggestions are currently limited to suggested pull requests.", "type": "object", "properties": { "properties": { "description": "Specific properties describing the suggestion.", "type": "object", "additionalProperties": { "type": "object" } }, "type": { "description": "The type of suggestion (e.g. pull request).", "type": "string" } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/suggestionsList" }, "task": true }, { "name": "treesGet", "summary": "The Tree endpoint returns the collection of objects underneath the specified tree. Trees are folder", "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.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryId", "type": "string", "info": "Repository Id.: string", "required": true, "schema": { "title": "repositoryId", "type": "string" } }, { "name": "sha1", "type": "string", "info": "SHA1 hash of the tree object.: string", "required": true, "schema": { "title": "sha1", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "projectId", "type": "string", "info": "Project Id.: string", "required": false, "schema": { "title": "projectId", "type": "string" } }, { "name": "recursive", "type": "boolean", "info": "Search recursively. Include trees underneath this tree. Default is false.: boolean", "required": false, "schema": { "title": "recursive", "type": "boolean" } }, { "name": "fileName", "type": "string", "info": "Name to use if a .zip file is returned. Default is the object ID.: string", "required": false, "schema": { "title": "fileName", "type": "string" } }, { "name": "format", "type": "string", "info": "Use \"zip\". Defaults to the MIME type set in the Accept header.: string", "required": false, "schema": { "title": "format", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/treesGet" }, "task": true }, { "name": "mergeBasesList", "summary": "Find the merge bases of two commits, optionally across forks. If otherRepositoryId is not specified", "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.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryNameOrId", "type": "string", "info": "ID or name of the local repository.: string", "required": true, "schema": { "title": "repositoryNameOrId", "type": "string" } }, { "name": "commitId", "type": "string", "info": "First commit, usually the tip of the target branch of the potential merge.: string", "required": true, "schema": { "title": "commitId", "type": "string" } }, { "name": "otherCommitId", "type": "string", "info": "Other commit, usually the tip of the source branch of the potential merge.: string", "required": true, "schema": { "title": "otherCommitId", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "otherCollectionId", "type": "string", "info": "The collection ID where otherCommitId lives.: string", "required": false, "schema": { "title": "otherCollectionId", "type": "string" } }, { "name": "otherRepositoryId", "type": "string", "info": "The repository ID where otherCommitId lives.: string", "required": false, "schema": { "title": "otherRepositoryId", "type": "string" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "Provides properties that describe a Git commit and associated metadata.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "author": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "changeCounts": { "description": "", "type": "object", "allOf": [ { "type": "object", "additionalProperties": { "type": "integer" } } ], "properties": {} }, "changes": { "description": "An enumeration of the changes included with the commit.", "type": "array", "items": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "changeType": { "description": "The type of change that was made to the item.", "enum": [ "none", "add", "edit", "encoding", "rename", "delete", "undelete", "branch", "merge", "lock", "rollback", "sourceRename", "targetRename", "property", "all" ], "x-ms-enum": { "name": "VersionControlChangeType", "values": [ { "value": "none", "description": "" }, { "value": "add", "description": "" }, { "value": "edit", "description": "" }, { "value": "encoding", "description": "" }, { "value": "rename", "description": "" }, { "value": "delete", "description": "" }, { "value": "undelete", "description": "" }, { "value": "branch", "description": "" }, { "value": "merge", "description": "" }, { "value": "lock", "description": "" }, { "value": "rollback", "description": "" }, { "value": "sourceRename", "description": "" }, { "value": "targetRename", "description": "" }, { "value": "property", "description": "" }, { "value": "all", "description": "" } ] } }, "item": { "description": "Current version.", "type": "string" }, "newContent": { "description": "", "type": "object", "properties": { "content": { "type": "string" }, "contentType": { "enum": [ "rawText", "base64Encoded" ], "x-ms-enum": { "name": "ItemContentType", "values": [ { "value": "rawText", "description": "" }, { "value": "base64Encoded", "description": "" } ] } } } }, "sourceServerItem": { "description": "Path of the item on the server.", "type": "string" }, "url": { "description": "URL to retrieve the item.", "type": "string" } } } ], "properties": { "changeId": { "description": "ID of the change within the group of changes.", "type": "integer" }, "newContentTemplate": { "description": "", "type": "object", "properties": { "name": { "description": "Name of the Template", "type": "string" }, "type": { "description": "Type of the Template", "type": "string" } } }, "originalPath": { "description": "Original path of item if different from current path.", "type": "string" } } } }, "comment": { "description": "Comment or message of the commit.", "type": "string" }, "commentTruncated": { "description": "Indicates if the comment is truncated from the full Git commit comment message.", "type": "boolean" }, "commitId": { "description": "ID (SHA-1) of the commit.", "type": "string" }, "committer": { "description": "User info and date for Git operations.", "type": "object", "properties": { "date": { "description": "Date of the Git operation.", "type": "string" }, "email": { "description": "Email address of the user performing the Git operation.", "type": "string" }, "imageUrl": { "description": "Url for the user's avatar.", "type": "string" }, "name": { "description": "Name of the user performing the Git operation.", "type": "string" } } }, "parents": { "description": "An enumeration of the parent commit IDs for this commit.", "type": "array", "items": { "type": "string" } }, "push": { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "date": { "type": "string" }, "pushedBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "pushId": { "type": "integer" }, "url": { "type": "string" } } }, "remoteUrl": { "description": "Remote URL path to the commit.", "type": "string" }, "statuses": { "description": "A list of status metadata from services and extensions that may associate additional information to the commit.", "type": "array", "items": { "description": "This class contains the metadata of a service/extension posting a status.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "context": { "description": "Status context that uniquely identifies the status.", "type": "object", "properties": { "genre": { "description": "Genre of the status. Typically name of the service/tool generating the status, can be empty.", "type": "string" }, "name": { "description": "Name identifier of the status, cannot be null or empty.", "type": "string" } } }, "createdBy": { "description": "", "type": "object", "allOf": [ { "description": "", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "descriptor": { "description": "The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.", "type": "string" }, "displayName": { "description": "This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.", "type": "string" }, "url": { "description": "This url is the full route to the source resource of this graph subject.", "type": "string" } } } ], "properties": { "directoryAlias": { "description": "Deprecated - Can be retrieved by querying the Graph user referenced in the \"self\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "id": { "type": "string" }, "imageUrl": { "description": "Deprecated - Available in the \"avatar\" entry of the IdentityRef \"_links\" dictionary", "type": "string" }, "inactive": { "description": "Deprecated - Can be retrieved by querying the Graph membership state referenced in the \"membershipState\" entry of the GraphUser \"_links\" dictionary", "type": "boolean" }, "isAadIdentity": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)", "type": "boolean" }, "isContainer": { "description": "Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)", "type": "boolean" }, "isDeletedInOrigin": { "type": "boolean" }, "profileUrl": { "description": "Deprecated - not in use in most preexisting implementations of ToIdentityRef", "type": "string" }, "uniqueName": { "description": "Deprecated - use Domain+PrincipalName instead", "type": "string" } } }, "creationDate": { "description": "Creation date and time of the status.", "type": "string" }, "description": { "description": "Status description. Typically describes current state of the status.", "type": "string" }, "id": { "description": "Status identifier.", "type": "integer" }, "state": { "description": "State of the status.", "enum": [ "notSet", "pending", "succeeded", "failed", "error", "notApplicable" ], "x-ms-enum": { "name": "GitStatusState", "values": [ { "value": "notSet", "description": "Status state not set. Default state." }, { "value": "pending", "description": "Status pending." }, { "value": "succeeded", "description": "Status succeeded." }, { "value": "failed", "description": "Status failed." }, { "value": "error", "description": "Status with an error." }, { "value": "notApplicable", "description": "Status is not applicable to the target object." } ] } }, "targetUrl": { "description": "URL with status details.", "type": "string" }, "updatedDate": { "description": "Last update date and time of the status.", "type": "string" } } } }, "url": { "description": "REST URL for this resource.", "type": "string" }, "workItems": { "description": "A list of workitems associated with this commit.", "type": "array", "items": { "description": "", "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/mergeBasesList" }, "task": true }, { "name": "forksList", "summary": "Retrieve all forks of a repository in the collection.", "description": "Retrieve all forks of a repository in the collection.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryNameOrId", "type": "string", "info": "The name or ID of the repository.: string", "required": true, "schema": { "title": "repositoryNameOrId", "type": "string" } }, { "name": "collectionId", "type": "string", "info": "Team project collection ID.: string", "required": true, "schema": { "title": "collectionId", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "includeLinks", "type": "boolean", "info": "True to include links.: boolean", "required": false, "schema": { "title": "includeLinks", "type": "boolean" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "", "type": "object", "properties": { "collection": { "description": "Reference object for a TeamProjectCollection.", "type": "object", "properties": { "id": { "description": "Collection Id.", "type": "string" }, "name": { "description": "Collection Name.", "type": "string" }, "url": { "description": "Collection REST Url.", "type": "string" } } }, "id": { "type": "string" }, "isFork": { "description": "True if the repository was created as a fork", "type": "boolean" }, "name": { "type": "string" }, "project": { "description": "Represents a shallow reference to a TeamProject.", "type": "object", "properties": { "abbreviation": { "description": "Project abbreviation.", "type": "string" }, "defaultTeamImageUrl": { "description": "Url to default team identity image.", "type": "string" }, "description": { "description": "The project's description (if any).", "type": "string" }, "id": { "description": "Project identifier.", "type": "string" }, "lastUpdateTime": { "description": "Project last update time.", "type": "string" }, "name": { "description": "Project name.", "type": "string" }, "revision": { "description": "Project revision.", "type": "integer" }, "state": { "description": "Project state.", "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." } ] } }, "url": { "description": "Url to the full version of the object.", "type": "string" }, "visibility": { "description": "Project visibility.", "enum": [ "private", "public" ], "x-ms-enum": { "name": "ProjectVisibility", "values": [ { "value": "private", "description": "The project is only visible to users with explicit access." }, { "value": "public", "description": "The project is visible to all." } ] } } } }, "remoteUrl": { "type": "string" }, "sshUrl": { "type": "string" }, "url": { "type": "string" } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/forksList" }, "task": true }, { "name": "forksCreateForkSyncRequest", "summary": "Request that another repository's refs be fetched into this one. It syncs two existing forks. To cr", "description": "Request that another repository's refs be fetched into this one. It syncs two existing forks. To create a fork, please see the repositories endpoint", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": "Source repository and ref mapping.: {\"source\": {\"collectionId\": \"string\", \"projectId\": \"string\", \"repositoryId\": \"string\"}, \"sourceToTargetRefs\": [{\"sourceRef\": \"string\", \"targetRef\": \"string\"}]}", "required": true, "schema": { "description": "Parameters for creating a fork request", "type": "object", "properties": { "source": { "description": "Globally unique key for a repository.", "type": "object", "properties": { "collectionId": { "description": "Team Project Collection ID of the collection for the repository.", "type": "string" }, "projectId": { "description": "Team Project ID of the project for the repository.", "type": "string" }, "repositoryId": { "description": "ID of the repository.", "type": "string" } } }, "sourceToTargetRefs": { "description": "If supplied, the set of ref mappings to use when performing a \"sync\" or create. If missing, all refs will be synchronized.", "type": "array", "items": { "description": "", "type": "object", "properties": { "sourceRef": { "description": "The source ref to copy. For example, refs/heads/master.", "type": "string" }, "targetRef": { "description": "The target ref to update. For example, refs/heads/master.", "type": "string" } } } } } } }, { "name": "repositoryNameOrId", "type": "string", "info": "The name or ID of the repository.: string", "required": true, "schema": { "title": "repositoryNameOrId", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "includeLinks", "type": "boolean", "info": "True to include links: boolean", "required": false, "schema": { "title": "includeLinks", "type": "boolean" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/forksCreateForkSyncRequest" }, "task": true }, { "name": "forksGetForkSyncRequests", "summary": "Retrieve all requested fork sync operations on this repository.", "description": "Retrieve all requested fork sync operations on this repository.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryNameOrId", "type": "string", "info": "The name or ID of the repository.: string", "required": true, "schema": { "title": "repositoryNameOrId", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "includeAbandoned", "type": "boolean", "info": "True to include abandoned requests.: boolean", "required": false, "schema": { "title": "includeAbandoned", "type": "boolean" } }, { "name": "includeLinks", "type": "boolean", "info": "True to include links.: boolean", "required": false, "schema": { "title": "includeLinks", "type": "boolean" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "description": "Request to sync data between two forks.", "type": "object", "properties": { "_links": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "detailedStatus": { "description": "Status information about a requested fork operation.", "type": "object", "properties": { "allSteps": { "description": "All valid steps for the forking process", "type": "array", "items": { "type": "string" } }, "currentStep": { "description": "Index into AllSteps for the current step", "type": "integer" }, "errorMessage": { "description": "Error message if the operation failed.", "type": "string" } } }, "operationId": { "description": "Unique identifier for the operation.", "type": "integer" }, "source": { "description": "Globally unique key for a repository.", "type": "object", "properties": { "collectionId": { "description": "Team Project Collection ID of the collection for the repository.", "type": "string" }, "projectId": { "description": "Team Project ID of the project for the repository.", "type": "string" }, "repositoryId": { "description": "ID of the repository.", "type": "string" } } }, "sourceToTargetRefs": { "description": "If supplied, the set of ref mappings to use when performing a \"sync\" or create. If missing, all refs will be synchronized.", "type": "array", "items": { "description": "", "type": "object", "properties": { "sourceRef": { "description": "The source ref to copy. For example, refs/heads/master.", "type": "string" }, "targetRef": { "description": "The target ref to update. For example, refs/heads/master.", "type": "string" } } } }, "status": { "enum": [ "queued", "inProgress", "completed", "failed", "abandoned" ], "x-ms-enum": { "name": "GitAsyncOperationStatus", "values": [ { "value": "queued", "description": "The operation is waiting in a queue and has not yet started." }, { "value": "inProgress", "description": "The operation is currently in progress." }, { "value": "completed", "description": "The operation has completed." }, { "value": "failed", "description": "The operation has failed. Check for an error message." }, { "value": "abandoned", "description": "The operation has been abandoned." } ] } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/forksGetForkSyncRequests" }, "task": true }, { "name": "forksGetForkSyncRequest", "summary": "Get a specific fork sync operation's details.", "description": "Get a specific fork sync operation's details.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "repositoryNameOrId", "type": "string", "info": "The name or ID of the repository.: string", "required": true, "schema": { "title": "repositoryNameOrId", "type": "string" } }, { "name": "forkSyncOperationId", "type": "number", "info": "OperationId of the sync request.: 123", "required": true, "schema": { "title": "forkSyncOperationId", "type": "number" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "includeLinks", "type": "boolean", "info": "True to include links.: boolean", "required": false, "schema": { "title": "includeLinks", "type": "boolean" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/forksGetForkSyncRequest" }, "task": true }, { "name": "mergesCreate", "summary": "Request a git merge operation. Currently we support merging only 2 commits.", "description": "Request a git merge operation. Currently we support merging only 2 commits.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "body", "type": "object", "info": "Parents commitIds and merge commit messsage.: {\"comment\": \"string\", \"parents\": \"array\"}", "required": true, "schema": { "description": "Parameters required for performing git merge.", "type": "object", "properties": { "comment": { "description": "Comment or message of the commit.", "type": "string" }, "parents": { "description": "An enumeration of the parent commit IDs for the merge commit.", "type": "array", "items": { "type": "string" } } } } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "repositoryNameOrId", "type": "string", "info": "The name or ID of the repository.: string", "required": true, "schema": { "title": "repositoryNameOrId", "type": "string" } }, { "name": "includeLinks", "type": "boolean", "info": "True to include links: boolean", "required": false, "schema": { "title": "includeLinks", "type": "boolean" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/mergesCreate" }, "task": true }, { "name": "mergesGet", "summary": "Get a specific merge operation's details.", "description": "Get a specific merge operation's details.", "input": [ { "name": "organization", "type": "string", "info": "The name of the Azure DevOps organization.: string", "required": true, "schema": { "title": "organization", "type": "string" } }, { "name": "project", "type": "string", "info": "Project ID or project name: string", "required": true, "schema": { "title": "project", "type": "string" } }, { "name": "repositoryNameOrId", "type": "string", "info": "The name or ID of the repository.: string", "required": true, "schema": { "title": "repositoryNameOrId", "type": "string" } }, { "name": "mergeOperationId", "type": "number", "info": "OperationId of the merge request.: 123", "required": true, "schema": { "title": "mergeOperationId", "type": "number" } }, { "name": "includeLinks", "type": "boolean", "info": "True to include links: boolean", "required": false, "schema": { "title": "includeLinks", "type": "boolean" } }, { "name": "apiVersion", "type": "string", "info": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.: string", "required": true, "schema": { "title": "apiVersion", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/mergesGet" }, "task": true } ], "views": [] }