UNPKG

@itentialopensource/adapter-azure_devops

Version:

This adapter integrates with system described as: Azure DevOps.

2,029 lines 318 kB
openapi: 3.0.0 info: title: adapter-azure_devops contact: {} version: '1.0.0' servers: - url: https://{defaultHost} variables: defaultHost: default: www.example.com paths: /{organization}/{project}/_apis/pipelines: post: summary: pipelinesCreate description: '' operationId: pipelinesCreate parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: project in: path description: '' required: true style: simple schema: type: string - name: apiVersion in: query description: '' required: true style: form explode: true schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/ApisPipelinesResponse' - description: Definition of a pipeline. deprecated: false get: summary: pipelinesList description: '' operationId: pipelinesList parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: project in: path description: '' required: true style: simple schema: type: string - name: orderBy in: query description: '' style: form explode: true schema: type: string - name: top in: query description: '' style: form explode: true schema: type: number format: double - name: continuationToken in: query description: '' style: form explode: true schema: type: string - name: apiVersion in: query description: '' required: true style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/ApisPipelinesResponse' description: '' deprecated: false /{organization}/{project}/_apis/pipelines/{pipelineId}: get: summary: pipelinesGet description: '' operationId: pipelinesGet parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: project in: path description: '' required: true style: simple schema: type: string - name: pipelineId in: path description: '' required: true style: simple schema: type: number format: double - name: pipelineVersion in: query description: '' style: form explode: true schema: type: number format: double - name: apiVersion in: query description: '' required: true style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/ApisPipelinesPipelineIdResponse' - description: Definition of a pipeline. deprecated: false /{organization}/{project}/_apis/pipelines/{pipelineId}/preview: post: summary: previewPreview description: '' operationId: previewPreview parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: project in: path description: '' required: true style: simple schema: type: string - name: pipelineId in: path description: '' required: true style: simple schema: type: number format: double - name: pipelineVersion in: query description: '' style: form explode: true schema: type: number format: double - name: apiVersion in: query description: '' required: true style: form explode: true schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/ApisPipelinesPipelineIdPreviewResponse' deprecated: false /{organization}/{project}/_apis/pipelines/{pipelineId}/runs: get: summary: runsList description: '' operationId: runsList parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: project in: path description: '' required: true style: simple schema: type: string - name: pipelineId in: path description: '' required: true style: simple schema: type: number format: double - name: apiVersion in: query description: '' required: true style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/ApisPipelinesPipelineIdRunsResponse' description: '' deprecated: false post: summary: runsRunPipeline description: '' operationId: runsRunPipeline parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: project in: path description: '' required: true style: simple schema: type: string - name: pipelineId in: path description: '' required: true style: simple schema: type: number format: double - name: pipelineVersion in: query description: '' style: form explode: true schema: type: number format: double - name: apiVersion in: query description: '' required: true style: form explode: true schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/ApisPipelinesPipelineIdRunsResponse' deprecated: false /{organization}/{project}/_apis/pipelines/{pipelineId}/runs/{runId}: get: summary: runsGet description: '' operationId: runsGet parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: project in: path description: '' required: true style: simple schema: type: string - name: pipelineId in: path description: '' required: true style: simple schema: type: number format: double - name: runId in: path description: '' required: true style: simple schema: type: number format: double - name: apiVersion in: query description: '' required: true style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/ApisPipelinesPipelineIdRunsRunIdResponse' deprecated: false /{organization}/{project}/_apis/pipelines/{pipelineId}/runs/{runId}/artifacts: get: summary: artifactsGet description: '' operationId: artifactsGet parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: project in: path description: '' required: true style: simple schema: type: string - name: pipelineId in: path description: '' required: true style: simple schema: type: number format: double - name: runId in: path description: '' required: true style: simple schema: type: number format: double - name: artifactName in: query description: '' required: true style: form explode: true schema: type: string - name: expand in: query description: '' style: form explode: true schema: type: string - name: apiVersion in: query description: '' required: true style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/ApisPipelinesPipelineIdRunsRunIdArtifactsResponse' - description: Artifacts are collections of files produced by a pipeline. Use artifacts to share files between stages in a pipeline or between different pipelines. deprecated: false /{organization}/{project}/_apis/pipelines/{pipelineId}/runs/{runId}/logs: get: summary: logsList description: '' operationId: logsList parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: project in: path description: '' required: true style: simple schema: type: string - name: pipelineId in: path description: '' required: true style: simple schema: type: number format: double - name: runId in: path description: '' required: true style: simple schema: type: number format: double - name: expand in: query description: '' style: form explode: true schema: type: string - name: apiVersion in: query description: '' required: true style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/ApisPipelinesPipelineIdRunsRunIdLogsResponse' - description: A collection of logs. deprecated: false /{organization}/{project}/_apis/pipelines/{pipelineId}/runs/{runId}/logs/{logId}: get: summary: logsGet description: '' operationId: logsGet parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: project in: path description: '' required: true style: simple schema: type: string - name: pipelineId in: path description: '' required: true style: simple schema: type: number format: double - name: runId in: path description: '' required: true style: simple schema: type: number format: double - name: logId in: path description: '' required: true style: simple schema: type: number format: double - name: expand in: query description: '' style: form explode: true schema: type: string - name: apiVersion in: query description: '' required: true style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/ApisPipelinesPipelineIdRunsRunIdLogsLogIdResponse' - description: Log for a pipeline. deprecated: false /{organization}/{project}/_apis/git/deletedrepositories: get: summary: repositoriesGetDeletedRepositories description: '' operationId: repositoriesGetDeletedRepositories parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: project in: path description: '' required: true style: simple schema: type: string - name: apiVersion in: query description: '' required: true style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/ApisGitDeletedrepositoriesResponse' description: '' deprecated: false /{organization}/{project}/_apis/git/recycleBin/repositories: get: summary: repositoriesGetRecycleBinRepositories description: '' operationId: repositoriesGetRecycleBinRepositories parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: project in: path description: '' required: true style: simple schema: type: string - name: apiVersion in: query description: '' required: true style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/ApisGitRecycleBinRepositoriesResponse' description: '' deprecated: false /{organization}/{project}/_apis/git/recycleBin/repositories/{repositoryId}: delete: summary: repositoriesDeleteRepositoryFromRecycleBin description: '' operationId: repositoriesDeleteRepositoryFromRecycleBin parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: project in: path description: '' required: true style: simple schema: type: string - name: repositoryId in: path description: '' required: true style: simple schema: type: string - name: apiVersion in: query description: '' required: true style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false patch: summary: repositoriesRestoreRepositoryFromRecycleBin description: '' operationId: repositoriesRestoreRepositoryFromRecycleBin parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: project in: path description: '' required: true style: simple schema: type: string - name: repositoryId in: path description: '' required: true style: simple schema: type: string - name: apiVersion in: query description: '' required: true style: form explode: true schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /{organization}/{project}/_apis/git/repositories: post: summary: repositoriesCreate description: '' operationId: repositoriesCreate parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: project in: path description: '' required: true style: simple schema: type: string - name: sourceRef in: query description: '' style: form explode: true schema: type: string - name: apiVersion in: query description: '' required: true style: form explode: true schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false get: summary: repositoriesList description: '' operationId: repositoriesList parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: project in: path description: '' required: true style: simple schema: type: string - name: includeLinks in: query description: '' style: form explode: true schema: type: boolean - name: includeAllUrls in: query description: '' style: form explode: true schema: type: boolean - name: includeHidden in: query description: '' style: form explode: true schema: type: boolean - name: apiVersion in: query description: '' required: true style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/ApisGitRepositoriesResponse' description: '' deprecated: false /{organization}/{project}/_apis/git/repositories/{repositoryId}: delete: summary: repositoriesDelete description: '' operationId: repositoriesDelete parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: project in: path description: '' required: true style: simple schema: type: string - name: repositoryId in: path description: '' required: true style: simple schema: type: string - name: apiVersion in: query description: '' required: true style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false get: summary: repositoriesGetRepository description: '' operationId: repositoriesGetRepository parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: project in: path description: '' required: true style: simple schema: type: string - name: repositoryId in: path description: '' required: true style: simple schema: type: string - name: apiVersion in: query description: '' required: true style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false patch: summary: repositoriesUpdate description: '' operationId: repositoriesUpdate parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: project in: path description: '' required: true style: simple schema: type: string - name: repositoryId in: path description: '' required: true style: simple schema: type: string - name: apiVersion in: query description: '' required: true style: form explode: true schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /{organization}/{project}/_apis/git/favorites/refs: post: summary: refsFavoritesCreate description: '' operationId: refsFavoritesCreate parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: project in: path description: '' required: true style: simple schema: type: string - name: apiVersion in: query description: '' required: true style: form explode: true schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false get: summary: refsFavoritesList description: '' operationId: refsFavoritesList parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: project in: path description: '' required: true style: simple schema: type: string - name: repositoryId in: query description: '' style: form explode: true schema: type: string - name: identityId in: query description: '' style: form explode: true schema: type: string - name: apiVersion in: query description: '' required: true style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/ApisGitFavoritesRefsResponse' description: '' deprecated: false /{organization}/{project}/_apis/git/favorites/refs/{favoriteId}: delete: summary: refsFavoritesDelete description: '' operationId: refsFavoritesDelete parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: project in: path description: '' required: true style: simple schema: type: string - name: favoriteId in: path description: '' required: true style: simple schema: type: number format: double - name: apiVersion in: query description: '' required: true style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false get: summary: refsFavoritesGet description: '' operationId: refsFavoritesGet parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: project in: path description: '' required: true style: simple schema: type: string - name: favoriteId in: path description: '' required: true style: simple schema: type: number format: double - name: apiVersion in: query description: '' required: true style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /{organization}/{project}/_apis/git/policy/configurations: get: summary: policyConfigurationsGet description: '' operationId: policyConfigurationsGet parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: project in: path description: '' required: true style: simple schema: type: string - name: repositoryId in: query description: '' style: form explode: true schema: type: string - name: refName in: query description: '' style: form explode: true schema: type: string - name: policyType in: query description: '' style: form explode: true schema: type: string - name: top in: query description: '' style: form explode: true schema: type: number format: double - name: continuationToken in: query description: '' style: form explode: true schema: type: string - name: apiVersion in: query description: '' required: true style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/ApisGitPolicyConfigurationsResponse' description: '' deprecated: false /{organization}/{project}/_apis/git/pullrequests: get: summary: pullRequestsGetPullRequestsByProject description: '' operationId: pullRequestsGetPullRequestsByProject parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: project in: path description: '' required: true style: simple schema: type: string - name: searchCriteriaCreatorId in: query description: '' style: form explode: true schema: type: string - name: searchCriteriaIncludeLinks in: query description: '' style: form explode: true schema: type: boolean - name: searchCriteriaRepositoryId in: query description: '' style: form explode: true schema: type: string - name: searchCriteriaReviewerId in: query description: '' style: form explode: true schema: type: string - name: searchCriteriaSourceRefName in: query description: '' style: form explode: true schema: type: string - name: searchCriteriaSourceRepositoryId in: query description: '' style: form explode: true schema: type: string - name: searchCriteriaStatus in: query description: '' style: form explode: true schema: type: string - name: searchCriteriaTargetRefName in: query description: '' style: form explode: true schema: type: string - name: maxCommentLength in: query description: '' style: form explode: true schema: type: number format: double - name: skip in: query description: '' style: form explode: true schema: type: number format: double - name: top in: query description: '' style: form explode: true schema: type: number format: double - name: apiVersion in: query description: '' required: true style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/ApisGitPullrequestsResponse' description: '' deprecated: false /{organization}/{project}/_apis/git/pullrequests/{pullRequestId}: get: summary: pullRequestsGetPullRequestById description: '' operationId: pullRequestsGetPullRequestById parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: project in: path description: '' required: true style: simple schema: type: string - name: pullRequestId in: path description: '' required: true style: simple schema: type: number format: double - name: apiVersion in: query description: '' required: true style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /{organization}/{project}/_apis/git/repositories/{repositoryId}/pullrequests: post: summary: pullRequestsCreate description: '' operationId: pullRequestsCreate parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: project in: path description: '' required: true style: simple schema: type: string - name: repositoryId in: path description: '' required: true style: simple schema: type: string - name: supportsIterations in: query description: '' style: form explode: true schema: type: boolean - name: apiVersion in: query description: '' required: true style: form explode: true schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false get: summary: pullRequestsGetPullRequests description: '' operationId: pullRequestsGetPullRequests parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: project in: path description: '' required: true style: simple schema: type: string - name: repositoryId in: path description: '' required: true style: simple schema: type: string - name: searchCriteriaCreatorId in: query description: '' style: form explode: true schema: type: string - name: searchCriteriaIncludeLinks in: query description: '' style: form explode: true schema: type: boolean - name: searchCriteriaRepositoryId in: query description: '' style: form explode: true schema: type: string - name: searchCriteriaReviewerId in: query description: '' style: form explode: true schema: type: string - name: searchCriteriaSourceRefName in: query description: '' style: form explode: true schema: type: string - name: searchCriteriaSourceRepositoryId in: query description: '' style: form explode: true schema: type: string - name: searchCriteriaStatus in: query description: '' style: form explode: true schema: type: string - name: searchCriteriaTargetRefName in: query description: '' style: form explode: true schema: type: string - name: maxCommentLength in: query description: '' style: form explode: true schema: type: number format: double - name: skip in: query description: '' style: form explode: true schema: type: number format: double - name: top in: query description: '' style: form explode: true schema: type: number format: double - name: apiVersion in: query description: '' required: true style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/ApisGitRepositoriesRepositoryIdPullrequestsResponse' description: '' deprecated: false /{organization}/{project}/_apis/git/repositories/{repositoryId}/pullrequests/{pullRequestId}: get: summary: pullRequestsGetPullRequest description: '' operationId: pullRequestsGetPullRequest parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: project in: path description: '' required: true style: simple schema: type: string - name: repositoryId in: path description: '' required: true style: simple schema: type: string - name: pullRequestId in: path description: '' required: true style: simple schema: type: number format: double - name: maxCommentLength in: query description: '' style: form explode: true schema: type: number format: double - name: skip in: query description: '' style: form explode: true schema: type: number format: double - name: top in: query description: '' style: form explode: true schema: type: number format: double - name: includeCommits in: query description: '' style: form explode: true schema: type: boolean - name: includeWorkItemRefs in: query description: '' style: form explode: true schema: type: boolean - name: apiVersion in: query description: '' required: true style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false patch: summary: pullRequestsUpdate description: '' operationId: pullRequestsUpdate parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: project in: path description: '' required: true style: simple schema: type: string - name: repositoryId in: path description: '' required: true style: simple schema: type: string - name: pullRequestId in: path description: '' required: true style: simple schema: type: number format: double - name: apiVersion in: query description: '' required: true style: form explode: true schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /{organization}/{project}/_apis/git/repositories/{repositoryId}/annotatedtags: post: summary: annotatedTagsCreate description: '' operationId: annotatedTagsCreate parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: project in: path description: '' required: true style: simple schema: type: string - name: repositoryId in: path description: '' required: true style: simple schema: type: string - name: apiVersion in: query description: '' required: true style: form explode: true schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /{organization}/{project}/_apis/git/repositories/{repositoryId}/annotatedtags/{objectId}: get: summary: annotatedTagsGet description: '' operationId: annotatedTagsGet parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: project in: path description: '' required: true style: simple schema: type: string - name: repositoryId in: path description: '' required: true style: simple schema: type: string - name: objectId in: path description: '' required: true style: simple schema: type: string - name: apiVersion in: query description: '' required: true style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /{organization}/{project}/_apis/git/repositories/{repositoryId}/blobs: post: summary: blobsGetBlobsZip description: '' operationId: blobsGetBlobsZip parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: project in: path description: '' required: true style: simple schema: type: string - name: repositoryId in: path description: '' required: true style: simple schema: type: string - name: filename in: query description: '' style: form explode: true schema: type: string - name: apiVersion in: query description: '' required: true style: form explode: true schema: type: string requestBody: description: '' content: application/json: schema: type: object required: false responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /{organization}/{project}/_apis/git/repositories/{repositoryId}/blobs/{sha1}: get: summary: blobsGetBlob description: '' operationId: blobsGetBlob parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: project in: path description: '' required: true style: simple schema: type: string - name: repositoryId in: path description: '' required: true style: simple schema: type: string - name: sha1 in: path description: '' required: true style: simple schema: type: string - name: download in: query description: '' style: form explode: true schema: type: boolean - name: fileName in: query description: '' style: form explode: true schema: type: string - name: format in: query description: '' style: form explode: true schema: type: string - name: resolveLfs in: query description: '' style: form explode: true schema: type: boolean - name: apiVersion in: query description: '' required: true style: form explode: true schema: type: string responses: '200': description: Successful operation headers: {} content: application/json: schema: type: object deprecated: false /{organization}/{project}/_apis/git/repositories/{repositoryId}/cherryPicks: post: summary: cherryPicksCreate description: '' operationId: cherryPicksCreate parameters: - name: organization in: path description: '' required: true style: simple schema: type: string - name: proje