@itentialopensource/adapter-azure_devops

{ "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" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapTroubleshootAdapter" }, "task": true }, { "name": "iapRunAdapterHealthcheck", "summary": "Runs healthcheck script for adapter", "description": "Runs healthcheck script for adapter", "input": [], "output": { "name": "result", "type": "boolean", "description": "Whether healthcheck passed or failed", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterHealthcheck" }, "task": true }, { "name": "iapRunAdapterConnectivity", "summary": "Runs connectivity check script for adapter", "description": "Runs connectivity check script for adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterConnectivity" }, "task": true }, { "name": "iapRunAdapterBasicGet", "summary": "Runs basicGet script for adapter", "description": "Runs basicGet script for adapter", "input": [ { "name": "maxCalls", "required": false, "type": "number", "info": "How many GET endpoints to test (defaults to 5)", "schema": { "title": "maxCalls", "type": "number", "default": 5 } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterBasicGet" }, "task": true }, { "name": "iapMoveAdapterEntitiesToDB", "summary": "Moves entities from an adapter into the Itential Platform database", "description": "Moves entities from an adapter into the Itential Platform database", "input": [], "output": { "name": "res", "type": "object", "description": "A JSON Object containing status, code and the response from the mongo transaction", "schema": { "title": "res", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapMoveAdapterEntitiesToDB" }, "task": true }, { "name": "iapDeactivateTasks", "summary": "Deactivate the inputted tasks", "description": "Deactivate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to deactivate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapDeactivateTasks" }, "task": true }, { "name": "iapActivateTasks", "summary": "Activate the inputted tasks", "description": "activate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to activate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapActivateTasks" }, "task": true }, { "name": "iapPopulateEntityCache", "summary": "Populate the cache for the given entities", "description": "Populate the cache for the given entities", "input": [ { "name": "entityTypes", "type": "array", "info": "the entity type(s) to populate", "required": true, "schema": { "title": "entityTypes", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapPopulateEntityCache" }, "task": true }, { "name": "iapRetrieveEntitiesCache", "summary": "Retrieves data from cache for specified entity type", "description": "Retrieves data from cache for specified entity type", "input": [ { "name": "entityType", "type": "string", "info": "entity of which to retrieve", "required": true, "schema": { "title": "entityType", "type": "string" } }, { "name": "options", "type": "object", "info": "settings of which data to return and how to return it", "required": false, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRetrieveEntitiesCache" }, "task": true }, { "name": "getDevice", "summary": "Get the Appliance", "description": "Get the Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevice" }, "task": false }, { "name": "getDevicesFiltered", "summary": "Get Appliances that match the filter", "description": "Get Appliances that match the filter", "input": [ { "name": "options", "type": "object", "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }", "required": true, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevicesFiltered" }, "task": false }, { "name": "isAlive", "summary": "Checks the status for the provided Appliance", "description": "Checks the status for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "boolean", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/isAlive" }, "task": false }, { "name": "getConfig", "summary": "Gets a config for the provided Appliance", "description": "Gets a config for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } }, { "name": "format", "type": "string", "info": "The format to be returned - this is ignored as we always return json", "required": false, "schema": { "title": "format", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getConfig" }, "task": false }, { "name": "iapGetDeviceCount", "summary": "Gets a device count from the system", "description": "Gets a device count from the system", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetDeviceCount" }, "task": false }, { "name": "iapExpandedGenericAdapterRequest", "summary": "Makes the requested generic call with additional options", "description": "Makes the requested generic call with additional options via metadata", "input": [ { "name": "metadata", "type": "object", "info": "metadata for the call (optional)", "description": "metadata for the call - allows for many enhancements (optional)", "schema": { "title": "metadata", "type": "object" }, "required": false }, { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": false }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": false }, { "name": "pathVars", "type": "object", "info": "the parameters to be put within the url path (optional)", "description": "the parameters to be put within the url path (optional)", "schema": { "title": "pathVars", "type": "object" }, "required": false }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapExpandedGenericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequest", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequestNoBasePath", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequestNoBasePath" }, "task": true }, { "name": "iapRunAdapterLint", "summary": "Run the adapter lint script to return the results", "description": "Run the adapter lint script to return the results", "input": [], "output": { "name": "result", "type": "string", "description": "A string containing the run results", "schema": { "title": "result", "type": "string" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterLint" }, "task": true }, { "name": "iapRunAdapterTests", "summary": "Run the adapter test scripts (baseunit and unit) to return the results", "description": "Run the adapter test scripts (baseunit and unit) to return the results", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterTests" }, "task": true }, { "name": "iapGetAdapterInventory", "summary": "Provide inventory information abbout the adapter", "description": "Provide inventory information abbout the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapGetAdapterInventory" }, "task": true }, { "name": "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",