```json { "openapi": "3.0.0", "info": { "contact": { "name": "DevOps Web", "url": "https://github.com/orgs/Unity-Technologies/teams/devops-web", "x-slack-channel-alerts": "#alert-plastic-orchestration-service" }, "description": "Unity Version Control client-facing APIs for working with VCS repositories\nattached to Unity Build Automation projects. Supports user JWTs, End User\nService Account API keys (basic auth), and End User Service Account bearer\ntokens (`Authorization: Bearer unity_sa_bt..`).\n", "title": "Unity Version Control Client API", "version": "1.0" }, "servers": [ { "description": "Production", "url": "https://services.api.unity.com/plastic/v1" } ], "paths": { "/organizations/{organizationId}/projects/{projectId}/vcs/repositories": { "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } } ], "get": { "description": "List repositories from the VCS provider without going through UBA's stored SCM credentials.\nGitHub: caller supplies a personal access token in the `x-vcs-pat` header. UVCS: no header\nrequired. The gateway-authenticated user identity and URL org/project identify the target.\n", "operationId": "getorganizationsorganizationidprojectsprojectidvcsrepositories", "parameters": [ { "in": "query", "name": "providerType", "required": true, "description": "Provider identifier (`GITHUB` or `UVCS`).", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "description": "Page size. Defaults to 30.", "schema": { "type": "number", "minimum": 1, "default": 30 } }, { "in": "query", "name": "next", "required": false, "description": "Opaque cursor returned in a previous response as `cursor.next`.", "schema": { "type": "string" } }, { "in": "query", "name": "previous", "required": false, "description": "Opaque cursor returned in a previous response as `cursor.previous`.", "schema": { "type": "string" } }, { "in": "header", "name": "x-vcs-pat", "required": false, "description": "GitHub personal access token. Required when `providerType=GITHUB`; ignored for UVCS. Never logged.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Page of repositories visible to the caller on the VCS provider.", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "description": { "type": "string" }, "defaultBranch": { "type": "string" }, "url": { "type": "string" }, "fullName": { "type": "string" }, "cloneUrl": { "type": "string" }, "owner": { "type": "object", "properties": { "login": { "type": "string" } } } } } }, "cursor": { "type": "object", "properties": { "next": { "type": "string" }, "previous": { "type": "string" } } }, "limit": { "type": "number" } } } } } }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "GET /organizations/{organizationId}/projects/{projectId}/vcs/repositories", "tags": [ "vcs" ] } }, "/organizations/{organizationId}/projects/{projectId}/vcs/repositories/{repository}/branches": { "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repository", "required": true, "schema": { "type": "string" } } ], "get": { "description": "List branches in a VCS repository. Two auth modes on the same route.\nOmit `providerType` for the default flow, which resolves credentials via UBA scm-credentials.\nSet `providerType=GITHUB` with the PAT in `x-vcs-pat`, or `providerType=UVCS` with no\nheader, to skip the UBA lookup and use the caller-supplied or gateway-authenticated\ncredential directly.\n", "operationId": "getorganizationsorganizationidprojectsprojectidvcsrepositoriesrepositorybranches", "parameters": [ { "in": "query", "name": "providerType", "required": false, "description": "`GITHUB` or `UVCS`. When present, the credential-in-header flow handles the request and bypasses UBA. When absent, the UBA-backed listing handles it.", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "description": "Page size. Defaults to 30.", "schema": { "type": "number", "minimum": 1, "default": 30 } }, { "in": "query", "name": "next", "required": false, "description": "Opaque cursor returned in a previous response as `cursor.next`.", "schema": { "type": "string" } }, { "in": "query", "name": "previous", "required": false, "description": "Opaque cursor returned in a previous response as `cursor.previous`.", "schema": { "type": "string" } }, { "in": "header", "name": "x-vcs-pat", "required": false, "description": "GitHub personal access token. Required when `providerType=GITHUB`; ignored otherwise. Never logged.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Page of branches on the repository.", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "number" }, "description": { "type": "string" }, "author": { "type": "string" }, "lastChangesetName": { "type": "string" }, "lastChangesetComment": { "type": "string" }, "lastChangesetId": { "type": "number" }, "lastActivityDate": { "type": "string", "format": "date-time" }, "creationDate": { "type": "string", "format": "date-time" }, "status": { "type": "string" }, "canBeDeleted": { "type": "boolean" }, "numberOfReviews": { "type": "number" }, "numberOfChangesets": { "type": "number" }, "isMain": { "type": "boolean" }, "pulls": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "title": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string" }, "sourceBranch": { "type": "string" }, "targetBranch": { "type": "string" } } } } } } }, "cursor": { "type": "object", "properties": { "next": { "type": "string" }, "previous": { "type": "string" } } }, "limit": { "type": "number" } } } } } }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "GET /organizations/{organizationId}/projects/{projectId}/vcs/repositories/{repository}/branches", "tags": [ "vcs" ] }, "post": { "description": "Fork a new branch from an existing one. UVCS resolves `fromBranch` to its head\nchangeset and POSTs to Plastic's `/branches`. GitHub looks up the source ref's\ncommit SHA and POSTs to `/git/refs`.\n", "operationId": "postorganizationsorganizationidprojectsprojectidvcsrepositoriesrepositorybranches", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "fromBranch" ], "properties": { "name": { "type": "string", "description": "New branch name. UVCS expects a leading \"/\" (Plastic adds one if missing). GitHub treats it as a plain ref name (no leading \"/\")." }, "fromBranch": { "type": "string", "description": "Existing branch to fork from. Its current head becomes the new branch's parent." }, "comment": { "type": "string", "description": "Optional description. UVCS only; GitHub ignores it." } } } } } }, "responses": { "200": { "description": "The created branch.", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "number" }, "description": { "type": "string" }, "author": { "type": "string" }, "lastChangesetName": { "type": "string" }, "lastChangesetComment": { "type": "string" }, "lastChangesetId": { "type": "number" }, "lastActivityDate": { "type": "string", "format": "date-time" }, "creationDate": { "type": "string", "format": "date-time" }, "status": { "type": "string" }, "canBeDeleted": { "type": "boolean" }, "numberOfReviews": { "type": "number" }, "numberOfChangesets": { "type": "number" }, "isMain": { "type": "boolean" }, "pulls": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "title": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string" }, "sourceBranch": { "type": "string" }, "targetBranch": { "type": "string" } } } } } } } } }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "POST /organizations/{organizationId}/projects/{projectId}/vcs/repositories/{repository}/branches", "tags": [ "vcs" ] } }, "/organizations/{organizationId}/projects/{projectId}/vcs/repositories/{repository}/branches/{branchName}/changesets": { "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repository", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "branchName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "description": "Page size for GET. Defaults to 30. Ignored by POST.", "schema": { "type": "number", "minimum": 1, "default": 30 } }, { "in": "query", "name": "next", "required": false, "description": "Opaque cursor (for GET) returned in a previous response as `cursor.next`.", "schema": { "type": "string" } }, { "in": "query", "name": "previous", "required": false, "description": "Opaque cursor (for GET) returned in a previous response as `cursor.previous`.", "schema": { "type": "string" } } ], "get": { "description": "List changesets / commits on a branch.", "operationId": "getorganizationsorganizationidprojectsprojectidvcsrepositoriesrepositorybranchesbranchnamechangesets", "responses": { "200": { "description": "Page of changesets on the branch.", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "guid": { "type": "string" }, "branchName": { "type": "string" }, "branchId": { "type": "number" }, "comment": { "type": "string" }, "authorName": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "labels": { "type": "array", "items": { "type": "string" } }, "canBeDeleted": { "type": "boolean" }, "hasCodeReview": { "type": "boolean" }, "codeReviewIds": { "type": "array", "items": { "type": "number" } }, "merges": { "type": "array", "items": { "type": "object" } }, "createdByMe": { "type": "boolean" } } } }, "cursor": { "type": "object", "properties": { "next": { "type": "string" }, "previous": { "type": "string" } } }, "limit": { "type": "number" } } } } } }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "GET /organizations/{organizationId}/projects/{projectId}/vcs/repositories/{repository}/branches/{branchName}/changesets", "tags": [ "vcs" ] }, "post": { "description": "Create a changeset on the branch from previously-uploaded files.", "operationId": "postorganizationsorganizationidprojectsprojectidvcsrepositoriesrepositorybranchesbranchnamechangesets", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "changes" ], "properties": { "comment": { "type": "string", "description": "Changeset / commit message." }, "changes": { "type": "array", "items": { "type": "object", "required": [ "changeType", "path" ], "properties": { "changeType": { "type": "string", "enum": [ "Added", "Changed", "Moved", "Deleted" ] }, "itemType": { "type": "string", "enum": [ "Text", "Bin", "Symlink", "Dir" ] }, "path": { "type": "string", "description": "Repository path of the item." }, "content": { "type": "string", "description": "`fileUploadId` returned by the file-upload endpoint." }, "md5": { "type": "string", "description": "MD5 checksum of the uploaded bytes." }, "dstPath": { "type": "string", "description": "Destination path for `Moved` changes." }, "symlinkPath": { "type": "string", "description": "Link target for `Symlink` items." } } } } } } } } }, "responses": { "200": { "description": "The created changeset.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "guid": { "type": "string" }, "branchName": { "type": "string" }, "branchId": { "type": "number" }, "comment": { "type": "string" }, "authorName": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "labels": { "type": "array", "items": { "type": "string" } }, "canBeDeleted": { "type": "boolean" }, "hasCodeReview": { "type": "boolean" }, "codeReviewIds": { "type": "array", "items": { "type": "number" } }, "merges": { "type": "array", "items": { "type": "object" } }, "createdByMe": { "type": "boolean" } } } } } }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "POST /organizations/{organizationId}/projects/{projectId}/vcs/repositories/{repository}/branches/{branchName}/changesets", "tags": [ "vcs" ] } }, "/organizations/{organizationId}/projects/{projectId}/vcs/repositories/{repository}/file-upload": { "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repository", "required": true, "schema": { "type": "string" } } ], "post": { "description": "Upload the full bytes of a single file. The gateway accepts Content-Type\napplication/offset+octet-stream, Unity's standard binary media type.\nPlain application/octet-stream is not on the gateway allowlist.\nPer-file cap is 75 MB (raw bytes).\n", "operationId": "postorganizationsorganizationidprojectsprojectidvcsrepositoriesrepositoryfileupload", "requestBody": { "required": true, "content": { "application/offset+octet-stream": { "schema": { "type": "string", "format": "binary", "description": "Raw file bytes." } } } }, "responses": { "200": { "description": "Upload result with file identifier and md5 checksum.", "content": { "application/json": { "schema": { "type": "object", "properties": { "fileUploadId": { "type": "string" }, "md5": { "type": "string" } } } } } }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "POST /organizations/{organizationId}/projects/{projectId}/vcs/repositories/{repository}/file-upload", "tags": [ "vcs" ] } }, "/organizations/{organizationId}/projects/{projectId}/vcs/repositories/{repository}/pulls": { "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repository", "required": true, "schema": { "type": "string" } } ], "post": { "description": "Create a pull request / code review.", "operationId": "postorganizationsorganizationidprojectsprojectidvcsrepositoriesrepositorypulls", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "title", "sourceBranch" ], "properties": { "title": { "type": "string" }, "sourceBranch": { "type": "string", "description": "Source branch (GitHub head / UVCS code-review branch)." }, "targetBranch": { "type": "string", "description": "Target branch. Required for GitHub (used as the PR `base`). Ignored by UVCS, which anchors Plastic code reviews on the source branch only." }, "baseBranch": { "type": "string", "description": "Alias for `targetBranch`; targetBranch wins when both are sent." }, "description": { "type": "string" }, "reviewers": { "type": "array", "items": { "type": "string" }, "description": "Reviewer user emails to assign." } } } } } }, "responses": { "200": { "description": "The created pull request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "title": { "type": "string" }, "description": { "type": "string" }, "sourceBranch": { "type": "string" }, "targetBranch": { "type": "string" }, "author": { "type": "string" }, "status": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "url": { "type": "string" } } } } } }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "POST /organizations/{organizationId}/projects/{projectId}/vcs/repositories/{repository}/pulls", "tags": [ "vcs" ] } }, "/organizations/{organizationId}/projects/{projectId}/vcs/repositories/{repository}/merges": { "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repository", "required": true, "schema": { "type": "string" } } ], "post": { "description": "Merge a VCS branch into another. UVCS posts to /mergeto (sourceType=branch);\nGitHub posts to /repos/.../merges. sourceBranch and targetBranch are both required.\n", "operationId": "postorganizationsorganizationidprojectsprojectidvcsrepositoriesrepositorymerges", "requestBody": { "content": { "application/json": { "schema": { "properties": { "comment": { "type": "string", "description": "Merge commit message. UVCS comment / GitHub commit_message." }, "sourceBranch": { "type": "string", "description": "Branch to merge from. UVCS branch path or GitHub head ref." }, "targetBranch": { "type": "string", "description": "Branch to merge into. UVCS branch path or GitHub base ref." } }, "required": [ "sourceBranch", "targetBranch" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "Result of the merge operation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "OK", "MergeNotNeeded", "Conflicts", "AncestorNotFound", "DestinationChanges", "MultipleHeads", "Error" ] }, "revision": { "type": "string", "description": "Provider-native id of the resulting merge commit on the destination." }, "message": { "type": "string", "description": "Human-readable detail from the provider." } } } } } }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "POST /organizations/{organizationId}/projects/{projectId}/vcs/repositories/{repository}/merges", "tags": [ "vcs" ] } }, "/organizations/{organizationId}/projects/{projectId}/vcs/repositories/{repository}/branches/{branchName}/build-status": { "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repository", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "branchName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "buildTargetId", "required": true, "description": "Unity Build Automation build target id to inspect.", "schema": { "type": "string" } } ], "get": { "description": "Return the latest successful + currently in-progress build for the given build target, with the file diffs for \"files being built\" and \"pending changes after the latest build\".", "operationId": "getorganizationsorganizationidprojectsprojectidvcsrepositoriesrepositorybranchesbranchnamebuildstatus", "responses": { "200": { "description": "Latest successful and in-progress build for the target on this branch.", "content": { "application/json": { "schema": { "type": "object", "properties": { "lastSuccessful": { "type": "object", "properties": { "buildNumber": { "type": "number" }, "scmBranch": { "type": "string" }, "scmCommitId": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "started", "success", "failure", "canceled" ] }, "startedAt": { "type": "string", "format": "date-time" }, "finishedAt": { "type": "string", "format": "date-time" } } }, "inProgress": { "type": "object", "properties": { "buildNumber": { "type": "number" }, "scmBranch": { "type": "string" }, "scmCommitId": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "started", "success", "failure", "canceled" ] }, "startedAt": { "type": "string", "format": "date-time" }, "finishedAt": { "type": "string", "format": "date-time" } } }, "status": { "type": "string", "enum": [ "not_started", "processing", "completed", "failed" ] } } } } } }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "GET /organizations/{organizationId}/projects/{projectId}/vcs/repositories/{repository}/branches/{branchName}/build-status", "tags": [ "vcs" ] } }, "/organizations/{organizationId}/projects/{projectId}/vcs/repositories/{repository}/branches/{branchName}/vcs-status": { "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repository", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "branchName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "buildTargetId", "required": false, "description": "Unity Build Automation build target id. When provided, each `pendingFiles` entry carries a `pending` flag. The flag marks paths not yet captured by the most recent successful build for the target.", "schema": { "type": "string" } } ], "get": { "description": "Return the VCS-side state of a branch: current head revision, parent (destination) branch with its merge-target tip and fork point, and files introduced on this branch (diff from forkPoint to head).", "operationId": "getorganizationsorganizationidprojectsprojectidvcsrepositoriesrepositorybranchesbranchnamevcsstatus", "responses": { "200": { "description": "Current VCS state of the branch, including its head revision and files pending / being built.", "content": { "application/json": { "schema": { "type": "object", "properties": { "branchHead": { "type": "object", "properties": { "revision": { "type": "string" } } }, "destinationBranch": { "type": "object", "properties": { "name": { "type": "string" }, "revision": { "type": "string" }, "forkPoint": { "type": "string" } } }, "pendingFiles": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "changeType": { "type": "string", "enum": [ "Added", "Changed", "Moved", "Deleted", "LocallyDeleted" ] }, "size": { "type": "number" }, "srcPath": { "type": "string" }, "itemType": { "type": "string", "enum": [ "Text", "Bin", "Symlink", "Dir" ] }, "pending": { "type": "boolean" }, "revisionId": { "type": "string" } } } }, "processing": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "changeType": { "type": "string", "enum": [ "Added", "Changed", "Moved", "Deleted", "LocallyDeleted" ] }, "size": { "type": "number" }, "srcPath": { "type": "string" }, "itemType": { "type": "string", "enum": [ "Text", "Bin", "Symlink", "Dir" ] }, "pending": { "type": "boolean" }, "revisionId": { "type": "string" } } } } } } } } }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "GET /organizations/{organizationId}/projects/{projectId}/vcs/repositories/{repository}/branches/{branchName}/vcs-status", "tags": [ "vcs" ] } }, "/organizations/{organizationId}/projects/{projectId}/vcs/repositories/{repository}/branches/{branchName}/files/{filePath}/source-url": { "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repository", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "branchName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "filePath", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "revisionId", "required": false, "description": "Provider-native revision id. UVCS: numeric per-file revisionId from a build-status diff entry. GitHub: a commit SHA. When omitted, the URL targets the latest revision of the file on the branch.", "schema": { "type": "string" } } ], "get": { "description": "Return a signed, downloadable URL for the bytes of the file on the given branch. UVCS mints a JWT-signed URL with a short TTL; GitHub returns the contents API's download_url (pre-signed for private repos, plain raw URL for public).", "operationId": "getorganizationsorganizationidprojectsprojectidvcsrepositoriesrepositorybranchesbranchnamefilesfilepathsourceurl", "responses": { "200": { "description": "Signed, downloadable URL for the bytes of the file on the branch.", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string" } } } } } }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "GET /organizations/{organizationId}/projects/{projectId}/vcs/repositories/{repository}/branches/{branchName}/files/{filePath}/source-url", "tags": [ "vcs" ] } }, "/organizations/{organizationName}": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get organization details by name.", "operationId": "getorganizationsname", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "GET /organizations/{organizationName}", "tags": [ "organizations" ] }, "patch": { "description": "Update organization fields by name.", "operationId": "patchorganizationsname", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "PATCH /organizations/{organizationName}", "tags": [ "organizations" ] } }, "/organizations/{organizationName}/projects/{projectId}/repositories": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } } ], "get": { "description": "List repositories under a project for the organization.", "operationId": "getorganizationsnameprojectsprojectidrepositories", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "GET /organizations/{organizationName}/projects/{projectId}/repositories", "tags": [ "organizations" ] }, "post": { "description": "Create a repository under a project for the organization.", "operationId": "postorganizationsnameprojectsprojectidrepositories", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "POST /organizations/{organizationName}/projects/{projectId}/repositories", "tags": [ "organizations" ] } }, "/organizations/{organizationName}/repositories": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "List repositories for the organization.", "operationId": "getorganizationsnamerepositories", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "GET /organizations/{organizationName}/repositories", "tags": [ "organizations" ] }, "post": { "description": "Create a repository for the organization.", "operationId": "postorganizationsnamerepositories", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "POST /organizations/{organizationName}/repositories", "tags": [ "organizations" ] } }, "/organizations/{organizationName}/activities": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get organization activity", "operationId": "getActivity", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "startDate", "required": true, "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "endDate", "required": true, "schema": { "format": "date-time", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "activeUsers": { "$ref": "#/components/schemas/RestActivityItem" }, "automaticSolvedFileConflicts": { "$ref": "#/components/schemas/RestActivityItem" }, "branchExplorerViews": { "$ref": "#/components/schemas/RestActivityItem" }, "changesets": { "$ref": "#/components/schemas/RestActivityItem" }, "crossFileDiffsUsage": { "$ref": "#/components/schemas/RestActivityItem" }, "dataStored": { "$ref": "#/components/schemas/RestActivityItem" }, "diffsPerformed": { "$ref": "#/components/schemas/RestActivityItem" }, "downloadedGb": { "$ref": "#/components/schemas/RestActivityItem" }, "imageDiffsUsage": { "$ref": "#/components/schemas/RestActivityItem" }, "keyOperationsNewBranches": { "$ref": "#/components/schemas/RestActivityItem" }, "manualSolvedFileConflicts": { "$ref": "#/components/schemas/RestActivityItem" }, "newBranches": { "$ref": "#/components/schemas/RestActivityItem" }, "semanticDiffUsage": { "$ref": "#/components/schemas/RestActivityItem" }, "solvedDirectoryConflicts": { "$ref": "#/components/schemas/RestActivityItem" }, "xDiffsUsage": { "$ref": "#/components/schemas/RestActivityItem" } }, "required": [ "activeUsers", "dataStored", "newBranches", "changesets", "downloadedGb", "branchExplorerViews", "keyOperationsNewBranches", "diffsPerformed", "solvedDirectoryConflicts", "automaticSolvedFileConflicts", "manualSolvedFileConflicts", "semanticDiffUsage", "crossFileDiffsUsage", "xDiffsUsage", "imageDiffsUsage" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get organization activity", "tags": [ "activity" ] } }, "/organizations/{organizationName}/code-reviews": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get a paginated list of code reviews for an organization.", "operationId": "getOrganizationReviews", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "format": "integer", "minimum": 0, "type": "number" } }, { "in": "query", "name": "order", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string" } }, { "description": "JSON array of target types and ids in format [[\"branch\"|\"changeset\"|\"label\", number]]", "in": "query", "name": "filterTargets", "required": true, "schema": { "type": "string" } }, { "description": "Comma separated list of branch names", "in": "query", "name": "filterBranchNames", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Comma separated list of branch ids", "in": "query", "name": "filterBranchIds", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Comma separated list of code review statuses", "in": "query", "name": "filterStatus", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Comma separated list of code review statuses", "in": "query", "name": "filterReviewerStatus", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Comma separated list of owner emails", "in": "query", "name": "filterOwner", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Comma separated list of reviewer emails", "in": "query", "name": "filterReviewer", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Comma separated list of repository names", "in": "query", "name": "filterRepoNames", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "orderBy", "required": true, "schema": { "enum": [ "id", "createdAt", "updatedAt", "status", "title" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "allOf": [ { "properties": { "limit": { "format": "integer", "minimum": 0, "type": "number" }, "offset": { "format": "integer", "minimum": 0, "type": "number" }, "total": { "format": "integer", "minimum": 0, "type": "number" } }, "required": [ "offset", "limit", "total" ], "type": "object" }, { "properties": { "results": { "items": { "properties": { "assignee": { "type": "string" }, "comments": { "items": { "$ref": "#/components/schemas/CodeReviewCommentDto" }, "type": "array" }, "commentsCount": { "format": "integer", "type": "number" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "type": "string" }, "id": { "type": "number" }, "mergeAllowed": { "type": "boolean" }, "mergeIssues": { "type": "string" }, "merges": { "items": { "$ref": "#/components/schemas/MergeDto" }, "type": "array" }, "numberOfIssues": { "format": "integer", "type": "number" }, "object": { "$ref": "#/components/schemas/CodeReviewObjectDto" }, "owner": { "type": "string" }, "repositoryName": { "type": "string" }, "reviewers": { "items": { "$ref": "#/components/schemas/ReviewerWithStatusDto" }, "type": "array" }, "status": { "enum": [ "under-review", "reviewed", "rework-required" ], "type": "string" }, "title": { "type": "string" }, "unansweredQuestionsCount": { "format": "integer", "type": "number" }, "updatedAt": { "format": "date-time", "type": "string" }, "userCommentsCount": { "format": "integer", "type": "number" } }, "required": [ "id", "object", "owner", "createdAt", "updatedAt", "status", "title", "description", "commentsCount", "userCommentsCount", "unansweredQuestionsCount", "numberOfIssues", "comments", "reviewers" ], "type": "object" }, "type": "array" } } } ], "title": "CodeReviewDtoPageDto" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get organization code reviews", "tags": [ "code review" ] } }, "/organizations/{organizationName}/consumption": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get an organization consumption", "operationId": "getConsumption", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "startDate", "required": true, "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "endDate", "required": true, "schema": { "format": "date-time", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "results": { "items": { "properties": { "date": { "format": "date-time", "type": "string" }, "networkUsageChange": { "type": "number" }, "storageChange": { "type": "number" }, "storageTotal": { "type": "number" } }, "required": [ "storageChange", "storageTotal", "networkUsageChange", "date" ], "type": "object" }, "type": "array" } }, "required": [ "results" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get an organization consumption", "tags": [ "organization" ] } }, "/organizations/{organizationName}/integrations": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get integrations", "operationId": "getAllIntegrations", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "oneOf": [ { "properties": { "channelWebhook": { "type": "string" }, "events": { "items": { "type": "string" }, "type": "array" }, "failures": { "items": { "$ref": "#/components/schemas/RestGetIntegrationError" }, "type": "array" }, "filters": { "type": "string" }, "id": { "type": "number" }, "name": { "nullable": true, "type": "string" }, "organizationName": { "type": "string" }, "repositories": { "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type", "id", "repositories", "name", "filters", "events", "channelWebhook", "organizationName" ], "type": "object" }, { "properties": { "botOauthToken": { "type": "string" }, "events": { "items": { "type": "string" }, "type": "array" }, "failures": { "items": { "$ref": "#/components/schemas/RestGetIntegrationError" }, "type": "array" }, "filters": { "type": "string" }, "id": { "type": "number" }, "name": { "nullable": true, "type": "string" }, "organizationName": { "type": "string" }, "repositories": { "items": { "type": "string" }, "type": "array" }, "slackChannel": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id", "repositories", "name", "filters", "events", "botOauthToken", "slackChannel", "organizationName" ], "type": "object" }, { "properties": { "events": { "items": { "type": "string" }, "type": "array" }, "failures": { "items": { "$ref": "#/components/schemas/RestGetIntegrationError" }, "type": "array" }, "filters": { "type": "string" }, "id": { "type": "number" }, "name": { "nullable": true, "type": "string" }, "organizationName": { "type": "string" }, "repositories": { "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" }, "url": { "type": "string" } }, "required": [ "type", "id", "repositories", "name", "filters", "events", "url", "organizationName" ], "type": "object" } ] }, "type": "array" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get integrations", "tags": [ "integration" ] }, "delete": { "description": "Delete integrations", "operationId": "deleteIntegrations", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "ids": { "items": { "type": "number" }, "type": "array" } }, "required": [ "ids" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "207": { "content": { "application/json": { "schema": { "properties": { "failures": { "items": { "type": "number" }, "type": "array" } }, "required": [ "failures" ], "type": "object" } } }, "description": "" }, "400": { "description": "Bad request. Indicates that all delete operations have failed" } }, "summary": "Delete integrations", "tags": [ "integration" ] } }, "/organizations/{organizationName}/integrations/discord": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "post": { "description": "Create a discord integration", "operationId": "createDiscordIntegration", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "channelWebhook": { "type": "string" }, "events": { "items": { "type": "string" }, "type": "array" }, "filters": { "type": "string" }, "name": { "type": "string" }, "repositories": { "items": { "type": "string" }, "type": "array" } }, "required": [ "repositories", "name", "filters", "events", "channelWebhook" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "207": { "content": { "application/json": { "schema": { "properties": { "channelWebhook": { "type": "string" }, "events": { "items": { "type": "string" }, "type": "array" }, "failures": { "items": { "$ref": "#/components/schemas/RestGetIntegrationError" }, "type": "array" }, "filters": { "type": "string" }, "id": { "type": "number" }, "name": { "nullable": true, "type": "string" }, "organizationName": { "type": "string" }, "repositories": { "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type", "id", "repositories", "name", "filters", "events", "channelWebhook", "organizationName" ], "type": "object" } } }, "description": "" }, "400": { "description": "Bad request. Indicates that all create operations (based on the number of events) have failed." } }, "summary": "Create a discord integration", "tags": [ "integration" ] } }, "/organizations/{organizationName}/integrations/discord/{id}": { "parameters": [ { "description": "Path parameter id", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "put": { "description": "Replace a discord integration", "operationId": "replaceDiscordIntegration", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "channelWebhook": { "type": "string" }, "events": { "items": { "type": "string" }, "type": "array" }, "filters": { "type": "string" }, "name": { "type": "string" }, "repositories": { "items": { "type": "string" }, "type": "array" } }, "required": [ "repositories", "name", "filters", "events", "channelWebhook" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "207": { "content": { "application/json": { "schema": { "properties": { "channelWebhook": { "type": "string" }, "events": { "items": { "type": "string" }, "type": "array" }, "failures": { "items": { "$ref": "#/components/schemas/RestGetIntegrationError" }, "type": "array" }, "filters": { "type": "string" }, "id": { "type": "number" }, "name": { "nullable": true, "type": "string" }, "organizationName": { "type": "string" }, "repositories": { "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "type", "id", "repositories", "name", "filters", "events", "channelWebhook", "organizationName" ], "type": "object" } } }, "description": "" }, "400": { "description": "Bad request. Indicates that all update operations (based on the number of events) have failed." } }, "summary": "Replace a discord integration", "tags": [ "integration" ] } }, "/organizations/{organizationName}/integrations/slack": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "post": { "description": "Create a slack integration", "operationId": "createSlackIntegration", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "botOauthToken": { "type": "string" }, "events": { "items": { "type": "string" }, "type": "array" }, "filters": { "type": "string" }, "name": { "type": "string" }, "repositories": { "items": { "type": "string" }, "type": "array" }, "slackChannel": { "type": "string" } }, "required": [ "repositories", "name", "filters", "events", "botOauthToken", "slackChannel" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "207": { "content": { "application/json": { "schema": { "properties": { "botOauthToken": { "type": "string" }, "events": { "items": { "type": "string" }, "type": "array" }, "failures": { "items": { "$ref": "#/components/schemas/RestGetIntegrationError" }, "type": "array" }, "filters": { "type": "string" }, "id": { "type": "number" }, "name": { "nullable": true, "type": "string" }, "organizationName": { "type": "string" }, "repositories": { "items": { "type": "string" }, "type": "array" }, "slackChannel": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id", "repositories", "name", "filters", "events", "botOauthToken", "slackChannel", "organizationName" ], "type": "object" } } }, "description": "" }, "400": { "description": "Bad request. Indicates that all create operations (based on the number of events) have failed." } }, "summary": "Create a slack integration", "tags": [ "integration" ] } }, "/organizations/{organizationName}/integrations/slack/{id}": { "parameters": [ { "description": "Path parameter id", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "put": { "description": "Replace a slack integration", "operationId": "replaceSlackIntegration", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "botOauthToken": { "type": "string" }, "events": { "items": { "type": "string" }, "type": "array" }, "filters": { "type": "string" }, "name": { "type": "string" }, "repositories": { "items": { "type": "string" }, "type": "array" }, "slackChannel": { "type": "string" } }, "required": [ "repositories", "name", "filters", "events", "botOauthToken", "slackChannel" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "207": { "content": { "application/json": { "schema": { "properties": { "botOauthToken": { "type": "string" }, "events": { "items": { "type": "string" }, "type": "array" }, "failures": { "items": { "$ref": "#/components/schemas/RestGetIntegrationError" }, "type": "array" }, "filters": { "type": "string" }, "id": { "type": "number" }, "name": { "nullable": true, "type": "string" }, "organizationName": { "type": "string" }, "repositories": { "items": { "type": "string" }, "type": "array" }, "slackChannel": { "type": "string" }, "type": { "type": "string" } }, "required": [ "type", "id", "repositories", "name", "filters", "events", "botOauthToken", "slackChannel", "organizationName" ], "type": "object" } } }, "description": "" }, "400": { "description": "Bad request. Indicates that all update operations (based on the number of events) have failed." } }, "summary": "Replace a slack integration", "tags": [ "integration" ] } }, "/organizations/{organizationName}/integrations/webhook": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "post": { "description": "Create a webhook integration", "operationId": "createWebhookIntegration", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "events": { "items": { "type": "string" }, "type": "array" }, "filters": { "type": "string" }, "name": { "type": "string" }, "repositories": { "items": { "type": "string" }, "type": "array" }, "url": { "type": "string" } }, "required": [ "repositories", "name", "filters", "events", "url" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "207": { "content": { "application/json": { "schema": { "properties": { "events": { "items": { "type": "string" }, "type": "array" }, "failures": { "items": { "$ref": "#/components/schemas/RestGetIntegrationError" }, "type": "array" }, "filters": { "type": "string" }, "id": { "type": "number" }, "name": { "nullable": true, "type": "string" }, "organizationName": { "type": "string" }, "repositories": { "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" }, "url": { "type": "string" } }, "required": [ "type", "id", "repositories", "name", "filters", "events", "url", "organizationName" ], "type": "object" } } }, "description": "" }, "400": { "description": "Bad request. Indicates that all create operations (based on the number of events) have failed." } }, "summary": "Create a webhook integration", "tags": [ "integration" ] } }, "/organizations/{organizationName}/integrations/webhook/{id}": { "parameters": [ { "description": "Path parameter id", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "put": { "description": "Replace a webhook integration", "operationId": "replaceWebhookIntegration", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "events": { "items": { "type": "string" }, "type": "array" }, "filters": { "type": "string" }, "name": { "type": "string" }, "repositories": { "items": { "type": "string" }, "type": "array" }, "url": { "type": "string" } }, "required": [ "repositories", "name", "filters", "events", "url" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "207": { "content": { "application/json": { "schema": { "properties": { "events": { "items": { "type": "string" }, "type": "array" }, "failures": { "items": { "$ref": "#/components/schemas/RestGetIntegrationError" }, "type": "array" }, "filters": { "type": "string" }, "id": { "type": "number" }, "name": { "nullable": true, "type": "string" }, "organizationName": { "type": "string" }, "repositories": { "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" }, "url": { "type": "string" } }, "required": [ "type", "id", "repositories", "name", "filters", "events", "url", "organizationName" ], "type": "object" } } }, "description": "" }, "400": { "description": "Bad request. Indicates that all update operations (based on the number of events) have failed." } }, "summary": "Replace a webhook integration", "tags": [ "integration" ] } }, "/organizations/{organizationName}/lock-rule": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get organization lock rule", "operationId": "getOrganizationLockRule", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "excludedBranches": { "items": { "type": "string" }, "type": "array" }, "fileExtensions": { "format": "rule1, rule2", "type": "string" }, "targetBranch": { "type": "string" }, "targetBranches": { "items": { "type": "string" }, "type": "array" } }, "required": [ "fileExtensions" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get organization lock rule", "tags": [ "lock rule" ] }, "put": { "description": "Change the organization lock rule", "operationId": "putOrganizationLockRule", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "excludedBranches": { "items": { "type": "string" }, "type": "array" }, "fileExtensions": { "format": "rule1, rule2", "type": "string" }, "targetBranch": { "type": "string" }, "targetBranches": { "items": { "type": "string" }, "type": "array" } }, "required": [ "fileExtensions" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "excludedBranches": { "items": { "type": "string" }, "type": "array" }, "fileExtensions": { "format": "rule1, rule2", "type": "string" }, "targetBranch": { "type": "string" }, "targetBranches": { "items": { "type": "string" }, "type": "array" } }, "required": [ "fileExtensions" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Change the organization lock rule", "tags": [ "lock rule" ] }, "delete": { "description": "Delete an organization lock rule", "operationId": "deleteOrganizationLockRule", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "204": { "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Delete an organization lock rule", "tags": [ "lock rule" ] } }, "/organizations/{organizationName}/me/assigned-code-reviews": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "From recent repositories, ie: repositories that have received changes", "operationId": "assignedCodeReviews", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "numberOfRecentRepositories", "required": true, "schema": { "maximum": 5, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "results": { "items": { "properties": { "numberOfCodeReviews": { "type": "integer" }, "repositoryName": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get assigned code reviews", "tags": [ "code review" ] } }, "/organizations/{organizationName}/merge-bots": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "List merge bots configured for the organization.", "operationId": "getorganizationsorganizationnamemergebots", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "GET /organizations/{organizationName}/merge-bots", "tags": [ "organizations" ] } }, "/organizations/{organizationName}/merge-bots/plug-definitions": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get merge bot plug definitions", "operationId": "getPlugDefinitions", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "results": { "items": { "properties": { "buildIn": { "type": "boolean" }, "configuration": { "description": "This array values depend on the plug definition type", "items": { "type": "object" }, "type": "array" }, "description": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get merge bot plug definitions", "tags": [ "merge-bot" ] } }, "/organizations/{organizationName}/merge-rules": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get merge rules", "operationId": "getAllMergeRules", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "results": { "items": { "properties": { "condition": { "type": "string" }, "destination": { "$ref": "#/components/schemas/RestGetMergeRuleMatcher" }, "id": { "type": "number" }, "isEnabled": { "type": "boolean" }, "repositoriesPattern": { "items": { "type": "string" }, "type": "array" }, "source": { "$ref": "#/components/schemas/RestGetMergeRuleMatcher" } }, "required": [ "id", "isEnabled", "condition", "source", "destination", "repositoriesPattern" ], "type": "object" }, "type": "array" } }, "required": [ "results" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get merge rules", "tags": [ "merge rule" ] }, "post": { "description": "Create a merge rule", "operationId": "post", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "condition": { "pattern": "^(only_allow_merges_if_reviewed|restrict_merges_to_branch|only_allow_merges_from_parent|only_allow_merges_from_children)$", "type": "string" }, "destination": { "properties": { "attributes": { "items": { "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "branchesNamesPattern": { "items": { "type": "string" }, "type": "array" } }, "required": [ "branchesNamesPattern", "attributes" ], "type": "object" }, "isEnabled": { "type": "boolean" }, "repositoriesPattern": { "items": { "type": "string" }, "type": "array" }, "source": { "properties": { "attributes": { "items": { "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "branchesNamesPattern": { "items": { "type": "string" }, "type": "array" } }, "required": [ "branchesNamesPattern", "attributes" ], "type": "object" } }, "required": [ "isEnabled", "condition", "source", "destination", "repositoriesPattern" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "201": { "content": { "application/json": { "schema": { "properties": { "condition": { "type": "string" }, "destination": { "$ref": "#/components/schemas/RestGetMergeRuleMatcher" }, "id": { "type": "number" }, "isEnabled": { "type": "boolean" }, "repositoriesPattern": { "items": { "type": "string" }, "type": "array" }, "source": { "$ref": "#/components/schemas/RestGetMergeRuleMatcher" } }, "required": [ "id", "isEnabled", "condition", "source", "destination", "repositoriesPattern" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Create a merge rule", "tags": [ "merge rule" ] }, "delete": { "description": "Delete merge rules", "operationId": "deleteMergeRules", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "ids": { "items": { "type": "number" }, "type": "array" } }, "required": [ "ids" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "207": { "content": { "application/json": { "schema": { "properties": { "failures": { "items": { "type": "number" }, "type": "array" } }, "required": [ "failures" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Delete merge rules", "tags": [ "merge rule" ] } }, "/organizations/{organizationName}/merge-rules/{id}": { "parameters": [ { "description": "Path parameter id", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "put": { "description": "Replace a merge rule", "operationId": "putMergeRule", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "condition": { "pattern": "^(only_allow_merges_if_reviewed|restrict_merges_to_branch|only_allow_merges_from_parent|only_allow_merges_from_children)$", "type": "string" }, "destination": { "properties": { "attributes": { "items": { "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "branchesNamesPattern": { "items": { "type": "string" }, "type": "array" } }, "required": [ "branchesNamesPattern", "attributes" ], "type": "object" }, "id": { "type": "number" }, "isEnabled": { "type": "boolean" }, "repositoriesPattern": { "items": { "type": "string" }, "type": "array" }, "source": { "properties": { "attributes": { "items": { "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "branchesNamesPattern": { "items": { "type": "string" }, "type": "array" } }, "required": [ "branchesNamesPattern", "attributes" ], "type": "object" } }, "required": [ "id", "isEnabled", "condition", "source", "destination", "repositoriesPattern" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "condition": { "type": "string" }, "destination": { "$ref": "#/components/schemas/RestGetMergeRuleMatcher" }, "id": { "type": "number" }, "isEnabled": { "type": "boolean" }, "repositoriesPattern": { "items": { "type": "string" }, "type": "array" }, "source": { "$ref": "#/components/schemas/RestGetMergeRuleMatcher" } }, "required": [ "id", "isEnabled", "condition", "source", "destination", "repositoriesPattern" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Replace a merge rule", "tags": [ "merge rule" ] } }, "/organizations/{organizationName}/network-permissions": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get network permissions", "operationId": "getPermissions", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "organizationName": { "type": "string" }, "permissions": { "type": "string" } }, "required": [ "organizationName", "permissions" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get network permissions", "tags": [ "network permission" ] }, "put": { "description": "Change network permissions", "operationId": "changePermissions", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "permissions": { "type": "string" } }, "required": [ "permissions" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "204": { "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Change network permissions", "tags": [ "network permission" ] } }, "/organizations/{organizationName}/notifications": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Gets the email notification settings for the organization.", "operationId": "NotificationsController_getEmailNotification", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "id": { "format": "int64", "type": "number" }, "organizationName": { "type": "string" }, "repositories": { "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "repositories", "organizationName" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "GET /organizations/{organizationName}/notifications", "tags": [ "notifications" ] }, "post": { "description": "Enables email notifications for the organization.", "operationId": "NotificationsController_enableEmailNotifications", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "repositories": { "items": { "type": "string" }, "type": "array" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "201": { "content": { "application/json": { "schema": { "properties": { "id": { "format": "int64", "type": "number" }, "organizationName": { "type": "string" }, "repositories": { "items": { "type": "string" }, "type": "array" } }, "required": [ "id", "repositories", "organizationName" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "POST /organizations/{organizationName}/notifications", "tags": [ "notifications" ] }, "delete": { "description": "Disables email notifications for the organization.", "operationId": "NotificationsController_disableEmailNotifications", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "204": { "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "DELETE /organizations/{organizationName}/notifications", "tags": [ "notifications" ] } }, "/organizations/{organizationName}/permissions": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get permissions for an organization by name.", "operationId": "getOrganizationPermissions", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "endUserType", "schema": { "enum": [ "user", "user_group" ], "type": "string" } }, { "in": "query", "name": "endUserName", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "permissions": { "items": { "$ref": "#/components/schemas/EndUserPermissionsDto" }, "type": "array" } }, "required": [ "permissions" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get organization permissions", "tags": [ "organization", "permission" ] }, "patch": { "description": "Patch an organization permissions", "operationId": "setOrganizationPermissions", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "endUsersPermissions": { "items": { "$ref": "#/components/schemas/RestSetEndUserPermissions" }, "type": "array" } }, "required": [ "endUsersPermissions" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "204": { "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Patch an organization permissions", "tags": [ "organization", "permission" ] } }, "/organizations/{organizationName}/profiles": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get profiles of users in the organization", "operationId": "ProfilesController_getProfiles", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "format": "integer", "minimum": 0, "type": "number" } }, { "in": "query", "name": "order", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, { "in": "query", "name": "offset", "required": false, "schema": { "format": "integer", "minimum": 0, "type": "number" } }, { "in": "query", "name": "orderBy", "required": false, "schema": { "enum": [ "email", "isAdmin" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "allOf": [ { "properties": { "limit": { "format": "integer", "minimum": 0, "type": "number" }, "offset": { "format": "integer", "minimum": 0, "type": "number" }, "total": { "format": "integer", "minimum": 0, "type": "number" } }, "required": [ "offset", "limit", "total" ], "type": "object" }, { "properties": { "results": { "items": { "properties": { "assignedAt": { "format": "date-time", "type": "string" }, "email": { "format": "email", "type": "string" }, "groups": { "items": { "$ref": "#/components/schemas/OrganizationUserGroupDto" }, "type": "array" }, "id": { "format": "integer", "type": "number" }, "isAdmin": { "type": "boolean" }, "isOwner": { "type": "boolean" }, "joinedOrganizationAt": { "format": "date-time", "type": "string" }, "permissions": { "items": { "properties": { "isEnabled": { "type": "boolean" }, "isOverride": { "type": "boolean" }, "name": { "type": "string" }, "valueInherited": { "type": "boolean" } }, "required": [ "name", "isOverride", "isEnabled" ], "type": "object" }, "type": "array" }, "source": { "enum": [ "DevOps", "PlasticScm", "UnityCloud", "OwnerSeat" ], "type": "string" }, "unityUser": { "properties": { "avatarUrl": { "format": "uri", "type": "string" }, "email": { "format": "email", "type": "string" }, "genesisId": { "format": "integer", "type": "string" }, "id": { "format": "uuid", "nullable": true, "type": "string" }, "name": { "nullable": true, "type": "string" } }, "required": [ "genesisId" ], "type": "object" } }, "required": [ "id", "email", "isAdmin" ], "type": "object" }, "type": "array" } } } ], "title": "OrganizationUserDtoPageDto" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get profiles", "tags": [ "user" ] } }, "/organizations/{organizationName}/projects/{projectId}/repositories/{repositoryName}": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get a repository scoped under a project.", "operationId": "getorganizationsorganizationnameprojectsprojectidrepositoriesrepositoryname", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "GET /organizations/{organizationName}/projects/{projectId}/repositories/{repositoryName}", "tags": [ "organizations" ] }, "patch": { "description": "Update a repository scoped under a project.", "operationId": "patchorganizationsorganizationnameprojectsprojectidrepositoriesrepositoryname", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "PATCH /organizations/{organizationName}/projects/{projectId}/repositories/{repositoryName}", "tags": [ "organizations" ] }, "delete": { "description": "Delete a repository scoped under a project.", "operationId": "deleteorganizationsorganizationnameprojectsprojectidrepositoriesrepositoryname", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "DELETE /organizations/{organizationName}/projects/{projectId}/repositories/{repositoryName}", "tags": [ "organizations" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get an organization repository", "operationId": "getOrganizationRepository", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "description": "Comma-separated list of fields to include in the response", "explode": false, "in": "query", "name": "includeFields", "required": false, "schema": { "items": { "enum": [ "workspaces", "unityUsers" ] }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "creatorName": { "type": "string" }, "description": { "type": "string" }, "id": { "format": "integer", "type": "number" }, "isFavorite": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "lastActivityDate": { "format": "date-time", "type": "string" }, "mainBranch": { "type": "string" }, "mainBranchId": { "format": "integer", "type": "number" }, "name": { "type": "string" }, "uuid": { "format": "uuid", "type": "string" }, "workspaces": { "items": { "properties": { "guid": { "format": "uuid", "type": "string" }, "id": { "format": "integer", "type": "number" }, "lastActivityDate": { "format": "date-time", "type": "string" }, "name": { "type": "string" }, "owner": { "type": "string" }, "ownerUnityUser": { "properties": { "avatarUrl": { "format": "uri", "type": "string" }, "email": { "format": "email", "type": "string" }, "genesisId": { "format": "integer", "type": "string" }, "id": { "format": "uuid", "nullable": true, "type": "string" }, "name": { "nullable": true, "type": "string" } }, "required": [ "genesisId" ], "type": "object" }, "repositoryName": { "type": "string" }, "shares": { "items": { "$ref": "#/components/schemas/WorkspaceShareDto" }, "type": "array" }, "uvcsConnections": { "items": { "$ref": "#/components/schemas/WorkspaceUvcsConnectionDto" }, "type": "array" } }, "required": [ "id", "name", "owner", "lastActivityDate", "repositoryName", "guid", "shares", "uvcsConnections" ], "type": "object" }, "type": "array" } }, "required": [ "id", "uuid", "name", "description", "isFavorite", "creatorName", "lastActivityDate", "mainBranch", "mainBranchId", "isPublic" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get an organization repository", "tags": [ "repository" ] }, "patch": { "description": "Patch an organization repository", "operationId": "updateOrganizationRepository", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "description": { "description": "New description of the repository. Skipped if not provided.", "type": "string" }, "isPublic": { "description": "New public status of the repository. Skipped if not provided.", "type": "boolean" }, "name": { "description": "New name of the repository. Skipped if not provided.", "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "creatorName": { "type": "string" }, "description": { "type": "string" }, "id": { "format": "integer", "type": "number" }, "isFavorite": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "lastActivityDate": { "format": "date-time", "type": "string" }, "mainBranch": { "type": "string" }, "mainBranchId": { "format": "integer", "type": "number" }, "name": { "type": "string" }, "uuid": { "format": "uuid", "type": "string" }, "workspaces": { "items": { "properties": { "guid": { "format": "uuid", "type": "string" }, "id": { "format": "integer", "type": "number" }, "lastActivityDate": { "format": "date-time", "type": "string" }, "name": { "type": "string" }, "owner": { "type": "string" }, "ownerUnityUser": { "properties": { "avatarUrl": { "format": "uri", "type": "string" }, "email": { "format": "email", "type": "string" }, "genesisId": { "format": "integer", "type": "string" }, "id": { "format": "uuid", "nullable": true, "type": "string" }, "name": { "nullable": true, "type": "string" } }, "required": [ "genesisId" ], "type": "object" }, "repositoryName": { "type": "string" }, "shares": { "items": { "$ref": "#/components/schemas/WorkspaceShareDto" }, "type": "array" }, "uvcsConnections": { "items": { "$ref": "#/components/schemas/WorkspaceUvcsConnectionDto" }, "type": "array" } }, "required": [ "id", "name", "owner", "lastActivityDate", "repositoryName", "guid", "shares", "uvcsConnections" ], "type": "object" }, "type": "array" } }, "required": [ "id", "uuid", "name", "description", "isFavorite", "creatorName", "lastActivityDate", "mainBranch", "mainBranchId", "isPublic" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Patch an organization repository", "tags": [ "repository" ] }, "delete": { "description": "Delete an organization repository", "operationId": "deleteOrganizationRepository", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "204": { "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Delete an organization repository", "tags": [ "repository" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/{targetType}/{targetNameOrId}/attributes/{id}": { "parameters": [ { "description": "Path parameter id", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter targetNameOrId", "in": "path", "name": "targetNameOrId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter targetType", "in": "path", "name": "targetType", "required": true, "schema": { "type": "string" } } ], "put": { "description": "Create or replace a custom attribute on a branch, label, or other target.", "operationId": "putorganizationsorganizationnamerepositoriesrepositorynametargettypetargetnameoridattributesid", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestPutAttributeValueBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestGetAttributeValue" } } }, "description": "Attribute value updated" }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestGetAttributeValue" } } }, "description": "Attribute value created" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "PUT /organizations/{organizationName}/repositories/{repositoryName}/{targetType}/{targetNameOrId}/attributes/{id}", "tags": [ "organizations" ] }, "delete": { "description": "Delete a custom attribute on a branch, label, or other target.", "operationId": "deleteorganizationsorganizationnamerepositoriesrepositorynametargettypetargetnameoridattributesid", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "DELETE /organizations/{organizationName}/repositories/{repositoryName}/{targetType}/{targetNameOrId}/attributes/{id}", "tags": [ "organizations" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/{targetType}/{targetValue}/merge-bots/start": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter targetType", "in": "path", "name": "targetType", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter targetValue", "in": "path", "name": "targetValue", "required": true, "schema": { "type": "string" } } ], "post": { "description": "Start merge bots for a repository and a branch", "operationId": "startMergeBots", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "targetType", "required": true, "schema": { "enum": [ "branches" ], "type": "string" } }, { "in": "path", "name": "targetValue", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Start merge bots", "tags": [ "merge-bot" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/{type}/{id}/subscriptions": { "parameters": [ { "description": "Path parameter id", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter type", "in": "path", "name": "type", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get the all notification subscriptions for the object", "operationId": "NotificationSubscriptionsController_getObjectSubscriptions", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "type", "required": true, "schema": { "enum": [ "code-reviews" ], "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "format": "int64", "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "properties": { "id": { "format": "int64", "type": "number" }, "type": { "enum": [ "review" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" }, "type": "array" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "GET /organizations/{organizationName}/repositories/{repositoryName}/{type}/{id}/subscriptions", "tags": [ "notifications" ] }, "post": { "description": "Subscribe to notifications for the object", "operationId": "NotificationSubscriptionsController_subscribeToObject", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "type", "required": true, "schema": { "enum": [ "code-reviews" ], "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "format": "int64", "type": "number" } } ], "responses": { "200": { "description": "OK" }, "201": { "content": { "application/json": { "schema": { "properties": { "object": { "$ref": "#/components/schemas/NotificationObjectSubscriptionObjectDto" }, "reason": { "enum": [ "userIsUnsubscribed", "userCommentedInReview", "userMentionedInReview", "userIsReviewer", "userIsOwner", "userSubscribedManually" ], "type": "string" }, "user": { "$ref": "#/components/schemas/NotificationObjectSubscriptionUserDto" } }, "required": [ "user", "object", "reason" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "POST /organizations/{organizationName}/repositories/{repositoryName}/{type}/{id}/subscriptions", "tags": [ "notifications" ] }, "delete": { "description": "Unsubscribe from notifications for the object", "operationId": "NotificationSubscriptionsController_unsubscribeFromObject", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "type", "required": true, "schema": { "enum": [ "code-reviews" ], "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "format": "int64", "type": "number" } } ], "responses": { "200": { "description": "OK" }, "204": { "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "DELETE /organizations/{organizationName}/repositories/{repositoryName}/{type}/{id}/subscriptions", "tags": [ "notifications" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/attributes": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "This is paginated", "operationId": "getAttributes", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filterStartDate", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "filterEndDate", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "filterAuthors", "schema": { "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "orderBy", "schema": { "enum": [ "name", "creationDate" ], "type": "string" } }, { "in": "query", "name": "next", "schema": { "type": "string" } }, { "in": "query", "name": "previous", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "minimum": 0, "type": "number" } }, { "in": "query", "name": "search", "schema": { "type": "string" } }, { "in": "query", "name": "order", "schema": { "enum": [ "asc", "desc" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "allOf": [ { "properties": { "cursor": { "$ref": "#/components/schemas/RestCursor" }, "limit": { "type": "number" }, "results": { "items": { "type": "string" }, "type": "array" } }, "required": [ "cursor", "limit", "results" ], "type": "object" }, { "properties": { "results": { "items": { "properties": { "author": { "type": "string" }, "comment": { "type": "string" }, "creationDate": { "format": "date-time", "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" } }, "required": [ "id", "name", "comment", "author", "creationDate" ], "type": "object" }, "type": "array" } } } ] } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get attributes", "tags": [ "attribute" ] }, "post": { "description": "Create an attribute", "operationId": "createAttribute", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "comment": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "comment" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "201": { "content": { "application/json": { "schema": { "properties": { "author": { "type": "string" }, "comment": { "type": "string" }, "creationDate": { "format": "date-time", "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" } }, "required": [ "id", "name", "comment", "author", "creationDate" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Create an attribute", "tags": [ "attribute" ] }, "delete": { "description": "Delete attributes", "operationId": "deleteAttributes", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "ids": { "items": { "type": "integer" }, "type": "array" } }, "required": [ "ids" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "207": { "content": { "application/json": { "schema": { "properties": { "failures": { "items": { "type": "integer" }, "type": "array" } }, "required": [ "failures" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Delete attributes", "tags": [ "attribute" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/attributes/{id}": { "parameters": [ { "description": "Path parameter id", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "patch": { "description": "Patch attribute", "operationId": "changeAttribute", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "comment": { "type": "string" }, "name": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "author": { "type": "string" }, "comment": { "type": "string" }, "creationDate": { "format": "date-time", "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" } }, "required": [ "id", "name", "comment", "author", "creationDate" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Patch attribute", "tags": [ "attribute" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/attributes/{id}/permissions": { "parameters": [ { "description": "Path parameter id", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get attribute permissions", "operationId": "getAttributePermissions", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "permissions": { "items": { "$ref": "#/components/schemas/RestGetEndUserPermissions" }, "type": "array" } }, "required": [ "permissions" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get attribute permissions", "tags": [ "permission", "attribute" ] }, "put": { "description": "Set attribute permissions", "operationId": "setAttributePermissions", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "endUsersPermissions": { "items": { "$ref": "#/components/schemas/RestSetEndUserPermissions" }, "type": "array" } }, "required": [ "endUsersPermissions" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "204": { "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Set attribute permissions", "tags": [ "permission", "attribute" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/branches": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get branches", "operationId": "getBranches", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "format": "integer", "minimum": 0, "type": "number" } }, { "description": "Optional search string. Can be repeated to search for multiple strings. Only available on endpoints with multi-search support.", "explode": true, "in": "query", "name": "search", "required": false, "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "in": "query", "name": "order", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "orderBy", "required": false, "schema": { "enum": [ "name", "lastChangesetId", "lastActivityDate", "creationDate" ], "type": "string" } }, { "explode": false, "in": "query", "name": "filterAuthors", "required": false, "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "in": "query", "name": "filterStartDate", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "filterEndDate", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "filterActivityStartDate", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "filterActivityEndDate", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "description": "Comma-separated list of fields to include in the response", "explode": false, "in": "query", "name": "includeFields", "required": false, "schema": { "items": { "enum": [ "merges" ] }, "type": "array" }, "style": "form" }, { "in": "query", "name": "hidden", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "allOf": [ { "properties": { "cursor": { "$ref": "#/components/schemas/RestCursor" }, "limit": { "type": "number" }, "results": { "items": { "type": "string" }, "type": "array" } }, "required": [ "cursor", "limit", "results" ], "type": "object" }, { "properties": { "results": { "items": { "properties": { "author": { "type": "string" }, "canBeDeleted": { "type": "boolean" }, "creationDate": { "format": "date-time", "type": "string" }, "description": { "type": "string" }, "hidden": { "type": "boolean" }, "id": { "type": "number" }, "isMain": { "type": "boolean" }, "lastActivityDate": { "format": "date-time", "type": "string" }, "lastChangesetId": { "type": "number" }, "lastChangesetName": { "type": "string" }, "merges": { "items": { "properties": { "author": { "type": "string" }, "comment": { "type": "string" }, "destinationBranchId": { "type": "number" }, "destinationBranchName": { "type": "string" }, "destinationChangesetId": { "type": "number" }, "destinationIsMain": { "type": "boolean" }, "mergeDate": { "format": "date-time", "type": "string" }, "sourceBranchId": { "type": "number" }, "sourceBranchName": { "type": "string" }, "sourceChangesetId": { "type": "number" } }, "required": [ "sourceChangesetId", "sourceBranchId", "sourceBranchName", "destinationChangesetId", "destinationBranchId", "destinationBranchName", "destinationIsMain", "mergeDate", "author", "comment" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "numberOfChangesets": { "type": "number" }, "numberOfReviews": { "type": "number" }, "status": { "type": "string" } }, "required": [ "name", "id", "description", "author", "lastChangesetName", "lastChangesetId", "lastActivityDate", "creationDate", "canBeDeleted", "numberOfReviews", "numberOfChangesets", "isMain" ], "type": "object" }, "type": "array" } } } ] } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get branches", "tags": [ "branch" ] }, "post": { "description": "Create a branch", "operationId": "createBranch", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "changeset": { "minimum": 0, "type": "number" }, "comment": { "default": "", "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "changeset" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "201": { "content": { "application/json": { "schema": { "properties": { "author": { "type": "string" }, "canBeDeleted": { "type": "boolean" }, "creationDate": { "format": "date-time", "type": "string" }, "description": { "type": "string" }, "hidden": { "type": "boolean" }, "id": { "type": "number" }, "isMain": { "type": "boolean" }, "lastActivityDate": { "format": "date-time", "type": "string" }, "lastChangesetId": { "type": "number" }, "lastChangesetName": { "type": "string" }, "merges": { "items": { "properties": { "author": { "type": "string" }, "comment": { "type": "string" }, "destinationBranchId": { "type": "number" }, "destinationBranchName": { "type": "string" }, "destinationChangesetId": { "type": "number" }, "destinationIsMain": { "type": "boolean" }, "mergeDate": { "format": "date-time", "type": "string" }, "sourceBranchId": { "type": "number" }, "sourceBranchName": { "type": "string" }, "sourceChangesetId": { "type": "number" } }, "required": [ "sourceChangesetId", "sourceBranchId", "sourceBranchName", "destinationChangesetId", "destinationBranchId", "destinationBranchName", "destinationIsMain", "mergeDate", "author", "comment" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "numberOfChangesets": { "type": "number" }, "numberOfReviews": { "type": "number" }, "status": { "type": "string" } }, "required": [ "name", "id", "description", "author", "lastChangesetName", "lastChangesetId", "lastActivityDate", "creationDate", "canBeDeleted", "numberOfReviews", "numberOfChangesets", "isMain" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Create a branch", "tags": [ "branch" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/branches/{branchIdOrName}": { "parameters": [ { "description": "Branch name or id", "in": "path", "name": "branchIdOrName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Use `idType` to specify whether you are using name or id to lookup the branch", "operationId": "getBranch", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "description": "Branch name or id", "in": "path", "name": "branchIdOrName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "idType", "required": true, "schema": { "default": "unknown", "enum": [ "name", "id", "unknown" ], "type": "string" } }, { "description": "Comma-separated list of fields to include in the response", "explode": false, "in": "query", "name": "includeFields", "required": false, "schema": { "items": { "enum": [ "merges", "attributeValues", "mergebots" ] }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "attributesValues": { "items": { "properties": { "attributeComment": { "type": "string" }, "attributeId": { "type": "number" }, "attributeName": { "type": "string" }, "lastUpdatedDate": { "format": "date-time", "type": "string" }, "target": { "$ref": "#/components/schemas/RestAttributeTarget" }, "value": { "type": "string" } }, "required": [ "attributeId", "attributeName", "attributeComment", "target", "value", "lastUpdatedDate" ], "type": "object" }, "type": "array" }, "author": { "type": "string" }, "canBeDeleted": { "type": "boolean" }, "creationDate": { "format": "date-time", "type": "string" }, "description": { "type": "string" }, "hidden": { "type": "boolean" }, "id": { "type": "number" }, "isMain": { "type": "boolean" }, "lastActivityDate": { "format": "date-time", "type": "string" }, "lastChangesetId": { "type": "number" }, "lastChangesetName": { "type": "string" }, "merges": { "items": { "properties": { "author": { "type": "string" }, "comment": { "type": "string" }, "destinationBranchId": { "type": "number" }, "destinationBranchName": { "type": "string" }, "destinationChangesetId": { "type": "number" }, "destinationIsMain": { "type": "boolean" }, "mergeDate": { "format": "date-time", "type": "string" }, "sourceBranchId": { "type": "number" }, "sourceBranchName": { "type": "string" }, "sourceChangesetId": { "type": "number" } }, "required": [ "sourceChangesetId", "sourceBranchId", "sourceBranchName", "destinationChangesetId", "destinationBranchId", "destinationBranchName", "destinationIsMain", "mergeDate", "author", "comment" ], "type": "object" }, "type": "array" }, "name": { "type": "string" }, "numberOfChangesets": { "type": "number" }, "numberOfReviews": { "type": "number" }, "status": { "type": "string" } }, "required": [ "name", "id", "description", "author", "lastChangesetName", "lastChangesetId", "lastActivityDate", "creationDate", "canBeDeleted", "numberOfReviews", "numberOfChangesets", "isMain" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get a branch", "tags": [ "branch" ] }, "patch": { "description": "Patch a branch", "operationId": "updateBranch", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "branchIdOrName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "hidden": { "type": "boolean" }, "name": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "204": { "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Patch a branch", "tags": [ "branch" ] }, "delete": { "description": "Delete a branch", "operationId": "deleteBranch", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "branchIdOrName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "204": { "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Delete a branch", "tags": [ "branch" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/branches/{branchName}/folder-info": { "parameters": [ { "description": "Path parameter branchName", "in": "path", "name": "branchName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get folder summary information for the branch root.", "operationId": "getorganizationsorganizationnamerepositoriesrepositorynamebranchesbranchnamefolderinfo", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "GET /organizations/{organizationName}/repositories/{repositoryName}/branches/{branchName}/folder-info", "tags": [ "organizations" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/branches/{branchName}/folder-info/{path}": { "parameters": [ { "description": "Path parameter branchName", "in": "path", "name": "branchName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter path", "in": "path", "name": "path", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get folder information (files, folders and total size in bytes) from a branch", "operationId": "getFolderInfo", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "branchName", "required": true, "schema": { "type": "string" } }, { "description": "Optional parameter for the item path", "in": "path", "name": "path", "required": true, "schema": { "default": "/" } }, { "description": "If true, traverse the entire directory tree.", "in": "query", "name": "recursive", "required": false, "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "files": { "format": "integer", "type": "number" }, "folders": { "format": "integer", "type": "number" }, "totalSize": { "format": "integer", "type": "number" } }, "required": [ "files", "folders", "totalSize" ], "type": "object" } } }, "description": "The number of files, folders and total size in bytes" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get folder information (files, folders and total size in bytes) from a branch", "tags": [ "changeset" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/branches/{branchName}/items": { "parameters": [ { "description": "Path parameter branchName", "in": "path", "name": "branchName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "List items at the branch root.", "operationId": "getorganizationsorganizationnamerepositoriesrepositorynamebranchesbranchnameitems", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "GET /organizations/{organizationName}/repositories/{repositoryName}/branches/{branchName}/items", "tags": [ "organizations" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/branches/{branchName}/items/{path}": { "parameters": [ { "description": "Path parameter branchName", "in": "path", "name": "branchName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter path", "in": "path", "name": "path", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get items from a branch", "operationId": "getBranchItems", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "branchName", "required": true, "schema": { "type": "string" } }, { "description": "Optional parameter for the item path", "in": "path", "name": "path", "required": true, "schema": { "default": "/", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "format": "integer", "minimum": 0, "type": "number" } }, { "description": "Optional search string. Can be repeated to search for multiple strings. Only available on endpoints with multi-search support.", "explode": true, "in": "query", "name": "search", "required": false, "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "in": "query", "name": "order", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, { "in": "query", "name": "offset", "required": false, "schema": { "format": "integer", "minimum": 0, "type": "number" } }, { "in": "query", "name": "orderBy", "required": false, "schema": { "enum": [ "revision", "item", "date", "type", "name" ], "type": "string" } }, { "in": "query", "name": "multiSearch", "required": false, "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "idType", "required": false, "schema": { "default": "unknown", "enum": [ "name", "id", "unknown" ], "type": "string" } }, { "in": "query", "name": "childrenOffset", "required": false, "schema": { "format": "integer", "type": "number" } }, { "in": "query", "name": "childrenLimit", "required": false, "schema": { "format": "integer", "type": "number" } }, { "description": "Comma-separated list of fields to include in the response", "explode": false, "in": "query", "name": "includeFields", "required": false, "schema": { "items": { "enum": [ "locks" ] }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "branch": { "type": "string" }, "branchId": { "type": "number" }, "changeset": { "type": "number" }, "children": { "items": { "$ref": "#/components/schemas/RestItemChild" }, "type": "array" }, "comment": { "type": "string" }, "contentType": { "type": "string" }, "date": { "format": "date-time", "type": "string" }, "item": { "type": "string" }, "lock": { "properties": { "date": { "format": "date-time", "type": "string" }, "destinationBranchId": { "type": "number" }, "destinationBranchName": { "type": "string" }, "holderBranchId": { "type": "number" }, "holderBranchName": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "owner": { "type": "string" }, "status": { "enum": [ "Retained", "Locked" ], "type": "string" } }, "type": "object" }, "owner": { "type": "string" }, "path": { "type": "string" }, "rawUrl": { "type": "string" }, "repository": { "type": "string" }, "revision": { "type": "number" }, "size": { "type": "number" }, "type": { "type": "string" }, "xLink": { "$ref": "#/components/schemas/RestXLink" } }, "required": [ "path", "revision", "item", "size", "branch", "branchId", "changeset", "comment", "owner", "date", "repository", "type", "contentType", "children" ], "type": "object" }, { "allOf": [ { "properties": { "limit": { "type": "number" }, "offset": { "type": "number" }, "results": { "items": { "type": "string" }, "type": "array" }, "total": { "type": "number" } }, "required": [ "total", "offset", "limit", "results" ], "type": "object" }, { "properties": { "results": { "items": { "properties": { "branch": { "type": "string" }, "branchId": { "type": "number" }, "changeset": { "type": "number" }, "children": { "items": { "$ref": "#/components/schemas/RestItemChild" }, "type": "array" }, "comment": { "type": "string" }, "contentType": { "type": "string" }, "date": { "format": "date-time", "type": "string" }, "item": { "type": "string" }, "lock": { "properties": { "date": { "format": "date-time", "type": "string" }, "destinationBranchId": { "type": "number" }, "destinationBranchName": { "type": "string" }, "holderBranchId": { "type": "number" }, "holderBranchName": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "owner": { "type": "string" }, "status": { "enum": [ "Retained", "Locked" ], "type": "string" } }, "type": "object" }, "owner": { "type": "string" }, "path": { "type": "string" }, "rawUrl": { "type": "string" }, "repository": { "type": "string" }, "revision": { "type": "number" }, "size": { "type": "number" }, "type": { "type": "string" }, "xLink": { "$ref": "#/components/schemas/RestXLink" } }, "required": [ "path", "revision", "item", "size", "branch", "branchId", "changeset", "comment", "owner", "date", "repository", "type", "contentType", "children" ], "type": "object" }, "type": "array" } } } ] } ], "type": "object" } } }, "description": "It is paginated if there are several results, otherwise it is a single result" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get items from a branch", "tags": [ "branch" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/branches/{branchName}/items/permissions/{path}": { "parameters": [ { "description": "Path parameter branchName", "in": "path", "name": "branchName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter path", "in": "path", "name": "path", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get an item permissions", "operationId": "getItemPermissions", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "branchName", "required": true, "schema": { "type": "string" } }, { "description": "Optional parameter for the item path", "in": "path", "name": "path", "required": true, "schema": { "default": "/" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "permissions": { "items": { "$ref": "#/components/schemas/RestGetEndUserPermissions" }, "type": "array" } }, "required": [ "permissions" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get an item permissions", "tags": [ "permission" ] }, "put": { "description": "Set an item permissions", "operationId": "setItemPermissions", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "branchName", "required": true, "schema": { "type": "string" } }, { "description": "Optional parameter for the item path", "in": "path", "name": "path", "required": true, "schema": { "default": "/" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "endUsersPermissions": { "items": { "$ref": "#/components/schemas/RestSetEndUserPermissions" }, "type": "array" } }, "required": [ "endUsersPermissions" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "204": { "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Set an item permissions", "tags": [ "permission" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/branches/{branchName}/permissions": { "parameters": [ { "description": "Path parameter branchName", "in": "path", "name": "branchName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get a branch permissions", "operationId": "getBranchPermissions", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "branchName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "permissions": { "items": { "$ref": "#/components/schemas/RestGetEndUserPermissions" }, "type": "array" } }, "required": [ "permissions" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get a branch permissions", "tags": [ "permission", "branch" ] }, "put": { "description": "Set a branch permissions", "operationId": "setBranchPermissions", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "branchName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "endUsersPermissions": { "items": { "$ref": "#/components/schemas/RestSetEndUserPermissions" }, "type": "array" } }, "required": [ "endUsersPermissions" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "204": { "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Set a branch permissions", "tags": [ "branch", "permission" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/changesets": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "This is paginated", "operationId": "getChangesets", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "format": "integer", "minimum": 0, "type": "number" } }, { "description": "Optional search string. Can be repeated to search for multiple strings. Only available on endpoints with multi-search support.", "explode": true, "in": "query", "name": "search", "required": false, "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "in": "query", "name": "order", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "orderBy", "required": false, "schema": { "enum": [ "id", "date" ], "type": "string" } }, { "in": "query", "name": "branchName", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "filterStartDate", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "filterEndDate", "required": false, "schema": { "format": "date-time", "type": "string" } }, { "explode": false, "in": "query", "name": "filterBranchIds", "required": false, "schema": { "format": "integer", "items": { "type": "number" }, "type": "array" }, "style": "form" }, { "explode": false, "in": "query", "name": "filterAuthors", "required": false, "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Comma-separated list of fields to include in the response", "explode": false, "in": "query", "name": "includeFields", "required": false, "schema": { "items": { "enum": [ "canBeDeleted", "merges" ] }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "allOf": [ { "properties": { "cursor": { "$ref": "#/components/schemas/RestCursor" }, "limit": { "type": "number" }, "results": { "items": { "type": "string" }, "type": "array" } }, "required": [ "cursor", "limit", "results" ], "type": "object" }, { "properties": { "results": { "items": { "properties": { "authorName": { "type": "string" }, "branchId": { "type": "number" }, "branchName": { "type": "string" }, "canBeDeleted": { "type": "boolean" }, "codeReviewIds": { "items": { "type": "number" }, "type": "array" }, "comment": { "type": "string" }, "date": { "format": "date-time", "type": "string" }, "guid": { "type": "string" }, "hasCodeReview": { "type": "boolean" }, "id": { "type": "number" }, "labels": { "items": { "type": "string" }, "type": "array" }, "merges": { "items": { "properties": { "author": { "type": "string" }, "comment": { "type": "string" }, "destinationBranchId": { "type": "number" }, "destinationBranchName": { "type": "string" }, "destinationChangesetId": { "type": "number" }, "destinationIsMain": { "type": "boolean" }, "mergeDate": { "format": "date-time", "type": "string" }, "sourceBranchId": { "type": "number" }, "sourceBranchName": { "type": "string" }, "sourceChangesetId": { "type": "number" } }, "required": [ "sourceChangesetId", "sourceBranchId", "sourceBranchName", "destinationChangesetId", "destinationBranchId", "destinationBranchName", "destinationIsMain", "mergeDate", "author", "comment" ], "type": "object" }, "type": "array" }, "name": { "type": "string" } }, "required": [ "id", "name", "guid", "branchName", "branchId", "comment", "authorName", "date", "labels", "canBeDeleted", "hasCodeReview", "codeReviewIds" ], "type": "object" }, "type": "array" } } } ] } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get changesets", "tags": [ "changeset" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/changesets/{changesetId}/items": { "parameters": [ { "description": "Path parameter changesetId", "in": "path", "name": "changesetId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "List items changed in a changeset (root path).", "operationId": "getorganizationsorganizationnamerepositoriesrepositorynamechangesetschangesetiditems", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "GET /organizations/{organizationName}/repositories/{repositoryName}/changesets/{changesetId}/items", "tags": [ "organizations" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/changesets/{changesetId}/items/{path}": { "parameters": [ { "description": "Path parameter changesetId", "in": "path", "name": "changesetId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter path", "in": "path", "name": "path", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get items from a changeset", "operationId": "getChangesetItems", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "changesetId", "required": true, "schema": { "type": "number" } }, { "description": "Optional parameter for the item path", "in": "path", "name": "path", "required": true, "schema": { "default": "/" } }, { "in": "query", "name": "limit", "required": false, "schema": { "format": "integer", "minimum": 0, "type": "number" } }, { "description": "Optional search string. Can be repeated to search for multiple strings. Only available on endpoints with multi-search support.", "explode": true, "in": "query", "name": "search", "required": false, "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "in": "query", "name": "order", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, { "in": "query", "name": "offset", "required": false, "schema": { "format": "integer", "minimum": 0, "type": "number" } }, { "in": "query", "name": "orderBy", "required": false, "schema": { "enum": [ "revision", "item", "date", "type", "name" ], "type": "string" } }, { "in": "query", "name": "multiSearch", "required": false, "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "idType", "required": false, "schema": { "default": "unknown", "enum": [ "name", "id", "unknown" ], "type": "string" } }, { "in": "query", "name": "childrenOffset", "required": false, "schema": { "format": "integer", "type": "number" } }, { "in": "query", "name": "childrenLimit", "required": false, "schema": { "format": "integer", "type": "number" } }, { "description": "Comma-separated list of fields to include in the response", "explode": false, "in": "query", "name": "includeFields", "required": false, "schema": { "items": { "enum": [ "locks" ] }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "branch": { "type": "string" }, "branchId": { "type": "number" }, "changeset": { "type": "number" }, "children": { "items": { "$ref": "#/components/schemas/RestItemChild" }, "type": "array" }, "comment": { "type": "string" }, "contentType": { "type": "string" }, "date": { "format": "date-time", "type": "string" }, "item": { "type": "string" }, "lock": { "properties": { "date": { "format": "date-time", "type": "string" }, "destinationBranchId": { "type": "number" }, "destinationBranchName": { "type": "string" }, "holderBranchId": { "type": "number" }, "holderBranchName": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "owner": { "type": "string" }, "status": { "enum": [ "Retained", "Locked" ], "type": "string" } }, "type": "object" }, "owner": { "type": "string" }, "path": { "type": "string" }, "rawUrl": { "type": "string" }, "repository": { "type": "string" }, "revision": { "type": "number" }, "size": { "type": "number" }, "type": { "type": "string" }, "xLink": { "$ref": "#/components/schemas/RestXLink" } }, "required": [ "path", "revision", "item", "size", "branch", "branchId", "changeset", "comment", "owner", "date", "repository", "type", "contentType", "children" ], "type": "object" }, { "allOf": [ { "properties": { "limit": { "type": "number" }, "offset": { "type": "number" }, "results": { "items": { "type": "string" }, "type": "array" }, "total": { "type": "number" } }, "required": [ "total", "offset", "limit", "results" ], "type": "object" }, { "properties": { "results": { "items": { "properties": { "branch": { "type": "string" }, "branchId": { "type": "number" }, "changeset": { "type": "number" }, "children": { "items": { "$ref": "#/components/schemas/RestItemChild" }, "type": "array" }, "comment": { "type": "string" }, "contentType": { "type": "string" }, "date": { "format": "date-time", "type": "string" }, "item": { "type": "string" }, "lock": { "properties": { "date": { "format": "date-time", "type": "string" }, "destinationBranchId": { "type": "number" }, "destinationBranchName": { "type": "string" }, "holderBranchId": { "type": "number" }, "holderBranchName": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "owner": { "type": "string" }, "status": { "enum": [ "Retained", "Locked" ], "type": "string" } }, "type": "object" }, "owner": { "type": "string" }, "path": { "type": "string" }, "rawUrl": { "type": "string" }, "repository": { "type": "string" }, "revision": { "type": "number" }, "size": { "type": "number" }, "type": { "type": "string" }, "xLink": { "$ref": "#/components/schemas/RestXLink" } }, "required": [ "path", "revision", "item", "size", "branch", "branchId", "changeset", "comment", "owner", "date", "repository", "type", "contentType", "children" ], "type": "object" }, "type": "array" } } } ] } ], "type": "object" } } }, "description": "It is paginated if there are several results, otherwise it is a single result" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get items from a changeset", "tags": [ "changeset" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/changesets/{id}": { "parameters": [ { "description": "Path parameter id", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get changeset details.", "operationId": "getorganizationsorganizationnamerepositoriesrepositorynamechangesetsid", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "GET /organizations/{organizationName}/repositories/{repositoryName}/changesets/{id}", "tags": [ "organizations" ] }, "patch": { "description": "Update changeset metadata.", "operationId": "patchorganizationsorganizationnamerepositoriesrepositorynamechangesetsid", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "PATCH /organizations/{organizationName}/repositories/{repositoryName}/changesets/{id}", "tags": [ "organizations" ] }, "delete": { "description": "Delete a changeset.", "operationId": "deleteorganizationsorganizationnamerepositoriesrepositorynamechangesetsid", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "DELETE /organizations/{organizationName}/repositories/{repositoryName}/changesets/{id}", "tags": [ "organizations" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/code-reviews": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get a paginated list of code reviews.", "operationId": "getReviews", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "format": "integer", "minimum": 0, "type": "number" } }, { "description": "Optional search string. Can be repeated to search for multiple strings. Only available on endpoints with multi-search support.", "explode": true, "in": "query", "name": "search", "required": false, "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "in": "query", "name": "order", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, { "in": "query", "name": "next", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "previous", "required": false, "schema": { "type": "string" } }, { "description": "JSON array of target types and ids in format [[\"branch\"|\"changeset\"|\"label\", number]]", "in": "query", "name": "filterTargets", "required": false, "schema": { "type": "string" } }, { "description": "Comma separated list of branch names", "in": "query", "name": "filterBranchNames", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Comma separated list of branch ids", "in": "query", "name": "filterBranchIds", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Comma separated list of code review statuses", "in": "query", "name": "filterStatus", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Comma separated list of code review statuses", "in": "query", "name": "filterReviewerStatus", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Comma separated list of owner emails", "in": "query", "name": "filterOwner", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Comma separated list of reviewer emails", "in": "query", "name": "filterReviewer", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } }, { "description": "Comma separated list of repository names", "in": "query", "name": "filterRepoNames", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "orderBy", "required": false, "schema": { "enum": [ "id", "createdAt", "updatedAt", "status", "title" ], "type": "string" } }, { "description": "Comma-separated list of fields to include in the response", "explode": false, "in": "query", "name": "includeFields", "required": false, "schema": { "items": { "enum": [ "statusNumbers", "merges" ] }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "assignedToMe": { "type": "number" }, "reviewedCount": { "type": "number" }, "reviews": { "additionalProperties": { "allOf": [ { "properties": { "cursor": { "$ref": "#/components/schemas/CursorDto" }, "limit": { "format": "integer", "minimum": 0, "type": "number" } }, "required": [ "limit", "cursor" ], "type": "object" }, { "properties": { "results": { "items": { "$ref": "#/components/schemas/CodeReviewDto" }, "type": "array" } } } ], "title": "CodeReviewDtoPageDto" }, "type": "object" }, "reworkRequiredCount": { "type": "number" }, "totalCount": { "type": "number" }, "underReviewCount": { "type": "number" } }, "required": [ "reviews" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get code reviews", "tags": [ "code review" ] }, "post": { "description": "Create a code review with the given data.", "operationId": "requestAReview", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "description": { "type": "string" }, "object": { "$ref": "#/components/schemas/PostCodeReviewObject" }, "reviewers": { "items": { "oneOf": [ { "type": "string" }, { "$ref": "#/components/schemas/ReviewerWithStatusDto" } ] }, "type": "array" }, "title": { "type": "string" } }, "required": [ "object", "title", "description", "reviewers" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "201": { "content": { "application/json": { "schema": { "properties": { "assignee": { "type": "string" }, "comments": { "items": { "$ref": "#/components/schemas/CodeReviewCommentDto" }, "type": "array" }, "commentsCount": { "format": "integer", "type": "number" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "type": "string" }, "id": { "type": "number" }, "mergeAllowed": { "type": "boolean" }, "mergeIssues": { "type": "string" }, "merges": { "items": { "$ref": "#/components/schemas/MergeDto" }, "type": "array" }, "numberOfIssues": { "format": "integer", "type": "number" }, "object": { "$ref": "#/components/schemas/CodeReviewObjectDto" }, "owner": { "type": "string" }, "repositoryName": { "type": "string" }, "reviewers": { "items": { "$ref": "#/components/schemas/ReviewerWithStatusDto" }, "type": "array" }, "status": { "enum": [ "under-review", "reviewed", "rework-required" ], "type": "string" }, "title": { "type": "string" }, "unansweredQuestionsCount": { "format": "integer", "type": "number" }, "updatedAt": { "format": "date-time", "type": "string" }, "userCommentsCount": { "format": "integer", "type": "number" } }, "required": [ "id", "object", "owner", "createdAt", "updatedAt", "status", "title", "description", "commentsCount", "userCommentsCount", "unansweredQuestionsCount", "numberOfIssues", "comments", "reviewers" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Create a code review", "tags": [ "code review" ] }, "delete": { "description": "Delete code reviews by id", "operationId": "deleteReviews", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "reviews": { "items": { "type": "string" }, "type": "array" } }, "required": [ "reviews" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "207": { "content": { "application/json": { "schema": { "properties": { "failures": { "items": { "type": "string" }, "type": "array" } }, "required": [ "failures" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Delete code reviews", "tags": [ "code review" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/code-reviews/{codeReviewId}": { "parameters": [ { "description": "Path parameter codeReviewId", "in": "path", "name": "codeReviewId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get a code review by id", "operationId": "getReview", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "codeReviewId", "required": true, "schema": { "format": "integer", "type": "number" } }, { "description": "Comma-separated list of fields to include in the response", "explode": false, "in": "query", "name": "includeFields", "required": false, "schema": { "items": { "enum": [ "mergeAllowed", "merges" ] }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "assignee": { "type": "string" }, "comments": { "items": { "$ref": "#/components/schemas/CodeReviewCommentDto" }, "type": "array" }, "commentsCount": { "format": "integer", "type": "number" }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "type": "string" }, "id": { "type": "number" }, "mergeAllowed": { "type": "boolean" }, "mergeIssues": { "type": "string" }, "merges": { "items": { "$ref": "#/components/schemas/MergeDto" }, "type": "array" }, "numberOfIssues": { "format": "integer", "type": "number" }, "object": { "$ref": "#/components/schemas/CodeReviewObjectDto" }, "owner": { "type": "string" }, "repositoryName": { "type": "string" }, "reviewers": { "items": { "$ref": "#/components/schemas/ReviewerWithStatusDto" }, "type": "array" }, "status": { "enum": [ "under-review", "reviewed", "rework-required" ], "type": "string" }, "title": { "type": "string" }, "unansweredQuestionsCount": { "format": "integer", "type": "number" }, "updatedAt": { "format": "date-time", "type": "string" }, "userCommentsCount": { "format": "integer", "type": "number" } }, "required": [ "id", "object", "owner", "createdAt", "updatedAt", "status", "title", "description", "commentsCount", "userCommentsCount", "unansweredQuestionsCount", "numberOfIssues", "comments", "reviewers" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get a code review", "tags": [ "code review" ] }, "patch": { "description": "Patch a code review by id", "operationId": "patchReview", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "codeReviewId", "required": true, "schema": { "format": "integer", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "description": { "type": "string" }, "title": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "204": { "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Patch a code review", "tags": [ "code review" ] }, "delete": { "description": "Delete a code review by id", "operationId": "deleteReview", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "codeReviewId", "required": true, "schema": { "format": "integer", "type": "number" } } ], "responses": { "200": { "description": "OK" }, "204": { "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Delete a code review", "tags": [ "code review" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/code-reviews/{codeReviewId}/comments": { "parameters": [ { "description": "Path parameter codeReviewId", "in": "path", "name": "codeReviewId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get comments for a code review.", "operationId": "getComments", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "codeReviewId", "required": true, "schema": { "format": "integer", "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "comments": { "items": { "$ref": "#/components/schemas/CodeReviewCommentDto" }, "type": "array" } }, "required": [ "comments" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get comments", "tags": [ "code review" ] }, "post": { "description": "Add a comment to a code review.", "operationId": "addComment", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "codeReviewId", "required": true, "schema": { "format": "integer", "type": "number" } }, { "description": "Comma-separated list of fields to include in the response", "explode": false, "in": "query", "name": "includeFields", "required": false, "schema": { "items": { "enum": [ "itemPath" ] }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "changesetId": { "format": "integer", "type": "number" }, "commentText": { "type": "string" }, "locationSpec": { "type": "string" }, "revisionId": { "format": "integer", "type": "number" }, "type": { "enum": [ "Change", "Question", "Conversation", "Comment", "Timeline", "Script", "Discarded" ], "type": "string" } }, "required": [ "revisionId", "changesetId", "commentText", "type" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "201": { "content": { "application/json": { "schema": { "properties": { "appliedInChangesetId": { "type": "integer" }, "branchChangesetId": { "type": "integer" }, "changesetId": { "type": "integer" }, "commentText": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "type": "number" }, "itemId": { "type": "integer" }, "itemPath": { "type": "string" }, "locationSpec": { "type": "string" }, "owner": { "format": "email", "type": "string" }, "parentCommentId": { "type": "integer" }, "reviewId": { "type": "integer" }, "revisionId": { "type": "integer" }, "timestamp": { "deprecated": true, "format": "date-time", "type": "string" }, "type": { "enum": [ "Comment", "Change", "Question", "Conversation", "Timeline", "Script", "Discarded", "Description", "StatusUnderReview", "StatusReworkRequired", "StatusReviewed" ], "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "uuid": { "format": "uuid", "type": "string" } }, "required": [ "type", "id", "uuid", "owner", "timestamp", "createdAt", "updatedAt", "itemId", "itemPath", "revisionId", "commentText", "reviewId", "parentCommentId", "changesetId", "appliedInChangesetId", "branchChangesetId" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Add a comment", "tags": [ "code review" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/code-reviews/{codeReviewId}/comments/{commentId}": { "parameters": [ { "description": "Path parameter codeReviewId", "in": "path", "name": "codeReviewId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter commentId", "in": "path", "name": "commentId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "patch": { "description": "Patch a comment for a code review.", "operationId": "changeComment", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "codeReviewId", "required": true, "schema": { "format": "integer", "type": "number" } }, { "in": "path", "name": "commentId", "required": true, "schema": { "format": "integer", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "commentText": { "type": "string" } }, "required": [ "commentText" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "appliedInChangesetId": { "type": "integer" }, "branchChangesetId": { "type": "integer" }, "changesetId": { "type": "integer" }, "commentText": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "type": "number" }, "itemId": { "type": "integer" }, "itemPath": { "type": "string" }, "locationSpec": { "type": "string" }, "owner": { "format": "email", "type": "string" }, "parentCommentId": { "type": "integer" }, "reviewId": { "type": "integer" }, "revisionId": { "type": "integer" }, "timestamp": { "deprecated": true, "format": "date-time", "type": "string" }, "type": { "enum": [ "Comment", "Change", "Question", "Conversation", "Timeline", "Script", "Discarded", "Description", "StatusUnderReview", "StatusReworkRequired", "StatusReviewed" ], "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "uuid": { "format": "uuid", "type": "string" } }, "required": [ "type", "id", "uuid", "owner", "timestamp", "createdAt", "updatedAt", "itemId", "itemPath", "revisionId", "commentText", "reviewId", "parentCommentId", "changesetId", "appliedInChangesetId", "branchChangesetId" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Patch a comment", "tags": [ "code review" ] }, "delete": { "description": "Delete a comment on a code review.", "operationId": "deleteComment", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "codeReviewId", "required": true, "schema": { "format": "integer", "type": "number" } }, { "in": "path", "name": "commentId", "required": true, "schema": { "format": "integer", "type": "number" } } ], "responses": { "200": { "description": "OK" }, "204": { "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Delete a comment", "tags": [ "code review" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/code-reviews/{codeReviewId}/comments/{commentId}/resolutions": { "parameters": [ { "description": "Path parameter codeReviewId", "in": "path", "name": "codeReviewId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter commentId", "in": "path", "name": "commentId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "post": { "description": "Resolve a comment on a code review.", "operationId": "resolveAComment", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "codeReviewId", "required": true, "schema": { "format": "integer", "type": "number" } }, { "in": "path", "name": "commentId", "required": true, "schema": { "format": "integer", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "changesetId": { "format": "integer", "type": "number" } }, "required": [ "changesetId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "204": { "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Resolve a comment", "tags": [ "code review" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/code-reviews/{codeReviewId}/comments/{parentCommentId}/replies": { "parameters": [ { "description": "Path parameter codeReviewId", "in": "path", "name": "codeReviewId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter parentCommentId", "in": "path", "name": "parentCommentId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "post": { "description": "Post a reply to a code review comment thread.", "operationId": "postorganizationsorganizationnamerepositoriesrepositorynamecodereviewscodereviewidcommentsparentcommentidreplies", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "POST /organizations/{organizationName}/repositories/{repositoryName}/code-reviews/{codeReviewId}/comments/{parentCommentId}/replies", "tags": [ "organizations" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/code-reviews/{codeReviewId}/reviewers": { "parameters": [ { "description": "Path parameter codeReviewId", "in": "path", "name": "codeReviewId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get reviewers for a code review.", "operationId": "getReviewers", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "codeReviewId", "required": true, "schema": { "format": "integer", "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "reviewers": { "items": { "$ref": "#/components/schemas/ReviewerWithStatusDto" }, "type": "array" } }, "required": [ "reviewers" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get reviewers", "tags": [ "code review" ] }, "post": { "description": "Add reviewers to a code review.", "operationId": "addReviewers", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "codeReviewId", "required": true, "schema": { "format": "integer", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "reviewers": { "items": { "anyOf": [ { "$ref": "#/components/schemas/ReviewerWithStatusDto" }, { "type": "string" } ] }, "type": "array" } }, "required": [ "reviewers" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "201": { "content": { "application/json": { "schema": { "properties": { "reviewers": { "items": { "$ref": "#/components/schemas/ReviewerWithStatusDto" }, "type": "array" } }, "required": [ "reviewers" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Add reviewers", "tags": [ "code review" ] }, "delete": { "description": "Remove reviewers from a code review.", "operationId": "removeReviewers", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "codeReviewId", "required": true, "schema": { "format": "integer", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "reviewers": { "items": { "anyOf": [ { "$ref": "#/components/schemas/ReviewerDto" }, { "type": "string" } ] }, "type": "array" } }, "required": [ "reviewers" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "207": { "content": { "application/json": { "schema": { "properties": { "failures": { "items": { "$ref": "#/components/schemas/ReviewerDto" }, "type": "array" } }, "required": [ "failures" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Remove reviewers", "tags": [ "code review" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/code-reviews/{codeReviewId}/reviews": { "parameters": [ { "description": "Path parameter codeReviewId", "in": "path", "name": "codeReviewId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "post": { "description": "Mark a code review as the provided review status.", "operationId": "markAsReview", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "codeReviewId", "required": true, "schema": { "format": "integer", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "comment": { "type": "string" }, "reviewerName": { "format": "email", "type": "string" }, "status": { "enum": [ "under-review", "reviewed", "rework-required" ], "type": "string" } }, "required": [ "status", "reviewerName" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "201": { "content": { "application/json": { "schema": { "properties": { "appliedInChangesetId": { "type": "integer" }, "branchChangesetId": { "type": "integer" }, "changesetId": { "type": "integer" }, "commentText": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "type": "number" }, "itemId": { "type": "integer" }, "itemPath": { "type": "string" }, "locationSpec": { "type": "string" }, "owner": { "format": "email", "type": "string" }, "parentCommentId": { "type": "integer" }, "reviewId": { "type": "integer" }, "revisionId": { "type": "integer" }, "timestamp": { "deprecated": true, "format": "date-time", "type": "string" }, "type": { "enum": [ "Comment", "Change", "Question", "Conversation", "Timeline", "Script", "Discarded", "Description", "StatusUnderReview", "StatusReworkRequired", "StatusReviewed" ], "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "uuid": { "format": "uuid", "type": "string" } }, "required": [ "type", "id", "uuid", "owner", "timestamp", "createdAt", "updatedAt", "itemId", "itemPath", "revisionId", "commentText", "reviewId", "parentCommentId", "changesetId", "appliedInChangesetId", "branchChangesetId" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Mark as reviewed", "tags": [ "code review" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/diffs/branches": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "There is a source branch and a destination branch. Destination is not mandatory, if not provided, the diff will be with the origin branch of the source branch", "operationId": "getBranchDiffs", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "sourceBranchId", "required": true, "schema": { "format": "integer", "minimum": 0, "type": "number" } }, { "in": "query", "name": "destinationBranchId", "required": false, "schema": { "format": "integer", "minimum": 0, "type": "number" } }, { "in": "query", "name": "isSemantic", "required": false, "schema": { "default": true } }, { "in": "query", "name": "pendingToIntegrate", "required": false, "schema": { "default": false } }, { "in": "query", "name": "comparisonType", "required": false, "schema": { "default": "IgnoreEolWhiteSpaces", "enum": [ "IgnoreEol", "IgnoreWhiteSpaces", "IgnoreEolWhiteSpaces", "NotIgnore" ], "type": "string" } }, { "description": "Comma-separated list of fields to include in the response", "explode": false, "in": "query", "name": "includeFields", "required": false, "schema": { "items": { "enum": [ "diffInfo" ] }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "added": { "items": { "$ref": "#/components/schemas/RestGetTreeDiffItem" }, "type": "array" }, "author": { "type": "string" }, "changed": { "items": { "$ref": "#/components/schemas/RestGetTreeDiffItem" }, "type": "array" }, "comment": { "type": "string" }, "deleted": { "items": { "$ref": "#/components/schemas/RestGetTreeDiffItem" }, "type": "array" }, "destination": { "type": "string" }, "destinationId": { "type": "number" }, "fsProtectionChanged": { "items": { "$ref": "#/components/schemas/RestGetTreeDiffItem" }, "type": "array" }, "mergeGroups": { "items": { "$ref": "#/components/schemas/RestGetMergeGroupDiffItems" }, "type": "array" }, "merged": { "items": { "$ref": "#/components/schemas/RestGetTreeDiffItem" }, "type": "array" }, "moved": { "items": { "$ref": "#/components/schemas/RestGetTreeDiffItem" }, "type": "array" }, "objectType": { "type": "string" }, "refactorGroups": { "items": { "$ref": "#/components/schemas/RestGetMergeGroupDiffItems" }, "type": "array" }, "repository": { "type": "string" }, "source": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "author", "comment", "timestamp", "source", "destination", "destinationId", "objectType", "repository", "fsProtectionChanged", "merged", "added", "changed", "moved", "deleted" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get a diff for branches", "tags": [ "branch" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/diffs/changesets/{changesetId}": { "parameters": [ { "description": "Path parameter changesetId", "in": "path", "name": "changesetId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get a diff for a single changeset (no destination changeset in path).", "operationId": "getorganizationsorganizationnamerepositoriesrepositorynamediffschangesetschangesetid", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "GET /organizations/{organizationName}/repositories/{repositoryName}/diffs/changesets/{changesetId}", "tags": [ "organizations" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/diffs/changesets/{changesetId}/{destinationChangesetId}": { "parameters": [ { "description": "Path parameter changesetId", "in": "path", "name": "changesetId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter destinationChangesetId", "in": "path", "name": "destinationChangesetId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get a changeset diff", "operationId": "getChangesetDiff", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "changesetId", "required": true, "schema": { "type": "number" } }, { "description": "Optional destination changeset to diff against", "in": "path", "name": "destinationChangesetId", "required": true, "schema": { "type": "number" } }, { "in": "query", "name": "isSemantic", "required": false, "schema": { "default": true } }, { "in": "query", "name": "comparisonType", "required": false, "schema": { "default": "IgnoreEolWhiteSpaces", "enum": [ "IgnoreEol", "IgnoreWhiteSpaces", "IgnoreEolWhiteSpaces", "NotIgnore" ], "type": "string" } }, { "description": "Comma-separated list of fields to include in the response", "explode": false, "in": "query", "name": "includeFields", "required": false, "schema": { "items": { "enum": [ "diffInfo" ] }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "added": { "items": { "$ref": "#/components/schemas/RestGetTreeDiffItem" }, "type": "array" }, "author": { "type": "string" }, "changed": { "items": { "$ref": "#/components/schemas/RestGetTreeDiffItem" }, "type": "array" }, "comment": { "type": "string" }, "deleted": { "items": { "$ref": "#/components/schemas/RestGetTreeDiffItem" }, "type": "array" }, "destination": { "type": "string" }, "destinationId": { "type": "number" }, "fsProtectionChanged": { "items": { "$ref": "#/components/schemas/RestGetTreeDiffItem" }, "type": "array" }, "mergeGroups": { "items": { "$ref": "#/components/schemas/RestGetMergeGroupDiffItems" }, "type": "array" }, "merged": { "items": { "$ref": "#/components/schemas/RestGetTreeDiffItem" }, "type": "array" }, "moved": { "items": { "$ref": "#/components/schemas/RestGetTreeDiffItem" }, "type": "array" }, "objectType": { "type": "string" }, "refactorGroups": { "items": { "$ref": "#/components/schemas/RestGetMergeGroupDiffItems" }, "type": "array" }, "repository": { "type": "string" }, "source": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "author", "comment", "timestamp", "source", "destination", "destinationId", "objectType", "repository", "fsProtectionChanged", "merged", "added", "changed", "moved", "deleted" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get a changeset diff", "tags": [ "changeset" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/diffs/labels/{labelId}": { "parameters": [ { "description": "Path parameter labelId", "in": "path", "name": "labelId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get a diff for a label (no destination label in path).", "operationId": "getorganizationsorganizationnamerepositoriesrepositorynamediffslabelslabelid", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "GET /organizations/{organizationName}/repositories/{repositoryName}/diffs/labels/{labelId}", "tags": [ "organizations" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/diffs/labels/{labelId}/{destinationLabelId}": { "parameters": [ { "description": "Path parameter destinationLabelId", "in": "path", "name": "destinationLabelId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter labelId", "in": "path", "name": "labelId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get a diff between two labels.", "operationId": "getorganizationsorganizationnamerepositoriesrepositorynamediffslabelslabeliddestinationlabelid", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "GET /organizations/{organizationName}/repositories/{repositoryName}/diffs/labels/{labelId}/{destinationLabelId}", "tags": [ "organizations" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/diffs/revisions": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get a revision diff", "operationId": "getRevisionDiff", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "source", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "destination", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "isSemantic", "required": false, "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "comparisonType", "required": false, "schema": { "default": "IgnoreEolWhiteSpaces", "enum": [ "IgnoreEol", "IgnoreWhiteSpaces", "IgnoreEolWhiteSpaces", "NotIgnore" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "comment": { "type": "string" }, "diffInfo": { "properties": { "drawingInfo": { "properties": { "left": { "properties": { "diffRegions": { "items": { "$ref": "#/components/schemas/RestGetRevisionDiffLineColor" }, "type": "array" }, "insideLineRegions": { "items": { "$ref": "#/components/schemas/RestGetRevisionDiffColumnColor" }, "type": "array" } }, "required": [ "diffRegions", "insideLineRegions" ], "type": "object" }, "right": { "properties": { "diffRegions": { "items": { "type": "object" }, "type": "array" }, "insideLineRegions": { "items": { "$ref": "#/components/schemas/RestGetRevisionDiffColumnColor" }, "type": "array" } }, "required": [ "diffRegions", "insideLineRegions" ], "type": "object" } }, "type": "object" }, "lineMapping": { "properties": { "destinationEditor": { "items": { "type": "number" }, "type": "array" }, "sourceEditor": { "items": { "type": "number" }, "type": "array" } }, "required": [ "sourceEditor", "destinationEditor" ], "type": "object" }, "moveInfo": { "properties": { "diffRegions": { "properties": { "left": { "items": { "$ref": "#/components/schemas/RestGetRevisionDiffLineColor" }, "type": "array" }, "right": { "items": { "$ref": "#/components/schemas/RestGetRevisionDiffLineColor" }, "type": "array" } }, "required": [ "left", "right" ], "type": "object" }, "insideLineRegions": { "properties": { "left": { "items": { "$ref": "#/components/schemas/RestGetRevisionDiffColumnColor" }, "type": "array" }, "right": { "items": { "$ref": "#/components/schemas/RestGetRevisionDiffColumnColor" }, "type": "array" } }, "required": [ "left", "right" ], "type": "object" }, "regions": { "properties": { "left": { "items": { "$ref": "#/components/schemas/RestGetRevisionDiffLineColor" }, "type": "array" }, "right": { "items": { "$ref": "#/components/schemas/RestGetRevisionDiffLineColor" }, "type": "array" } }, "required": [ "left", "right" ], "type": "object" } }, "type": "object" }, "semanticInfo": { "properties": { "left": { "properties": { "diffIcons": { "items": { "$ref": "#/components/schemas/RestGetRevisionDiffIcon" }, "type": "array" } }, "required": [ "diffIcons" ], "type": "object" }, "right": { "properties": { "diffIcons": { "items": { "$ref": "#/components/schemas/RestGetRevisionDiffIcon" }, "type": "array" } }, "required": [ "diffIcons" ], "type": "object" } }, "type": "object" } }, "type": "object" }, "dstRev": { "properties": { "branchName": { "type": "string" }, "changeset": { "type": "number" }, "owner": { "type": "string" } }, "required": [ "changeset", "branchName", "owner" ], "type": "object" }, "path": { "type": "string" }, "srcRev": { "properties": { "branchName": { "type": "string" }, "changeset": { "type": "number" }, "owner": { "type": "string" } }, "required": [ "changeset", "branchName", "owner" ], "type": "object" } }, "required": [ "path", "comment", "srcRev", "dstRev", "diffInfo" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get a revision diff", "tags": [ "revision" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/items/history/{sourceType}/{sourceName}/{path}": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter path", "in": "path", "name": "path", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter sourceName", "in": "path", "name": "sourceName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter sourceType", "in": "path", "name": "sourceType", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get a source history", "operationId": "getHistory", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "path", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "sourceType", "required": true, "schema": { "enum": [ "branches", "labels" ], "type": "string" } }, { "in": "path", "name": "sourceName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "orderBy", "schema": { "enum": [ "date", "changesetName", "comment", "branchName", "ownerName" ], "type": "string" } }, { "in": "query", "name": "startDate", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "endDate", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "branchName", "schema": { "type": "string" } }, { "in": "query", "name": "type", "schema": { "type": "string" } }, { "in": "query", "name": "next", "schema": { "type": "string" } }, { "in": "query", "name": "previous", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "minimum": 0, "type": "number" } }, { "in": "query", "name": "search", "schema": { "type": "string" } }, { "in": "query", "name": "order", "schema": { "enum": [ "asc", "desc" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "allOf": [ { "properties": { "cursor": { "$ref": "#/components/schemas/RestCursor" }, "limit": { "type": "number" }, "results": { "items": { "type": "string" }, "type": "array" } }, "required": [ "cursor", "limit", "results" ], "type": "object" }, { "properties": { "results": { "items": { "properties": { "branchId": { "type": "number" }, "branchName": { "type": "string" }, "changesetId": { "type": "number" }, "changesetName": { "type": "string" }, "comment": { "type": "string" }, "date": { "type": "string" }, "ownerName": { "type": "string" }, "parentRevisionId": { "type": "number" }, "prevName": { "type": "string" }, "revisionId": { "type": "number" }, "type": { "type": "string" } }, "required": [ "prevName", "changesetId", "changesetName", "ownerName", "date", "branchName", "branchId", "comment", "revisionId", "parentRevisionId", "type" ], "type": "object" }, "type": "array" } } } ] } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get a source history", "tags": [ "revision" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/labels": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "It is paginated", "operationId": "getLabels", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "orderBy", "schema": { "enum": [ "name", "id", "date", "lastChangesetId", "ownerEmail" ], "type": "string" } }, { "in": "query", "name": "filterStartDate", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "filterEndDate", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "next", "schema": { "type": "string" } }, { "in": "query", "name": "previous", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "minimum": 0, "type": "number" } }, { "in": "query", "name": "search", "schema": { "type": "string" } }, { "in": "query", "name": "order", "schema": { "enum": [ "asc", "desc" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "allOf": [ { "properties": { "cursor": { "$ref": "#/components/schemas/RestCursor" }, "limit": { "type": "number" }, "results": { "items": { "type": "string" }, "type": "array" } }, "required": [ "cursor", "limit", "results" ], "type": "object" }, { "properties": { "results": { "items": { "properties": { "comment": { "type": "string" }, "date": { "format": "date-time", "type": "string" }, "id": { "type": "number" }, "lastChangesetId": { "type": "number" }, "lastChangesetName": { "type": "string" }, "name": { "type": "string" }, "ownerEmail": { "type": "string" }, "repositoryName": { "type": "string" } }, "required": [ "name", "repositoryName", "lastChangesetId", "lastChangesetName", "date", "ownerEmail", "comment", "id" ], "type": "object" }, "type": "array" } } } ] } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get labels", "tags": [ "label" ] }, "post": { "description": "Create a label", "operationId": "createLabel", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "applyLabelToXlinkRepositories": { "type": "boolean" }, "changeset": { "minimum": 0, "type": "number" }, "comment": { "default": "", "type": "string" }, "name": { "type": "string" } }, "required": [ "name", "comment", "changeset", "applyLabelToXlinkRepositories" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "201": { "content": { "application/json": { "schema": { "properties": { "comment": { "type": "string" }, "date": { "format": "date-time", "type": "string" }, "id": { "type": "number" }, "lastChangesetId": { "type": "number" }, "lastChangesetName": { "type": "string" }, "name": { "type": "string" }, "ownerEmail": { "type": "string" }, "repositoryName": { "type": "string" } }, "required": [ "name", "repositoryName", "lastChangesetId", "lastChangesetName", "date", "ownerEmail", "comment", "id" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Create a label", "tags": [ "label" ] }, "delete": { "description": "Delete several labels", "operationId": "bulkDelete", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "ids": { "items": { "type": "number" }, "type": "array" } }, "required": [ "ids" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "207": { "content": { "application/json": { "schema": { "properties": { "failures": { "items": { "type": "number" }, "type": "array" } }, "required": [ "failures" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Delete several labels", "tags": [ "label" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/labels/{id}": { "parameters": [ { "description": "Path parameter id", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get a label by id.", "operationId": "getorganizationsorganizationnamerepositoriesrepositorynamelabelsid", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "GET /organizations/{organizationName}/repositories/{repositoryName}/labels/{id}", "tags": [ "organizations" ] }, "patch": { "description": "Update label fields by id.", "operationId": "patchorganizationsorganizationnamerepositoriesrepositorynamelabelsid", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "PATCH /organizations/{organizationName}/repositories/{repositoryName}/labels/{id}", "tags": [ "organizations" ] }, "delete": { "description": "Delete a label by id.", "operationId": "deleteorganizationsorganizationnamerepositoriesrepositorynamelabelsid", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "DELETE /organizations/{organizationName}/repositories/{repositoryName}/labels/{id}", "tags": [ "organizations" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/labels/{id}/permissions": { "parameters": [ { "description": "Path parameter id", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get permissions for a label.", "operationId": "getorganizationsorganizationnamerepositoriesrepositorynamelabelsidpermissions", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "GET /organizations/{organizationName}/repositories/{repositoryName}/labels/{id}/permissions", "tags": [ "organizations" ] }, "put": { "description": "Replace permissions for a label.", "operationId": "putorganizationsorganizationnamerepositoriesrepositorynamelabelsidpermissions", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "PUT /organizations/{organizationName}/repositories/{repositoryName}/labels/{id}/permissions", "tags": [ "organizations" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/labels/{labelName}/items": { "parameters": [ { "description": "Path parameter labelName", "in": "path", "name": "labelName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "List items included in a label (root path).", "operationId": "getorganizationsorganizationnamerepositoriesrepositorynamelabelslabelnameitems", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "GET /organizations/{organizationName}/repositories/{repositoryName}/labels/{labelName}/items", "tags": [ "organizations" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/labels/{labelName}/items/{path}": { "parameters": [ { "description": "Path parameter labelName", "in": "path", "name": "labelName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter path", "in": "path", "name": "path", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get items from a label", "operationId": "getLabelItems", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "labelName", "required": true, "schema": { "type": "string" } }, { "description": "Optional parameter for the item path", "in": "path", "name": "path", "required": true, "schema": { "default": "/" } }, { "in": "query", "name": "limit", "required": false, "schema": { "format": "integer", "minimum": 0, "type": "number" } }, { "description": "Optional search string. Can be repeated to search for multiple strings. Only available on endpoints with multi-search support.", "explode": true, "in": "query", "name": "search", "required": false, "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "in": "query", "name": "order", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, { "in": "query", "name": "offset", "required": false, "schema": { "format": "integer", "minimum": 0, "type": "number" } }, { "in": "query", "name": "orderBy", "required": false, "schema": { "enum": [ "revision", "item", "date", "type", "name" ], "type": "string" } }, { "in": "query", "name": "multiSearch", "required": false, "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "idType", "required": false, "schema": { "default": "unknown", "enum": [ "name", "id", "unknown" ], "type": "string" } }, { "in": "query", "name": "childrenOffset", "required": false, "schema": { "format": "integer", "type": "number" } }, { "in": "query", "name": "childrenLimit", "required": false, "schema": { "format": "integer", "type": "number" } }, { "description": "Comma-separated list of fields to include in the response", "explode": false, "in": "query", "name": "includeFields", "required": false, "schema": { "items": { "enum": [ "locks" ] }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "properties": { "branch": { "type": "string" }, "branchId": { "type": "number" }, "changeset": { "type": "number" }, "children": { "items": { "$ref": "#/components/schemas/RestItemChild" }, "type": "array" }, "comment": { "type": "string" }, "contentType": { "type": "string" }, "date": { "format": "date-time", "type": "string" }, "item": { "type": "string" }, "lock": { "properties": { "date": { "format": "date-time", "type": "string" }, "destinationBranchId": { "type": "number" }, "destinationBranchName": { "type": "string" }, "holderBranchId": { "type": "number" }, "holderBranchName": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "owner": { "type": "string" }, "status": { "enum": [ "Retained", "Locked" ], "type": "string" } }, "type": "object" }, "owner": { "type": "string" }, "path": { "type": "string" }, "rawUrl": { "type": "string" }, "repository": { "type": "string" }, "revision": { "type": "number" }, "size": { "type": "number" }, "type": { "type": "string" }, "xLink": { "$ref": "#/components/schemas/RestXLink" } }, "required": [ "path", "revision", "item", "size", "branch", "branchId", "changeset", "comment", "owner", "date", "repository", "type", "contentType", "children" ], "type": "object" }, { "allOf": [ { "properties": { "limit": { "type": "number" }, "offset": { "type": "number" }, "results": { "items": { "type": "string" }, "type": "array" }, "total": { "type": "number" } }, "required": [ "total", "offset", "limit", "results" ], "type": "object" }, { "properties": { "results": { "items": { "properties": { "branch": { "type": "string" }, "branchId": { "type": "number" }, "changeset": { "type": "number" }, "children": { "items": { "$ref": "#/components/schemas/RestItemChild" }, "type": "array" }, "comment": { "type": "string" }, "contentType": { "type": "string" }, "date": { "format": "date-time", "type": "string" }, "item": { "type": "string" }, "lock": { "properties": { "date": { "format": "date-time", "type": "string" }, "destinationBranchId": { "type": "number" }, "destinationBranchName": { "type": "string" }, "holderBranchId": { "type": "number" }, "holderBranchName": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "owner": { "type": "string" }, "status": { "enum": [ "Retained", "Locked" ], "type": "string" } }, "type": "object" }, "owner": { "type": "string" }, "path": { "type": "string" }, "rawUrl": { "type": "string" }, "repository": { "type": "string" }, "revision": { "type": "number" }, "size": { "type": "number" }, "type": { "type": "string" }, "xLink": { "$ref": "#/components/schemas/RestXLink" } }, "required": [ "path", "revision", "item", "size", "branch", "branchId", "changeset", "comment", "owner", "date", "repository", "type", "contentType", "children" ], "type": "object" }, "type": "array" } } } ] } ], "type": "object" } } }, "description": "It is paginated if there are several results, otherwise it is a single result" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get items from a label", "tags": [ "label" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/lock-rule": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "put": { "description": "Change or create a repository lock rule", "operationId": "putLockRule", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "excludedBranches": { "items": { "type": "string" }, "type": "array" }, "fileExtensions": { "format": "rule1, rule2", "type": "string" }, "targetBranch": { "type": "string" }, "targetBranches": { "items": { "type": "string" }, "type": "array" } }, "required": [ "fileExtensions" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "excludedBranches": { "items": { "type": "string" }, "type": "array" }, "fileExtensions": { "type": "string" }, "repositoryName": { "type": "string" }, "targetBranch": { "type": "string" }, "targetBranches": { "items": { "type": "string" }, "type": "array" } }, "required": [ "fileExtensions", "repositoryName" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Change or create a repository lock rule", "tags": [ "lock rule" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/locks": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get all lock rules", "operationId": "getAllLocks", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filterStartDate", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "filterEndDate", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "filterOwners", "schema": { "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "filterBranchIds", "schema": { "items": { "type": "number" }, "type": "array" } }, { "in": "query", "name": "orderBy", "schema": { "enum": [ "name", "date" ], "type": "string" } }, { "in": "query", "name": "offset", "schema": { "type": "number" } }, { "in": "query", "name": "limit", "schema": { "minimum": 0, "type": "number" } }, { "in": "query", "name": "search", "schema": { "type": "string" } }, { "in": "query", "name": "order", "schema": { "enum": [ "asc", "desc" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "properties": { "date": { "format": "date-time", "type": "string" }, "destinationBranchId": { "type": "number" }, "destinationBranchName": { "type": "string" }, "holderBranchId": { "type": "number" }, "holderBranchName": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "owner": { "type": "string" }, "status": { "enum": [ "Retained", "Locked" ], "type": "string" } }, "type": "object" }, "type": "array" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get all lock rules", "tags": [ "lock" ] }, "delete": { "description": "Delete several locks", "operationId": "deleteLocks", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "ids": { "items": { "type": "string" }, "type": "array" } }, "required": [ "ids" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "207": { "content": { "application/json": { "schema": { "properties": { "failures": { "items": { "$ref": "#/components/schemas/RestFailure" }, "type": "array" } }, "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Delete several locks", "tags": [ "lock" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/merge": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "post": { "description": "Perform a merge", "operationId": "merge", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "comment": { "type": "string" }, "destination": { "type": "string" }, "source": { "type": "object" }, "sourceType": { "default": "branch", "enum": [ "branch", "changeset", "label", "shelve" ], "type": "string" } }, "required": [ "sourceType", "source", "destination" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "201": { "content": { "application/json": { "schema": { "properties": { "changesetId": { "type": "number" }, "message": { "type": "string" }, "status": { "enum": [ "OK", "AncestorNotFound", "MergeNotNeeded", "Conflicts", "DestinationChanges", "Error", "MultipleHeads" ], "type": "string" } }, "required": [ "message", "changesetId", "status" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Perform a merge", "tags": [ "merge" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/merge-allowed": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get if a merge is allowed", "operationId": "mergeAllowed", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "sourceBranchName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "destinationBranchName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "result": { "enum": [ "Ok", "NotInitializedCorrectly", "NoMatch", "NotFromChildren", "NotFromParent", "NotReviewed" ], "type": "string" } }, "required": [ "result" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get if a merge is allowed", "tags": [ "merge" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/merge-bots": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "There is no pagination", "operationId": "getMergeBots", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "results": { "items": { "properties": { "configuration": { "oneOf": [ { "properties": { "branchPrefix": { "type": "string" }, "ciGroup": { "description": "This is bot type specific data. See with plastic what to fill", "type": "object" } }, "required": [ "branchPrefix", "ciGroup" ] }, { "properties": { "ciGroup": { "description": "This is bot type specific data. See with plastic what to fill", "type": "object" }, "originBranch": { "description": "This is the destination branch", "type": "string" } }, "required": [ "originBranch", "ciGroup" ] } ], "required": [ "type", "ciGroup", "configuration" ], "type": "object" }, "description": { "type": "string" }, "name": { "type": "string" }, "started": { "type": "boolean" }, "type": { "type": "string" } }, "required": [ "name", "description", "type", "started", "configuration" ], "type": "object" }, "type": "array" } }, "required": [ "results" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get merge bots", "tags": [ "merge-bot" ] }, "post": { "description": "This merge bot will be specific for the repository", "operationId": "postMergeBot", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "configuration": { "oneOf": [ { "properties": { "branchPrefix": { "type": "string" }, "ciGroup": { "description": "This is bot type specific data. See with plastic what to fill", "type": "object" } }, "required": [ "branchPrefix", "ciGroup" ] }, { "properties": { "ciGroup": { "description": "This is bot type specific data. See with plastic what to fill", "type": "object" }, "originBranch": { "description": "This is the destination branch", "type": "string" } }, "required": [ "originBranch", "ciGroup" ] } ], "type": "object" }, "description": { "type": "string" }, "name": { "type": "string" }, "type": { "enum": [ "trunk-bot", "conflict-bot" ], "type": "string" } }, "required": [ "name", "description", "type", "configuration" ], "type": "object" } } } }, "responses": { "200": { "description": "OK" }, "201": { "content": { "application/json": { "schema": { "properties": { "configuration": { "oneOf": [ { "properties": { "branchPrefix": { "type": "string" }, "ciGroup": { "description": "This is bot type specific data. See with plastic what to fill", "type": "object" } }, "required": [ "branchPrefix", "ciGroup" ] }, { "properties": { "ciGroup": { "description": "This is bot type specific data. See with plastic what to fill", "type": "object" }, "originBranch": { "description": "This is the destination branch", "type": "string" } }, "required": [ "originBranch", "ciGroup" ] } ], "required": [ "type", "ciGroup", "configuration" ], "type": "object" }, "description": { "type": "string" }, "name": { "type": "string" }, "started": { "type": "boolean" }, "type": { "type": "string" } }, "required": [ "name", "description", "type", "started", "configuration" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Create a merge bot", "tags": [ "merge-bot" ] }, "delete": { "description": "Delete merge bots", "operationId": "deleteMergeBots", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "mergeBotNames": { "items": { "type": "string" }, "type": "array" } }, "required": [ "mergeBotNames" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "204": { "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Delete merge bots", "tags": [ "merge-bot" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/merge-bots/{mergeBotName}": { "parameters": [ { "description": "Path parameter mergeBotName", "in": "path", "name": "mergeBotName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get a merge bot", "operationId": "getMergeBot", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "mergeBotName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "configuration": { "oneOf": [ { "properties": { "branchPrefix": { "type": "string" }, "ciGroup": { "description": "This is bot type specific data. See with plastic what to fill", "type": "object" } }, "required": [ "branchPrefix", "ciGroup" ] }, { "properties": { "ciGroup": { "description": "This is bot type specific data. See with plastic what to fill", "type": "object" }, "originBranch": { "description": "This is the destination branch", "type": "string" } }, "required": [ "originBranch", "ciGroup" ] } ], "required": [ "type", "ciGroup", "configuration" ], "type": "object" }, "description": { "type": "string" }, "name": { "type": "string" }, "started": { "type": "boolean" }, "type": { "type": "string" } }, "required": [ "name", "description", "type", "started", "configuration" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get a merge bot", "tags": [ "merge-bot" ] }, "patch": { "description": "Change a merge bot", "operationId": "changeMergeBot", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "mergeBotName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "configuration": { "oneOf": [ { "properties": { "branchPrefix": { "type": "string" }, "ciGroup": { "description": "This is bot type specific data. See with plastic what to fill", "type": "object" } } }, { "properties": { "ciGroup": { "description": "This is bot type specific data. See with plastic what to fill", "type": "object" }, "originBranch": { "description": "This is the destination branch", "type": "string" } } } ], "type": "object" }, "description": { "type": "string" }, "name": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "configuration": { "oneOf": [ { "properties": { "branchPrefix": { "type": "string" }, "ciGroup": { "description": "This is bot type specific data. See with plastic what to fill", "type": "object" } }, "required": [ "branchPrefix", "ciGroup" ] }, { "properties": { "ciGroup": { "description": "This is bot type specific data. See with plastic what to fill", "type": "object" }, "originBranch": { "description": "This is the destination branch", "type": "string" } }, "required": [ "originBranch", "ciGroup" ] } ], "required": [ "type", "ciGroup", "configuration" ], "type": "object" }, "description": { "type": "string" }, "name": { "type": "string" }, "started": { "type": "boolean" }, "type": { "type": "string" } }, "required": [ "name", "description", "type", "started", "configuration" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Change a merge bot", "tags": [ "merge-bot" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/merge-bots/{mergeBotName}/started": { "parameters": [ { "description": "Path parameter mergeBotName", "in": "path", "name": "mergeBotName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "put": { "description": "Start or stop a merge bot", "operationId": "putStartedMergeBot", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "mergeBotName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "started": { "type": "boolean" } }, "required": [ "started" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "204": { "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Start or stop a merge bot", "tags": [ "merge-bot" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/merge-bots/plugs": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get merge bot plugs", "operationId": "getMergeBotPlugs", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "results": { "items": { "properties": { "configuration": { "description": "This part depends on the plug config selected", "type": "object" }, "name": { "type": "string" }, "plugDefinitionName": { "type": "string" }, "plugDefinitionType": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get merge bot plugs", "tags": [ "merge-bot" ] }, "post": { "description": "Create merge bot plug", "operationId": "createMergeBotPlug", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "configuration": { "description": "This part depends on the plug config selected. There is no check done.", "type": "object" }, "name": { "type": "string" }, "plugDefinitionName": { "type": "string" }, "plugDefinitionType": { "type": "string" } }, "required": [ "name", "plugDefinitionName", "plugDefinitionType", "configuration" ], "type": "object" } } } }, "responses": { "200": { "description": "OK" }, "201": { "content": { "application/json": { "schema": { "properties": { "configuration": { "description": "This part depends on the plug config selected", "type": "object" }, "name": { "type": "string" }, "plugDefinitionName": { "type": "string" }, "plugDefinitionType": { "type": "string" } }, "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Create merge bot plug", "tags": [ "merge-bot" ] }, "delete": { "description": "Delete merge bot plugs", "operationId": "deleteMergeBotPlugs", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "names": { "items": { "type": "string" }, "type": "array" } }, "required": [ "names" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "207": { "content": { "application/json": { "schema": { "properties": { "failures": { "items": { "$ref": "#/components/schemas/RestFailure" }, "type": "array" } }, "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Delete merge bot plugs", "tags": [ "merge-bot" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/merge-bots/plugs/{name}": { "parameters": [ { "description": "Path parameter name", "in": "path", "name": "name", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get merge bot plug configuration by name.", "operationId": "getorganizationsorganizationnamerepositoriesrepositorynamemergebotsplugsname", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "GET /organizations/{organizationName}/repositories/{repositoryName}/merge-bots/plugs/{name}", "tags": [ "organizations" ] }, "put": { "description": "Update merge bot plug configuration by name.", "operationId": "putorganizationsorganizationnamerepositoriesrepositorynamemergebotsplugsname", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "PUT /organizations/{organizationName}/repositories/{repositoryName}/merge-bots/plugs/{name}", "tags": [ "organizations" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/merge-bots/reports": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get merge bots reports", "operationId": "getMergeBotsReports", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "mergeBotsNames", "required": true, "schema": { "format": "name1,name2,name3", "type": "string" } }, { "in": "query", "name": "date", "schema": { "format": "date-time", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "results": { "items": { "properties": { "date": { "format": "date-time", "type": "string" }, "mergeBotName": { "type": "string" }, "properties": { "items": { "properties": { "type": { "type": "string" }, "value": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "type": "array" }, "repositoryName": { "type": "string" } }, "required": [ "mergeBotName", "repositoryName", "properties" ], "type": "object" }, "type": "array" } }, "required": [ "results" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get merge bots reports", "tags": [ "merge-bot" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/merge-bots/reports/latest": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get the latest merge bot reports for the repository.", "operationId": "getorganizationsorganizationnamerepositoriesrepositorynamemergebotsreportslatest", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "GET /organizations/{organizationName}/repositories/{repositoryName}/merge-bots/reports/latest", "tags": [ "organizations" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/merge-report": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "post": { "description": "Produce a merge report", "operationId": "mergeReport", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "comment": { "type": "string" }, "destination": { "type": "string" }, "source": { "type": "object" }, "sourceType": { "default": "branch", "enum": [ "branch", "changeset", "label", "shelve" ], "type": "string" } }, "required": [ "sourceType", "source", "destination" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "201": { "content": { "application/json": { "schema": { "properties": { "conflictsThatCannotBeSolved": { "type": "boolean" }, "mergeAllowed": { "type": "boolean" }, "mergeIssues": { "type": "string" }, "result": { "properties": { "changes": { "items": { "$ref": "#/components/schemas/RestMergeDifference" }, "type": "array" }, "directoryConflicts": { "items": { "$ref": "#/components/schemas/RestFileConflict" }, "type": "array" }, "fileConflicts": { "items": { "$ref": "#/components/schemas/RestFileConflict" }, "type": "array" }, "resultStatus": { "type": "string" } }, "required": [ "resultStatus", "changes", "directoryConflicts", "fileConflicts" ], "type": "object" } }, "required": [ "conflictsThatCannotBeSolved", "result", "mergeAllowed" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Produce a merge report", "tags": [ "merge" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/notifications": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "List repository notifications.", "operationId": "getorganizationsorganizationnamerepositoriesrepositorynamenotifications", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "GET /organizations/{organizationName}/repositories/{repositoryName}/notifications", "tags": [ "organizations" ] }, "post": { "description": "Create or register a repository notification.", "operationId": "postorganizationsorganizationnamerepositoriesrepositorynamenotifications", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "POST /organizations/{organizationName}/repositories/{repositoryName}/notifications", "tags": [ "organizations" ] }, "delete": { "description": "Clear or dismiss repository notifications.", "operationId": "deleteorganizationsorganizationnamerepositoriesrepositorynamenotifications", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "DELETE /organizations/{organizationName}/repositories/{repositoryName}/notifications", "tags": [ "organizations" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/permissions": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get a repository permissions", "operationId": "getRepositoryPermissions", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "endUserType", "schema": { "enum": [ "user", "user_group" ], "type": "string" } }, { "in": "query", "name": "endUserName", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "permissions": { "items": { "$ref": "#/components/schemas/RestGetEndUserPermissions" }, "type": "array" } }, "required": [ "permissions" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get a repository permissions", "tags": [ "repository", "permission" ] }, "patch": { "description": "Patch a repository permissions", "operationId": "setRepositoryPermissions", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "endUsersPermissions": { "items": { "$ref": "#/components/schemas/RestSetEndUserPermissions" }, "type": "array" } }, "required": [ "endUsersPermissions" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "204": { "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Patch a repository permissions", "tags": [ "repository", "permission" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/revisions/{revisionId}": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter revisionId", "in": "path", "name": "revisionId", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get a revision", "operationId": "getRevision", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "revisionId", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "branch": { "type": "string" }, "changesetId": { "type": "number" }, "comment": { "type": "string" }, "date": { "format": "date-time", "type": "string" }, "itemPath": { "type": "string" }, "owner": { "type": "string" }, "repositoryName": { "type": "string" }, "revisionId": { "type": "number" }, "size": { "type": "number" }, "type": { "type": "string" } }, "required": [ "revisionId", "itemPath", "size", "branch", "changesetId", "comment", "owner", "date", "repositoryName", "type" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get a revision", "tags": [ "revision" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/revisions/{revisionId}/{format}": { "parameters": [ { "description": "Path parameter format", "in": "path", "name": "format", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter revisionId", "in": "path", "name": "revisionId", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get the content of a revision", "operationId": "getRevisionContent", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "revisionId", "required": true, "schema": { "minimum": 0, "type": "number" } }, { "in": "path", "name": "format", "required": true, "schema": { "description": "raw gives you the file content, whatever the file type. data gives you metadata if it is a binary or the content if it is a text file", "enum": [ "raw", "data" ], "type": "string" } }, { "in": "header", "name": "x-encryption-token", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get the content of a revision", "tags": [ "revision" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/revisions/{revisionId}/{format}/url": { "parameters": [ { "description": "Path parameter format", "in": "path", "name": "format", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter revisionId", "in": "path", "name": "revisionId", "required": true, "schema": { "type": "string" } } ], "get": { "description": "This returned url can directly be used without other authentication", "operationId": "getRevisionRawUrl", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "revisionId", "required": true, "schema": { "minimum": 0, "type": "number" } }, { "in": "path", "name": "format", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "x-encryption-token", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "url": { "type": "string" } }, "required": [ "url" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get short-lived url that points to revision content", "tags": [ "revision" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/revisions/{revisionId}/annotations": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter revisionId", "in": "path", "name": "revisionId", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get revision annotations", "operationId": "getAnnotations", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "revisionId", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "properties": { "branchName": { "type": "string" }, "changesetId": { "type": "number" }, "comment": { "type": "string" }, "date": { "format": "date-time", "type": "string" }, "line": { "type": "number" }, "owner": { "type": "string" }, "parentRevisionId": { "type": "number" }, "revisionId": { "type": "number" } }, "required": [ "branchName", "changesetId", "comment", "date", "line", "owner", "parentRevisionId", "revisionId" ], "type": "object" }, "type": "array" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get revision annotations", "tags": [ "annotation" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/revisions/data": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Gives you metadata if it is a binary or the content if it is a text file", "operationId": "getRevisionsContentData", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "revisionId", "required": true, "schema": { "default": [], "items": { "type": "number" }, "minimum": 0, "type": "array" } }, { "in": "header", "name": "x-encryption-token", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get data content revisions", "tags": [ "revision" ] }, "post": { "description": "Gives you metadata if it is a binary or the content if it is a text file. This endpoint has a body to avoid the url size limit", "operationId": "postRevisionsContentData", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "x-encryption-token", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "encryptionToken": { "type": "string" }, "revision": { "items": { "properties": { "name": { "type": "string" }, "revisionId": { "type": "number" } }, "required": [ "revisionId", "name" ], "type": "object" }, "type": "array" }, "revisionIds": { "default": [], "items": { "minimum": 0, "type": "number" }, "type": "array" } }, "required": [ "revisionIds" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get data content revisions", "tags": [ "revision" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/revisions/data/url": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get signed URLs for data (non-raw) revision content via query parameters.", "operationId": "getorganizationsorganizationnamerepositoriesrepositorynamerevisionsdataurl", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "GET /organizations/{organizationName}/repositories/{repositoryName}/revisions/data/url", "tags": [ "organizations" ] }, "post": { "description": "Obtain signed URLs for data revision content via request body.", "operationId": "postorganizationsorganizationnamerepositoriesrepositorynamerevisionsdataurl", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "POST /organizations/{organizationName}/repositories/{repositoryName}/revisions/data/url", "tags": [ "organizations" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/revisions/raw": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Gives you the file content, whatever the file type", "operationId": "getRevisionsContent", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "revisionId", "required": true, "schema": { "default": [], "items": { "type": "number" }, "minimum": 0, "type": "array" } }, { "in": "header", "name": "x-encryption-token", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get raw content revisions", "tags": [ "revision" ] }, "post": { "description": "Gives you the file content, whatever the file type. This endpoint has a body to avoid the url size limit", "operationId": "postRevisionsContent", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "x-encryption-token", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "encryptionToken": { "type": "string" }, "revision": { "items": { "properties": { "name": { "type": "string" }, "revisionId": { "type": "number" } }, "required": [ "revisionId", "name" ], "type": "object" }, "type": "array" }, "revisionIds": { "default": [], "items": { "minimum": 0, "type": "number" }, "type": "array" } }, "required": [ "revisionIds" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get raw content revisions", "tags": [ "revision" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/revisions/raw/url": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get signed URLs for raw revision content via query parameters.", "operationId": "getorganizationsorganizationnamerepositoriesrepositorynamerevisionsrawurl", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "GET /organizations/{organizationName}/repositories/{repositoryName}/revisions/raw/url", "tags": [ "organizations" ] }, "post": { "description": "Obtain signed URLs for raw revision content via request body.", "operationId": "postorganizationsorganizationnamerepositoriesrepositorynamerevisionsrawurl", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "POST /organizations/{organizationName}/repositories/{repositoryName}/revisions/raw/url", "tags": [ "organizations" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/subscriptions": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get the user subscription for notifications from repository", "operationId": "NotificationSubscriptionsController_getRepositorySubscription", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "type": { "items": { "enum": [ "reviews", "all", "none" ], "type": "string" }, "type": "array" } }, "required": [ "type" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "GET /organizations/{organizationName}/repositories/{repositoryName}/subscriptions", "tags": [ "notifications" ] }, "patch": { "description": "Update the user subscription for notifications from repository", "operationId": "NotificationSubscriptionsController_updateRepositorySubscription", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "types": { "items": { "enum": [ "reviews", "all", "none" ], "type": "string" }, "type": "array" } }, "required": [ "types" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "type": { "items": { "enum": [ "reviews", "all", "none" ], "type": "string" }, "type": "array" } }, "required": [ "type" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "PATCH /organizations/{organizationName}/repositories/{repositoryName}/subscriptions", "tags": [ "notifications" ] } }, "/organizations/{organizationName}/repositories/{repositoryName}/validate-name": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter repositoryName", "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Check if the name follows the repository name nomenclature", "operationId": "repositoryValidateName", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repositoryName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "error": { "type": "string" }, "isValid": { "type": "boolean" } }, "required": [ "isValid" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Validate if a name is correct", "tags": [ "repository" ] } }, "/organizations/{organizationName}/repositories/lock-rules": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get all rules for all repositories in the organization", "operationId": "getRepositoriesLockRules", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "format": "integer", "minimum": 0, "type": "number" } }, { "description": "Optional search string. Can be repeated to search for multiple strings. Only available on endpoints with multi-search support.", "explode": true, "in": "query", "name": "search", "required": false, "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "in": "query", "name": "order", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, { "in": "query", "name": "offset", "required": false, "schema": { "format": "integer", "minimum": 0, "type": "number" } }, { "in": "query", "name": "orderBy", "required": false, "schema": { "enum": [ "repositoryName" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "allOf": [ { "properties": { "limit": { "format": "integer", "minimum": 0, "type": "number" }, "offset": { "format": "integer", "minimum": 0, "type": "number" }, "total": { "format": "integer", "minimum": 0, "type": "number" } }, "required": [ "offset", "limit", "total" ], "type": "object" }, { "properties": { "results": { "items": { "properties": { "excludedBranches": { "items": { "type": "string" }, "type": "array" }, "fileExtensions": { "type": "string" }, "repositoryName": { "type": "string" }, "targetBranch": { "type": "string" }, "targetBranches": { "items": { "type": "string" }, "type": "array" } }, "required": [ "fileExtensions", "repositoryName" ], "type": "object" }, "type": "array" } } } ], "title": "RepositoryLockRuleDtoPageDto" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get repositories lock rules", "tags": [ "lock rule" ] }, "post": { "description": "Create or update a lock rule for a repository. If the lock rule exists, the POST we replace it", "operationId": "postLockRule", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "excludedBranches": { "items": { "type": "string" }, "type": "array" }, "fileExtensions": { "format": "rule1, rule2", "type": "string" }, "repositoryName": { "type": "string" }, "targetBranch": { "type": "string" }, "targetBranches": { "items": { "type": "string" }, "type": "array" } }, "required": [ "fileExtensions", "repositoryName" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "201": { "content": { "application/json": { "schema": { "properties": { "excludedBranches": { "items": { "type": "string" }, "type": "array" }, "fileExtensions": { "type": "string" }, "repositoryName": { "type": "string" }, "targetBranch": { "type": "string" }, "targetBranches": { "items": { "type": "string" }, "type": "array" } }, "required": [ "fileExtensions", "repositoryName" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Create or update a repository lock rule", "tags": [ "lock rule" ] }, "delete": { "description": "Each repository has only one lock rule. Give the name of the repository is enough to delete it s lock rule", "operationId": "deleteLockRules", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "repositoriesNames": { "items": { "type": "string" }, "type": "array" } }, "required": [ "repositoriesNames" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "207": { "content": { "application/json": { "schema": { "properties": { "failures": { "items": { "$ref": "#/components/schemas/RestFailure" }, "type": "array" } }, "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Delete repositories lock rules", "tags": [ "lock rule" ] } }, "/organizations/{organizationName}/storage": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get organization storage", "operationId": "getOrganizationStorage", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "rawStorageMax": { "format": "integer", "type": "number" }, "rawStorageUsed": { "format": "integer", "type": "number" }, "repositories": { "items": { "$ref": "#/components/schemas/RepositoryStorageDto" }, "type": "array" }, "storageMax": { "type": "number" }, "storageUsed": { "type": "number" } }, "required": [ "storageUsed", "storageMax", "rawStorageUsed", "rawStorageMax", "repositories" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get organization storage", "tags": [ "organization" ] } }, "/organizations/{organizationName}/subscriptions": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get the user subscription for notifications from organization", "operationId": "NotificationSubscriptionsController_getOrganizationSubscription", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "type": { "items": { "enum": [ "reviews", "all", "none" ], "type": "string" }, "type": "array" } }, "required": [ "type" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "GET /organizations/{organizationName}/subscriptions", "tags": [ "notifications" ] }, "patch": { "description": "Update the user subscription for notifications from organization", "operationId": "NotificationSubscriptionsController_updateOrganizationSubscription", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "types": { "items": { "enum": [ "reviews", "all", "none" ], "type": "string" }, "type": "array" } }, "required": [ "types" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "type": { "items": { "enum": [ "reviews", "all", "none" ], "type": "string" }, "type": "array" } }, "required": [ "type" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "PATCH /organizations/{organizationName}/subscriptions", "tags": [ "notifications" ] } }, "/organizations/{organizationName}/user-groups": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "This is paginated", "operationId": "getUserGroups", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "orderBy", "schema": { "enum": [ "id", "name" ], "type": "string" } }, { "in": "query", "name": "filterUserIds", "schema": { "items": { "type": "number" }, "type": "array" } }, { "in": "query", "name": "offset", "schema": { "minimum": 0, "type": "number" } }, { "in": "query", "name": "limit", "schema": { "minimum": 0, "type": "number" } }, { "in": "query", "name": "search", "schema": { "type": "string" } }, { "in": "query", "name": "order", "schema": { "enum": [ "asc", "desc" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "allOf": [ { "properties": { "limit": { "type": "number" }, "offset": { "type": "number" }, "results": { "items": { "type": "string" }, "type": "array" }, "total": { "type": "number" } }, "required": [ "total", "offset", "limit", "results" ], "type": "object" }, { "properties": { "results": { "items": { "properties": { "description": { "type": "string" }, "id": { "type": "number" }, "name": { "type": "string" }, "userCount": { "type": "number" } }, "required": [ "id", "name", "description", "userCount" ], "type": "object" }, "type": "array" } } } ] } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get user groups", "tags": [ "user group" ] }, "post": { "description": "Create a user group", "operationId": "UserGroupsController_postUserGroups", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "description": { "type": "string" }, "name": { "pattern": "GROUP_INVALID_CHARACTERS", "type": "string" }, "permissions": { "items": { "properties": { "endUsersPermissions": { "items": { "$ref": "#/components/schemas/RestSetEndUserPermissions" }, "type": "array" } }, "required": [ "endUsersPermissions" ], "type": "object" }, "type": "array" } }, "required": [ "name", "description", "permissions" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "201": { "content": { "application/json": { "schema": { "properties": { "description": { "type": "string" }, "id": { "type": "number" }, "name": { "type": "string" }, "userCount": { "type": "number" } }, "required": [ "id", "name", "description", "userCount" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Create a user group", "tags": [ "user group" ] }, "patch": { "description": "Change a user group", "operationId": "patchUserGroups", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "userGroups": { "items": { "properties": { "id": { "type": "number" }, "users": { "properties": { "add": { "items": { "type": "string" }, "type": "array" }, "remove": { "items": { "type": "string" }, "type": "array" } }, "required": [ "add", "remove" ], "type": "object" } }, "required": [ "id", "users" ], "type": "object" }, "type": "array" } }, "required": [ "userGroups" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "204": { "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Change a user group", "tags": [ "user group" ] }, "delete": { "description": "Remove user groups", "operationId": "removeUserGroups", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "ids": { "items": { "type": "number" }, "type": "array" } }, "required": [ "ids" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "207": { "content": { "application/json": { "schema": { "properties": { "failures": { "items": { "type": "number" }, "type": "array" } }, "required": [ "failures" ], "type": "object" } } }, "description": "Returns the ids that have failed to be deleted" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Remove user groups", "tags": [ "user group" ] } }, "/organizations/{organizationName}/user-groups/{groupId}": { "parameters": [ { "description": "Path parameter groupId", "in": "path", "name": "groupId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get a user group", "operationId": "getUserGroup", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "groupId", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "description": { "type": "string" }, "id": { "type": "number" }, "name": { "type": "string" }, "userCount": { "type": "number" } }, "required": [ "id", "name", "description", "userCount" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get a user group", "tags": [ "user group" ] }, "patch": { "description": "Patch a user group", "operationId": "patchUserGroup", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "groupId", "required": true, "schema": { "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "description": { "type": "string" }, "name": { "pattern": "^[^<>*%:&\\\\\\\\?]*$", "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "204": { "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Patch a user group", "tags": [ "user group" ] }, "delete": { "description": "Delete a user group", "operationId": "deleteUserGroup", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "groupId", "required": true, "schema": { "type": "number" } } ], "responses": { "200": { "description": "OK" }, "204": { "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Delete a user group", "tags": [ "user group" ] } }, "/organizations/{organizationName}/user-groups/{groupId}/users": { "parameters": [ { "description": "Path parameter groupId", "in": "path", "name": "groupId", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get a paginated list of users in a user group by name.", "operationId": "getUserGroupUsers", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "The group ID", "in": "path", "name": "groupId", "required": true, "schema": { "format": "integer", "type": "number" } }, { "in": "query", "name": "limit", "required": false, "schema": { "format": "integer", "minimum": 0, "type": "number" } }, { "description": "Optional search string. Can be repeated to search for multiple strings. Only available on endpoints with multi-search support.", "explode": true, "in": "query", "name": "search", "required": false, "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "in": "query", "name": "order", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, { "in": "query", "name": "offset", "required": false, "schema": { "format": "integer", "minimum": 0, "type": "number" } }, { "in": "query", "name": "orderBy", "required": false, "schema": { "enum": [ "email", "isAdmin" ], "type": "string" } }, { "description": "Comma-separated list of fields to include in the response", "explode": false, "in": "query", "name": "includeFields", "required": false, "schema": { "items": { "enum": [ "unityUsers" ] }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "allOf": [ { "properties": { "limit": { "format": "integer", "minimum": 0, "type": "number" }, "offset": { "format": "integer", "minimum": 0, "type": "number" }, "total": { "format": "integer", "minimum": 0, "type": "number" } }, "required": [ "offset", "limit", "total" ], "type": "object" }, { "properties": { "results": { "items": { "properties": { "assignedAt": { "format": "date-time", "type": "string" }, "email": { "format": "email", "type": "string" }, "groups": { "items": { "$ref": "#/components/schemas/OrganizationUserGroupDto" }, "type": "array" }, "id": { "format": "integer", "type": "number" }, "isAdmin": { "type": "boolean" }, "isOwner": { "type": "boolean" }, "joinedOrganizationAt": { "format": "date-time", "type": "string" }, "permissions": { "items": { "properties": { "isEnabled": { "type": "boolean" }, "isOverride": { "type": "boolean" }, "name": { "type": "string" }, "valueInherited": { "type": "boolean" } }, "required": [ "name", "isOverride", "isEnabled" ], "type": "object" }, "type": "array" }, "source": { "enum": [ "DevOps", "PlasticScm", "UnityCloud", "OwnerSeat" ], "type": "string" }, "unityUser": { "properties": { "avatarUrl": { "format": "uri", "type": "string" }, "email": { "format": "email", "type": "string" }, "genesisId": { "format": "integer", "type": "string" }, "id": { "format": "uuid", "nullable": true, "type": "string" }, "name": { "nullable": true, "type": "string" } }, "required": [ "genesisId" ], "type": "object" } }, "required": [ "id", "email", "isAdmin" ], "type": "object" }, "type": "array" } } } ], "title": "OrganizationUserDtoPageDto" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get users in a user group", "tags": [ "user group" ] }, "post": { "description": "Add users to a user group by name.", "operationId": "postUserGroupUsers", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "The group ID", "in": "path", "name": "groupId", "required": true, "schema": { "format": "integer", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "emails": { "items": { "format": "email", "type": "string" }, "type": "array" } }, "required": [ "emails" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "204": { "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Add users to a user group", "tags": [ "user group" ] }, "delete": { "description": "Remove users from a user group by name.", "operationId": "deleteUserGroupUsers", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "description": "The group ID", "in": "path", "name": "groupId", "required": true, "schema": { "format": "integer", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "emails": { "items": { "format": "email", "type": "string" }, "type": "array" } }, "required": [ "emails" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "204": { "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Remove users from a user group", "tags": [ "user group" ] } }, "/organizations/{organizationName}/user-groups/names/available": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get if a user group name is available", "operationId": "geUserGroupsNameIsAvailable", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "isAvailable": { "type": "boolean" } }, "required": [ "isAvailable" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get if a user group name is available", "tags": [ "user group" ] } }, "/organizations/{organizationName}/users": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Paginated list of users in the organization.", "operationId": "getUsers", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "format": "integer", "minimum": 0, "type": "number" } }, { "description": "Optional search string. Can be repeated to search for multiple strings. Only available on endpoints with multi-search support.", "explode": true, "in": "query", "name": "search", "required": false, "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "in": "query", "name": "order", "required": false, "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, { "in": "query", "name": "offset", "required": false, "schema": { "format": "integer", "minimum": 0, "type": "number" } }, { "in": "query", "name": "orderBy", "required": false, "schema": { "enum": [ "email", "isAdmin" ], "type": "string" } }, { "description": "Comma-separated list of group names to filter by", "in": "query", "name": "filterGroupNames", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "filterRegistered", "required": false, "schema": { "type": "boolean" } }, { "description": "Comma-separated list of fields to include in the response", "explode": false, "in": "query", "name": "includeFields", "required": false, "schema": { "items": { "enum": [ "permissions", "unityUsers" ] }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "allOf": [ { "properties": { "limit": { "format": "integer", "minimum": 0, "type": "number" }, "offset": { "format": "integer", "minimum": 0, "type": "number" }, "total": { "format": "integer", "minimum": 0, "type": "number" } }, "required": [ "offset", "limit", "total" ], "type": "object" }, { "properties": { "results": { "items": { "properties": { "assignedAt": { "format": "date-time", "type": "string" }, "email": { "format": "email", "type": "string" }, "groups": { "items": { "$ref": "#/components/schemas/OrganizationUserGroupDto" }, "type": "array" }, "id": { "format": "integer", "type": "number" }, "isAdmin": { "type": "boolean" }, "isOwner": { "type": "boolean" }, "joinedOrganizationAt": { "format": "date-time", "type": "string" }, "permissions": { "items": { "properties": { "isEnabled": { "type": "boolean" }, "isOverride": { "type": "boolean" }, "name": { "type": "string" }, "valueInherited": { "type": "boolean" } }, "required": [ "name", "isOverride", "isEnabled" ], "type": "object" }, "type": "array" }, "source": { "enum": [ "DevOps", "PlasticScm", "UnityCloud", "OwnerSeat" ], "type": "string" }, "unityUser": { "properties": { "avatarUrl": { "format": "uri", "type": "string" }, "email": { "format": "email", "type": "string" }, "genesisId": { "format": "integer", "type": "string" }, "id": { "format": "uuid", "nullable": true, "type": "string" }, "name": { "nullable": true, "type": "string" } }, "required": [ "genesisId" ], "type": "object" } }, "required": [ "id", "email", "isAdmin" ], "type": "object" }, "type": "array" } } } ], "title": "OrganizationUserDtoPageDto" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Get users", "tags": [ "user" ] }, "delete": { "description": "Delete the provided users from the organization.", "operationId": "deleteUsers", "parameters": [ { "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "emails": { "items": { "format": "email", "type": "string" }, "type": "array" } }, "required": [ "emails" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "failures": { "items": { "format": "email", "type": "string" }, "type": "array" } }, "required": [ "failures" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "Delete users", "tags": [ "user" ] } }, "/organizations/{organizationName}/users/{id}": { "parameters": [ { "description": "Path parameter id", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get an organization user by id.", "operationId": "getorganizationsorganizationnameusersid", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "GET /organizations/{organizationName}/users/{id}", "tags": [ "organizations" ] }, "patch": { "description": "Update an organization user by id.", "operationId": "patchorganizationsorganizationnameusersid", "responses": { "200": { "description": "OK" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "PATCH /organizations/{organizationName}/users/{id}", "tags": [ "organizations" ] } }, "/at-unity-organizations/{organizationId}": { "parameters": [ { "description": "Genesis ID of the organization", "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get @unity organization by unity organization id", "operationId": "AtUnityOrganizationsController_getOrganization", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "canCreateRepository": { "type": "boolean" }, "creationDate": { "format": "date-time", "type": "string" }, "description": { "type": "string" }, "devOpsUnlimited": { "type": "boolean" }, "freeTierLimitReached": { "type": "boolean" }, "genesisOrganizationId": { "type": "string" }, "isEncrypted": { "type": "boolean" }, "isLinked": { "type": "boolean" }, "isUnityCloudBundle": { "type": "boolean" }, "name": { "type": "string" }, "ownerId": { "type": "number" }, "rawStorageMax": { "format": "integer", "type": "number" }, "rawStorageUsed": { "format": "integer", "type": "number" }, "regionDescription": { "type": "string" }, "regionName": { "type": "string" }, "regionUrl": { "format": "uri", "type": "string" }, "source": { "enum": [ "purchase", "uBazaar", "unityCollabMigration", "devOps", "ugo", "unknown" ], "type": "string" }, "storageMax": { "type": "number" }, "storageUsed": { "type": "number" }, "ugoLimitReached": { "type": "boolean" }, "unityOrganization": { "properties": { "genesisId": { "format": "integer", "type": "string" }, "id": { "format": "uuid", "nullable": true, "type": "string" }, "name": { "type": "string" } }, "required": [ "genesisId", "name" ], "type": "object" }, "userBelongsToOrganization": { "type": "boolean" }, "userCount": { "type": "number" } }, "required": [ "regionUrl", "creationDate", "source", "name", "description", "isEncrypted", "ownerId", "regionName", "regionDescription", "userCount", "isLinked" ], "type": "object" } } }, "description": "" }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "GET /at-unity-organizations/{organizationId}", "tags": [ "organization" ] } }, "/organizations/{organizationName}/invitations": { "parameters": [ { "description": "Path parameter organizationName", "in": "path", "name": "organizationName", "required": true, "schema": { "type": "string" } } ], "post": { "description": "Send invitations to join the organization. Duplicate emails are deduplicated.", "operationId": "postorganizationsnameinvitations", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "emails", "adminPermissions" ], "properties": { "emails": { "type": "array", "minItems": 1, "items": { "type": "string", "format": "email" } }, "adminPermissions": { "type": "boolean", "description": "Grant admin permissions to the invited users." } } } } } }, "responses": { "201": { "description": "Invitations sent. No response body." }, "4XX": { "description": "Request rejected. The failure body names the specific error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFailures" } } } } }, "summary": "POST /organizations/{organizationName}/invitations", "tags": [ "organizations" ] } } }, "tags": [ { "description": "Version control operations for Unity Build Automation projects (UVCS and GitHub).", "name": "vcs" }, { "description": "Activity operations.", "name": "activity" }, { "description": "Annotation operations.", "name": "annotation" }, { "description": "Attribute operations.", "name": "attribute" }, { "description": "Branch operations.", "name": "branch" }, { "description": "Changeset operations.", "name": "changeset" }, { "description": "Code review operations.", "name": "code review" }, { "description": "Integration operations.", "name": "integration" }, { "description": "Label operations.", "name": "label" }, { "description": "Lock operations.", "name": "lock" }, { "description": "Lock rule operations.", "name": "lock rule" }, { "description": "Merge operations.", "name": "merge" }, { "description": "Merge rule operations.", "name": "merge rule" }, { "description": "Merge-bot operations.", "name": "merge-bot" }, { "description": "Network permission operations.", "name": "network permission" }, { "description": "Notifications operations.", "name": "notifications" }, { "description": "Organization operations.", "name": "organization" }, { "description": "Organizations operations.", "name": "organizations" }, { "description": "Permission operations.", "name": "permission" }, { "description": "Repository operations.", "name": "repository" }, { "description": "Revision operations.", "name": "revision" }, { "description": "User operations.", "name": "user" }, { "description": "User group operations.", "name": "user group" } ], "components": { "schemas": { "RestFailure": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "number", "format": "integer" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ] }, "RestFailures": { "type": "object", "properties": { "failures": { "type": "array", "items": { "$ref": "#/components/schemas/RestFailure" } } } }, "RestActivitySeriesItem": { "type": "object", "properties": { "date": { "format": "date-time", "type": "string" }, "value": { "type": "number" } }, "required": [ "date", "value" ] }, "RestActivityItem": { "type": "object", "properties": { "dataset": { "type": "array", "items": { "$ref": "#/components/schemas/RestActivitySeriesItem" } }, "trend": { "type": "number" }, "average": { "type": "number" } }, "required": [ "dataset", "trend", "average" ] }, "CodeReviewCommentDto": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "Comment", "Change", "Question", "Conversation", "Timeline", "Script", "Discarded", "Description", "StatusUnderReview", "StatusReworkRequired", "StatusReviewed" ] }, "id": { "type": "number" }, "uuid": { "type": "string", "format": "uuid" }, "owner": { "type": "string", "format": "email" }, "timestamp": { "type": "string", "format": "date-time", "deprecated": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "itemId": { "type": "integer" }, "itemPath": { "type": "string" }, "revisionId": { "type": "integer" }, "locationSpec": { "type": "string" }, "commentText": { "type": "string" }, "reviewId": { "type": "integer" }, "parentCommentId": { "type": "integer" }, "changesetId": { "type": "integer" }, "appliedInChangesetId": { "type": "integer" }, "branchChangesetId": { "type": "integer" } }, "required": [ "type", "id", "uuid", "owner", "timestamp", "createdAt", "updatedAt", "itemId", "itemPath", "revisionId", "commentText", "reviewId", "parentCommentId", "changesetId", "appliedInChangesetId", "branchChangesetId" ] }, "MergeDto": { "type": "object", "properties": { "sourceChangesetId": { "type": "number" }, "sourceBranchId": { "type": "number" }, "sourceBranchName": { "type": "string" }, "destinationChangesetId": { "type": "number" }, "destinationBranchId": { "type": "number" }, "destinationBranchName": { "type": "string" }, "destinationIsMain": { "type": "boolean" }, "mergeDate": { "type": "string", "format": "date-time" }, "author": { "type": "string" }, "comment": { "type": "string" } }, "required": [ "sourceChangesetId", "sourceBranchId", "sourceBranchName", "destinationChangesetId", "destinationBranchId", "destinationBranchName", "destinationIsMain", "mergeDate", "author", "comment" ] }, "CodeReviewObjectDto": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "branch", "changeset", "revision", "item" ] }, "spec": { "type": "string" }, "id": { "type": "number", "format": "integer" } }, "required": [ "type", "spec", "id" ] }, "ReviewerWithStatusDto": { "type": "object", "properties": { "name": { "type": "string", "format": "email" }, "isGroup": { "type": "boolean" }, "status": { "type": "string", "enum": [ "under-review", "reviewed", "rework-required" ] } }, "required": [ "name", "isGroup", "status" ] }, "RestGetIntegrationError": { "type": "object", "properties": { "message": { "type": "string" }, "status": { "type": "string" } }, "required": [ "message", "status" ] }, "RestGetMergeRuleAttribute": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ] }, "RestGetMergeRuleMatcher": { "type": "object", "properties": { "branchesNamesPattern": { "type": "array", "items": { "type": "string" } }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/RestGetMergeRuleAttribute" } } }, "required": [ "branchesNamesPattern", "attributes" ] }, "PermissionDto": { "type": "object", "properties": { "name": { "type": "string" }, "isOverride": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "valueInherited": { "type": "boolean" } }, "required": [ "name", "isOverride", "isEnabled" ] }, "EndUserPermissionsDto": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "user", "user_group" ] }, "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionDto" } } }, "required": [ "name", "type", "permissions" ] }, "RestSetPermission": { "type": "object", "properties": { "name": { "type": "string" }, "isOverride": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "valueInherited": { "type": "boolean" } }, "required": [ "name", "isOverride", "isEnabled" ] }, "RestSetEndUserPermissions": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "user", "user_group" ] }, "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/RestSetPermission" } } }, "required": [ "name", "type", "permissions" ] }, "OrganizationUserGroupDto": { "type": "object", "properties": { "id": { "type": "number", "format": "integer" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "UnityUserDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "nullable": true }, "genesisId": { "type": "string", "format": "integer" }, "name": { "type": "string", "nullable": true }, "email": { "type": "string", "format": "email" }, "avatarUrl": { "type": "string", "format": "uri" } }, "required": [ "genesisId" ] }, "WorkspaceShareDto": { "type": "object", "properties": { "name": { "type": "string" }, "user": { "type": "string" }, "unityUser": { "$ref": "#/components/schemas/UnityUserDto" } }, "required": [ "name", "user" ] }, "WorkspaceUvcsConnectionTargetDto": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "branch", "changeset", "label", "shelve" ] }, "server": { "type": "string" }, "repositoryId": { "type": "string", "format": "uuid" }, "repositoryName": { "type": "string" }, "id": { "type": "number", "format": "integer" }, "spec": { "type": "string" } }, "required": [ "type", "server", "repositoryId", "repositoryName", "id", "spec" ] }, "WorkspaceUvcsConnectionDto": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "isPartial": { "type": "boolean" }, "target": { "$ref": "#/components/schemas/WorkspaceUvcsConnectionTargetDto" } }, "required": [ "id", "name", "path", "isPartial", "target" ] }, "RestPutAttributeValueBody": { "type": "object", "properties": { "value": { "type": "string" } }, "required": [ "value" ] }, "RestAttributeTarget": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "integer" }, "type": { "type": "string", "enum": [ "branch", "label", "changeset" ] } }, "required": [ "name", "id", "type" ] }, "RestGetAttributeValue": { "type": "object", "properties": { "attributeId": { "type": "integer" }, "attributeName": { "type": "string" }, "attributeComment": { "type": "string" }, "target": { "$ref": "#/components/schemas/RestAttributeTarget" }, "value": { "type": "string" }, "lastUpdatedDate": { "type": "string", "format": "date-time" } }, "required": [ "attributeId", "attributeName", "attributeComment", "target", "value", "lastUpdatedDate" ] }, "NotificationObjectSubscriptionObjectDto": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "review" ] }, "id": { "type": "number", "format": "int64" } }, "required": [ "type", "id" ] }, "NotificationObjectSubscriptionUserDto": { "type": "object", "properties": { "email": { "type": "string" }, "isGroup": { "type": "boolean" }, "groupMembers": { "type": "array", "items": { "type": "string" } } }, "required": [ "email", "isGroup" ] }, "RestCursor": { "type": "object", "properties": { "next": { "type": "string" }, "previous": { "type": "string" } } }, "RestGetPermission": { "type": "object", "properties": { "name": { "type": "string" }, "isOverride": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "valueInherited": { "type": "boolean" } }, "required": [ "name", "isOverride", "isEnabled" ] }, "RestGetEndUserPermissions": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "user", "user_group" ] }, "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/RestGetPermission" } } }, "required": [ "name", "type", "permissions" ] }, "RestXLink": { "type": "object", "properties": { "xLinkChangeset": { "type": "object" }, "xLinkRelative": { "type": "boolean" }, "xLinkOrganization": { "type": "string" }, "xLinkRepository": { "type": "string" }, "xLinkRoot": { "type": "string" } }, "required": [ "xLinkChangeset", "xLinkRelative", "xLinkOrganization", "xLinkRepository", "xLinkRoot" ] }, "RestItemChild": { "type": "object", "properties": { "revision": { "type": "number" }, "item": { "type": "string" }, "size": { "type": "number" }, "branch": { "type": "string" }, "branchId": { "type": "number" }, "changeset": { "type": "number" }, "comment": { "type": "string" }, "owner": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "repository": { "type": "string" }, "type": { "type": "string" }, "contentType": { "type": "string" }, "xLink": { "$ref": "#/components/schemas/RestXLink" } }, "required": [ "revision", "item", "size", "branch", "branchId", "changeset", "comment", "owner", "date", "repository", "type", "contentType" ] }, "CursorDto": { "type": "object", "properties": { "next": { "type": "string" }, "previous": { "type": "string" } } }, "CodeReviewDto": { "type": "object", "properties": { "id": { "type": "number" }, "object": { "$ref": "#/components/schemas/CodeReviewObjectDto" }, "assignee": { "type": "string" }, "owner": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "under-review", "reviewed", "rework-required" ] }, "title": { "type": "string" }, "description": { "type": "string" }, "commentsCount": { "type": "number", "format": "integer" }, "userCommentsCount": { "type": "number", "format": "integer" }, "unansweredQuestionsCount": { "type": "number", "format": "integer" }, "numberOfIssues": { "type": "number", "format": "integer" }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/CodeReviewCommentDto" } }, "reviewers": { "type": "array", "items": { "$ref": "#/components/schemas/ReviewerWithStatusDto" } }, "mergeAllowed": { "type": "boolean" }, "mergeIssues": { "type": "string" }, "merges": { "type": "array", "items": { "$ref": "#/components/schemas/MergeDto" } }, "repositoryName": { "type": "string" } }, "required": [ "id", "object", "owner", "createdAt", "updatedAt", "status", "title", "description", "commentsCount", "userCommentsCount", "unansweredQuestionsCount", "numberOfIssues", "comments", "reviewers" ] }, "PostCodeReviewObject": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "branch", "changeset", "revision", "item" ] }, "spec": { "type": "string" } }, "required": [ "type", "spec" ] }, "ReviewerDto": { "type": "object", "properties": { "name": { "type": "string", "format": "email" }, "isGroup": { "type": "boolean" } }, "required": [ "name", "isGroup" ] }, "RestGetDiffColor": { "type": "object", "properties": { "a": { "type": "number" }, "r": { "type": "number" }, "g": { "type": "number" }, "b": { "type": "number" } }, "required": [ "a", "r", "g", "b" ] }, "RestGetDiffLineColor": { "type": "object", "properties": { "initialLine": { "type": "number" }, "endLine": { "type": "number" }, "color": { "$ref": "#/components/schemas/RestGetDiffColor" }, "borderColor": { "$ref": "#/components/schemas/RestGetDiffColor" } }, "required": [ "initialLine", "endLine" ] }, "RestGetDiffColumnColorRegion": { "type": "object", "properties": { "initialColumn": { "type": "number" }, "endColumn": { "type": "number" }, "color": { "$ref": "#/components/schemas/RestGetDiffColor" } }, "required": [ "initialColumn", "endColumn" ] }, "RestGetDiffColumnColor": { "type": "object", "properties": { "line": { "type": "number" }, "regions": { "type": "array", "items": { "$ref": "#/components/schemas/RestGetDiffColumnColorRegion" } } }, "required": [ "line", "regions" ] }, "RestGetDiffIcon": { "type": "object", "properties": { "diffIconType": { "type": "string" }, "position": { "type": "number" } }, "required": [ "diffIconType", "position" ] }, "RestGetDiffInfo": { "type": "object", "properties": { "drawingInfo": { "type": "object", "properties": { "left": { "type": "object", "required": [ "diffRegions", "insideLineRegions" ], "properties": { "diffRegions": { "type": "array", "items": { "$ref": "#/components/schemas/RestGetDiffLineColor" } }, "insideLineRegions": { "type": "array", "items": { "$ref": "#/components/schemas/RestGetDiffColumnColor" } } } }, "right": { "type": "object", "required": [ "diffRegions", "insideLineRegions" ], "properties": { "diffRegions": { "type": "array", "items": { "$ref": "#/components/schemas/RestGetDiffLineColor" } }, "insideLineRegions": { "type": "array", "items": { "$ref": "#/components/schemas/RestGetDiffColumnColor" } } } } } }, "lineMapping": { "type": "object", "required": [ "sourceEditor", "destinationEditor" ], "properties": { "sourceEditor": { "type": "array", "items": { "type": "number" } }, "destinationEditor": { "type": "array", "items": { "type": "number" } } } }, "moveInfo": { "type": "object", "properties": { "regions": { "type": "object", "required": [ "left", "right" ], "properties": { "left": { "type": "array", "items": { "$ref": "#/components/schemas/RestGetDiffLineColor" } }, "right": { "type": "array", "items": { "$ref": "#/components/schemas/RestGetDiffLineColor" } } } }, "diffRegions": { "type": "object", "required": [ "left", "right" ], "properties": { "left": { "type": "array", "items": { "$ref": "#/components/schemas/RestGetDiffLineColor" } }, "right": { "type": "array", "items": { "$ref": "#/components/schemas/RestGetDiffLineColor" } } } }, "insideLineRegions": { "type": "object", "required": [ "left", "right" ], "properties": { "left": { "type": "array", "items": { "$ref": "#/components/schemas/RestGetDiffColumnColor" } }, "right": { "type": "array", "items": { "$ref": "#/components/schemas/RestGetDiffColumnColor" } } } } } }, "semanticInfo": { "type": "object", "properties": { "left": { "type": "object", "required": [ "diffIcons" ], "properties": { "diffIcons": { "type": "array", "items": { "$ref": "#/components/schemas/RestGetDiffIcon" } } } }, "right": { "type": "object", "required": [ "diffIcons" ], "properties": { "diffIcons": { "type": "array", "items": { "$ref": "#/components/schemas/RestGetDiffIcon" } } } } } } }, "required": [ "drawingInfo", "lineMapping", "moveInfo", "semanticInfo" ] }, "RestGetLock": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "holderBranchName": { "type": "string" }, "holderBranchId": { "type": "number" }, "destinationBranchName": { "type": "string" }, "destinationBranchId": { "type": "number" }, "owner": { "type": "string" }, "date": { "format": "date-time", "type": "string" }, "status": { "type": "string", "enum": [ "Retained", "Locked" ] } } }, "RestGetTreeDiffItem": { "type": "object", "properties": { "mountId": { "type": "string" }, "itemId": { "type": "number" }, "path": { "type": "string" }, "srcPath": { "type": "string" }, "sourceRev": { "type": "number" }, "sourceRevSize": { "type": "number" }, "sourceChangeset": { "type": "number" }, "sourceBranch": { "type": "number" }, "sourceBranchName": { "type": "string" }, "dstRev": { "type": "number" }, "dstRevSize": { "type": "number" }, "dstChangeset": { "type": "number" }, "dstBranch": { "type": "number" }, "dstBranchName": { "type": "string" }, "timestamp": { "type": "string" }, "repoName": { "type": "string" }, "xlink": { "type": "object", "required": [ "sourceData", "dstData" ], "properties": { "sourceData": { "type": "string" }, "sourceXLink": { "$ref": "#/components/schemas/RestXLink" }, "dstData": { "type": "string" }, "dstXLink": { "$ref": "#/components/schemas/RestXLink" } } }, "type": { "type": "string" }, "diffInfo": { "$ref": "#/components/schemas/RestGetDiffInfo" }, "lock": { "$ref": "#/components/schemas/RestGetLock" } }, "required": [ "mountId", "itemId", "path", "srcPath", "timestamp", "repoName", "xlink", "type" ] }, "RestGetMergeGroupDiffItems": { "type": "object", "properties": { "itemId": { "type": "number" }, "branchName": { "type": "string" }, "branchId": { "type": "number" }, "repoName": { "type": "string" }, "merged": { "type": "array", "items": { "$ref": "#/components/schemas/RestGetTreeDiffItem" } }, "added": { "type": "array", "items": { "$ref": "#/components/schemas/RestGetTreeDiffItem" } }, "changed": { "type": "array", "items": { "$ref": "#/components/schemas/RestGetTreeDiffItem" } }, "moved": { "type": "array", "items": { "$ref": "#/components/schemas/RestGetTreeDiffItem" } }, "deleted": { "type": "array", "items": { "$ref": "#/components/schemas/RestGetTreeDiffItem" } } }, "required": [ "merged", "added", "changed", "moved", "deleted" ] }, "RestGetRevisionDiffColor": { "type": "object", "properties": { "a": { "type": "number" }, "r": { "type": "number" }, "g": { "type": "number" }, "b": { "type": "number" } }, "required": [ "a", "r", "g", "b" ] }, "RestGetRevisionDiffLineColor": { "type": "object", "properties": { "initialLine": { "type": "number" }, "endLine": { "type": "number" }, "color": { "$ref": "#/components/schemas/RestGetRevisionDiffColor" }, "borderColor": { "$ref": "#/components/schemas/RestGetRevisionDiffColor" } }, "required": [ "initialLine", "endLine" ] }, "RestGetRevisionDiffColumnColorRegion": { "type": "object", "properties": { "initialColumn": { "type": "number" }, "endColumn": { "type": "number" }, "color": { "$ref": "#/components/schemas/RestGetRevisionDiffColor" } }, "required": [ "initialColumn", "endColumn" ] }, "RestGetRevisionDiffColumnColor": { "type": "object", "properties": { "line": { "type": "number" }, "regions": { "type": "array", "items": { "$ref": "#/components/schemas/RestGetRevisionDiffColumnColorRegion" } } }, "required": [ "line", "regions" ] }, "RestGetRevisionDiffIcon": { "type": "object", "properties": { "diffIconType": { "type": "string" }, "position": { "type": "number" } }, "required": [ "diffIconType", "position" ] }, "RestMergeRevInfo": { "type": "object", "properties": { "changeset": { "type": "number" }, "branchId": { "type": "number" }, "itemId": { "type": "number" }, "type": { "type": "string", "enum": [ "directory", "textFile", "binaryFile", "symlink", "xlink" ] }, "owner": { "type": "string" }, "date": { "format": "date-time", "type": "string" }, "size": { "type": "number" } }, "required": [ "changeset", "branchId", "itemId", "type", "owner", "date", "size" ] }, "RestMergeDifference": { "type": "object", "properties": { "base": { "$ref": "#/components/schemas/RestMergeRevInfo" }, "isDirectory": { "type": "boolean" }, "isContentChanged": { "type": "boolean" }, "itemId": { "type": "number" }, "path": { "type": "string" }, "revInfo": { "$ref": "#/components/schemas/RestMergeRevInfo" }, "status": { "type": "string" }, "sourcePath": { "type": "string" }, "destinationPath": { "type": "string" }, "type": { "type": "string" } }, "required": [ "isDirectory", "isContentChanged", "itemId", "path" ] }, "RestFileConflict": { "type": "object", "properties": { "type": { "type": "string" }, "source": { "$ref": "#/components/schemas/RestMergeDifference" }, "destination": { "$ref": "#/components/schemas/RestMergeDifference" }, "base": { "$ref": "#/components/schemas/RestMergeRevInfo" } }, "required": [ "type" ] }, "RepositoryStorageDto": { "type": "object", "properties": { "name": { "type": "string" }, "size": { "type": "number" } }, "required": [ "name", "size" ] } } } } ```