diff --git a/packages/create-app/templates/default-app/packages/app/src/components/catalog/EntityPage.tsx b/packages/create-app/templates/default-app/packages/app/src/components/catalog/EntityPage.tsx
index 84d094410b..6ec4da055d 100644
--- a/packages/create-app/templates/default-app/packages/app/src/components/catalog/EntityPage.tsx
+++ b/packages/create-app/templates/default-app/packages/app/src/components/catalog/EntityPage.tsx
@@ -68,6 +68,17 @@ import {
RELATION_PROVIDES_API,
} from '@backstage/catalog-model';
+import { TechDocsAddons } from '@backstage/plugin-techdocs-react';
+import { ReportIssue } from '@backstage/plugin-techdocs-module-addons-contrib';
+
+const techdocsContent = (
+
+
+
+
+);
+
const cicdContent = (
// This is an example of how you can implement your company's logic in entity page.
// You can for example enforce that all components of type 'service' should use GitHubActions
@@ -167,7 +178,7 @@ const serviceEntityPage = (
-
);
@@ -194,7 +205,7 @@ const websiteEntityPage = (
-
);
@@ -213,7 +224,7 @@ const defaultEntityPage = (
-
);
diff --git a/packages/create-app/templates/default-app/packages/app/src/components/search/SearchPage.tsx b/packages/create-app/templates/default-app/packages/app/src/components/search/SearchPage.tsx
index d4c7c92346..928b8201ea 100644
--- a/packages/create-app/templates/default-app/packages/app/src/components/search/SearchPage.tsx
+++ b/packages/create-app/templates/default-app/packages/app/src/components/search/SearchPage.tsx
@@ -8,14 +8,14 @@ import {
} from '@backstage/plugin-catalog-react';
import { TechDocsSearchResultListItem } from '@backstage/plugin-techdocs';
+import { SearchType } from '@backstage/plugin-search';
import {
+ DefaultResultListItem,
SearchBar,
SearchFilter,
SearchResult,
- SearchType,
- DefaultResultListItem,
-} from '@backstage/plugin-search';
-import { useSearch } from '@backstage/plugin-search-react';
+ useSearch,
+} from '@backstage/plugin-search-react';
import {
CatalogIcon,
Content,
@@ -112,7 +112,7 @@ const SearchPage = () => {
{({ results }) => (
- {results.map(({ type, document, highlight }) => {
+ {results.map(({ type, document, highlight, rank }) => {
switch (type) {
case 'software-catalog':
return (
@@ -120,6 +120,7 @@ const SearchPage = () => {
key={document.location}
result={document}
highlight={highlight}
+ rank={rank}
/>
);
case 'techdocs':
@@ -128,6 +129,7 @@ const SearchPage = () => {
key={document.location}
result={document}
highlight={highlight}
+ rank={rank}
/>
);
default:
@@ -136,6 +138,7 @@ const SearchPage = () => {
key={document.location}
result={document}
highlight={highlight}
+ rank={rank}
/>
);
}
diff --git a/packages/create-app/templates/default-app/packages/backend/src/plugins/auth.ts b/packages/create-app/templates/default-app/packages/backend/src/plugins/auth.ts
index 13f18c55e9..159116d7b8 100644
--- a/packages/create-app/templates/default-app/packages/backend/src/plugins/auth.ts
+++ b/packages/create-app/templates/default-app/packages/backend/src/plugins/auth.ts
@@ -18,18 +18,36 @@ export default async function createPlugin(
providerFactories: {
...defaultAuthProviderFactories,
- // This overrides the default GitHub auth provider with a custom one.
- // Since the options are empty it will behave just like the default
- // provider, but if you uncomment the `signIn` section you will enable
- // sign-in via GitHub. This particular configuration uses a resolver
- // that matches the username to the user entity name. See the auth
- // documentation for more details on how to enable and customize sign-in:
+ // This replaces the default GitHub auth provider with a customized one.
+ // The `signIn` option enables sign-in for this provider, using the
+ // identity resolution logic that's provided in the `resolver` callback.
+ //
+ // This particular resolver makes all users share a single "guest" identity.
+ // It should only be used for testing and trying out Backstage.
+ //
+ // If you want to use a production ready resolver you can switch to the
+ // the one that is commented out below, it looks up a user entity in the
+ // catalog using the GitHub username of the authenticated user.
+ // That resolver requires you to have user entities populated in the catalog,
+ // for example using https://backstage.io/docs/integrations/github/org
+ //
+ // There are other resolvers to choose from, and you can also create
+ // your own, see the auth documentation for more details:
//
// https://backstage.io/docs/auth/identity-resolver
github: providers.github.create({
- // signIn: {
- // resolver: providers.github.resolvers.usernameMatchingUserEntityName(),
- // },
+ signIn: {
+ resolver(_, ctx) {
+ const userRef = 'user:default/guest'; // Must be a full entity reference
+ return ctx.issueToken({
+ claims: {
+ sub: userRef, // The user's own identity
+ ent: [userRef], // A list of identities that the user claims ownership through
+ },
+ });
+ },
+ // resolver: providers.github.resolvers.usernameMatchingUserEntityName(),
+ },
}),
},
});
diff --git a/packages/dev-utils/CHANGELOG.md b/packages/dev-utils/CHANGELOG.md
index 3463c378fe..563de9fc44 100644
--- a/packages/dev-utils/CHANGELOG.md
+++ b/packages/dev-utils/CHANGELOG.md
@@ -1,5 +1,43 @@
# @backstage/dev-utils
+## 1.0.3
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-catalog-react@1.1.1
+ - @backstage/core-components@0.9.5
+ - @backstage/core-app-api@1.0.3
+ - @backstage/core-plugin-api@1.0.3
+ - @backstage/integration-react@1.1.1
+ - @backstage/test-utils@1.1.1
+ - @backstage/catalog-model@1.0.3
+ - @backstage/app-defaults@1.0.3
+
+## 1.0.3-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/core-components@0.9.5-next.1
+ - @backstage/core-app-api@1.0.3-next.0
+ - @backstage/core-plugin-api@1.0.3-next.0
+ - @backstage/integration-react@1.1.1-next.1
+ - @backstage/test-utils@1.1.1-next.0
+ - @backstage/catalog-model@1.0.3-next.0
+ - @backstage/plugin-catalog-react@1.1.1-next.1
+ - @backstage/app-defaults@1.0.3-next.1
+
+## 1.0.3-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-catalog-react@1.1.1-next.0
+ - @backstage/core-components@0.9.5-next.0
+ - @backstage/app-defaults@1.0.3-next.0
+ - @backstage/integration-react@1.1.1-next.0
+
## 1.0.2
### Patch Changes
diff --git a/packages/dev-utils/package.json b/packages/dev-utils/package.json
index 8ced35c07c..2da041d9b7 100644
--- a/packages/dev-utils/package.json
+++ b/packages/dev-utils/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/dev-utils",
"description": "Utilities for developing Backstage plugins.",
- "version": "1.0.2",
+ "version": "1.0.3",
"private": false,
"publishConfig": {
"access": "public",
@@ -33,14 +33,14 @@
"start": "backstage-cli package start"
},
"dependencies": {
- "@backstage/app-defaults": "^1.0.2",
- "@backstage/core-app-api": "^1.0.2",
- "@backstage/core-components": "^0.9.4",
- "@backstage/core-plugin-api": "^1.0.2",
- "@backstage/catalog-model": "^1.0.2",
- "@backstage/integration-react": "^1.1.0",
- "@backstage/plugin-catalog-react": "^1.1.0",
- "@backstage/test-utils": "^1.1.0",
+ "@backstage/app-defaults": "^1.0.3",
+ "@backstage/core-app-api": "^1.0.3",
+ "@backstage/core-components": "^0.9.5",
+ "@backstage/core-plugin-api": "^1.0.3",
+ "@backstage/catalog-model": "^1.0.3",
+ "@backstage/integration-react": "^1.1.1",
+ "@backstage/plugin-catalog-react": "^1.1.1",
+ "@backstage/test-utils": "^1.1.1",
"@backstage/theme": "^0.2.15",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
@@ -59,7 +59,7 @@
"react-dom": "^16.13.1 || ^17.0.0"
},
"devDependencies": {
- "@backstage/cli": "^0.17.1",
+ "@backstage/cli": "^0.17.2",
"@types/jest": "^26.0.7",
"@types/node": "^16.0.0"
},
diff --git a/packages/e2e-test/src/commands/run.ts b/packages/e2e-test/src/commands/run.ts
index e1477d98d7..d324aeafaf 100644
--- a/packages/e2e-test/src/commands/run.ts
+++ b/packages/e2e-test/src/commands/run.ts
@@ -235,6 +235,18 @@ async function createApp(
print('Rewriting module resolutions of app to use workspace packages');
await overrideModuleResolutions(appDir, workspaceDir);
+ // Yarn does not clean up node_module folders in the linked in dependencies by itself
+ print('Cleaning up node_modules in workspace');
+ await fs.remove(resolvePath(workspaceDir, 'node_modules'));
+ for (const wsDir of ['packages', 'plugins']) {
+ for (const dir of await fs.readdir(resolvePath(workspaceDir, wsDir))) {
+ const moduleDir = resolvePath(workspaceDir, wsDir, dir, 'node_modules');
+ if (await fs.pathExists(moduleDir)) {
+ await fs.remove(moduleDir);
+ }
+ }
+ }
+
print('Pinning yarn version and registry in app');
await pinYarnVersion(appDir);
await fs.writeFile(
diff --git a/packages/errors/package.json b/packages/errors/package.json
index f37c103f37..8327246224 100644
--- a/packages/errors/package.json
+++ b/packages/errors/package.json
@@ -38,7 +38,7 @@
"serialize-error": "^8.0.1"
},
"devDependencies": {
- "@backstage/cli": "^0.17.1-next.0",
+ "@backstage/cli": "^0.17.2-next.0",
"@types/jest": "^26.0.7"
},
"files": [
diff --git a/packages/integration-react/CHANGELOG.md b/packages/integration-react/CHANGELOG.md
index baa0318529..d03553f50d 100644
--- a/packages/integration-react/CHANGELOG.md
+++ b/packages/integration-react/CHANGELOG.md
@@ -1,5 +1,33 @@
# @backstage/integration-react
+## 1.1.1
+
+### Patch Changes
+
+- 8f7b1835df: Updated dependency `msw` to `^0.41.0`.
+- Updated dependencies
+ - @backstage/core-components@0.9.5
+ - @backstage/integration@1.2.1
+ - @backstage/core-plugin-api@1.0.3
+
+## 1.1.1-next.1
+
+### Patch Changes
+
+- 8f7b1835df: Updated dependency `msw` to `^0.41.0`.
+- Updated dependencies
+ - @backstage/core-components@0.9.5-next.1
+ - @backstage/core-plugin-api@1.0.3-next.0
+ - @backstage/integration@1.2.1-next.1
+
+## 1.1.1-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/core-components@0.9.5-next.0
+ - @backstage/integration@1.2.1-next.0
+
## 1.1.0
### Minor Changes
diff --git a/packages/integration-react/package.json b/packages/integration-react/package.json
index 34790174d0..580b91509f 100644
--- a/packages/integration-react/package.json
+++ b/packages/integration-react/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/integration-react",
"description": "Frontend package for managing integrations towards external systems",
- "version": "1.1.0",
+ "version": "1.1.1",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -25,9 +25,9 @@
},
"dependencies": {
"@backstage/config": "^1.0.1",
- "@backstage/core-components": "^0.9.4",
- "@backstage/core-plugin-api": "^1.0.2",
- "@backstage/integration": "^1.2.0",
+ "@backstage/core-components": "^0.9.5",
+ "@backstage/core-plugin-api": "^1.0.3",
+ "@backstage/integration": "^1.2.1",
"@backstage/theme": "^0.2.15",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
@@ -38,15 +38,15 @@
"react": "^16.13.1 || ^17.0.0"
},
"devDependencies": {
- "@backstage/cli": "^0.17.1",
- "@backstage/dev-utils": "^1.0.2",
- "@backstage/test-utils": "^1.1.0",
+ "@backstage/cli": "^0.17.2",
+ "@backstage/dev-utils": "^1.0.3",
+ "@backstage/test-utils": "^1.1.1",
"@testing-library/jest-dom": "^5.10.1",
"@testing-library/react": "^12.1.3",
"@testing-library/user-event": "^14.0.0",
"@types/jest": "^26.0.7",
"@types/node": "^16.11.26",
- "msw": "^0.35.0",
+ "msw": "^0.42.0",
"cross-fetch": "^3.1.5"
},
"files": [
diff --git a/packages/integration/CHANGELOG.md b/packages/integration/CHANGELOG.md
index fa4999f57c..736d9ff2a1 100644
--- a/packages/integration/CHANGELOG.md
+++ b/packages/integration/CHANGELOG.md
@@ -1,5 +1,31 @@
# @backstage/integration
+## 1.2.1
+
+### Patch Changes
+
+- 72dfcbc8bf: Gerrit Integration: Handle absolute paths in `resolveUrl` properly.
+- 8f7b1835df: Updated dependency `msw` to `^0.41.0`.
+- e37c71b5a4: Updated to support deployments of Azure DevOps Server under TFS or similar sub path
+
+## 1.2.1-next.2
+
+### Patch Changes
+
+- e37c71b5a4: Updated to support deployments of Azure DevOps Server under TFS or similar sub path
+
+## 1.2.1-next.1
+
+### Patch Changes
+
+- 8f7b1835df: Updated dependency `msw` to `^0.41.0`.
+
+## 1.2.1-next.0
+
+### Patch Changes
+
+- 72dfcbc8bf: Gerrit Integration: Handle absolute paths in `resolveUrl` properly.
+
## 1.2.0
### Minor Changes
diff --git a/packages/integration/config.d.ts b/packages/integration/config.d.ts
index c14f5c76cd..22acc5cd70 100644
--- a/packages/integration/config.d.ts
+++ b/packages/integration/config.d.ts
@@ -15,7 +15,10 @@
*/
export interface Config {
- /** Configuration for integrations towards various external repository provider systems */
+ /**
+ * Configuration for integrations towards various external repository provider systems
+ * @visibility frontend
+ */
integrations?: {
/** Integration configuration for Azure */
azure?: Array<{
diff --git a/packages/integration/package.json b/packages/integration/package.json
index ae91c4ca2f..06faef890d 100644
--- a/packages/integration/package.json
+++ b/packages/integration/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/integration",
"description": "Helpers for managing integrations towards external systems",
- "version": "1.2.0",
+ "version": "1.2.1",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -43,12 +43,12 @@
"lodash": "^4.17.21"
},
"devDependencies": {
- "@backstage/cli": "^0.17.1",
- "@backstage/config-loader": "^1.1.1",
- "@backstage/test-utils": "^1.1.0",
+ "@backstage/cli": "^0.17.2",
+ "@backstage/config-loader": "^1.1.2",
+ "@backstage/test-utils": "^1.1.1",
"@types/jest": "^26.0.7",
"@types/luxon": "^2.0.4",
- "msw": "^0.35.0"
+ "msw": "^0.42.0"
},
"files": [
"dist",
diff --git a/packages/integration/src/azure/AzureUrl.test.ts b/packages/integration/src/azure/AzureUrl.test.ts
index 2f22dd13da..a56f800133 100644
--- a/packages/integration/src/azure/AzureUrl.test.ts
+++ b/packages/integration/src/azure/AzureUrl.test.ts
@@ -142,6 +142,30 @@ describe('AzureUrl', () => {
);
});
+ it('should work with the old tfs long URL', () => {
+ const url = AzureUrl.fromRepoUrl(
+ 'http://my-host/tfs/projects/my-project/_git/my-repo',
+ );
+
+ expect(url.getOwner()).toBe('tfs/projects');
+ expect(url.getProject()).toBe('my-project');
+ expect(url.getRepo()).toBe('my-repo');
+ expect(url.getRef()).toBeUndefined();
+ expect(url.getPath()).toBeUndefined();
+ });
+
+ it('should work with the old tfs long URL form with a path and ref', () => {
+ const url = AzureUrl.fromRepoUrl(
+ 'http://my-host/tfs/projects/my-project/_git/my-repo?path=%2Ffolder&version=GBtest-branch',
+ );
+
+ expect(url.getOwner()).toBe('tfs/projects');
+ expect(url.getProject()).toBe('my-project');
+ expect(url.getRepo()).toBe('my-repo');
+ expect(url.getRef()).toBe('test-branch');
+ expect(url.getPath()).toBe('/folder');
+ });
+
it('should reject non-branch refs', () => {
expect(() =>
AzureUrl.fromRepoUrl(
diff --git a/packages/integration/src/azure/AzureUrl.ts b/packages/integration/src/azure/AzureUrl.ts
index 76de8550ed..1161ab7a1b 100644
--- a/packages/integration/src/azure/AzureUrl.ts
+++ b/packages/integration/src/azure/AzureUrl.ts
@@ -37,6 +37,10 @@ export class AzureUrl {
owner = parts[1];
project = parts[2];
repo = parts[4];
+ } else if (parts[4] === '_git') {
+ owner = `${parts[1]}/${parts[2]}`;
+ project = parts[3];
+ repo = parts[5];
}
if (!owner || !project || !repo) {
diff --git a/packages/integration/src/gerrit/GerritIntegration.test.ts b/packages/integration/src/gerrit/GerritIntegration.test.ts
index 6b5e228bb6..1a7bac5be6 100644
--- a/packages/integration/src/gerrit/GerritIntegration.test.ts
+++ b/packages/integration/src/gerrit/GerritIntegration.test.ts
@@ -97,6 +97,24 @@ describe('GerritIntegration', () => {
});
});
+ describe('resolves with an absolute url', () => {
+ it('works for valid urls', () => {
+ const integration = new GerritIntegration({
+ host: 'gerrit-review.example.com',
+ gitilesBaseUrl: 'https://gerrit-review.example.com/gitiles',
+ } as any);
+
+ expect(
+ integration.resolveUrl({
+ url: '/catalog-info.yaml',
+ base: 'https://gerrit-review.example.com/gitiles/repo/+/refs/heads/master/',
+ }),
+ ).toBe(
+ 'https://gerrit-review.example.com/gitiles/repo/+/refs/heads/master/catalog-info.yaml',
+ );
+ });
+ });
+
it('resolve edit URL', () => {
const integration = new GerritIntegration({
host: 'gerrit-review.example.com',
diff --git a/packages/integration/src/gerrit/GerritIntegration.ts b/packages/integration/src/gerrit/GerritIntegration.ts
index 97eb9372c0..d57b54df8e 100644
--- a/packages/integration/src/gerrit/GerritIntegration.ts
+++ b/packages/integration/src/gerrit/GerritIntegration.ts
@@ -20,6 +20,7 @@ import {
GerritIntegrationConfig,
readGerritIntegrationConfigs,
} from './config';
+import { parseGerritGitilesUrl, builldGerritGitilesUrl } from './core';
/**
* A Gerrit based integration.
@@ -58,6 +59,10 @@ export class GerritIntegration implements ScmIntegration {
}): string {
const { url, base, lineNumber } = options;
let updated;
+ if (url.startsWith('/')) {
+ const { branch, project } = parseGerritGitilesUrl(this.config, base);
+ return builldGerritGitilesUrl(this.config, project, branch, url);
+ }
if (url) {
updated = new URL(url, base);
} else {
diff --git a/packages/integration/src/gerrit/core.test.ts b/packages/integration/src/gerrit/core.test.ts
index 84bc1c0c19..351e7ce58e 100644
--- a/packages/integration/src/gerrit/core.test.ts
+++ b/packages/integration/src/gerrit/core.test.ts
@@ -20,6 +20,7 @@ import fetch from 'cross-fetch';
import { setupRequestMockHandlers } from '@backstage/test-utils';
import { GerritIntegrationConfig } from './config';
import {
+ builldGerritGitilesUrl,
getGerritBranchApiUrl,
getGerritCloneRepoUrl,
getGerritRequestOptions,
@@ -32,6 +33,20 @@ describe('gerrit core', () => {
const worker = setupServer();
setupRequestMockHandlers(worker);
+ describe('builldGerritGitilesUrl', () => {
+ it('can create an url from arguments', () => {
+ const config: GerritIntegrationConfig = {
+ host: 'gerrit.com',
+ gitilesBaseUrl: 'https://gerrit.com/gitiles',
+ };
+ expect(
+ builldGerritGitilesUrl(config, 'repo', 'dev', 'catalog-info.yaml'),
+ ).toEqual(
+ 'https://gerrit.com/gitiles/repo/+/refs/heads/dev/catalog-info.yaml',
+ );
+ });
+ });
+
describe('getGerritRequestOptions', () => {
it('adds headers when a password is specified', () => {
const authRequest: GerritIntegrationConfig = {
diff --git a/packages/integration/src/gerrit/core.ts b/packages/integration/src/gerrit/core.ts
index eb413a2608..cd2b919e09 100644
--- a/packages/integration/src/gerrit/core.ts
+++ b/packages/integration/src/gerrit/core.ts
@@ -70,6 +70,26 @@ export function parseGerritGitilesUrl(
};
}
+/**
+ * Build a Gerrit Gitiles url that targets a specific path.
+ *
+ * @param config - A Gerrit provider config.
+ * @param project - The name of the git project
+ * @param branch - The branch we will target.
+ * @param filePath - The absolute file path.
+ * @public
+ */
+export function builldGerritGitilesUrl(
+ config: GerritIntegrationConfig,
+ project: string,
+ branch: string,
+ filePath: string,
+): string {
+ return `${
+ config.gitilesBaseUrl
+ }/${project}/+/refs/heads/${branch}/${trimStart(filePath, '/')}`;
+}
+
/**
* Return the authentication prefix.
*
diff --git a/packages/release-manifests/CHANGELOG.md b/packages/release-manifests/CHANGELOG.md
index 017a50bd6c..279128576c 100644
--- a/packages/release-manifests/CHANGELOG.md
+++ b/packages/release-manifests/CHANGELOG.md
@@ -1,5 +1,17 @@
# @backstage/release-manifests
+## 0.0.4
+
+### Patch Changes
+
+- 8f7b1835df: Updated dependency `msw` to `^0.41.0`.
+
+## 0.0.4-next.0
+
+### Patch Changes
+
+- 8f7b1835df: Updated dependency `msw` to `^0.41.0`.
+
## 0.0.3
### Patch Changes
diff --git a/packages/release-manifests/package.json b/packages/release-manifests/package.json
index ef968e7a2d..f0627a9c95 100644
--- a/packages/release-manifests/package.json
+++ b/packages/release-manifests/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/release-manifests",
"description": "Helper library for receiving release manifests",
- "version": "0.0.3",
+ "version": "0.0.4",
"private": false,
"main": "src/index.ts",
"types": "src/index.ts",
@@ -36,8 +36,8 @@
"cross-fetch": "^3.1.5"
},
"devDependencies": {
- "@backstage/test-utils": "^1.1.0",
- "msw": "^0.35.0",
+ "@backstage/test-utils": "^1.1.1",
+ "msw": "^0.42.0",
"@types/jest": "^26.0.7",
"@types/node": "^16.0.0"
},
diff --git a/packages/release-manifests/src/manifest.test.ts b/packages/release-manifests/src/manifest.test.ts
index 70894e5431..272555df70 100644
--- a/packages/release-manifests/src/manifest.test.ts
+++ b/packages/release-manifests/src/manifest.test.ts
@@ -14,73 +14,75 @@
* limitations under the License.
*/
-import { setupRequestMockHandlers } from '@backstage/test-utils';
-import { getManifestByReleaseLine, getManifestByVersion } from './manifest';
import { setupServer } from 'msw/node';
import { rest } from 'msw';
+import { setupRequestMockHandlers } from '@backstage/test-utils';
+import { getManifestByReleaseLine, getManifestByVersion } from './manifest';
-describe('getManifestByVersion', () => {
+describe('Release Manifests', () => {
const worker = setupServer();
setupRequestMockHandlers(worker);
- it('should return a list of packages in a release', async () => {
- worker.use(
- rest.get('*/v1/releases/0.0.0/manifest.json', (_, res, ctx) =>
- res(
- ctx.status(200),
- ctx.json({
- packages: [{ name: '@backstage/core', version: '1.2.3' }],
- }),
+ describe('getManifestByVersion', () => {
+ it('should return a list of packages in a release', async () => {
+ worker.use(
+ rest.get('*/v1/releases/0.0.0/manifest.json', (_, res, ctx) =>
+ res(
+ ctx.status(200),
+ ctx.json({
+ packages: [{ name: '@backstage/core', version: '1.2.3' }],
+ }),
+ ),
),
- ),
- rest.get('*/v1/releases/999.0.1/manifest.json', (_, res, ctx) =>
- res(ctx.status(404), ctx.json({})),
- ),
- );
+ rest.get('*/v1/releases/999.0.1/manifest.json', (_, res, ctx) =>
+ res(ctx.status(404), ctx.json({})),
+ ),
+ );
- const pkgs = await getManifestByVersion({ version: '0.0.0' });
- expect(pkgs.packages).toEqual([
- {
- name: '@backstage/core',
- version: '1.2.3',
- },
- ]);
+ const pkgs = await getManifestByVersion({ version: '0.0.0' });
+ expect(pkgs.packages).toEqual([
+ {
+ name: '@backstage/core',
+ version: '1.2.3',
+ },
+ ]);
- await expect(getManifestByVersion({ version: '999.0.1' })).rejects.toThrow(
- 'No release found for 999.0.1 version',
- );
- });
-});
-
-describe('getManifestByReleaseLine', () => {
- const worker = setupServer();
- setupRequestMockHandlers(worker);
-
- it('should return a list of packages in a release', async () => {
- worker.use(
- rest.get('*/v1/tags/main/manifest.json', (_, res, ctx) =>
- res(
- ctx.status(200),
- ctx.json({
- packages: [{ name: '@backstage/core', version: '1.2.3' }],
- }),
- ),
- ),
- rest.get('*/v1/tags/foo/manifest.json', (_, res, ctx) =>
- res(ctx.status(404), ctx.json({})),
- ),
- );
-
- const pkgs = await getManifestByReleaseLine({ releaseLine: 'main' });
- expect(pkgs.packages).toEqual([
- {
- name: '@backstage/core',
- version: '1.2.3',
- },
- ]);
-
- await expect(
- getManifestByReleaseLine({ releaseLine: 'foo' }),
- ).rejects.toThrow("No 'foo' release line found");
+ await expect(
+ getManifestByVersion({ version: '999.0.1' }),
+ ).rejects.toThrow('No release found for 999.0.1 version');
+ });
+ });
+
+ describe('getManifestByReleaseLine', () => {
+ it('should return a list of packages in a release', async () => {
+ worker.use(
+ rest.get(
+ 'https://versions.backstage.io/v1/tags/main/manifest.json',
+ (_, res, ctx) =>
+ res(
+ ctx.status(200),
+ ctx.json({
+ packages: [{ name: '@backstage/core', version: '1.2.3' }],
+ }),
+ ),
+ ),
+ rest.get(
+ 'https://versions.backstage.io/v1/tags/foo/manifest.json',
+ (_, res, ctx) => res(ctx.status(404), ctx.json({})),
+ ),
+ );
+
+ const pkgs = await getManifestByReleaseLine({ releaseLine: 'main' });
+ expect(pkgs.packages).toEqual([
+ {
+ name: '@backstage/core',
+ version: '1.2.3',
+ },
+ ]);
+
+ await expect(
+ getManifestByReleaseLine({ releaseLine: 'foo' }),
+ ).rejects.toThrow("No 'foo' release line found");
+ });
});
});
diff --git a/packages/search-common/CHANGELOG.md b/packages/search-common/CHANGELOG.md
deleted file mode 100644
index 2a757c1909..0000000000
--- a/packages/search-common/CHANGELOG.md
+++ /dev/null
@@ -1,213 +0,0 @@
-# @backstage/search-common
-
-## 0.3.4
-
-### Patch Changes
-
-- Updated dependencies
- - @backstage/plugin-search-common@0.3.4
-
-## 0.3.4-next.0
-
-### Patch Changes
-
-- Updated dependencies
- - @backstage/plugin-search-common@0.3.4-next.0
-
-## 0.3.3
-
-### Patch Changes
-
-- Updated dependencies
- - @backstage/plugin-search-common@0.3.3
-
-## 0.3.3-next.1
-
-### Patch Changes
-
-- Updated dependencies
- - @backstage/plugin-search-common@0.3.3-next.1
-
-## 0.3.3-next.0
-
-### Patch Changes
-
-- Updated dependencies
- - @backstage/plugin-search-common@0.3.3-next.0
-
-## 0.3.2
-
-### Patch Changes
-
-- 82b0190155: This package is no longer maintained. Use `@backstage/plugin-search-common`, going forward.
-- Updated dependencies
- - @backstage/plugin-search-common@0.3.2
-
-## 0.3.1
-
-### Patch Changes
-
-- d52155466a: **DEPRECATION**
-
- The `@backstage/search-common` package is being renamed `@backstage/plugin-search-common`. We may continue to publish changes to `@backstage/search-common` for a time, but will stop doing so in the near future. If you depend on this package, you should update your dependencies to point at the renamed package.
-
-- Updated dependencies
- - @backstage/plugin-search-common@0.3.1
-
-## 0.3.1-next.0
-
-### Patch Changes
-
-- d52155466a: **DEPRECATION**
-
- The `@backstage/search-common` package is being renamed `@backstage/plugin-search-common`. We may continue to publish changes to `@backstage/search-common` for a time, but will stop doing so in the near future. If you depend on this package, you should update your dependencies to point at the renamed package.
-
-- Updated dependencies
- - @backstage/plugin-search-common@0.3.1-next.0
-
-## 0.3.0
-
-### Minor Changes
-
-- 022507c860: **BREAKING**
-
- The Backstage Search Platform's indexing process has been rewritten as a stream
- pipeline in order to improve efficiency and performance on large document sets.
-
- The concepts of `Collator` and `Decorator` have been replaced with readable and
- transform object streams (respectively), as well as factory classes to
- instantiate them. Accordingly, the `SearchEngine.index()` method has also been
- replaced with a `getIndexer()` factory method that resolves to a writable
- object stream.
-
- Check [this upgrade guide](https://backstage.io/docs/features/search/how-to-guides#how-to-migrate-from-search-alpha-to-beta)
- for further details.
-
-### Patch Changes
-
-- Updated dependencies
- - @backstage/plugin-permission-common@0.5.2
-
-## 0.2.4
-
-### Patch Changes
-
-- Fix for the previous release with missing type declarations.
-- Updated dependencies
- - @backstage/types@0.1.3
- - @backstage/plugin-permission-common@0.5.1
-
-## 0.2.3
-
-### Patch Changes
-
-- c77c5c7eb6: Added `backstage.role` to `package.json`
-- Updated dependencies
- - @backstage/plugin-permission-common@0.5.0
- - @backstage/types@0.1.2
-
-## 0.2.2
-
-### Patch Changes
-
-- 9a511968b1: - Add optional visibilityPermission property to DocumentCollator type
- - Add new DocumentTypeInfo type for housing information about the document types stored in a search engine.
-- b2e918fa0b: Add optional resourceRef field to the IndexableDocument type for use when authorizing access to documents.
-- 96cbebc629: Add optional query request options containing authorization token to SearchEngine#query.
-
-## 0.2.1
-
-### Patch Changes
-
-- 10615525f3: Switch to use the json and observable types from `@backstage/types`
-
-## 0.2.0
-
-### Minor Changes
-
-- a13f21cdc: Implement optional `pageCursor` based paging in search.
-
- To use paging in your app, add a `
diff --git a/packages/techdocs-cli/CHANGELOG.md b/packages/techdocs-cli/CHANGELOG.md
index 44c8b9a1d1..21eb2393b7 100644
--- a/packages/techdocs-cli/CHANGELOG.md
+++ b/packages/techdocs-cli/CHANGELOG.md
@@ -1,5 +1,43 @@
# @techdocs/cli
+## 1.1.2
+
+### Patch Changes
+
+- f96e98f4cd: Updated dependency `cypress` to `^10.0.0`.
+- bff65e6958: Updated sidebar-related logic to use `
` + `useSidebarPinState()` and/or `` + `useSidebarOpenState()` from `@backstage/core-components`.
+- Updated dependencies
+ - @backstage/backend-common@0.14.0
+ - @backstage/plugin-techdocs-node@1.1.2
+ - @backstage/catalog-model@1.0.3
+
+## 1.1.2-next.2
+
+### Patch Changes
+
+- f96e98f4cd: Updated dependency `cypress` to `^10.0.0`.
+- Updated dependencies
+ - @backstage/backend-common@0.14.0-next.2
+ - @backstage/plugin-techdocs-node@1.1.2-next.2
+
+## 1.1.2-next.1
+
+### Patch Changes
+
+- bff65e6958: Updated sidebar-related logic to use `` + `useSidebarPinState()` and/or `` + `useSidebarOpenState()` from `@backstage/core-components`.
+- Updated dependencies
+ - @backstage/backend-common@0.13.6-next.1
+ - @backstage/catalog-model@1.0.3-next.0
+ - @backstage/plugin-techdocs-node@1.1.2-next.1
+
+## 1.1.2-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.13.6-next.0
+ - @backstage/plugin-techdocs-node@1.1.2-next.0
+
## 1.1.1
### Patch Changes
diff --git a/packages/techdocs-cli/package.json b/packages/techdocs-cli/package.json
index 2e8107aa35..d1db470572 100644
--- a/packages/techdocs-cli/package.json
+++ b/packages/techdocs-cli/package.json
@@ -1,7 +1,7 @@
{
"name": "@techdocs/cli",
"description": "Utility CLI for managing TechDocs sites in Backstage.",
- "version": "1.1.1",
+ "version": "1.1.2",
"private": false,
"publishConfig": {
"access": "public"
@@ -37,7 +37,7 @@
"techdocs-cli": "bin/techdocs-cli"
},
"devDependencies": {
- "@backstage/cli": "^0.17.1",
+ "@backstage/cli": "^0.17.2",
"@types/commander": "^2.12.2",
"@types/fs-extra": "^9.0.6",
"@types/http-proxy": "^1.17.4",
@@ -45,7 +45,7 @@
"@types/node": "^16.11.26",
"@types/serve-handler": "^6.1.0",
"@types/webpack-env": "^1.15.3",
- "cypress": "^9.5.0",
+ "cypress": "^10.0.0",
"cypress-plugin-snapshots": "^1.4.4",
"find-process": "^1.4.5",
"nodemon": "^2.0.2",
@@ -62,11 +62,11 @@
"ext": "ts"
},
"dependencies": {
- "@backstage/backend-common": "^0.13.3",
- "@backstage/catalog-model": "^1.0.2",
+ "@backstage/backend-common": "^0.14.0",
+ "@backstage/catalog-model": "^1.0.3",
"@backstage/cli-common": "^0.1.9",
"@backstage/config": "^1.0.1",
- "@backstage/plugin-techdocs-node": "^1.1.1",
+ "@backstage/plugin-techdocs-node": "^1.1.2",
"@types/dockerode": "^3.3.0",
"commander": "^9.1.0",
"dockerode": "^3.3.1",
diff --git a/packages/techdocs-cli/src/commands/index.ts b/packages/techdocs-cli/src/commands/index.ts
index 85a218eb54..68e8f88c0b 100644
--- a/packages/techdocs-cli/src/commands/index.ts
+++ b/packages/techdocs-cli/src/commands/index.ts
@@ -38,7 +38,7 @@ export function registerCommands(program: Command) {
'The mkdocs docker container to use',
defaultDockerImage,
)
- .option('--no-pull', 'Do not pull the latest docker image', false)
+ .option('--no-pull', 'Do not pull the latest docker image')
.option(
'--no-docker',
'Do not use Docker, use MkDocs executable and plugins in current user environment.',
diff --git a/packages/techdocs-common/CHANGELOG.md b/packages/techdocs-common/CHANGELOG.md
deleted file mode 100644
index 5d930469fa..0000000000
--- a/packages/techdocs-common/CHANGELOG.md
+++ /dev/null
@@ -1,1144 +0,0 @@
-# @backstage/techdocs-common
-
-## 0.11.15
-
-### Patch Changes
-
-- Updated dependencies
- - @backstage/plugin-techdocs-node@1.1.1
-
-## 0.11.15-next.1
-
-### Patch Changes
-
-- Updated dependencies
- - @backstage/plugin-techdocs-node@1.1.1-next.1
-
-## 0.11.15-next.0
-
-### Patch Changes
-
-- Updated dependencies
- - @backstage/plugin-techdocs-node@1.1.1-next.0
-
-## 0.11.14
-
-### Patch Changes
-
-- Updated dependencies
- - @backstage/plugin-techdocs-node@1.1.0
-
-## 0.11.14-next.2
-
-### Patch Changes
-
-- Updated dependencies
- - @backstage/plugin-techdocs-node@1.1.0-next.2
-
-## 0.11.14-next.1
-
-### Patch Changes
-
-- Updated dependencies
- - @backstage/plugin-techdocs-node@1.0.1-next.1
-
-## 0.11.14-next.0
-
-### Patch Changes
-
-- Updated dependencies
- - @backstage/plugin-techdocs-node@1.0.1-next.0
-
-## 0.11.13
-
-### Patch Changes
-
-- 82b0190155: This package is no longer maintained. Use `@backstage/plugin-techdocs-node`, going forward.
-- Updated dependencies
- - @backstage/plugin-techdocs-node@1.0.0
-
-## 0.11.12
-
-### Patch Changes
-
-- cea6f10b97: **DEPRECATION**
-
- The `@backstage/techdocs-common` package is being renamed `@backstage/plugin-techdocs-node`. We may continue to publish changes to `@backstage/techdocs-common` for a time, but will stop doing so in the near future. If you depend on this package, you should update your dependencies to point at the renamed package.
-
-- Updated dependencies
- - @backstage/plugin-techdocs-node@0.11.12
-
-## 0.11.12-next.0
-
-### Patch Changes
-
-- cea6f10b97: **DEPRECATION**
-
- The `@backstage/techdocs-common` package is being renamed `@backstage/plugin-techdocs-node`. We may continue to publish changes to `@backstage/techdocs-common` for a time, but will stop doing so in the near future. If you depend on this package, you should update your dependencies to point at the renamed package.
-
-- Updated dependencies
- - @backstage/plugin-techdocs-node@0.11.12-next.0
-
-## 0.11.11
-
-### Patch Changes
-
-- 955be6bc7d: adds passing projectID to the Storage client
-- ff0a16fb1a: Modify techdocs builder to automatically append techdocs-core plugin to mkdocs.yaml file if it is missing. Adds an optional configuration item if this plugin needs to be omitted.
-- Updated dependencies
- - @backstage/catalog-model@0.12.0
- - @backstage/backend-common@0.12.0
- - @backstage/integration@0.8.0
- - @backstage/search-common@0.3.0
-
-## 0.11.10
-
-### Patch Changes
-
-- 209fd128e6: Updated usage of `github:` location types in docs to use `url:` instead.
-- 13ef228d03: Clean up the API interface for TechDocs common library.
-- Updated dependencies
- - @backstage/backend-common@0.11.0
- - @backstage/catalog-model@0.11.0
- - @backstage/integration@0.7.5
-
-## 0.11.9
-
-### Patch Changes
-
-- Fix for the previous release with missing type declarations.
-- Updated dependencies
- - @backstage/backend-common@0.10.9
- - @backstage/catalog-model@0.10.1
- - @backstage/config@0.1.15
- - @backstage/errors@0.2.2
- - @backstage/integration@0.7.4
- - @backstage/search-common@0.2.4
-
-## 0.11.8
-
-### Patch Changes
-
-- c77c5c7eb6: Added `backstage.role` to `package.json`
-- 216725b434: Updated to use new names for `parseLocationRef` and `stringifyLocationRef`
-- 7aeb491394: Replace use of deprecated `ENTITY_DEFAULT_NAMESPACE` constant with `DEFAULT_NAMESPACE`.
-- Updated dependencies
- - @backstage/backend-common@0.10.8
- - @backstage/errors@0.2.1
- - @backstage/integration@0.7.3
- - @backstage/catalog-model@0.10.0
- - @backstage/config@0.1.14
- - @backstage/search-common@0.2.3
-
-## 0.11.7
-
-### Patch Changes
-
-- Updated dependencies
- - @backstage/backend-common@0.10.7
-
-## 0.11.7-next.0
-
-### Patch Changes
-
-- Updated dependencies
- - @backstage/backend-common@0.10.7-next.0
-
-## 0.11.6
-
-### Patch Changes
-
-- Updated dependencies
- - @backstage/backend-common@0.10.6
-
-## 0.11.6-next.0
-
-### Patch Changes
-
-- Updated dependencies
- - @backstage/backend-common@0.10.6-next.0
-
-## 0.11.5
-
-### Patch Changes
-
-- ff93fbeeec: Fix interpolated string for "Failed to generate docs from ..."
-- Updated dependencies
- - @backstage/search-common@0.2.2
- - @backstage/backend-common@0.10.5
-
-## 0.11.4
-
-### Patch Changes
-
-- 47277c0d8c: Updated the default version of the `@spotify/techdocs` container used when `techdocs.generator.runIn` is `docker` to `v0.3.6`, which includes an update to `mkdocs-monorepo-plugin` that allows glob-based wildcard includes.
-- Updated dependencies
- - @backstage/integration@0.7.2
- - @backstage/backend-common@0.10.4
- - @backstage/config@0.1.13
- - @backstage/catalog-model@0.9.10
-
-## 0.11.4-next.0
-
-### Patch Changes
-
-- 47277c0d8c: Updated the default version of the `@spotify/techdocs` container used when `techdocs.generator.runIn` is `docker` to `v0.3.6`, which includes an update to `mkdocs-monorepo-plugin` that allows glob-based wildcard includes.
-- Updated dependencies
- - @backstage/backend-common@0.10.4-next.0
- - @backstage/config@0.1.13-next.0
- - @backstage/catalog-model@0.9.10-next.0
- - @backstage/integration@0.7.2-next.0
-
-## 0.11.3
-
-### Patch Changes
-
-- 5333451def: Cleaned up API exports
-- Updated dependencies
- - @backstage/config@0.1.12
- - @backstage/integration@0.7.1
- - @backstage/backend-common@0.10.3
- - @backstage/errors@0.2.0
- - @backstage/catalog-model@0.9.9
-
-## 0.11.2
-
-### Patch Changes
-
-- c2c8768771: Bump `@azure/identity` from `^1.5.0` to `^2.0.1`.
-- Updated dependencies
- - @backstage/backend-common@0.10.1
- - @backstage/integration@0.7.0
-
-## 0.11.1
-
-### Patch Changes
-
-- Updated dependencies
- - @backstage/backend-common@0.10.0
-
-## 0.11.0
-
-### Minor Changes
-
-- 1bada775a9: Added the ability for the TechDocs Backend to (optionally) leverage a cache
- store to improve performance when reading files from a cloud storage provider.
-
-### Patch Changes
-
-- dcd1a0c3f4: Minor improvement to the API reports, by not unpacking arguments directly
-- Updated dependencies
- - @backstage/backend-common@0.9.13
-
-## 0.10.8
-
-### Patch Changes
-
-- bab752e2b3: Change default port of backend from 7000 to 7007.
-
- This is due to the AirPlay Receiver process occupying port 7000 and preventing local Backstage instances on MacOS to start.
-
- You can change the port back to 7000 or any other value by providing an `app-config.yaml` with the following values:
-
- ```
- backend:
- listen: 0.0.0.0:7123
- baseUrl: http://localhost:7123
- ```
-
- More information can be found here: https://backstage.io/docs/conf/writing
-
-- Updated dependencies
- - @backstage/errors@0.1.5
- - @backstage/backend-common@0.9.11
-
-## 0.10.7
-
-### Patch Changes
-
-- 0b60a051c9: Added OpenStack Swift case migration support.
-- 9e64a7ac1e: Allow amazon web services s3 buckets to pass an server side encryption configuration so they can publish to encrypted buckets
-- Updated dependencies
- - @backstage/catalog-model@0.9.7
- - @backstage/backend-common@0.9.10
-
-## 0.10.6
-
-### Patch Changes
-
-- a2d4389587: 1. Techdocs publisher constructors now use parameter objects when being
- instantiated
-
- 2. Internal refactor of `LocalPublish` publisher to use `fromConfig` for
- creation to be aligned with other publishers; this does not impact
- `LocalPublish` usage.
-
- ```diff
- - const publisher = new LocalPublish(config, logger, discovery);
- + const publisher = LocalPublish.fromConfig(config, logger, discovery);
- ```
-
-- 6129c89a47: Default TechDocs container used at docs generation-time is now [v0.3.5](https://github.com/backstage/techdocs-container/releases/tag/v0.3.5).
-- f3c7eec64b: Updated to properly join URL segments under any OS for both AWS S3 and GCP
-- Updated dependencies
- - @backstage/backend-common@0.9.9
-
-## 0.10.5
-
-### Patch Changes
-
-- d207f6ee9e: Support optional bucketRootPath configuration parameter in S3 and GCS publishers
-- Updated dependencies
- - @backstage/config@0.1.11
- - @backstage/errors@0.1.4
- - @backstage/integration@0.6.9
- - @backstage/backend-common@0.9.8
- - @backstage/catalog-model@0.9.6
- - @backstage/search-common@0.2.1
-
-## 0.10.4
-
-### Patch Changes
-
-- 87f5b9db13: Use docs/README.md or README.md as fallback if docs/index.md is missing
-- 36e67d2f24: Internal updates to apply more strict checks to throw errors.
-- Updated dependencies
- - @backstage/backend-common@0.9.7
- - @backstage/errors@0.1.3
- - @backstage/catalog-model@0.9.5
-
-## 0.10.3
-
-### Patch Changes
-
-- 156421c59a: Sets the default techdocs docker image to the [latest released version - v0.3.3](https://github.com/backstage/techdocs-container/releases/tag/v0.3.3).
-- Updated dependencies
- - @backstage/catalog-model@0.9.4
- - @backstage/backend-common@0.9.6
- - @backstage/integration@0.6.7
-
-## 0.10.2
-
-### Patch Changes
-
-- 1c75e8bf98: Add more context to techdocs log lines when files are not found along with
- ensuring that the routers return 404 with a descriptive message.
-- e92f0f728b: Locks the version of the default docker image used to generate TechDocs. As of
- this changelog entry, it is v0.3.2!
-- Updated dependencies
- - @backstage/backend-common@0.9.5
- - @backstage/integration@0.6.6
-
-## 0.10.1
-
-### Patch Changes
-
-- 96fef17a18: Upgrade git-parse-url to v11.6.0
-- Updated dependencies
- - @backstage/backend-common@0.9.3
- - @backstage/integration@0.6.4
-
-## 0.10.0
-
-### Minor Changes
-
-- 8b0f6f860: Set the correct `edit_uri` or `repo_url` for documentation pages that are hosted on GitHub and GitLab.
-
- The constructor of the `TechDocsGenerator` changed.
- Prefer the use of `TechdocsGenerator.fromConfig(โฆ)` instead:
-
- ```diff
- - const techdocsGenerator = new TechdocsGenerator({
- + const techdocsGenerator = TechdocsGenerator.fromConfig(config, {
- logger,
- containerRunner,
- - config,
- });
- ```
-
-### Patch Changes
-
-- 30ed662a3: Adding in-context search to TechDocs Reader component. Using existing search-backend to query for indexed search results scoped into a specific entity's techdocs. Needs TechDocsCollator enabled on the backend to work.
-
- Adding extra information to indexed tech docs documents for search.
-
-- 3624616e7: "Local" (out-of-the-box) publisher explicitly follows lower-case entity triplet
- logic.
-- 67ba7e088: Only write the updated `mkdocs.yml` file if the content was updated.
-
- This keeps local files unchanged if the `dir` annotation is used in combination with the `file` location.
-
-- 8eab6be6a: Force using `posix` path for cloud storage
-- Updated dependencies
- - @backstage/integration@0.6.3
- - @backstage/search-common@0.2.0
- - @backstage/catalog-model@0.9.1
- - @backstage/backend-common@0.9.1
-
-## 0.9.0
-
-### Minor Changes
-
-- 58452cdb7: OpenStack Swift Client changed with Trendyol's OpenStack Swift SDK.
-
- ## Migration from old OpenStack Swift Configuration
-
- Let's assume we have the old OpenStack Swift configuration here.
-
- ```yaml
- techdocs:
- publisher:
- type: 'openStackSwift'
- openStackSwift:
- containerName: 'name-of-techdocs-storage-bucket'
- credentials:
- username: ${OPENSTACK_SWIFT_STORAGE_USERNAME}
- password: ${OPENSTACK_SWIFT_STORAGE_PASSWORD}
- authUrl: ${OPENSTACK_SWIFT_STORAGE_AUTH_URL}
- keystoneAuthVersion: ${OPENSTACK_SWIFT_STORAGE_AUTH_VERSION}
- domainId: ${OPENSTACK_SWIFT_STORAGE_DOMAIN_ID}
- domainName: ${OPENSTACK_SWIFT_STORAGE_DOMAIN_NAME}
- region: ${OPENSTACK_SWIFT_STORAGE_REGION}
- ```
-
- ##### Step 1: Change the credential keys
-
- Since the new SDK uses _Application Credentials_ to authenticate OpenStack, we
- need to change the keys `credentials.username` to `credentials.id`,
- `credentials.password` to `credentials.secret` and use Application Credential ID
- and secret here. For more detail about credentials look
- [here](https://docs.openstack.org/api-ref/identity/v3/?expanded=password-authentication-with-unscoped-authorization-detail,authenticating-with-an-application-credential-detail#authenticating-with-an-application-credential).
-
- ##### Step 2: Remove the unused keys
-
- Since the new SDK doesn't use the old way authentication, we don't need the keys
- `openStackSwift.keystoneAuthVersion`, `openStackSwift.domainId`,
- `openStackSwift.domainName` and `openStackSwift.region`. So you can remove them.
-
- ##### Step 3: Add Swift URL
-
- The new SDK needs the OpenStack Swift connection URL for connecting the Swift.
- So you need to add a new key called `openStackSwift.swiftUrl` and give the
- OpenStack Swift url here. Example url should look like that:
- `https://example.com:6780/swift/v1`
-
- ##### That's it!
-
- Your new configuration should look like that!
-
- ```yaml
- techdocs:
- publisher:
- type: 'openStackSwift'
- openStackSwift:
- containerName: 'name-of-techdocs-storage-bucket'
- credentials:
- id: ${OPENSTACK_SWIFT_STORAGE_APPLICATION_CREDENTIALS_ID}
- secret: ${OPENSTACK_SWIFT_STORAGE_APPLICATION_CREDENTIALS_SECRET}
- authUrl: ${OPENSTACK_SWIFT_STORAGE_AUTH_URL}
- swiftUrl: ${OPENSTACK_SWIFT_STORAGE_SWIFT_URL}
- ```
-
-- c772d9a84: TechDocs sites can now be accessed using paths containing entity triplets of
- any case (e.g. `/docs/namespace/KIND/name` or `/docs/namespace/kind/name`).
-
- If you do not use an external storage provider for serving TechDocs, this is a
- transparent change and no action is required from you.
-
- If you _do_ use an external storage provider for serving TechDocs (one of\* GCS,
- AWS S3, or Azure Blob Storage), you must run a migration command against your
- storage provider before updating.
-
- [A migration guide is available here](https://backstage.io/docs/features/techdocs/how-to-guides#how-to-migrate-from-techdocs-alpha-to-beta).
-
- - (\*) We're seeking help from the community to bring OpenStack Swift support
- [to feature parity](https://github.com/backstage/backstage/issues/6763) with the above.
-
-### Patch Changes
-
-- Updated dependencies
- - @backstage/backend-common@0.9.0
- - @backstage/integration@0.6.2
- - @backstage/config@0.1.8
-
-## 0.8.1
-
-### Patch Changes
-
-- bc405be6e: Stale TechDocs content (files that had previously been published but which have
- since been removed) is now removed from storage at publish-time. This is now
- supported by the following publishers:
-
- - Google GCS
- - AWS S3
- - Azure Blob Storage
-
- You may need to apply a greater level of permissions (e.g. the ability to
- delete objects in your storage provider) to any credentials/accounts used by
- the TechDocs CLI or TechDocs backend in order for this change to take effect.
-
- For more details, see [#6132][issue-ref].
-
- [issue-ref]: https://github.com/backstage/backstage/issues/6132
-
-- Updated dependencies
- - @backstage/integration@0.6.0
- - @backstage/backend-common@0.8.9
-
-## 0.8.0
-
-### Minor Changes
-
-- 48ea3d25b: TechDocs has dropped all support for the long-ago deprecated git-based common
- prepares as well as all corresponding values in `backstage.io/techdocs-ref`
- annotations.
-
- Entities whose `backstage.io/techdocs-ref` annotation values still begin with
- `github:`, `gitlab:`, `bitbucket:`, or `azure/api:` will no longer be generated
- by TechDocs. Be sure to update these values so that they align with their
- expected format and your usage of TechDocs.
-
- For details, see [this explainer on TechDocs ref annotation values][how].
-
- [how]: https://backstage.io/docs/features/techdocs/how-to-guides#how-to-understand-techdocs-ref-annotation-values
-
-### Patch Changes
-
-- Updated dependencies
- - @backstage/backend-common@0.8.8
- - @backstage/config@0.1.6
- - @backstage/integration@0.5.9
-
-## 0.7.1
-
-### Patch Changes
-
-- 59a5fa319: Migrated files are now printed when `techdocs-cli migrate` is run with the
- `--verbose` flag set.
-- 54356336e: TechDocs generator stage now supports `mkdocs.yaml` file, in addition to `.yml`
- depending on whichever is present at the time of generation. (Assumes the
- latest `spotify/techdocs` container, running mkdocs `v1.2.2` or greater).
-
-## 0.7.0
-
-### Minor Changes
-
-- d32d01e5b: Improve the annotation `backstage.io/techdocs-ref: dir:` that links to a path that is relative to the source of the annotated entity.
- This annotation works with the basic and the recommended flow, however, it will be most useful with the basic approach.
-
- This change remove the deprecation of the `dir` reference and provides first-class support for it.
- In addition, this change removes the support of the deprecated `github`, `gitlab`, and `azure/api` locations from the `dir` reference preparer.
-
- #### Example Usage
-
- The annotation is convenient if the documentation is stored in the same location, i.e. the same git repository, as the `catalog-info.yaml`.
- While it is still supported to add full URLs such as `backstage.io/techdocs-ref: url:https://...` for custom setups, documentation is mostly stored in the same repository as the entity definition.
- By automatically resolving the target relative to the registration location of the entity, the configuration overhead for this default setup is minimized.
- Since it leverages the `@backstage/integrations` package for the URL resolution, this is compatible with every supported source.
-
- Consider the following examples:
-
- 1. "I have a repository with a single `catalog-info.yaml` and a TechDocs page in the root folder!"
-
- ```
- https://github.com/backstage/example/tree/main/
- |- catalog-info.yaml
- | > apiVersion: backstage.io/v1alpha1
- | > kind: Component
- | > metadata:
- | > name: example
- | > annotations:
- | > backstage.io/techdocs-ref: dir:. # -> same folder
- | > spec: {}
- |- docs/
- |- mkdocs.yml
- ```
-
- 2. "I have a repository with a single `catalog-info.yaml` and my TechDocs page in located in a folder!"
-
- ```
- https://bitbucket.org/my-owner/my-project/src/master/
- |- catalog-info.yaml
- | > apiVersion: backstage.io/v1alpha1
- | > kind: Component
- | > metadata:
- | > name: example
- | > annotations:
- | > backstage.io/techdocs-ref: dir:./some-folder # -> subfolder
- | > spec: {}
- |- some-folder/
- |- docs/
- |- mkdocs.yml
- ```
-
- 3. "I have a mono repository that hosts multiple components!"
-
- ```
- https://dev.azure.com/organization/project/_git/repository
- |- my-1st-module/
- |- catalog-info.yaml
- | > apiVersion: backstage.io/v1alpha1
- | > kind: Component
- | > metadata:
- | > name: my-1st-module
- | > annotations:
- | > backstage.io/techdocs-ref: dir:. # -> same folder
- | > spec: {}
- |- docs/
- |- mkdocs.yml
- |- my-2nd-module/
- |- catalog-info.yaml
- | > apiVersion: backstage.io/v1alpha1
- | > kind: Component
- | > metadata:
- | > name: my-2nd-module
- | > annotations:
- | > backstage.io/techdocs-ref: dir:. # -> same folder
- | > spec: {}
- |- docs/
- |- mkdocs.yml
- |- catalog-info.yaml
- | > apiVersion: backstage.io/v1alpha1
- | > kind: Location
- | > metadata:
- | > name: example
- | > spec:
- | > targets:
- | > - ./*/catalog-info.yaml
- ```
-
-### Patch Changes
-
-- 6e5aed1c9: Fix validation of mkdocs.yml docs_dir
-- 250984333: Add link to https://backstage.io/docs/features/techdocs/configuration in the log warning message about updating techdocs.generate key.
-- Updated dependencies
- - @backstage/backend-common@0.8.7
-
-## 0.6.8
-
-### Patch Changes
-
-- d5eaab91d: Adds custom docker image support to the techdocs generator. This change adds a new `techdocs.generator` configuration key and deprecates the existing `techdocs.generators.techdocs` key.
-
- ```yaml
- techdocs:
- # recommended, going forward:
- generator:
- runIn: 'docker' # or 'local'
- # New optional settings
- dockerImage: my-org/techdocs # use a custom docker image
- pullImage: false # disable automatic pulling of image (e.g. if custom docker login is required)
- # legacy (deprecated):
- generators:
- techdocs: 'docker' # or 'local'
- ```
-
-- c18e8eb91: Provide optional `logger: Logger` and `logStream: Writable` arguments to the `GeneratorBase#run(...)` command.
- They receive all log messages that are emitted during the generator run.
-- ae84b20cf: Revert the upgrade to `fs-extra@10.0.0` as that seemed to have broken all installs inexplicably.
-- Updated dependencies
- - @backstage/backend-common@0.8.6
-
-## 0.6.7
-
-### Patch Changes
-
-- 683308ecf: Fix openStack swift publisher encoding issue. Remove utf8 forced encoding on binary files
-- 6841e0113: fix minor version of git-url-parse as 11.5.x introduced a bug for Bitbucket Server
-- Updated dependencies
- - @backstage/integration@0.5.8
- - @backstage/catalog-model@0.9.0
- - @backstage/backend-common@0.8.5
-
-## 0.6.6
-
-### Patch Changes
-
-- ab5cc376f: Use new utilities from `@backstage/backend-common` for safely resolving child paths
-- b47fc34bc: Update "service catalog" references to "software catalog"
-- Updated dependencies
- - @backstage/backend-common@0.8.4
- - @backstage/integration@0.5.7
-
-## 0.6.5
-
-### Patch Changes
-
-- c17c0fcf9: Adding additional checks on tech docs to prevent folder traversal via mkdocs.yml docs_dir value.
-- Updated dependencies
- - @backstage/catalog-model@0.8.4
-
-## 0.6.4
-
-### Patch Changes
-
-- aad98c544: Fixes multiple XSS and sanitization bypass vulnerabilities in TechDocs.
-- 090594755: Support parsing `mkdocs.yml` files that are using custom yaml tags like
- `!!python/name:materialx.emoji.twemoji`.
-- Updated dependencies [ebe802bc4]
-- Updated dependencies [49d7ec169]
- - @backstage/catalog-model@0.8.1
- - @backstage/integration@0.5.5
-
-## 0.6.3
-
-### Patch Changes
-
-- 8cefadca0: Adding validation to mkdocs.yml parsing to prevent directory tree traversing
-- Updated dependencies [0fd4ea443]
-- Updated dependencies [add62a455]
-- Updated dependencies [704875e26]
- - @backstage/integration@0.5.4
- - @backstage/catalog-model@0.8.0
-
-## 0.6.2
-
-### Patch Changes
-
-- 65e6c4541: Remove circular dependencies
-- Updated dependencies [f7f7783a3]
-- Updated dependencies [c7dad9218]
-- Updated dependencies [65e6c4541]
-- Updated dependencies [68fdbf014]
-- Updated dependencies [5001de908]
- - @backstage/catalog-model@0.7.10
- - @backstage/backend-common@0.8.1
- - @backstage/integration@0.5.3
-
-## 0.6.1
-
-### Patch Changes
-
-- e04f1ccfb: Fixed a bug that prevented loading static assets from GCS, S3, Azure, and OpenStackSwift whose keys contain spaces or other special characters.
-- Updated dependencies [22fd8ce2a]
-- Updated dependencies [10c008a3a]
-- Updated dependencies [f9fb4a205]
-- Updated dependencies [16be1d093]
- - @backstage/backend-common@0.8.0
- - @backstage/catalog-model@0.7.9
-
-## 0.6.0
-
-### Minor Changes
-
-- e0bfd3d44: Migrate the package to use the `ContainerRunner` interface instead of `runDockerContainer(โฆ)`.
- It also no longer provides the `ContainerRunner` as an input to the `GeneratorBase#run(โฆ)` function, but expects it as a constructor parameter instead.
-
- If you use the `TechdocsGenerator` you need to update the usage:
-
- ```diff
- + const containerRunner = new DockerContainerRunner({ dockerClient });
-
- - const generator = new TechdocsGenerator(logger, config);
- + const techdocsGenerator = new TechdocsGenerator({
- + logger,
- + containerRunner,
- + config,
- + });
-
- await this.generator.run({
- inputDir: preparedDir,
- outputDir,
- - dockerClient: this.dockerClient,
- parsedLocationAnnotation,
- etag: newEtag,
- });
- ```
-
-### Patch Changes
-
-- e9e56b01a: Adding optional config to enable S3-like API for tech-docs using s3ForcePathStyle option.
- This allows providers like LocalStack, Minio and Wasabi (+possibly others) to be used to host tech docs.
-- Updated dependencies [e0bfd3d44]
-- Updated dependencies [38ca05168]
-- Updated dependencies [d8b81fd28]
- - @backstage/backend-common@0.7.0
- - @backstage/integration@0.5.2
- - @backstage/catalog-model@0.7.8
- - @backstage/config@0.1.5
-
-## 0.5.1
-
-### Patch Changes
-
-- f4af06ebe: Gracefully handle HTTP request failures in download method of AzureBlobStorage publisher.
-
-## 0.5.0
-
-### Minor Changes
-
-- bc9d62f4f: Move the sanity checks of the publisher configurations to a dedicated `PublisherBase#getReadiness()` method instead of throwing an error when doing `Publisher.fromConfig(...)`.
- You should include the check when your backend to get early feedback about a potential misconfiguration:
-
- ```diff
- // packages/backend/src/plugins/techdocs.ts
-
- export default async function createPlugin({
- logger,
- config,
- discovery,
- reader,
- }: PluginEnvironment): Promise {
- // ...
-
- const publisher = await Publisher.fromConfig(config, {
- logger,
- discovery,
- })
-
- + // checks if the publisher is working and logs the result
- + await publisher.getReadiness();
-
- // Docker client (conditionally) used by the generators, based on techdocs.generators config.
- const dockerClient = new Docker();
-
- // ...
- }
- ```
-
- If you want to crash your application on invalid configurations, you can throw an `Error` to preserve the old behavior.
- Please be aware that this is not the recommended for the use in a Backstage backend but might be helpful in CLI tools such as the `techdocs-cli`.
-
- ```ts
- const publisher = await Publisher.fromConfig(config, {
- logger,
- discovery,
- });
-
- const ready = await publisher.getReadiness();
- if (!ready.isAvailable) {
- throw new Error('Invalid TechDocs publisher configuration');
- }
- ```
-
-### Patch Changes
-
-- Updated dependencies [bb5055aee]
-- Updated dependencies [5d0740563]
- - @backstage/catalog-model@0.7.7
-
-## 0.4.5
-
-### Patch Changes
-
-- 8686eb38c: Use errors from `@backstage/errors`
-- 424742dc1: Applies only if you use TechDocs local builder instead of building on CI/CD i.e. if `techdocs.builder` in your `app-config.yaml` is set to `'local'`
-
- Improvements
-
- 1. Do not check for updates in the repository if a check has been made in the last 60 seconds. This is to prevent the annoying check for update on every page switch or load.
- 2. No need to maintain an in-memory etag storage, and use the one stored in `techdocs_metadata.json` file alongside generated docs.
-
- New feature
-
- 1. You can now use a mix of basic and recommended setup i.e. `techdocs.builder` is `'local'` but using an external cloud storage instead of local storage. Previously, in this setup, the docs would never get updated.
-
-- Updated dependencies [8686eb38c]
-- Updated dependencies [0434853a5]
-- Updated dependencies [8686eb38c]
- - @backstage/backend-common@0.6.0
- - @backstage/config@0.1.4
-
-## 0.4.4
-
-### Patch Changes
-
-- d7245b733: Remove runDockerContainer, and start using the utility function provided by @backstage/backend-common
-- 0b42fff22: Make use of parseLocationReference/stringifyLocationReference
-- 2ef5bc7ea: Implement proper AWS Credentials precedence with assume-role and explicit credentials
-- aa095e469: OpenStack Swift publisher added for tech-docs.
-- bc46435f5: - Improve deprecation warning messaging in logs.
- - Replace temp folder path from git provider domain(`source`) to full git host name (`resource`). (See: https://github.com/IonicaBizau/git-url-parse#giturlparseurl)
-- a501128db: Refactor log messaging to improve clarity
-- ca4a904f6: Add an optional configuration option for setting the url endpoint for AWS S3 publisher: `techdocs.publisher.awsS3.endpoint`
-- Updated dependencies [277644e09]
-- Updated dependencies [52f613030]
-- Updated dependencies [d7245b733]
-- Updated dependencies [0b42fff22]
-- Updated dependencies [905cbfc96]
-- Updated dependencies [761698831]
-- Updated dependencies [d4e77ec5f]
- - @backstage/integration@0.5.1
- - @backstage/backend-common@0.5.6
- - @backstage/catalog-model@0.7.4
-
-## 0.4.3
-
-### Patch Changes
-
-- f43192207: remove usage of res.send() for res.json() and res.end() to ensure content types are more consistently application/json on backend responses and error cases
-- 61299519f: Remove read-store-upload loop when uploading S3 objects for TechDocs
-- Updated dependencies [12d8f27a6]
-- Updated dependencies [497859088]
-- Updated dependencies [8adb48df4]
- - @backstage/catalog-model@0.7.3
- - @backstage/backend-common@0.5.5
-
-## 0.4.2
-
-### Patch Changes
-
-- 2499f6cde: Add support for assuming role in AWS integrations
-- 1e4ddd71d: Fix AWS, GCS and Azure publisher to work on Windows.
-- Updated dependencies [bad21a085]
-- Updated dependencies [a1f5e6545]
- - @backstage/catalog-model@0.7.2
- - @backstage/config@0.1.3
-
-## 0.4.1
-
-### Patch Changes
-
-- fb28da212: Switched to using `'x-access-token'` for authenticating Git over HTTPS towards GitHub.
-- 26e143e60: After TechDocs generate step, insert build timestamp to techdocs_metadata.json
-- c6655413d: Improved error reporting in AzureBlobStorage to surface errors when fetching metadata and uploading files fails.
-- 44414239f: Pass user and group ID when invoking docker container. When TechDocs invokes Docker, docker could be run as a `root` user which results in generation of files by applications run by non-root user (e.g. TechDocs) will not have access to modify. This PR passes in current user and group ID to docker so that the file permissions of the generated files and folders are correct.
-- b0a41c707: Add etag of the prepared file tree to techdocs_metadata.json in the storage
-- Updated dependencies [16fb1d03a]
-- Updated dependencies [491f3a0ec]
-- Updated dependencies [491f3a0ec]
-- Updated dependencies [434b4e81a]
-- Updated dependencies [fb28da212]
- - @backstage/backend-common@0.5.4
- - @backstage/integration@0.5.0
-
-## 0.4.0
-
-### Minor Changes
-
-- 08142b256: URL Preparer will now use proper etag based caching introduced in https://github.com/backstage/backstage/pull/4120. Previously, builds used to be cached for 30 minutes.
-
-### Patch Changes
-
-- 77ad0003a: Revert AWS SDK version to v2
-- 08142b256: TechDocs will throw warning in backend logs when legacy git preparer or dir preparer is used to preparer docs. Migrate to URL Preparer by updating `backstage.io/techdocs-ref` annotation to be prefixed with `url:`.
- Detailed docs are here https://backstage.io/docs/features/techdocs/how-to-guides#how-to-use-url-reader-in-techdocs-prepare-step
- See benefits and reason for doing so https://github.com/backstage/backstage/issues/4409
-- Updated dependencies [ffffea8e6]
-- Updated dependencies [82b2c11b6]
-- Updated dependencies [965e200c6]
-- Updated dependencies [ffffea8e6]
-- Updated dependencies [5a5163519]
- - @backstage/backend-common@0.5.3
- - @backstage/integration@0.4.0
-
-## 0.3.7
-
-### Patch Changes
-
-- c777df180: 1. Added option to use Azure Blob Storage as a choice to store the static generated files for TechDocs.
-- e44925723: `techdocs.requestUrl` and `techdocs.storageUrl` are now optional configs and the discovery API will be used to get the URL where techdocs plugin is hosted.
-- f0320190d: dir preparer will use URL Reader in its implementation.
-- Updated dependencies [c4abcdb60]
-- Updated dependencies [2430ee7c2]
-- Updated dependencies [6e612ce25]
-- Updated dependencies [025e122c3]
-- Updated dependencies [064c513e1]
-- Updated dependencies [7881f2117]
-- Updated dependencies [3149bfe63]
-- Updated dependencies [2e62aea6f]
-- Updated dependencies [11cb5ef94]
- - @backstage/integration@0.3.2
- - @backstage/backend-common@0.5.2
- - @backstage/catalog-model@0.7.1
-
-## 0.3.6
-
-### Patch Changes
-
-- 9dd057662: Upgrade [git-url-parse](https://www.npmjs.com/package/git-url-parse) to [v11.4.4](https://github.com/IonicaBizau/git-url-parse/pull/125) which fixes parsing an Azure DevOps branch ref.
-- db2328c88: Add rate limiter for concurrent execution of file uploads in AWS and Google publishers
-- Updated dependencies [26a3a6cf0]
-- Updated dependencies [664dd08c9]
-- Updated dependencies [6800da78d]
-- Updated dependencies [9dd057662]
- - @backstage/backend-common@0.5.1
- - @backstage/integration@0.3.1
-
-## 0.3.5
-
-### Patch Changes
-
-- 53c9c51f2: TechDocs backend now streams files through from Google Cloud Storage to the browser, improving memory usage.
-- a5e27d5c1: Create type for TechDocsMetadata (#3716)
-
- This change introduces a new type (TechDocsMetadata) in packages/techdocs-common. This type is then introduced in the endpoint response in techdocs-backend and in the api interface in techdocs (frontend).
-
-- Updated dependencies [def2307f3]
-- Updated dependencies [0b135e7e0]
-- Updated dependencies [294a70cab]
-- Updated dependencies [fa8ba330a]
-- Updated dependencies [0ea032763]
-- Updated dependencies [5345a1f98]
-- Updated dependencies [ed6baab66]
-- Updated dependencies [09a370426]
-- Updated dependencies [a93f42213]
- - @backstage/catalog-model@0.7.0
- - @backstage/backend-common@0.5.0
- - @backstage/integration@0.3.0
-
-## 0.3.4
-
-### Patch Changes
-
-- a594a7257: @backstage/techdocs-common can now be imported in an environment without @backstage/plugin-techdocs-backend being installed.
-
-## 0.3.3
-
-### Patch Changes
-
-- 68ad5af51: Improve techdocs-common Generator API for it to be used by techdocs-cli. TechDocs generator.run function now takes
- an input AND an output directory. Most probably you use techdocs-common via plugin-techdocs-backend, and so there
- is no breaking change for you.
- But if you use techdocs-common separately, you need to create an output directory and pass into the generator.
-- 371f67ecd: fix to-string breakage of binary files
-- f1e74777a: Fix bug where binary files (`png`, etc.) could not load when using AWS or GCS publisher.
-- dbe4450c3: Google Cloud authentication in TechDocs has been improved.
-
- 1. `techdocs.publisher.googleGcs.credentials` is now optional. If it is missing, `GOOGLE_APPLICATION_CREDENTIALS`
- environment variable (and some other methods) will be used to authenticate.
- Read more here https://cloud.google.com/docs/authentication/production
-
- 2. `techdocs.publisher.googleGcs.projectId` is no longer used. You can remove it from your `app-config.yaml`.
-
-- 5826d0973: AWS SDK version bump for TechDocs.
-- b3b9445df: AWS S3 authentication in TechDocs has been improved.
-
- 1. `techdocs.publisher.awsS3.bucketName` is now the only required config. `techdocs.publisher.awsS3.credentials` and `techdocs.publisher.awsS3.region` are optional.
-
- 2. If `techdocs.publisher.awsS3.credentials` and `techdocs.publisher.awsS3.region` are missing, the AWS environment variables `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_REGION` will be used. There are more better ways of setting up AWS authentication. Read the guide at https://backstage.io/docs/features/techdocs/using-cloud-storage
-
-- Updated dependencies [466354aaa]
-- Updated dependencies [f3b064e1c]
-- Updated dependencies [abbee6fff]
-- Updated dependencies [147fadcb9]
- - @backstage/integration@0.2.0
- - @backstage/catalog-model@0.6.1
- - @backstage/backend-common@0.4.3
-
-## 0.3.2
-
-### Patch Changes
-
-- 7ec525481: 1. Added option to use AWS S3 as a choice to store the static generated files for TechDocs.
-- f8ba88ded: Fix for `integration.github.apiBaseUrl` configuration not properly overriding apiBaseUrl used by techdocs
-- 00042e73c: Moving the Git actions to isomorphic-git instead of the node binding version of nodegit
-- Updated dependencies [5ecd50f8a]
-- Updated dependencies [00042e73c]
-- Updated dependencies [0829ff126]
-- Updated dependencies [036a84373]
- - @backstage/backend-common@0.4.2
- - @backstage/integration@0.1.5
-
-## 0.3.1
-
-### Patch Changes
-
-- 8804e8981: Using @backstage/integration package for GitHub/GitLab/Azure tokens and request options.
-
- Most probably you do not have to make any changes in the app because of this change.
- However, if you are using the `DirectoryPreparer` or `CommonGitPreparer` exported by
- `@backstage/techdocs-common` package, you now need to add pass in a `config` (from `@backstage/config`)
- instance as argument.
-
- ```
-
- const directoryPreparer = new DirectoryPreparer(logger);
- const commonGitPreparer = new CommonGitPreparer(logger);
-
- const directoryPreparer = new DirectoryPreparer(config, logger);
- const commonGitPreparer = new CommonGitPreparer(config, logger);
- ```
-
-## 0.3.0
-
-### Minor Changes
-
-- a8573e53b: techdocs-backend: Simplified file, removing individual preparers and generators.
- techdocs-backend: UrlReader is now available to use in preparers.
-
- In your Backstage app, `packages/backend/plugins/techdocs.ts` file has now been simplified,
- to remove registering individual preparers and generators.
-
- Please update the file when upgrading the version of `@backstage/plugin-techdocs-backend` package.
-
- ```typescript
- const preparers = await Preparers.fromConfig(config, {
- logger,
- reader,
- });
-
- const generators = await Generators.fromConfig(config, {
- logger,
- });
-
- const publisher = await Publisher.fromConfig(config, {
- logger,
- discovery,
- });
- ```
-
- You should be able to remove unnecessary imports, and just do
-
- ```typescript
- import {
- createRouter,
- Preparers,
- Generators,
- Publisher,
- } from '@backstage/plugin-techdocs-backend';
- ```
-
-## 0.2.0
-
-### Minor Changes
-
-- dae4f3983: _Breaking changes_
-
- 1. Added option to use Google Cloud Storage as a choice to store the static generated files for TechDocs.
- It can be configured using `techdocs.publisher.type` option in `app-config.yaml`.
- Step-by-step guide to configure GCS is available here https://backstage.io/docs/features/techdocs/using-cloud-storage
- Set `techdocs.publisher.type` to `'local'` if you want to continue using local filesystem to store TechDocs files.
-
- 2. `techdocs.builder` is now required and can be set to `'local'` or `'external'`. (Set it to `'local'` for now, since CI/CD build
- workflow for TechDocs will be available soon (in few weeks)).
- If builder is set to 'local' and you open a TechDocs page, `techdocs-backend` will try to generate the docs, publish to storage and
- show the generated docs afterwords.
- If builder is set to `'external'`, `techdocs-backend` will only fetch the docs and will NOT try to generate and publish. In this case of `'external'`,
- we assume that docs are being built in the CI/CD pipeline of the repository.
- TechDocs will not assume a default value for `techdocs.builder`. It is better to explicitly define it in the `app-config.yaml`.
-
- 3. When configuring TechDocs in your backend, there is a difference in how a new publisher is created.
-
- ```
- --- const publisher = new LocalPublish(logger, discovery);
- +++ const publisher = Publisher.fromConfig(config, logger, discovery);
- ```
-
- Based on the config `techdocs.publisher.type`, the publisher could be either Local publisher or Google Cloud Storage publisher.
-
- 4. `techdocs.storageUrl` is now a required config. Should be `http://localhost:7007/api/techdocs/static/docs` in most setups.
-
- 5. Parts of `@backstage/plugin-techdocs-backend` have been moved to a new package `@backstage/techdocs-common` to generate docs. Also to publish docs
- to-and-fro between TechDocs and a storage (either local or external). However, a Backstage app does NOT need to import the `techdocs-common` package -
- app should only import `@backstage/plugin-techdocs` and `@backstage/plugin-techdocs-backend`.
-
- _Patch changes_
-
- 1. See all of TechDocs config options and its documentation https://backstage.io/docs/features/techdocs/configuration
-
- 2. Logic about serving static files and metadata retrieval have been abstracted away from the router in `techdocs-backend` to the instance of publisher.
-
- 3. Removed Material UI Spinner from TechDocs header. Spinners cause unnecessary UX distraction.
- Case 1 (when docs are built and are to be served): Spinners appear for a split second before the name of site shows up. This unnecessarily distracts eyes because spinners increase the size of the Header. A dot (.) would do fine. Definitely more can be done.
- Case 2 (when docs are being generated): There is already a linear progress bar (which is recommended in Storybook).
-
-### Patch Changes
-
-- Updated dependencies [c911061b7]
-- Updated dependencies [1d1c2860f]
-- Updated dependencies [0e6298f7e]
-- Updated dependencies [4eafdec4a]
-- Updated dependencies [ac3560b42]
- - @backstage/catalog-model@0.6.0
- - @backstage/backend-common@0.4.1
diff --git a/packages/techdocs-common/README.md b/packages/techdocs-common/README.md
deleted file mode 100644
index 052eae7ab2..0000000000
--- a/packages/techdocs-common/README.md
+++ /dev/null
@@ -1,5 +0,0 @@
-# @backstage/techdocs-common
-
-This package has been moved to `@backstage/plugin-techdocs-node` and is no
-longer maintained. Please update any dependencies you have on this package
-accordingly.
diff --git a/packages/techdocs-common/api-report.md b/packages/techdocs-common/api-report.md
deleted file mode 100644
index 62851bbd68..0000000000
--- a/packages/techdocs-common/api-report.md
+++ /dev/null
@@ -1,9 +0,0 @@
-## API Report File for "@backstage/techdocs-common"
-
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-
-```ts
-export * from '@backstage/plugin-techdocs-node';
-
-// (No @packageDocumentation comment for this package)
-```
diff --git a/packages/techdocs-common/package.json b/packages/techdocs-common/package.json
deleted file mode 100644
index fbc7052f9c..0000000000
--- a/packages/techdocs-common/package.json
+++ /dev/null
@@ -1,47 +0,0 @@
-{
- "name": "@backstage/techdocs-common",
- "description": "No longer maintained. Use @backstage/plugin-techdocs-node instead.",
- "version": "0.11.15",
- "main": "src/index.ts",
- "types": "src/index.ts",
- "private": false,
- "publishConfig": {
- "access": "public",
- "main": "dist/index.cjs.js",
- "types": "dist/index.d.ts"
- },
- "backstage": {
- "role": "node-library"
- },
- "homepage": "https://backstage.io",
- "repository": {
- "type": "git",
- "url": "https://github.com/backstage/backstage",
- "directory": "packages/techdocs-common"
- },
- "license": "Apache-2.0",
- "files": [
- "dist"
- ],
- "scripts": {
- "build": "backstage-cli package build",
- "lint": "backstage-cli package lint",
- "test": "backstage-cli package test",
- "prepack": "backstage-cli package prepack",
- "postpack": "backstage-cli package postpack",
- "clean": "backstage-cli package clean",
- "start": "backstage-cli package start"
- },
- "bugs": {
- "url": "https://github.com/backstage/backstage/issues"
- },
- "dependencies": {
- "@backstage/plugin-techdocs-node": "1.1.1"
- },
- "devDependencies": {},
- "jest": {
- "roots": [
- ".."
- ]
- }
-}
diff --git a/packages/test-utils/CHANGELOG.md b/packages/test-utils/CHANGELOG.md
index 1fd8aa82c7..d8e9a8dd11 100644
--- a/packages/test-utils/CHANGELOG.md
+++ b/packages/test-utils/CHANGELOG.md
@@ -1,5 +1,27 @@
# @backstage/test-utils
+## 1.1.1
+
+### Patch Changes
+
+- 8f7b1835df: Updated dependency `msw` to `^0.41.0`.
+- Updated dependencies
+ - @backstage/core-app-api@1.0.3
+ - @backstage/core-plugin-api@1.0.3
+ - @backstage/plugin-permission-common@0.6.2
+ - @backstage/plugin-permission-react@0.4.2
+
+## 1.1.1-next.0
+
+### Patch Changes
+
+- 8f7b1835df: Updated dependency `msw` to `^0.41.0`.
+- Updated dependencies
+ - @backstage/core-app-api@1.0.3-next.0
+ - @backstage/core-plugin-api@1.0.3-next.0
+ - @backstage/plugin-permission-common@0.6.2-next.0
+ - @backstage/plugin-permission-react@0.4.2-next.0
+
## 1.1.0
### Minor Changes
diff --git a/packages/test-utils/package.json b/packages/test-utils/package.json
index 870882463f..0c52f47325 100644
--- a/packages/test-utils/package.json
+++ b/packages/test-utils/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/test-utils",
"description": "Utilities to test Backstage plugins and apps.",
- "version": "1.1.0",
+ "version": "1.1.1",
"private": false,
"publishConfig": {
"access": "public",
@@ -34,10 +34,10 @@
},
"dependencies": {
"@backstage/config": "^1.0.1",
- "@backstage/core-app-api": "^1.0.2",
- "@backstage/core-plugin-api": "^1.0.2",
- "@backstage/plugin-permission-common": "^0.6.1",
- "@backstage/plugin-permission-react": "^0.4.1",
+ "@backstage/core-app-api": "^1.0.3",
+ "@backstage/core-plugin-api": "^1.0.3",
+ "@backstage/plugin-permission-common": "^0.6.2",
+ "@backstage/plugin-permission-react": "^0.4.2",
"@backstage/theme": "^0.2.15",
"@backstage/types": "^1.0.0",
"@material-ui/core": "^4.12.2",
@@ -55,10 +55,10 @@
"react": "^16.13.1 || ^17.0.0"
},
"devDependencies": {
- "@backstage/cli": "^0.17.1",
+ "@backstage/cli": "^0.17.2",
"@types/jest": "^26.0.7",
"@types/node": "^16.11.26",
- "msw": "^0.35.0"
+ "msw": "^0.42.0"
},
"files": [
"dist"
diff --git a/packages/theme/package.json b/packages/theme/package.json
index 537b6bab96..d10999fefb 100644
--- a/packages/theme/package.json
+++ b/packages/theme/package.json
@@ -36,7 +36,7 @@
"@material-ui/core": "^4.12.2"
},
"devDependencies": {
- "@backstage/cli": "^0.17.1-next.0"
+ "@backstage/cli": "^0.17.2-next.0"
},
"files": [
"dist"
diff --git a/packages/types/package.json b/packages/types/package.json
index 112247fefe..5ea10709ec 100644
--- a/packages/types/package.json
+++ b/packages/types/package.json
@@ -34,7 +34,7 @@
},
"dependencies": {},
"devDependencies": {
- "@backstage/cli": "^0.17.1-next.0",
+ "@backstage/cli": "^0.17.2-next.0",
"@types/zen-observable": "^0.8.0",
"zen-observable": "^0.8.15"
},
diff --git a/packages/version-bridge/package.json b/packages/version-bridge/package.json
index c7fdf46951..81ec8017a1 100644
--- a/packages/version-bridge/package.json
+++ b/packages/version-bridge/package.json
@@ -37,7 +37,7 @@
"react": "^16.13.1 || ^17.0.0"
},
"devDependencies": {
- "@backstage/cli": "^0.17.1-next.0",
+ "@backstage/cli": "^0.17.2-next.0",
"@testing-library/jest-dom": "^5.10.1",
"@testing-library/react": "^12.1.3",
"@testing-library/react-hooks": "^8.0.0"
diff --git a/plugins/adr-backend/CHANGELOG.md b/plugins/adr-backend/CHANGELOG.md
index 20b2cf507c..946df67282 100644
--- a/plugins/adr-backend/CHANGELOG.md
+++ b/plugins/adr-backend/CHANGELOG.md
@@ -1,5 +1,49 @@
# @backstage/plugin-adr-backend
+## 0.1.1
+
+### Patch Changes
+
+- 8f7b1835df: Updated dependency `msw` to `^0.41.0`.
+- Updated dependencies
+ - @backstage/plugin-search-common@0.3.5
+ - @backstage/backend-common@0.14.0
+ - @backstage/integration@1.2.1
+ - @backstage/catalog-client@1.0.3
+ - @backstage/catalog-model@1.0.3
+ - @backstage/plugin-adr-common@0.1.1
+
+## 0.1.1-next.2
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-search-common@0.3.5-next.1
+ - @backstage/backend-common@0.14.0-next.2
+ - @backstage/integration@1.2.1-next.2
+
+## 0.1.1-next.1
+
+### Patch Changes
+
+- 8f7b1835df: Updated dependency `msw` to `^0.41.0`.
+- Updated dependencies
+ - @backstage/backend-common@0.13.6-next.1
+ - @backstage/catalog-client@1.0.3-next.0
+ - @backstage/integration@1.2.1-next.1
+ - @backstage/catalog-model@1.0.3-next.0
+ - @backstage/plugin-search-common@0.3.5-next.0
+ - @backstage/plugin-adr-common@0.1.1-next.1
+
+## 0.1.1-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.13.6-next.0
+ - @backstage/integration@1.2.1-next.0
+ - @backstage/plugin-adr-common@0.1.1-next.0
+
## 0.1.0
### Minor Changes
diff --git a/plugins/adr-backend/package.json b/plugins/adr-backend/package.json
index bc7526754e..c192e0cd85 100644
--- a/plugins/adr-backend/package.json
+++ b/plugins/adr-backend/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-adr-backend",
- "version": "0.1.0",
+ "version": "0.1.1",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -29,14 +29,14 @@
"postpack": "backstage-cli package postpack"
},
"dependencies": {
- "@backstage/backend-common": "^0.13.3",
- "@backstage/catalog-client": "^1.0.2",
- "@backstage/catalog-model": "^1.0.2",
+ "@backstage/backend-common": "^0.14.0",
+ "@backstage/catalog-client": "^1.0.3",
+ "@backstage/catalog-model": "^1.0.3",
"@backstage/config": "^1.0.1",
"@backstage/errors": "^1.0.0",
- "@backstage/integration": "^1.2.0",
- "@backstage/plugin-adr-common": "^0.1.0",
- "@backstage/plugin-search-common": "^0.3.4",
+ "@backstage/integration": "^1.2.1",
+ "@backstage/plugin-adr-common": "^0.1.1",
+ "@backstage/plugin-search-common": "^0.3.5",
"luxon": "^2.0.2",
"marked": "^4.0.14",
"winston": "^3.2.1",
@@ -44,11 +44,11 @@
"yn": "^4.0.0"
},
"devDependencies": {
- "@backstage/cli": "^0.17.1",
+ "@backstage/cli": "^0.17.2",
"@types/marked": "^4.0.0",
"@types/supertest": "^2.0.8",
"supertest": "^6.1.3",
- "msw": "^0.35.0"
+ "msw": "^0.42.0"
},
"files": [
"dist"
diff --git a/plugins/adr-common/CHANGELOG.md b/plugins/adr-common/CHANGELOG.md
index 506d2b3d3d..d9a0207248 100644
--- a/plugins/adr-common/CHANGELOG.md
+++ b/plugins/adr-common/CHANGELOG.md
@@ -1,5 +1,30 @@
# @backstage/plugin-adr-common
+## 0.1.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-search-common@0.3.5
+ - @backstage/integration@1.2.1
+ - @backstage/catalog-model@1.0.3
+
+## 0.1.1-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/integration@1.2.1-next.1
+ - @backstage/catalog-model@1.0.3-next.0
+ - @backstage/plugin-search-common@0.3.5-next.0
+
+## 0.1.1-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/integration@1.2.1-next.0
+
## 0.1.0
### Minor Changes
diff --git a/plugins/adr-common/package.json b/plugins/adr-common/package.json
index 69774b4f9a..d3607f3a99 100644
--- a/plugins/adr-common/package.json
+++ b/plugins/adr-common/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-adr-common",
"description": "Common functionalities for the adr plugin",
- "version": "0.1.0",
+ "version": "0.1.1",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -30,12 +30,12 @@
"postpack": "backstage-cli package postpack"
},
"dependencies": {
- "@backstage/catalog-model": "^1.0.2",
- "@backstage/integration": "^1.2.0",
- "@backstage/plugin-search-common": "^0.3.4"
+ "@backstage/catalog-model": "^1.0.3",
+ "@backstage/integration": "^1.2.1",
+ "@backstage/plugin-search-common": "^0.3.5"
},
"devDependencies": {
- "@backstage/cli": "^0.17.1"
+ "@backstage/cli": "^0.17.2"
},
"files": [
"dist"
diff --git a/plugins/adr/CHANGELOG.md b/plugins/adr/CHANGELOG.md
index 735f333b2f..61e28f3834 100644
--- a/plugins/adr/CHANGELOG.md
+++ b/plugins/adr/CHANGELOG.md
@@ -1,5 +1,45 @@
# @backstage/plugin-adr
+## 0.1.1
+
+### Patch Changes
+
+- 8f7b1835df: Updated dependency `msw` to `^0.41.0`.
+- a6458a120b: Adding term highlighting support to `AdrSearchResultListItem`
+- Updated dependencies
+ - @backstage/plugin-catalog-react@1.1.1
+ - @backstage/plugin-search-common@0.3.5
+ - @backstage/plugin-search-react@0.2.1
+ - @backstage/core-components@0.9.5
+ - @backstage/core-plugin-api@1.0.3
+ - @backstage/integration-react@1.1.1
+ - @backstage/plugin-adr-common@0.1.1
+
+## 0.1.1-next.1
+
+### Patch Changes
+
+- 8f7b1835df: Updated dependency `msw` to `^0.41.0`.
+- Updated dependencies
+ - @backstage/core-components@0.9.5-next.1
+ - @backstage/core-plugin-api@1.0.3-next.0
+ - @backstage/integration-react@1.1.1-next.1
+ - @backstage/plugin-catalog-react@1.1.1-next.1
+ - @backstage/plugin-search-react@0.2.1-next.0
+ - @backstage/plugin-search-common@0.3.5-next.0
+ - @backstage/plugin-adr-common@0.1.1-next.1
+
+## 0.1.1-next.0
+
+### Patch Changes
+
+- a6458a120b: Adding term highlighting support to `AdrSearchResultListItem`
+- Updated dependencies
+ - @backstage/plugin-catalog-react@1.1.1-next.0
+ - @backstage/core-components@0.9.5-next.0
+ - @backstage/integration-react@1.1.1-next.0
+ - @backstage/plugin-adr-common@0.1.1-next.0
+
## 0.1.0
### Minor Changes
diff --git a/plugins/adr/api-report.md b/plugins/adr/api-report.md
index 61cf231784..fbe04b1dc4 100644
--- a/plugins/adr/api-report.md
+++ b/plugins/adr/api-report.md
@@ -47,10 +47,12 @@ export const AdrReader: {
export const AdrSearchResultListItem: ({
lineClamp,
highlight,
+ rank,
result,
}: {
lineClamp?: number | undefined;
highlight?: ResultHighlight | undefined;
+ rank?: number | undefined;
result: AdrDocument;
}) => JSX.Element;
diff --git a/plugins/adr/package.json b/plugins/adr/package.json
index 2274bdebd4..194cc44ae4 100644
--- a/plugins/adr/package.json
+++ b/plugins/adr/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-adr",
- "version": "0.1.0",
+ "version": "0.1.1",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -22,13 +22,13 @@
"postpack": "backstage-cli package postpack"
},
"dependencies": {
- "@backstage/core-components": "^0.9.4",
- "@backstage/core-plugin-api": "^1.0.2",
- "@backstage/integration-react": "^1.1.0",
- "@backstage/plugin-adr-common": "^0.1.0",
- "@backstage/plugin-catalog-react": "^1.1.0",
- "@backstage/plugin-search-common": "^0.3.4",
- "@backstage/plugin-search-react": "^0.2.0",
+ "@backstage/core-components": "^0.9.5",
+ "@backstage/core-plugin-api": "^1.0.3",
+ "@backstage/integration-react": "^1.1.1",
+ "@backstage/plugin-adr-common": "^0.1.1",
+ "@backstage/plugin-catalog-react": "^1.1.1",
+ "@backstage/plugin-search-common": "^0.3.5",
+ "@backstage/plugin-search-react": "^0.2.1",
"@backstage/theme": "^0.2.15",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
@@ -44,10 +44,10 @@
"react": "^16.13.1 || ^17.0.0"
},
"devDependencies": {
- "@backstage/cli": "^0.17.1",
- "@backstage/core-app-api": "^1.0.2",
- "@backstage/dev-utils": "^1.0.2",
- "@backstage/test-utils": "^1.1.0",
+ "@backstage/cli": "^0.17.2",
+ "@backstage/core-app-api": "^1.0.3",
+ "@backstage/dev-utils": "^1.0.3",
+ "@backstage/test-utils": "^1.1.1",
"@testing-library/jest-dom": "^5.10.1",
"@testing-library/react": "^12.1.3",
"@testing-library/user-event": "^14.0.0",
@@ -55,7 +55,7 @@
"@types/jest": "*",
"@types/node": "*",
"cross-fetch": "^3.1.5",
- "msw": "^0.35.0"
+ "msw": "^0.42.0"
},
"files": [
"dist"
diff --git a/plugins/adr/src/search/AdrSearchResultListItem.tsx b/plugins/adr/src/search/AdrSearchResultListItem.tsx
index 484bac336e..677e39fc11 100644
--- a/plugins/adr/src/search/AdrSearchResultListItem.tsx
+++ b/plugins/adr/src/search/AdrSearchResultListItem.tsx
@@ -24,6 +24,7 @@ import {
makeStyles,
} from '@material-ui/core';
import { Link } from '@backstage/core-components';
+import { useAnalytics } from '@backstage/core-plugin-api';
import { AdrDocument } from '@backstage/plugin-adr-common';
import { ResultHighlight } from '@backstage/plugin-search-common';
import { HighlightedSearchResultText } from '@backstage/plugin-search-react';
@@ -46,16 +47,26 @@ const useStyles = makeStyles({
export const AdrSearchResultListItem = ({
lineClamp = 5,
highlight,
+ rank,
result,
}: {
lineClamp?: number;
highlight?: ResultHighlight;
+ rank?: number;
result: AdrDocument;
}) => {
const classes = useStyles();
+ const analytics = useAnalytics();
+
+ const handleClick = () => {
+ analytics.captureEvent('discover', result.title, {
+ attributes: { to: result.location },
+ value: rank,
+ });
+ };
return (
-
{
+ // load the default widgets
+ const definitionWidgets = defaultDefinitionWidgets();
+ // add the grpc-docs api widget to the definition widgets
+ definitionWidgets.push(grpcDocsApiWidget);
+ return {
+ getApiDefinitionWidget: (apiEntity: ApiEntity) => {
+ // find the widget for the type of api entity
+ return definitionWidgets.find(d => d.type === apiEntity.spec.type);
+ },
+ };
+ },
+ }),
+];
+```
+
+### Set the type in your api entities
+
+This widget will render the generated `protoc-gen-doc` descriptors with the `grpc-docs` package. For this make sure you use the `grpc-docs` as the type in the API catalog file.
+
+```yaml
+apiVersion: backstage.io/v1alpha1
+kind: API
+metadata:
+ name: hello-world
+ description: Hello World example for gRPC
+spec:
+ type: grpc-docs
+ lifecycle: deprecated
+ owner: foo
+ definition:
+ $text: https://fetch-my-json.com/awesome-resource.json
+```
diff --git a/plugins/api-docs-module-protoc-gen-doc/api-report.md b/plugins/api-docs-module-protoc-gen-doc/api-report.md
new file mode 100644
index 0000000000..696fee2a20
--- /dev/null
+++ b/plugins/api-docs-module-protoc-gen-doc/api-report.md
@@ -0,0 +1,14 @@
+## API Report File for "@backstage/plugin-api-docs-module-protoc-gen-doc"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+/// {
+ getKey = async (header: JWTHeaderParameters): Promise => {
if (!header.kid) {
throw new AuthenticationError('No key id was specified in header');
}
@@ -208,7 +208,7 @@ export class AwsAlbAuthProvider implements AuthProviderRouteHandlers {
keyValue.export({ format: 'pem', type: 'spki' }),
);
return keyValue;
- }
+ };
}
/**
diff --git a/plugins/auth-node/CHANGELOG.md b/plugins/auth-node/CHANGELOG.md
index 34deb4db30..4381303915 100644
--- a/plugins/auth-node/CHANGELOG.md
+++ b/plugins/auth-node/CHANGELOG.md
@@ -1,5 +1,38 @@
# @backstage/plugin-auth-node
+## 0.2.2
+
+### Patch Changes
+
+- 5ca0b86b88: Address corner cases where the key store was not being created at startup
+- 8f7b1835df: Updated dependency `msw` to `^0.41.0`.
+- 9079a78078: Added configurable algorithms array for IdentityClient
+- Updated dependencies
+ - @backstage/backend-common@0.14.0
+
+## 0.2.2-next.2
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.14.0-next.2
+
+## 0.2.2-next.1
+
+### Patch Changes
+
+- 8f7b1835df: Updated dependency `msw` to `^0.41.0`.
+- Updated dependencies
+ - @backstage/backend-common@0.13.6-next.1
+
+## 0.2.2-next.0
+
+### Patch Changes
+
+- 9079a78078: Added configurable algorithms array for IdentityClient
+- Updated dependencies
+ - @backstage/backend-common@0.13.6-next.0
+
## 0.2.1
### Patch Changes
diff --git a/plugins/auth-node/package.json b/plugins/auth-node/package.json
index 301843239b..2281d2d35e 100644
--- a/plugins/auth-node/package.json
+++ b/plugins/auth-node/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-auth-node",
- "version": "0.2.1",
+ "version": "0.2.2",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -23,7 +23,7 @@
"start": "backstage-cli package start"
},
"dependencies": {
- "@backstage/backend-common": "^0.13.3",
+ "@backstage/backend-common": "^0.14.0",
"@backstage/config": "^1.0.1",
"@backstage/errors": "^1.0.0",
"jose": "^4.6.0",
@@ -31,9 +31,9 @@
"winston": "^3.2.1"
},
"devDependencies": {
- "@backstage/cli": "^0.17.1",
+ "@backstage/cli": "^0.17.2",
"lodash": "^4.17.21",
- "msw": "^0.35.0",
+ "msw": "^0.42.0",
"uuid": "^8.0.0"
},
"files": [
diff --git a/plugins/auth-node/src/IdentityClient.ts b/plugins/auth-node/src/IdentityClient.ts
index 3799222447..0773d22c26 100644
--- a/plugins/auth-node/src/IdentityClient.ts
+++ b/plugins/auth-node/src/IdentityClient.ts
@@ -141,7 +141,7 @@ export class IdentityClient {
// Add a small margin in case clocks are out of sync
const issuedAfterLastRefresh =
payload?.iat && payload.iat > this.keyStoreUpdated - CLOCK_MARGIN_S;
- if (!keyStoreHasKey && issuedAfterLastRefresh) {
+ if (!this.keyStore || (!keyStoreHasKey && issuedAfterLastRefresh)) {
const url = await this.discovery.getBaseUrl('auth');
const endpoint = new URL(`${url}/.well-known/jwks.json`);
this.keyStore = createRemoteJWKSet(endpoint);
diff --git a/plugins/azure-devops-backend/CHANGELOG.md b/plugins/azure-devops-backend/CHANGELOG.md
index 2755a273a5..f9d414bef9 100644
--- a/plugins/azure-devops-backend/CHANGELOG.md
+++ b/plugins/azure-devops-backend/CHANGELOG.md
@@ -1,5 +1,35 @@
# @backstage/plugin-azure-devops-backend
+## 0.3.12
+
+### Patch Changes
+
+- 8f7b1835df: Updated dependency `msw` to `^0.41.0`.
+- Updated dependencies
+ - @backstage/backend-common@0.14.0
+
+## 0.3.12-next.2
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.14.0-next.2
+
+## 0.3.12-next.1
+
+### Patch Changes
+
+- 8f7b1835df: Updated dependency `msw` to `^0.41.0`.
+- Updated dependencies
+ - @backstage/backend-common@0.13.6-next.1
+
+## 0.3.12-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.13.6-next.0
+
## 0.3.11
### Patch Changes
diff --git a/plugins/azure-devops-backend/README.md b/plugins/azure-devops-backend/README.md
index e71021471b..5dc0570bd2 100644
--- a/plugins/azure-devops-backend/README.md
+++ b/plugins/azure-devops-backend/README.md
@@ -60,7 +60,10 @@ Here's how to get the backend up and running:
// ...
async function main() {
// ...
+ // Add this line under the other lines that follow the useHotMemoize pattern
const azureDevOpsEnv = useHotMemoize(module, () => createEnv('azure-devops'));
+ // ...
+ // Insert this line under the other lines that add their routers to apiRouter in the same way
apiRouter.use('/azure-devops', await azureDevOps(azureDevOpsEnv));
```
diff --git a/plugins/azure-devops-backend/package.json b/plugins/azure-devops-backend/package.json
index 852e9bf03a..e85ba907c6 100644
--- a/plugins/azure-devops-backend/package.json
+++ b/plugins/azure-devops-backend/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-azure-devops-backend",
- "version": "0.3.11",
+ "version": "0.3.12",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -23,7 +23,7 @@
"clean": "backstage-cli package clean"
},
"dependencies": {
- "@backstage/backend-common": "^0.13.3",
+ "@backstage/backend-common": "^0.14.0",
"@backstage/config": "^1.0.1",
"@backstage/plugin-azure-devops-common": "^0.2.3",
"@types/express": "^4.17.6",
@@ -35,10 +35,10 @@
"yn": "^4.0.0"
},
"devDependencies": {
- "@backstage/cli": "^0.17.1",
+ "@backstage/cli": "^0.17.2",
"@types/supertest": "^2.0.8",
"supertest": "^6.1.6",
- "msw": "^0.35.0"
+ "msw": "^0.42.0"
},
"files": [
"dist",
diff --git a/plugins/azure-devops-common/package.json b/plugins/azure-devops-common/package.json
index 50fe55aa34..0f52082db6 100644
--- a/plugins/azure-devops-common/package.json
+++ b/plugins/azure-devops-common/package.json
@@ -32,7 +32,7 @@
"clean": "backstage-cli package clean"
},
"devDependencies": {
- "@backstage/cli": "^0.17.1"
+ "@backstage/cli": "^0.17.2-next.0"
},
"files": [
"dist"
diff --git a/plugins/azure-devops/CHANGELOG.md b/plugins/azure-devops/CHANGELOG.md
index 3c5466611e..8de9bd00a8 100644
--- a/plugins/azure-devops/CHANGELOG.md
+++ b/plugins/azure-devops/CHANGELOG.md
@@ -1,5 +1,35 @@
# @backstage/plugin-azure-devops
+## 0.1.22
+
+### Patch Changes
+
+- 8f7b1835df: Updated dependency `msw` to `^0.41.0`.
+- Updated dependencies
+ - @backstage/plugin-catalog-react@1.1.1
+ - @backstage/core-components@0.9.5
+ - @backstage/core-plugin-api@1.0.3
+ - @backstage/catalog-model@1.0.3
+
+## 0.1.22-next.1
+
+### Patch Changes
+
+- 8f7b1835df: Updated dependency `msw` to `^0.41.0`.
+- Updated dependencies
+ - @backstage/core-components@0.9.5-next.1
+ - @backstage/core-plugin-api@1.0.3-next.0
+ - @backstage/catalog-model@1.0.3-next.0
+ - @backstage/plugin-catalog-react@1.1.1-next.1
+
+## 0.1.22-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-catalog-react@1.1.1-next.0
+ - @backstage/core-components@0.9.5-next.0
+
## 0.1.21
### Patch Changes
diff --git a/plugins/azure-devops/api-report.md b/plugins/azure-devops/api-report.md
index 9760340771..b366166d95 100644
--- a/plugins/azure-devops/api-report.md
+++ b/plugins/azure-devops/api-report.md
@@ -5,10 +5,21 @@
```ts
/// ;
+ // (undocumented)
+ getBuildRuns(
+ projectName: string,
+ repoName?: string,
+ definitionName?: string,
+ options?: BuildRunOptions,
+ ): Promise<{
+ items: BuildRun[];
+ }>;
+ // (undocumented)
+ getDashboardPullRequests(
+ projectName: string,
+ ): Promise;
+ // (undocumented)
+ getGitTags(
+ projectName: string,
+ repoName: string,
+ ): Promise<{
+ items: GitTag[];
+ }>;
+ // (undocumented)
+ getPullRequests(
+ projectName: string,
+ repoName: string,
+ options?: PullRequestOptions,
+ ): Promise<{
+ items: PullRequest[];
+ }>;
+ // (undocumented)
+ getRepoBuilds(
+ projectName: string,
+ repoName: string,
+ options?: RepoBuildOptions,
+ ): Promise<{
+ items: RepoBuild[];
+ }>;
+ // (undocumented)
+ getUserTeamIds(userId: string): Promise;
+}
+
+// Warning: (ae-missing-release-tag) "azureDevOpsApiRef" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export const azureDevOpsApiRef: ApiRef;
+
+// Warning: (ae-missing-release-tag) "AzureDevOpsClient" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export class AzureDevOpsClient implements AzureDevOpsApi {
+ constructor(options: {
+ discoveryApi: DiscoveryApi;
+ identityApi: IdentityApi;
+ });
+ // (undocumented)
+ getAllTeams(): Promise;
+ // (undocumented)
+ getBuildRuns(
+ projectName: string,
+ repoName?: string,
+ definitionName?: string,
+ options?: BuildRunOptions,
+ ): Promise<{
+ items: BuildRun[];
+ }>;
+ // (undocumented)
+ getDashboardPullRequests(
+ projectName: string,
+ ): Promise;
+ // (undocumented)
+ getGitTags(
+ projectName: string,
+ repoName: string,
+ ): Promise<{
+ items: GitTag[];
+ }>;
+ // (undocumented)
+ getPullRequests(
+ projectName: string,
+ repoName: string,
+ options?: PullRequestOptions,
+ ): Promise<{
+ items: PullRequest[];
+ }>;
+ // (undocumented)
+ getRepoBuilds(
+ projectName: string,
+ repoName: string,
+ options?: RepoBuildOptions,
+ ): Promise<{
+ items: RepoBuild[];
+ }>;
+ // (undocumented)
+ getUserTeamIds(userId: string): Promise;
+}
+
// Warning: (ae-missing-release-tag) "azureDevOpsPlugin" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
diff --git a/plugins/azure-devops/package.json b/plugins/azure-devops/package.json
index 9ddf73f5e4..8fad3a8697 100644
--- a/plugins/azure-devops/package.json
+++ b/plugins/azure-devops/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-azure-devops",
- "version": "0.1.21",
+ "version": "0.1.22",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -30,12 +30,12 @@
"clean": "backstage-cli package clean"
},
"dependencies": {
- "@backstage/catalog-model": "^1.0.2",
- "@backstage/core-components": "^0.9.4",
- "@backstage/core-plugin-api": "^1.0.2",
+ "@backstage/catalog-model": "^1.0.3",
+ "@backstage/core-components": "^0.9.5",
+ "@backstage/core-plugin-api": "^1.0.3",
"@backstage/errors": "^1.0.0",
"@backstage/plugin-azure-devops-common": "^0.2.3",
- "@backstage/plugin-catalog-react": "^1.1.0",
+ "@backstage/plugin-catalog-react": "^1.1.1",
"@backstage/theme": "^0.2.15",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
@@ -49,17 +49,17 @@
"react": "^16.13.1 || ^17.0.0"
},
"devDependencies": {
- "@backstage/cli": "^0.17.1",
- "@backstage/core-app-api": "^1.0.2",
- "@backstage/dev-utils": "^1.0.2",
- "@backstage/test-utils": "^1.1.0",
+ "@backstage/cli": "^0.17.2",
+ "@backstage/core-app-api": "^1.0.3",
+ "@backstage/dev-utils": "^1.0.3",
+ "@backstage/test-utils": "^1.1.1",
"@testing-library/jest-dom": "^5.10.1",
"@testing-library/react": "^12.1.3",
"@testing-library/user-event": "^14.0.0",
"@types/jest": "^26.0.7",
"@types/node": "^16.11.26",
"cross-fetch": "^3.1.5",
- "msw": "^0.35.0"
+ "msw": "^0.42.0"
},
"files": [
"dist"
diff --git a/plugins/azure-devops/src/index.ts b/plugins/azure-devops/src/index.ts
index 48177ee830..e65c1d02a3 100644
--- a/plugins/azure-devops/src/index.ts
+++ b/plugins/azure-devops/src/index.ts
@@ -26,6 +26,8 @@ export {
export { AzurePullRequestsIcon } from './components/AzurePullRequestsIcon';
+export * from './api';
+
export { FilterType } from './components/PullRequestsPage';
export type {
PullRequestColumnConfig,
diff --git a/plugins/badges-backend/CHANGELOG.md b/plugins/badges-backend/CHANGELOG.md
index 0a40812f64..3b80f26ca1 100644
--- a/plugins/badges-backend/CHANGELOG.md
+++ b/plugins/badges-backend/CHANGELOG.md
@@ -1,5 +1,37 @@
# @backstage/plugin-badges-backend
+## 0.1.27
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.14.0
+ - @backstage/catalog-client@1.0.3
+ - @backstage/catalog-model@1.0.3
+
+## 0.1.27-next.2
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.14.0-next.2
+
+## 0.1.27-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.13.6-next.1
+ - @backstage/catalog-client@1.0.3-next.0
+ - @backstage/catalog-model@1.0.3-next.0
+
+## 0.1.27-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.13.6-next.0
+
## 0.1.26
### Patch Changes
diff --git a/plugins/badges-backend/package.json b/plugins/badges-backend/package.json
index cae6a418fd..d1b5d094d9 100644
--- a/plugins/badges-backend/package.json
+++ b/plugins/badges-backend/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-badges-backend",
"description": "A Backstage backend plugin that generates README badges for your entities",
- "version": "0.1.26",
+ "version": "0.1.27",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -34,9 +34,9 @@
"clean": "backstage-cli package clean"
},
"dependencies": {
- "@backstage/backend-common": "^0.13.3",
- "@backstage/catalog-client": "^1.0.2",
- "@backstage/catalog-model": "^1.0.2",
+ "@backstage/backend-common": "^0.14.0",
+ "@backstage/catalog-client": "^1.0.3",
+ "@backstage/catalog-model": "^1.0.3",
"@backstage/config": "^1.0.1",
"@backstage/errors": "^1.0.0",
"@types/express": "^4.17.6",
@@ -48,7 +48,7 @@
"yn": "^4.0.0"
},
"devDependencies": {
- "@backstage/cli": "^0.17.1",
+ "@backstage/cli": "^0.17.2",
"@types/supertest": "^2.0.8",
"supertest": "^6.1.3"
},
diff --git a/plugins/badges/CHANGELOG.md b/plugins/badges/CHANGELOG.md
index 33a7b76a73..ff7b290b68 100644
--- a/plugins/badges/CHANGELOG.md
+++ b/plugins/badges/CHANGELOG.md
@@ -1,5 +1,35 @@
# @backstage/plugin-badges
+## 0.2.30
+
+### Patch Changes
+
+- 8f7b1835df: Updated dependency `msw` to `^0.41.0`.
+- Updated dependencies
+ - @backstage/plugin-catalog-react@1.1.1
+ - @backstage/core-components@0.9.5
+ - @backstage/core-plugin-api@1.0.3
+ - @backstage/catalog-model@1.0.3
+
+## 0.2.30-next.1
+
+### Patch Changes
+
+- 8f7b1835df: Updated dependency `msw` to `^0.41.0`.
+- Updated dependencies
+ - @backstage/core-components@0.9.5-next.1
+ - @backstage/core-plugin-api@1.0.3-next.0
+ - @backstage/catalog-model@1.0.3-next.0
+ - @backstage/plugin-catalog-react@1.1.1-next.1
+
+## 0.2.30-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-catalog-react@1.1.1-next.0
+ - @backstage/core-components@0.9.5-next.0
+
## 0.2.29
### Patch Changes
diff --git a/plugins/badges/package.json b/plugins/badges/package.json
index 618e6ae7f4..aeade2c50a 100644
--- a/plugins/badges/package.json
+++ b/plugins/badges/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/plugin-badges",
"description": "A Backstage plugin that generates README badges for your entities",
- "version": "0.2.29",
+ "version": "0.2.30",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -30,11 +30,11 @@
"clean": "backstage-cli package clean"
},
"dependencies": {
- "@backstage/catalog-model": "^1.0.2",
- "@backstage/core-components": "^0.9.4",
- "@backstage/core-plugin-api": "^1.0.2",
+ "@backstage/catalog-model": "^1.0.3",
+ "@backstage/core-components": "^0.9.5",
+ "@backstage/core-plugin-api": "^1.0.3",
"@backstage/errors": "^1.0.0",
- "@backstage/plugin-catalog-react": "^1.1.0",
+ "@backstage/plugin-catalog-react": "^1.1.1",
"@backstage/theme": "^0.2.15",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
@@ -46,17 +46,17 @@
"react": "^16.13.1 || ^17.0.0"
},
"devDependencies": {
- "@backstage/cli": "^0.17.1",
- "@backstage/core-app-api": "^1.0.2",
- "@backstage/dev-utils": "^1.0.2",
- "@backstage/test-utils": "^1.1.0",
+ "@backstage/cli": "^0.17.2",
+ "@backstage/core-app-api": "^1.0.3",
+ "@backstage/dev-utils": "^1.0.3",
+ "@backstage/test-utils": "^1.1.1",
"@testing-library/jest-dom": "^5.10.1",
"@testing-library/react": "^12.1.3",
"@testing-library/user-event": "^14.0.0",
"@types/jest": "^26.0.7",
"@types/node": "^16.11.26",
"cross-fetch": "^3.1.5",
- "msw": "^0.35.0"
+ "msw": "^0.42.0"
},
"files": [
"dist"
diff --git a/plugins/bazaar-backend/CHANGELOG.md b/plugins/bazaar-backend/CHANGELOG.md
index 31fd97df3d..4b0cb04530 100644
--- a/plugins/bazaar-backend/CHANGELOG.md
+++ b/plugins/bazaar-backend/CHANGELOG.md
@@ -1,5 +1,29 @@
# @backstage/plugin-bazaar-backend
+## 0.1.17
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.14.0
+ - @backstage/backend-test-utils@0.1.25
+
+## 0.1.17-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.14.0-next.2
+ - @backstage/backend-test-utils@0.1.25-next.2
+
+## 0.1.17-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/backend-common@0.13.6-next.0
+ - @backstage/backend-test-utils@0.1.25-next.0
+
## 0.1.16
### Patch Changes
diff --git a/plugins/bazaar-backend/package.json b/plugins/bazaar-backend/package.json
index 8a940e5045..5f723a9dfb 100644
--- a/plugins/bazaar-backend/package.json
+++ b/plugins/bazaar-backend/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-bazaar-backend",
- "version": "0.1.16",
+ "version": "0.1.17",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -23,8 +23,8 @@
"clean": "backstage-cli package clean"
},
"dependencies": {
- "@backstage/backend-common": "^0.13.3",
- "@backstage/backend-test-utils": "^0.1.24",
+ "@backstage/backend-common": "^0.14.0",
+ "@backstage/backend-test-utils": "^0.1.25",
"@backstage/config": "^1.0.1",
"@types/express": "^4.17.6",
"express": "^4.17.1",
@@ -34,7 +34,7 @@
"yn": "^4.0.0"
},
"devDependencies": {
- "@backstage/cli": "^0.17.1"
+ "@backstage/cli": "^0.17.2"
},
"files": [
"dist",
diff --git a/plugins/bazaar/CHANGELOG.md b/plugins/bazaar/CHANGELOG.md
index 3ae149ecfb..911390ee28 100644
--- a/plugins/bazaar/CHANGELOG.md
+++ b/plugins/bazaar/CHANGELOG.md
@@ -1,5 +1,41 @@
# @backstage/plugin-bazaar
+## 0.1.21
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-catalog@1.3.0
+ - @backstage/plugin-catalog-react@1.1.1
+ - @backstage/cli@0.17.2
+ - @backstage/core-components@0.9.5
+ - @backstage/catalog-client@1.0.3
+ - @backstage/core-plugin-api@1.0.3
+ - @backstage/catalog-model@1.0.3
+
+## 0.1.21-next.1
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/core-components@0.9.5-next.1
+ - @backstage/cli@0.17.2-next.1
+ - @backstage/catalog-client@1.0.3-next.0
+ - @backstage/core-plugin-api@1.0.3-next.0
+ - @backstage/catalog-model@1.0.3-next.0
+ - @backstage/plugin-catalog@1.2.1-next.1
+ - @backstage/plugin-catalog-react@1.1.1-next.1
+
+## 0.1.21-next.0
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/plugin-catalog-react@1.1.1-next.0
+ - @backstage/plugin-catalog@1.2.1-next.0
+ - @backstage/cli@0.17.2-next.0
+ - @backstage/core-components@0.9.5-next.0
+
## 0.1.20
### Patch Changes
diff --git a/plugins/bazaar/package.json b/plugins/bazaar/package.json
index ca26e3c800..cb3318b4e9 100644
--- a/plugins/bazaar/package.json
+++ b/plugins/bazaar/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-bazaar",
- "version": "0.1.20",
+ "version": "0.1.21",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
@@ -24,13 +24,13 @@
"clean": "backstage-cli package clean"
},
"dependencies": {
- "@backstage/catalog-client": "^1.0.2",
- "@backstage/catalog-model": "^1.0.2",
- "@backstage/cli": "^0.17.1",
- "@backstage/core-components": "^0.9.4",
- "@backstage/core-plugin-api": "^1.0.2",
- "@backstage/plugin-catalog": "^1.2.0",
- "@backstage/plugin-catalog-react": "^1.1.0",
+ "@backstage/catalog-client": "^1.0.3",
+ "@backstage/catalog-model": "^1.0.3",
+ "@backstage/cli": "^0.17.2",
+ "@backstage/core-components": "^0.9.5",
+ "@backstage/core-plugin-api": "^1.0.3",
+ "@backstage/plugin-catalog": "^1.3.0",
+ "@backstage/plugin-catalog-react": "^1.1.1",
"@date-io/luxon": "1.x",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
@@ -47,8 +47,8 @@
"react": "^16.13.1 || ^17.0.0"
},
"devDependencies": {
- "@backstage/cli": "^0.17.1",
- "@backstage/dev-utils": "^1.0.2",
+ "@backstage/cli": "^0.17.2",
+ "@backstage/dev-utils": "^1.0.3",
"@testing-library/jest-dom": "^5.10.1",
"cross-fetch": "^3.1.5"
},
diff --git a/packages/techdocs-common/.eslintrc.js b/plugins/bitbucket-cloud-common/.eslintrc.js
similarity index 100%
rename from packages/techdocs-common/.eslintrc.js
rename to plugins/bitbucket-cloud-common/.eslintrc.js
diff --git a/plugins/bitbucket-cloud-common/CHANGELOG.md b/plugins/bitbucket-cloud-common/CHANGELOG.md
new file mode 100644
index 0000000000..62100f2e0b
--- /dev/null
+++ b/plugins/bitbucket-cloud-common/CHANGELOG.md
@@ -0,0 +1,34 @@
+# @backstage/plugin-bitbucket-cloud-common
+
+## 0.1.0
+
+### Minor Changes
+
+- 1dffa7dd4d: Add new common library `bitbucket-cloud-common` with a client for Bitbucket Cloud.
+
+ This client can be reused across all packages and might be the future place for additional
+ features like managing the rate limits, etc.
+
+ The client itself was generated in parts using the `@openapitools/openapi-generator-cli`.
+
+### Patch Changes
+
+- 9122060776: Updated dependency `msw` to `^0.42.0`.
+- Updated dependencies
+ - @backstage/integration@1.2.1
+
+## 0.1.0-next.0
+
+### Minor Changes
+
+- 1dffa7dd4d: Add new common library `bitbucket-cloud-common` with a client for Bitbucket Cloud.
+
+ This client can be reused across all packages and might be the future place for additional
+ features like managing the rate limits, etc.
+
+ The client itself was generated in parts using the `@openapitools/openapi-generator-cli`.
+
+### Patch Changes
+
+- Updated dependencies
+ - @backstage/integration@1.2.1-next.1
diff --git a/plugins/bitbucket-cloud-common/README.md b/plugins/bitbucket-cloud-common/README.md
new file mode 100644
index 0000000000..f4c3bef1e2
--- /dev/null
+++ b/plugins/bitbucket-cloud-common/README.md
@@ -0,0 +1,64 @@
+# @backstage/plugin-bitbucket-cloud-common
+
+Welcome to the common package for bitbucket-cloud plugins!
+
+This common package provides a reusable API client for the Bitbucket Cloud API
+which can be reused in catalog-backend-module plugins, scaffolder modules, etc.
+
+Using a shared client allows to control all traffic going from Backstage to
+the Bitbucket Cloud API compared to separate clients or inline API calls.
+
+We may want to leverage this later to add rate limiting, etc.
+
+## How to maintain the generated code
+
+### Update the Models
+
+This command will
+
+1. [refresh the schema/OpenAPI Specification](#refresh-the-schema)
+2. [re-generate the models](#generate-models)
+3. [reduce the models to the minimal needed](#reduce-models)
+
+### Refresh the schema
+
+This command will download the latest version of the Bitbucket Cloud OpenAPI Specification
+and apply some mutations to fix bugs or improve the schema for a better code generation output.
+
+```sh
+yarn refresh-schema
+```
+
+### Generate Models
+
+The models used are created based on the [local OpenAPI Specification file](bitbucket-cloud.oas.json)
+using a code generator.
+Some post-cleanup is applied to improve the generated output.
+
+The client itself using the models is not generated.
+
+```sh
+yarn generate-models
+```
+
+### Reduce Models
+
+In order to keep the API surface minimal, this command helps to only keep the minimal part of the
+generated models by considering all `Models` module members directly or transitively used by the
+client implementation.
+
+```sh
+yarn reduce-models
+```
+
+## Adding a New Client Method
+
+If you want to add a new method to the client implementation which may use a new endpoint or "new" models
+you can
+
+1. optionally [refresh the schema](#refresh-the-schema) to get the latest version
+2. and [generate the models](#generate-models).
+
+At this point, you have **all** models usable for adding a new method using any of them.
+
+If you are ready with your addition to the client, you can [reduce the models to the minimal needed](#reduce-models).
diff --git a/plugins/bitbucket-cloud-common/api-report.md b/plugins/bitbucket-cloud-common/api-report.md
new file mode 100644
index 0000000000..367a47b9e3
--- /dev/null
+++ b/plugins/bitbucket-cloud-common/api-report.md
@@ -0,0 +1,386 @@
+## API Report File for "@backstage/plugin-bitbucket-cloud-common"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+import { BitbucketCloudIntegrationConfig } from '@backstage/integration';
+
+// @public (undocumented)
+export class BitbucketCloudClient {
+ // (undocumented)
+ static fromConfig(
+ config: BitbucketCloudIntegrationConfig,
+ ): BitbucketCloudClient;
+ // (undocumented)
+ listRepositoriesByWorkspace(
+ workspace: string,
+ options?: FilterAndSortOptions & PartialResponseOptions,
+ ): WithPagination;
+ // (undocumented)
+ searchCode(
+ workspace: string,
+ query: string,
+ options?: FilterAndSortOptions & PartialResponseOptions,
+ ): WithPagination;
+}
+
+// @public (undocumented)
+export type FilterAndSortOptions = {
+ q?: string;
+ sort?: string;
+};
+
+// @public (undocumented)
+export namespace Models {
+ export interface Account extends ModelObject {
+ account_status?: string;
+ // (undocumented)
+ created_on?: string;
+ // (undocumented)
+ display_name?: string;
+ // (undocumented)
+ has_2fa_enabled?: boolean;
+ // (undocumented)
+ links?: AccountLinks;
+ nickname?: string;
+ // (undocumented)
+ username?: string;
+ // (undocumented)
+ uuid?: string;
+ // (undocumented)
+ website?: string;
+ }
+ // (undocumented)
+ export interface AccountLinks {
+ // (undocumented)
+ avatar?: Link;
+ // (undocumented)
+ followers?: Link;
+ // (undocumented)
+ following?: Link;
+ // (undocumented)
+ html?: Link;
+ // (undocumented)
+ repositories?: Link;
+ // (undocumented)
+ self?: Link;
+ }
+ export interface Author extends ModelObject {
+ raw?: string;
+ // (undocumented)
+ user?: Account;
+ }
+ export interface BaseCommit extends ModelObject {
+ // (undocumented)
+ author?: Author;
+ // (undocumented)
+ date?: string;
+ // (undocumented)
+ hash?: string;
+ // (undocumented)
+ message?: string;
+ // (undocumented)
+ parents?: Array;
+ // (undocumented)
+ summary?: BaseCommitSummary;
+ }
+ // (undocumented)
+ export interface BaseCommitSummary {
+ html?: string;
+ markup?: BaseCommitSummaryMarkupEnum;
+ raw?: string;
+ }
+ const BaseCommitSummaryMarkupEnum: {
+ readonly Markdown: 'markdown';
+ readonly Creole: 'creole';
+ readonly Plaintext: 'plaintext';
+ };
+ export type BaseCommitSummaryMarkupEnum =
+ typeof BaseCommitSummaryMarkupEnum[keyof typeof BaseCommitSummaryMarkupEnum];
+ export interface Branch {
+ default_merge_strategy?: string;
+ // (undocumented)
+ links?: RefLinks;
+ merge_strategies?: Array;
+ name?: string;
+ // (undocumented)
+ target?: Commit;
+ // (undocumented)
+ type: string;
+ }
+ const BranchMergeStrategiesEnum: {
+ readonly MergeCommit: 'merge_commit';
+ readonly Squash: 'squash';
+ readonly FastForward: 'fast_forward';
+ };
+ export type BranchMergeStrategiesEnum =
+ typeof BranchMergeStrategiesEnum[keyof typeof BranchMergeStrategiesEnum];
+ export interface Commit extends BaseCommit {
+ // (undocumented)
+ participants?: Array;
+ // (undocumented)
+ repository?: Repository;
+ }
+ export interface CommitFile {
+ // (undocumented)
+ [key: string]: unknown;
+ // (undocumented)
+ attributes?: CommitFileAttributesEnum;
+ // (undocumented)
+ commit?: Commit;
+ escaped_path?: string;
+ path?: string;
+ // (undocumented)
+ type: string;
+ }
+ const // (undocumented)
+ CommitFileAttributesEnum: {
+ readonly Link: 'link';
+ readonly Executable: 'executable';
+ readonly Subrepository: 'subrepository';
+ readonly Binary: 'binary';
+ readonly Lfs: 'lfs';
+ };
+ // (undocumented)
+ export type CommitFileAttributesEnum =
+ typeof CommitFileAttributesEnum[keyof typeof CommitFileAttributesEnum];
+ export interface Link {
+ // (undocumented)
+ href?: string;
+ // (undocumented)
+ name?: string;
+ }
+ export interface ModelObject {
+ // (undocumented)
+ [key: string]: unknown;
+ // (undocumented)
+ type: string;
+ }
+ export interface Paginated {
+ next?: string;
+ page?: number;
+ pagelen?: number;
+ previous?: string;
+ size?: number;
+ values?: Array | Set;
+ }
+ export interface PaginatedRepositories extends Paginated {
+ values?: Set;
+ }
+ export interface Participant extends ModelObject {
+ // (undocumented)
+ approved?: boolean;
+ participated_on?: string;
+ // (undocumented)
+ role?: ParticipantRoleEnum;
+ // (undocumented)
+ state?: ParticipantStateEnum;
+ // (undocumented)
+ user?: User;
+ }
+ const // (undocumented)
+ ParticipantRoleEnum: {
+ readonly Participant: 'PARTICIPANT';
+ readonly Reviewer: 'REVIEWER';
+ };
+ // (undocumented)
+ export type ParticipantRoleEnum =
+ typeof ParticipantRoleEnum[keyof typeof ParticipantRoleEnum];
+ const // (undocumented)
+ ParticipantStateEnum: {
+ readonly Approved: 'approved';
+ readonly ChangesRequested: 'changes_requested';
+ readonly Null: 'null';
+ };
+ // (undocumented)
+ export type ParticipantStateEnum =
+ typeof ParticipantStateEnum[keyof typeof ParticipantStateEnum];
+ export interface Project extends ModelObject {
+ // (undocumented)
+ created_on?: string;
+ // (undocumented)
+ description?: string;
+ has_publicly_visible_repos?: boolean;
+ is_private?: boolean;
+ key?: string;
+ // (undocumented)
+ links?: ProjectLinks;
+ name?: string;
+ // (undocumented)
+ owner?: Team;
+ // (undocumented)
+ updated_on?: string;
+ uuid?: string;
+ }
+ // (undocumented)
+ export interface ProjectLinks {
+ // (undocumented)
+ avatar?: Link;
+ // (undocumented)
+ html?: Link;
+ }
+ // (undocumented)
+ export interface RefLinks {
+ // (undocumented)
+ commits?: Link;
+ // (undocumented)
+ html?: Link;
+ // (undocumented)
+ self?: Link;
+ }
+ export interface Repository extends ModelObject {
+ // (undocumented)
+ created_on?: string;
+ // (undocumented)
+ description?: string;
+ fork_policy?: RepositoryForkPolicyEnum;
+ full_name?: string;
+ // (undocumented)
+ has_issues?: boolean;
+ // (undocumented)
+ has_wiki?: boolean;
+ // (undocumented)
+ is_private?: boolean;
+ // (undocumented)
+ language?: string;
+ // (undocumented)
+ links?: RepositoryLinks;
+ // (undocumented)
+ mainbranch?: Branch;
+ // (undocumented)
+ name?: string;
+ // (undocumented)
+ owner?: Account;
+ // (undocumented)
+ parent?: Repository;
+ // (undocumented)
+ project?: Project;
+ // (undocumented)
+ scm?: RepositoryScmEnum;
+ // (undocumented)
+ size?: number;
+ slug?: string;
+ // (undocumented)
+ updated_on?: string;
+ uuid?: string;
+ }
+ const RepositoryForkPolicyEnum: {
+ readonly AllowForks: 'allow_forks';
+ readonly NoPublicForks: 'no_public_forks';
+ readonly NoForks: 'no_forks';
+ };
+ export type RepositoryForkPolicyEnum =
+ typeof RepositoryForkPolicyEnum[keyof typeof RepositoryForkPolicyEnum];
+ const // (undocumented)
+ RepositoryScmEnum: {
+ readonly Git: 'git';
+ };
+ // (undocumented)
+ export interface RepositoryLinks {
+ // (undocumented)
+ avatar?: Link;
+ // (undocumented)
+ clone?: Array;
+ // (undocumented)
+ file?: CommitFile;
+ // (undocumented)
+ readonly path_matches?: Array;
+ // (undocumented)
+ readonly type?: string;
+ }
+ // (undocumented)
+ export interface SearchContentMatch {
+ // (undocumented)
+ readonly lines?: Array;
+ }
+ // (undocumented)
+ export interface SearchLine {
+ // (undocumented)
+ readonly line?: number;
+ // (undocumented)
+ readonly segments?: Array;
+ }
+ // (undocumented)
+ export interface SearchResultPage extends Paginated {
+ // (undocumented)
+ readonly query_substituted?: boolean;
+ readonly values?: Array;
+ }
+ // (undocumented)
+ export interface SearchSegment {
+ // (undocumented)
+ readonly match?: boolean;
+ // (undocumented)
+ readonly text?: string;
+ }
+ export interface Team extends Account {}
+ export interface User extends Account {
+ account_id?: string;
+ // (undocumented)
+ is_staff?: boolean;
+ }
+}
+
+// @public (undocumented)
+export type PaginationOptions = {
+ page?: number;
+ pagelen?: number;
+};
+
+// @public (undocumented)
+export type PartialResponseOptions = {
+ fields?: string;
+};
+
+// @public (undocumented)
+export type RequestOptions = FilterAndSortOptions &
+ PaginationOptions &
+ PartialResponseOptions & {
+ [key: string]: string | number | undefined;
+ };
+
+// @public (undocumented)
+export class WithPagination<
+ TPage extends Models.Paginated,
+ TResultItem,
+> {
+ constructor(
+ createUrl: (options: PaginationOptions) => URL,
+ fetch: (url: URL) => Promise,
+ );
+ // (undocumented)
+ getPage(options?: PaginationOptions): Promise;
+ // (undocumented)
+ iteratePages(options?: PaginationOptions): AsyncGenerator;
+ // (undocumented)
+ iterateResults(
+ options?: PaginationOptions,
+ ): AsyncGenerator, void, unknown>;
+}
+```
diff --git a/plugins/bitbucket-cloud-common/bitbucket-cloud.oas.json b/plugins/bitbucket-cloud-common/bitbucket-cloud.oas.json
new file mode 100644
index 0000000000..01cd910171
--- /dev/null
+++ b/plugins/bitbucket-cloud-common/bitbucket-cloud.oas.json
@@ -0,0 +1,25555 @@
+{
+ "openapi": "3.0.0",
+ "info": {
+ "termsOfService": "https://www.atlassian.com/legal/customer-agreement",
+ "version": "2.0",
+ "title": "Bitbucket API",
+ "description": "Code against the Bitbucket API to automate simple tasks, embed Bitbucket data into your own site, build mobile or desktop apps, or even add custom UI add-ons into Bitbucket itself using the Connect framework.",
+ "contact": {
+ "url": "https://support.atlassian.com/bitbucket-cloud/",
+ "name": "Bitbucket Support",
+ "email": "support@bitbucket.org"
+ }
+ },
+ "paths": {
+ "/addon": {
+ "delete": {
+ "responses": {
+ "204": {
+ "description": "Request has succeeded. The application has been deleted for the user."
+ },
+ "401": {
+ "description": "No authorization.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Improper authentication.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Addon"],
+ "summary": "Delete an app",
+ "security": [
+ {
+ "oauth2": []
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Deletes the application for the user.\n\nThis endpoint is intended to be used by Bitbucket Connect apps\nand only supports JWT authentication -- that is how Bitbucket\nidentifies the particular installation of the app. Developers\nwith applications registered in the \"Develop Apps\" section\nof Bitbucket Marketplace need not use this endpoint as\nupdates for those applications can be sent out via the\nUI of that section.\n\n```\n$ curl -X DELETE https://api.bitbucket.org/2.0/addon \\\n -H \"Authorization: JWT \"\n```"
+ },
+ "put": {
+ "responses": {
+ "204": {
+ "description": "Request has succeeded. The installation has been updated to the new descriptor."
+ },
+ "400": {
+ "description": "Scopes have increased or decreased to none.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "No authorization.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Improper authentication.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Addon"],
+ "summary": "Update an installed app",
+ "security": [
+ {
+ "oauth2": []
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Updates the application installation for the user.\n\nThis endpoint is intended to be used by Bitbucket Connect apps\nand only supports JWT authentication -- that is how Bitbucket\nidentifies the particular installation of the app. Developers\nwith applications registered in the \"Develop Apps\" section\nof Bitbucket need not use this endpoint as updates for those\napplications can be sent out via the UI of that section.\n\nPassing an empty body will update the installation using the\nexisting descriptor URL.\n\n```\n$ curl -X PUT https://api.bitbucket.org/2.0/addon \\\n -H \"Authorization: JWT \" \\\n --header \"Content-Type: application/json\" \\\n --data '{}'\n```\n\nThe new `descriptor` for the installation can be also provided\nin the body directly.\n\n```\n$ curl -X PUT https://api.bitbucket.org/2.0/addon \\\n -H \"Authorization: JWT \" \\\n --header \"Content-Type: application/json\" \\\n --data '{\"descriptor\": $NEW_DESCRIPTOR}'\n```\n\nIn both these modes the URL of the descriptor cannot be changed. To\nchange the descriptor location and upgrade an installation\nthe request must be made exclusively with a `descriptor_url`.\n\n ```\n$ curl -X PUT https://api.bitbucket.org/2.0/addon \\\n -H \"Authorization: JWT \" \\\n --header \"Content-Type: application/json\" \\\n --data '{\"descriptor_url\": $NEW_URL}'\n```\n\nThe `descriptor_url` must exactly match the marketplace registration\nthat Atlassian has for the application. Contact your Atlassian\ndeveloper advocate to update this registration. Once the registration\nhas been updated you may call this resource for each installation.\n\nNote that the scopes of the application cannot be increased\nin the new descriptor nor reduced to none."
+ },
+ "parameters": []
+ },
+ "/addon/linkers": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "Successful."
+ },
+ "401": {
+ "description": "Authentication must use app JWT",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Addon"],
+ "summary": "List linkers for an app",
+ "security": [
+ {
+ "oauth2": []
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Gets a list of all [linkers](/cloud/bitbucket/modules/linker/)\nfor the authenticated application."
+ },
+ "parameters": []
+ },
+ "/addon/linkers/{linker_key}": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "Successful."
+ },
+ "401": {
+ "description": "Authentication must use app JWT",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The linker does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Addon"],
+ "summary": "Get a linker for an app",
+ "security": [
+ {
+ "oauth2": []
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Gets a [linker](/cloud/bitbucket/modules/linker/) specified by `linker_key`\nfor the authenticated application."
+ },
+ "parameters": [
+ {
+ "name": "linker_key",
+ "in": "path",
+ "description": "The unique key of a [linker module](/cloud/bitbucket/modules/linker/)\nas defined in an application descriptor.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/addon/linkers/{linker_key}/values": {
+ "delete": {
+ "responses": {
+ "204": {
+ "description": "Successfully deleted the linker values."
+ },
+ "401": {
+ "description": "Authentication must use app JWT",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The linker does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Addon"],
+ "summary": "Delete all linker values",
+ "security": [
+ {
+ "oauth2": []
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Delete all [linker](/cloud/bitbucket/modules/linker/) values for the\nspecified linker of the authenticated application."
+ },
+ "get": {
+ "responses": {
+ "200": {
+ "description": "Successful."
+ },
+ "401": {
+ "description": "Authentication must use app JWT",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The linker does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Addon"],
+ "summary": "List linker values for a linker",
+ "security": [
+ {
+ "oauth2": []
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Gets a list of all [linker](/cloud/bitbucket/modules/linker/) values for the\nspecified linker of the authenticated application.\n\nA linker value lets applications supply values to modify its regular expression.\n\nThe base regular expression must use a Bitbucket-specific match group `(?K)`\nwhich will be translated to `([\\w\\-]+)`. A value must match this pattern.\n\n[Read more about linker values](/cloud/bitbucket/modules/linker/#usingthebitbucketapitosupplyvalues)"
+ },
+ "post": {
+ "responses": {
+ "201": {
+ "description": "Successfully created the linker value."
+ },
+ "401": {
+ "description": "Authentication must use app JWT",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The linker does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "The linker already has the value being added.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Addon"],
+ "summary": "Create a linker value",
+ "security": [
+ {
+ "oauth2": []
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Creates a [linker](/cloud/bitbucket/modules/linker/) value for the specified\nlinker of authenticated application.\n\nA linker value lets applications supply values to modify its regular expression.\n\nThe base regular expression must use a Bitbucket-specific match group `(?K)`\nwhich will be translated to `([\\w\\-]+)`. A value must match this pattern.\n\n[Read more about linker values](/cloud/bitbucket/modules/linker/#usingthebitbucketapitosupplyvalues)"
+ },
+ "put": {
+ "responses": {
+ "204": {
+ "description": "Successfully updated the linker values."
+ },
+ "400": {
+ "description": "Invalid input.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Authentication must use app JWT",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The linker does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Addon"],
+ "summary": "Update a linker value",
+ "security": [
+ {
+ "oauth2": []
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Bulk update [linker](/cloud/bitbucket/modules/linker/) values for the specified\nlinker of the authenticated application.\n\nA linker value lets applications supply values to modify its regular expression.\n\nThe base regular expression must use a Bitbucket-specific match group `(?K)`\nwhich will be translated to `([\\w\\-]+)`. A value must match this pattern.\n\n[Read more about linker values](/cloud/bitbucket/modules/linker/#usingthebitbucketapitosupplyvalues)"
+ },
+ "parameters": [
+ {
+ "name": "linker_key",
+ "in": "path",
+ "description": "The unique key of a [linker module](/cloud/bitbucket/modules/linker/)\nas defined in an application descriptor.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/addon/linkers/{linker_key}/values/{value_id}": {
+ "delete": {
+ "responses": {
+ "204": {
+ "description": "Successfully deleted the linker value."
+ },
+ "401": {
+ "description": "Authentication must use app JWT",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The linker value does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Addon"],
+ "summary": "Delete a linker value",
+ "security": [
+ {
+ "oauth2": []
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Delete a single [linker](/cloud/bitbucket/modules/linker/) value\nof the authenticated application."
+ },
+ "get": {
+ "responses": {
+ "200": {
+ "description": "Successful."
+ },
+ "401": {
+ "description": "Authentication must use app JWT",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The linker value does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Addon"],
+ "summary": "Get a linker value",
+ "security": [
+ {
+ "oauth2": []
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Get a single [linker](/cloud/bitbucket/modules/linker/) value\nof the authenticated application."
+ },
+ "parameters": [
+ {
+ "name": "linker_key",
+ "in": "path",
+ "description": "The unique key of a [linker module](/cloud/bitbucket/modules/linker/)\nas defined in an application descriptor.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "value_id",
+ "in": "path",
+ "description": "The numeric ID of the linker value.",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ]
+ },
+ "/hook_events": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "A mapping of resource/subject types pointing to their individual event types.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/subject_types"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Webhooks"],
+ "summary": "Get a webhook resource",
+ "security": [
+ {
+ "oauth2": []
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns the webhook resource or subject types on which webhooks can\nbe registered.\n\nEach resource/subject type contains an `events` link that returns the\npaginated list of specific events each individual subject type can\nemit.\n\nThis endpoint is publicly accessible and does not require\nauthentication or scopes.\n\nExample:\n\n```\n$ curl https://api.bitbucket.org/2.0/hook_events\n\n{\n \"repository\": {\n \"links\": {\n \"events\": {\n \"href\": \"https://api.bitbucket.org/2.0/hook_events/repository\"\n }\n }\n },\n \"team\": {\n \"links\": {\n \"events\": {\n \"href\": \"https://api.bitbucket.org/2.0/hook_events/team\"\n }\n }\n },\n \"user\": {\n \"links\": {\n \"events\": {\n \"href\": \"https://api.bitbucket.org/2.0/hook_events/user\"\n }\n }\n }\n}\n```"
+ },
+ "parameters": []
+ },
+ "/hook_events/{subject_type}": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "A paginated list of webhook types available to subscribe on.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_hook_events"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If an invalid `{subject_type}` value was specified.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Webhooks"],
+ "summary": "List subscribable webhook types",
+ "security": [
+ {
+ "oauth2": []
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns a paginated list of all valid webhook events for the\nspecified entity.\n**The team and user webhooks are deprecated, and you should use workspace instead.\nFor more information, see [the announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-teams-deprecation/).**\n\nThis is public data that does not require any scopes or authentication.\n\nExample:\n\nNOTE: The following example is a truncated response object for the `workspace` `subject_type`.\nWe return the same structure for the other `subject_type` objects.\n\n```\n$ curl https://api.bitbucket.org/2.0/hook_events/workspace\n{\n \"page\": 1,\n \"pagelen\": 30,\n \"size\": 21,\n \"values\": [\n {\n \"category\": \"Repository\",\n \"description\": \"Whenever a repository push occurs\",\n \"event\": \"repo:push\",\n \"label\": \"Push\"\n },\n {\n \"category\": \"Repository\",\n \"description\": \"Whenever a repository fork occurs\",\n \"event\": \"repo:fork\",\n \"label\": \"Fork\"\n },\n {\n \"category\": \"Repository\",\n \"description\": \"Whenever a repository import occurs\",\n \"event\": \"repo:imported\",\n \"label\": \"Import\"\n },\n ...\n {\n \"category\":\"Pull Request\",\n \"label\":\"Approved\",\n \"description\":\"When someone has approved a pull request\",\n \"event\":\"pullrequest:approved\"\n },\n ]\n}\n```"
+ },
+ "parameters": [
+ {
+ "name": "subject_type",
+ "in": "path",
+ "description": "A resource or subject type.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "enum": ["workspace", "user", "repository", "team"]
+ }
+ }
+ ]
+ },
+ "/pullrequests/{selected_user}": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "All pull requests authored by the specified user.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_pullrequests"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the specified user does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "state",
+ "in": "query",
+ "description": "Only return pull requests that are in this state. This parameter can be repeated.",
+ "schema": {
+ "type": "string",
+ "enum": ["MERGED", "SUPERSEDED", "OPEN", "DECLINED"]
+ }
+ }
+ ],
+ "tags": ["Pullrequests"],
+ "summary": "List pull requests for a user",
+ "security": [
+ {
+ "oauth2": ["pullrequest"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns all pull requests authored by the specified user.\n\nBy default only open pull requests are returned. This can be controlled\nusing the `state` query parameter. To retrieve pull requests that are\nin one of multiple states, repeat the `state` parameter for each\nindividual state.\n\nThis endpoint also supports filtering and sorting of the results. See\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for more details."
+ },
+ "parameters": [
+ {
+ "name": "selected_user",
+ "in": "path",
+ "description": "This can either be the username of the pull request author, the author's UUID\nsurrounded by curly-braces, for example: `{account UUID}`, or the author's Atlassian ID.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "All public repositories.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_repositories"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "after",
+ "in": "query",
+ "description": "Filter the results to include only repositories created on or\nafter this [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601)\n timestamp. Example: `YYYY-MM-DDTHH:mm:ss.sssZ`",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "role",
+ "in": "query",
+ "description": "Filters the result based on the authenticated user's role on each repository.\n\n* **member**: returns repositories to which the user has explicit read access\n* **contributor**: returns repositories to which the user has explicit write access\n* **admin**: returns repositories to which the user has explicit administrator access\n* **owner**: returns all repositories owned by the current user\n",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": ["admin", "contributor", "member", "owner"]
+ }
+ },
+ {
+ "name": "q",
+ "in": "query",
+ "description": "Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).\n`role` parameter must also be specified.\n",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "sort",
+ "in": "query",
+ "description": "Field by which the results should be sorted as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).\n",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Repositories"],
+ "summary": "List public repositories",
+ "security": [
+ {
+ "oauth2": ["repository"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns a paginated list of all public repositories.\n\nThis endpoint also supports filtering and sorting of the results. See\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for more details."
+ },
+ "parameters": []
+ },
+ "/repositories/{workspace}": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The repositories owned by the specified account.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_repositories"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the specified account does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "410": {
+ "description": "If the specified account marked as spam.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "role",
+ "in": "query",
+ "description": "\nFilters the result based on the authenticated user's role on each repository.\n\n* **member**: returns repositories to which the user has explicit read access\n* **contributor**: returns repositories to which the user has explicit write access\n* **admin**: returns repositories to which the user has explicit administrator access\n* **owner**: returns all repositories owned by the current user\n",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": ["admin", "contributor", "member", "owner"]
+ }
+ },
+ {
+ "name": "q",
+ "in": "query",
+ "description": "\nQuery string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).\n",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "sort",
+ "in": "query",
+ "description": "\nField by which the results should be sorted as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).\n ",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Repositories"],
+ "summary": "List repositories in a workspace",
+ "security": [
+ {
+ "oauth2": ["repository"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns a paginated list of all repositories owned by the specified\nworkspace.\n\nThe result can be narrowed down based on the authenticated user's role.\n\nE.g. with `?role=contributor`, only those repositories that the\nauthenticated user has write access to are returned (this includes any\nrepo the user is an admin on, as that implies write access).\n\nThis endpoint also supports filtering and sorting of the results. See\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for more details."
+ },
+ "parameters": [
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}": {
+ "delete": {
+ "responses": {
+ "204": {
+ "description": "Indicates successful deletion."
+ },
+ "403": {
+ "description": "If the caller either does not have admin access to the repository, or the repository is set to read-only.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the repository does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "redirect_to",
+ "in": "query",
+ "description": "If a repository has been moved to a new location, use this parameter to\nshow users a friendly message in the Bitbucket UI that the repository\nhas moved to a new location. However, a GET to this endpoint will still\nreturn a 404.\n",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Repositories"],
+ "summary": "Delete a repository",
+ "security": [
+ {
+ "oauth2": ["repository:delete"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Deletes the repository. This is an irreversible operation.\n\nThis does not affect its forks."
+ },
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The repository object.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/repository"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "If the repository is private and the authenticated user does not have access to it.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If no repository exists at this location.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Repositories"],
+ "summary": "Get a repository",
+ "security": [
+ {
+ "oauth2": ["repository"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns the object describing this repository."
+ },
+ "post": {
+ "responses": {
+ "200": {
+ "description": "The newly created repository.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/repository"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "If the input document was invalid, or if the caller lacks the privilege to create repositories under the targeted account.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "If the request was not authenticated.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/repository"
+ }
+ }
+ },
+ "description": "The repository that is to be created. Note that most object elements are optional. Elements \"owner\" and \"full_name\" are ignored as the URL implies them."
+ },
+ "tags": ["Repositories"],
+ "summary": "Create a repository",
+ "security": [
+ {
+ "oauth2": ["repository:admin"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Creates a new repository.\n\nNote: In order to set the project for the newly created repository,\npass in either the project key or the project UUID as part of the\nrequest body as shown in the examples below:\n\n```\n$ curl -X POST -H \"Content-Type: application/json\" -d '{\n \"scm\": \"git\",\n \"project\": {\n \"key\": \"MARS\"\n }\n}' https://api.bitbucket.org/2.0/repositories/teamsinspace/hablanding\n```\n\nor\n\n```\n$ curl -X POST -H \"Content-Type: application/json\" -d '{\n \"scm\": \"git\",\n \"project\": {\n \"key\": \"{ba516952-992a-4c2d-acbd-17d502922f96}\"\n }\n}' https://api.bitbucket.org/2.0/repositories/teamsinspace/hablanding\n```\n\nThe project must be assigned for all repositories. If the project is not provided,\nthe repository is automatically assigned to the oldest project in the workspace.\n\nNote: In the examples above, the workspace ID `teamsinspace`,\nand/or the repository name `hablanding` can be replaced by UUIDs."
+ },
+ "put": {
+ "responses": {
+ "200": {
+ "description": "The existing repository has been updated",
+ "headers": {
+ "Location": {
+ "description": "The location of the repository. This header is only\nprovided when the repository's name is changed.",
+ "schema": {
+ "type": "string"
+ }
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/repository"
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "A new repository has been created",
+ "headers": {
+ "Location": {
+ "description": "The location of the newly created repository",
+ "schema": {
+ "type": "string"
+ }
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/repository"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "If the input document was invalid, or if the caller lacks the privilege to create repositories under the targeted account.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "If the request was not authenticated.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/repository"
+ }
+ }
+ },
+ "description": "The repository that is to be updated.\n\nNote that the elements \"owner\" and \"full_name\" are ignored since the\nURL implies them.\n"
+ },
+ "tags": ["Repositories"],
+ "summary": "Update a repository",
+ "security": [
+ {
+ "oauth2": ["repository:admin"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Since this endpoint can be used to both update and to create a\nrepository, the request body depends on the intent.\n\n#### Creation\n\nSee the POST documentation for the repository endpoint for an example\nof the request body.\n\n#### Update\n\nNote: Changing the `name` of the repository will cause the location to\nbe changed. This is because the URL of the repo is derived from the\nname (a process called slugification). In such a scenario, it is\npossible for the request to fail if the newly created slug conflicts\nwith an existing repository's slug. But if there is no conflict,\nthe new location will be returned in the `Location` header of the\nresponse."
+ },
+ "parameters": [
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/branch-restrictions": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "A paginated list of branch restrictions",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_branchrestrictions"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "If the request was not authenticated",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "If the authenticated user does not have admin access to the repository",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the repository does not exist",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "kind",
+ "in": "query",
+ "description": "Branch restrictions of this type",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "pattern",
+ "in": "query",
+ "description": "Branch restrictions applied to branches of this pattern",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Branch restrictions"],
+ "summary": "List branch restrictions",
+ "security": [
+ {
+ "oauth2": ["repository:admin"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns a paginated list of all branch restrictions on the\nrepository."
+ },
+ "post": {
+ "responses": {
+ "201": {
+ "description": "A paginated list of branch restrictions",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/branchrestriction"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "If the request was not authenticated",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "If the authenticated user does not have admin access to the repository",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the repository does not exist",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/branchrestriction"
+ }
+ }
+ },
+ "description": "The new rule",
+ "required": true
+ },
+ "tags": ["Branch restrictions"],
+ "summary": "Create a branch restriction rule",
+ "security": [
+ {
+ "oauth2": ["repository:admin"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Creates a new branch restriction rule for a repository.\n\n`kind` describes what will be restricted. Allowed values include:\n`push`, `force`, `delete` and `restrict_merges`.\n\nDifferent kinds of branch restrictions have different requirements:\n\n* `push` and `restrict_merges` require `users` and `groups` to be\n specified. Empty lists are allowed, in which case permission is\n denied for everybody.\n\nThe restriction applies to all branches that match. There are\ntwo ways to match a branch. It is configured in `branch_match_kind`:\n\n1. `glob`: Matches a branch against the `pattern`. A `'*'` in\n `pattern` will expand to match zero or more characters, and every\n other character matches itself. For example, `'foo*'` will match\n `'foo'` and `'foobar'`, but not `'barfoo'`. `'*'` will match all\n branches.\n2. `branching_model`: Matches a branch against the repository's\n branching model. The `branch_type` controls the type of branch\n to match. Allowed values include: `production`, `development`,\n `bugfix`, `release`, `feature` and `hotfix`.\n\nThe combination of `kind` and match must be unique. This means that\ntwo `glob` restrictions in a repository cannot have the same `kind` and\n`pattern`. Additionally, two `branching_model` restrictions in a\nrepository cannot have the same `kind` and `branch_type`.\n\n`users` and `groups` are lists of users and groups that are except from\nthe restriction. They can only be configured in `push` and\n`restrict_merges` restrictions. The `push` restriction stops a user\npushing to matching branches unless that user is in `users` or is a\nmember of a group in `groups`. The `restrict_merges` stops a user\nmerging pull requests to matching branches unless that user is in\n`users` or is a member of a group in `groups`. Adding new users or\ngroups to an existing restriction should be done via `PUT`.\n\nNote that branch restrictions with overlapping matchers is allowed,\nbut the resulting behavior may be surprising."
+ },
+ "parameters": [
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/branch-restrictions/{id}": {
+ "delete": {
+ "responses": {
+ "204": {
+ "description": ""
+ },
+ "401": {
+ "description": "If the request was not authenticated",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "If the authenticated user does not have admin access to the repository",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the repository or branch restriction id does not exist",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Branch restrictions"],
+ "summary": "Delete a branch restriction rule",
+ "security": [
+ {
+ "oauth2": ["repository:admin"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Deletes an existing branch restriction rule."
+ },
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The branch restriction rule",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/branchrestriction"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "If the request was not authenticated",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "If the authenticated user does not have admin access to the repository",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the repository or branch restriction id does not exist",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Branch restrictions"],
+ "summary": "Get a branch restriction rule",
+ "security": [
+ {
+ "oauth2": ["repository:admin"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns a specific branch restriction rule."
+ },
+ "put": {
+ "responses": {
+ "200": {
+ "description": "The updated branch restriction rule",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/branchrestriction"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "If the request was not authenticated",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "If the authenticated user does not have admin access to the repository",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the repository or branch restriction id does not exist",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/branchrestriction"
+ }
+ }
+ },
+ "description": "The new version of the existing rule",
+ "required": true
+ },
+ "tags": ["Branch restrictions"],
+ "summary": "Update a branch restriction rule",
+ "security": [
+ {
+ "oauth2": ["repository:admin"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Updates an existing branch restriction rule.\n\nFields not present in the request body are ignored.\n\nSee [`POST`](/cloud/bitbucket/rest/api-group-branch-restrictions/#api-repositories-workspace-repo-slug-branch-restrictions-post) for details."
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "description": "The restriction rule's id",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/branching-model": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The branching model object",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/branching_model"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "If the request was not authenticated",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "If the authenticated user does not have read access to the repository",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the repository does not exist",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Branching model"],
+ "summary": "Get the branching model for a repository",
+ "security": [
+ {
+ "oauth2": ["repository"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Return the branching model as applied to the repository. This view is\nread-only. The branching model settings can be changed using the\n[settings](branching-model/settings#get) API.\n\nThe returned object:\n\n1. Always has a `development` property. `development.branch` contains\n the actual repository branch object that is considered to be the\n `development` branch. `development.branch` will not be present\n if it does not exist.\n2. Might have a `production` property. `production` will not\n be present when `production` is disabled.\n `production.branch` contains the actual branch object that is\n considered to be the `production` branch. `production.branch` will\n not be present if it does not exist.\n3. Always has a `branch_types` array which contains all enabled branch\n types.\n\nExample body:\n\n```\n{\n \"development\": {\n \"name\": \"master\",\n \"branch\": {\n \"type\": \"branch\",\n \"name\": \"master\",\n \"target\": {\n \"hash\": \"16dffcb0de1b22e249db6799532074cf32efe80f\"\n }\n },\n \"use_mainbranch\": true\n },\n \"production\": {\n \"name\": \"production\",\n \"branch\": {\n \"type\": \"branch\",\n \"name\": \"production\",\n \"target\": {\n \"hash\": \"16dffcb0de1b22e249db6799532074cf32efe80f\"\n }\n },\n \"use_mainbranch\": false\n },\n \"branch_types\": [\n {\n \"kind\": \"release\",\n \"prefix\": \"release/\"\n },\n {\n \"kind\": \"hotfix\",\n \"prefix\": \"hotfix/\"\n },\n {\n \"kind\": \"feature\",\n \"prefix\": \"feature/\"\n },\n {\n \"kind\": \"bugfix\",\n \"prefix\": \"bugfix/\"\n }\n ],\n \"type\": \"branching_model\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/.../branching-model\"\n }\n }\n}\n```"
+ },
+ "parameters": [
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/branching-model/settings": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The branching model configuration",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/branching_model_settings"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "If the request was not authenticated",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "If the authenticated user does not have admin access to the repository",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the repository does not exist",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Branching model"],
+ "summary": "Get the branching model config for a repository",
+ "security": [
+ {
+ "oauth2": ["repository:admin"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Return the branching model configuration for a repository. The returned\nobject:\n\n1. Always has a `development` property for the development branch.\n2. Always a `production` property for the production branch. The\n production branch can be disabled.\n3. The `branch_types` contains all the branch types.\n\nThis is the raw configuration for the branching model. A client\nwishing to see the branching model with its actual current branches may\nfind the [active model API](/cloud/bitbucket/rest/api-group-branching-model/#api-repositories-workspace-repo-slug-branching-model-get) more useful.\n\nExample body:\n\n```\n{\n \"development\": {\n \"is_valid\": true,\n \"name\": null,\n \"use_mainbranch\": true\n },\n \"production\": {\n \"is_valid\": true,\n \"name\": \"production\",\n \"use_mainbranch\": false,\n \"enabled\": false\n },\n \"branch_types\": [\n {\n \"kind\": \"release\",\n \"enabled\": true,\n \"prefix\": \"release/\"\n },\n {\n \"kind\": \"hotfix\",\n \"enabled\": true,\n \"prefix\": \"hotfix/\"\n },\n {\n \"kind\": \"feature\",\n \"enabled\": true,\n \"prefix\": \"feature/\"\n },\n {\n \"kind\": \"bugfix\",\n \"enabled\": false,\n \"prefix\": \"bugfix/\"\n }\n ],\n \"type\": \"branching_model_settings\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/.../branching-model/settings\"\n }\n }\n}\n```"
+ },
+ "put": {
+ "responses": {
+ "200": {
+ "description": "The updated branching model configuration",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/branching_model_settings"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "If the request contains invalid branching model configuration",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "If the request was not authenticated",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "If the authenticated user does not have admin access to the repository",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the repository does not exist",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Branching model"],
+ "summary": "Update the branching model config for a repository",
+ "security": [
+ {
+ "oauth2": ["repository:admin"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Update the branching model configuration for a repository.\n\nThe `development` branch can be configured to a specific branch or to\ntrack the main branch. When set to a specific branch it must\ncurrently exist. Only the passed properties will be updated. The\nproperties not passed will be left unchanged. A request without a\n`development` property will leave the development branch unchanged.\n\nIt is possible for the `development` branch to be invalid. This\nhappens when it points at a specific branch that has been\ndeleted. This is indicated in the `is_valid` field for the branch. It is\nnot possible to update the settings for `development` if that\nwould leave the branch in an invalid state. Such a request will be\nrejected.\n\nThe `production` branch can be a specific branch, the main\nbranch or disabled. When set to a specific branch it must currently\nexist. The `enabled` property can be used to enable (`true`) or\ndisable (`false`) it. Only the passed properties will be updated. The\nproperties not passed will be left unchanged. A request without a\n`production` property will leave the production branch unchanged.\n\nIt is possible for the `production` branch to be invalid. This\nhappens when it points at a specific branch that has been\ndeleted. This is indicated in the `is_valid` field for the branch. A\nrequest that would leave `production` enabled and invalid will be\nrejected. It is possible to update `production` and make it invalid if\nit would also be left disabled.\n\nThe `branch_types` property contains the branch types to be updated.\nOnly the branch types passed will be updated. All updates will be\nrejected if it would leave the branching model in an invalid state.\nFor branch types this means that:\n\n1. The prefixes for all enabled branch types are valid. For example,\n it is not possible to use '*' inside a Git prefix.\n2. A prefix of an enabled branch type must not be a prefix of another\n enabled branch type. This is to ensure that a branch can be easily\n classified by its prefix unambiguously.\n\nIt is possible to store an invalid prefix if that branch type would be\nleft disabled. Only the passed properties will be updated. The\nproperties not passed will be left unchanged. Each branch type must\nhave a `kind` property to identify it.\n\nExample Body:\n\n```\n {\n \"development\": {\n \"use_mainbranch\": true\n },\n \"production\": {\n \"enabled\": true,\n \"use_mainbranch\": false,\n \"name\": \"production\"\n },\n \"branch_types\": [\n {\n \"kind\": \"bugfix\",\n \"enabled\": true,\n \"prefix\": \"bugfix/\"\n },\n {\n \"kind\": \"feature\",\n \"enabled\": true,\n \"prefix\": \"feature/\"\n },\n {\n \"kind\": \"hotfix\",\n \"prefix\": \"hotfix/\"\n },\n {\n \"kind\": \"release\",\n \"enabled\": false,\n }\n ]\n }\n```\n\nThere is currently a side effect when using this API endpoint. If the\nrepository is inheriting branching model settings from its project,\nupdating the branching model for this repository will disable the\nproject setting inheritance.\n\n\nWe have deprecated this side effect and will remove it on 1 August 2022."
+ },
+ "parameters": [
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/commit/{commit}": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The commit object",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/commit"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the specified commit or repository does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Commits"],
+ "summary": "Get a commit",
+ "security": [
+ {
+ "oauth2": ["repository"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns the specified commit.\n\nExample:\n\n```\n$ curl https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/commit/f7591a1\n{\n \"rendered\": {\n \"message\": {\n \"raw\": \"Add a GEORDI_OUTPUT_DIR setting\",\n \"markup\": \"markdown\",\n \"html\": \"Add a GEORDI_OUTPUT_DIR setting
\",\n \"type\": \"rendered\"\n }\n },\n \"hash\": \"f7591a13eda445d9a9167f98eb870319f4b6c2d8\",\n \"repository\": {\n \"name\": \"geordi\",\n \"type\": \"repository\",\n \"full_name\": \"bitbucket/geordi\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/bitbucket/geordi\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/bitbucket/geordi\"\n },\n \"avatar\": {\n \"href\": \"https://bytebucket.org/ravatar/%7B85d08b4e-571d-44e9-a507-fa476535aa98%7D?ts=1730260\"\n }\n },\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/commit/f7591a13eda445d9a9167f98eb870319f4b6c2d8\"\n },\n \"comments\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/commit/f7591a13eda445d9a9167f98eb870319f4b6c2d8/comments\"\n },\n \"patch\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/patch/f7591a13eda445d9a9167f98eb870319f4b6c2d8\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/bitbucket/geordi/commits/f7591a13eda445d9a9167f98eb870319f4b6c2d8\"\n },\n \"diff\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/diff/f7591a13eda445d9a9167f98eb870319f4b6c2d8\"\n },\n \"approve\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/commit/f7591a13eda445d9a9167f98eb870319f4b6c2d8/approve\"\n },\n \"statuses\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/commit/f7591a13eda445d9a9167f98eb870319f4b6c2d8/statuses\"\n }\n },\n \"author\": {\n \"raw\": \"Brodie Rao \",\n \"type\": \"author\",\n \"user\": {\n \"display_name\": \"Brodie Rao\",\n \"uuid\": \"{9484702e-c663-4afd-aefb-c93a8cd31c28}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/%7B9484702e-c663-4afd-aefb-c93a8cd31c28%7D\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/%7B9484702e-c663-4afd-aefb-c93a8cd31c28%7D/\"\n },\n \"avatar\": {\n \"href\": \"https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/557058:3aae1e05-702a-41e5-81c8-f36f29afb6ca/613070db-28b0-421f-8dba-ae8a87e2a5c7/128\"\n }\n },\n \"type\": \"user\",\n \"nickname\": \"brodie\",\n \"account_id\": \"557058:3aae1e05-702a-41e5-81c8-f36f29afb6ca\"\n }\n },\n \"summary\": {\n \"raw\": \"Add a GEORDI_OUTPUT_DIR setting\",\n \"markup\": \"markdown\",\n \"html\": \"Add a GEORDI_OUTPUT_DIR setting
\",\n \"type\": \"rendered\"\n },\n \"participants\": [],\n \"parents\": [\n {\n \"type\": \"commit\",\n \"hash\": \"f06941fec4ef6bcb0c2456927a0cf258fa4f899b\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/commit/f06941fec4ef6bcb0c2456927a0cf258fa4f899b\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/bitbucket/geordi/commits/f06941fec4ef6bcb0c2456927a0cf258fa4f899b\"\n }\n }\n }\n ],\n \"date\": \"2012-07-16T19:37:54+00:00\",\n \"message\": \"Add a GEORDI_OUTPUT_DIR setting\",\n \"type\": \"commit\"\n}\n```"
+ },
+ "parameters": [
+ {
+ "name": "commit",
+ "in": "path",
+ "description": "The commit's SHA1.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/commit/{commit}/approve": {
+ "delete": {
+ "responses": {
+ "204": {
+ "description": "An empty response indicating the authenticated user's approval has been withdrawn."
+ },
+ "404": {
+ "description": "If the specified commit, or the repository does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Commits"],
+ "summary": "Unapprove a commit",
+ "security": [
+ {
+ "oauth2": ["repository:write"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Redact the authenticated user's approval of the specified commit.\n\nThis operation is only available to users that have explicit access to\nthe repository. In contrast, just the fact that a repository is\npublicly accessible to users does not give them the ability to approve\ncommits."
+ },
+ "post": {
+ "responses": {
+ "200": {
+ "description": "The `participant` object recording that the authenticated user approved the commit.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/participant"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the specified commit, or the repository does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Commits"],
+ "summary": "Approve a commit",
+ "security": [
+ {
+ "oauth2": ["repository:write"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Approve the specified commit as the authenticated user.\n\nThis operation is only available to users that have explicit access to\nthe repository. In contrast, just the fact that a repository is\npublicly accessible to users does not give them the ability to approve\ncommits."
+ },
+ "parameters": [
+ {
+ "name": "commit",
+ "in": "path",
+ "description": "The commit's SHA1.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/commit/{commit}/comments": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "A paginated list of commit comments.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_commit_comments"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "q",
+ "in": "query",
+ "description": "Query string to narrow down the response as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).\n",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "sort",
+ "in": "query",
+ "description": "Field by which the results should be sorted as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).\n",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Commits"],
+ "summary": "List a commit's comments",
+ "security": [
+ {
+ "oauth2": ["repository"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns the commit's comments.\n\nThis includes both global and inline comments.\n\nThe default sorting is oldest to newest and can be overridden with\nthe `sort` query parameter."
+ },
+ "post": {
+ "responses": {
+ "201": {
+ "description": "The newly created comment.",
+ "headers": {
+ "Location": {
+ "description": "The location of the newly created comment.",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "If the comment was detected as spam, or if the parent comment is not attached to the same node as the new comment"
+ },
+ "404": {
+ "description": "If a parent ID was passed in that cannot be found"
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/commit_comment"
+ }
+ }
+ },
+ "description": "The specified comment.",
+ "required": true
+ },
+ "tags": ["Commits"],
+ "summary": "Create comment for a commit",
+ "security": [
+ {
+ "oauth2": ["repository"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Creates new comment on the specified commit.\n\nTo post a reply to an existing comment, include the `parent.id` field:\n\n```\n$ curl https://api.bitbucket.org/2.0/repositories/atlassian/prlinks/commit/db9ba1e031d07a02603eae0e559a7adc010257fc/comments/ \\\n -X POST -u evzijst \\\n -H 'Content-Type: application/json' \\\n -d '{\"content\": {\"raw\": \"One more thing!\"},\n \"parent\": {\"id\": 5728901}}'\n```"
+ },
+ "parameters": [
+ {
+ "name": "commit",
+ "in": "path",
+ "description": "The commit's SHA1.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/commit/{commit}/comments/{comment_id}": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The commit comment.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/commit_comment"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Commits"],
+ "summary": "Get a commit comment",
+ "security": [
+ {
+ "oauth2": ["repository"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns the specified commit comment."
+ },
+ "parameters": [
+ {
+ "name": "comment_id",
+ "in": "path",
+ "description": "The id of the comment.",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "commit",
+ "in": "path",
+ "description": "The commit's SHA1.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name}": {
+ "put": {
+ "responses": {
+ "204": {
+ "description": "An empty response."
+ }
+ },
+ "parameters": [
+ {
+ "required": true,
+ "description": "The repository container; either the workspace slug or the UUID in curly braces.",
+ "in": "path",
+ "name": "workspace",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The repository.",
+ "in": "path",
+ "name": "repo_slug",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The commit.",
+ "in": "path",
+ "name": "commit",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The key of the Connect app.",
+ "in": "path",
+ "name": "app_key",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The name of the property.",
+ "in": "path",
+ "name": "property_name",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "$ref": "#/components/requestBodies/application_property"
+ },
+ "tags": ["properties"],
+ "description": "Update an [application property](/cloud/bitbucket/application-properties/) value stored against a commit.",
+ "summary": "Update a commit application property",
+ "operationId": "updateCommitHostedPropertyValue"
+ },
+ "delete": {
+ "responses": {
+ "204": {
+ "description": "An empty response."
+ }
+ },
+ "parameters": [
+ {
+ "required": true,
+ "description": "The repository container; either the workspace slug or the UUID in curly braces.",
+ "in": "path",
+ "name": "workspace",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The repository.",
+ "in": "path",
+ "name": "repo_slug",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The commit.",
+ "in": "path",
+ "name": "commit",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The key of the Connect app.",
+ "in": "path",
+ "name": "app_key",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The name of the property.",
+ "in": "path",
+ "name": "property_name",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["properties"],
+ "description": "Delete an [application property](/cloud/bitbucket/application-properties/) value stored against a commit.",
+ "summary": "Delete a commit application property",
+ "operationId": "deleteCommitHostedPropertyValue"
+ },
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The value of the property.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/application_property"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "required": true,
+ "description": "The repository container; either the workspace slug or the UUID in curly braces.",
+ "in": "path",
+ "name": "workspace",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The repository.",
+ "in": "path",
+ "name": "repo_slug",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The commit.",
+ "in": "path",
+ "name": "commit",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The key of the Connect app.",
+ "in": "path",
+ "name": "app_key",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The name of the property.",
+ "in": "path",
+ "name": "property_name",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["properties"],
+ "description": "Retrieve an [application property](/cloud/bitbucket/application-properties/) value stored against a commit.",
+ "summary": "Get a commit application property",
+ "operationId": "getCommitHostedPropertyValue"
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/commit/{commit}/pullrequests": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The paginated list of pull requests.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_pullrequests"
+ }
+ }
+ }
+ },
+ "202": {
+ "description": "The repository's pull requests are still being indexed.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_pullrequests"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Either the repository does not exist, or pull request commit links have not yet been indexed.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "required": true,
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces",
+ "in": "path",
+ "name": "workspace",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The repository; either the UUID in curly braces, or the slug",
+ "in": "path",
+ "name": "repo_slug",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The SHA1 of the commit",
+ "in": "path",
+ "name": "commit",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "Which page to retrieve",
+ "required": false,
+ "in": "query",
+ "name": "page",
+ "schema": {
+ "type": "integer",
+ "format": "int32",
+ "default": 1
+ }
+ },
+ {
+ "description": "How many pull requests to retrieve per page",
+ "required": false,
+ "in": "query",
+ "name": "pagelen",
+ "schema": {
+ "type": "integer",
+ "format": "int32",
+ "default": 30
+ }
+ }
+ ],
+ "tags": ["Pullrequests"],
+ "summary": "List pull requests that contain a commit",
+ "operationId": "getPullrequestsForCommit",
+ "description": "Returns a paginated list of all pull requests as part of which this commit was reviewed. Pull Request Commit Links app must be installed first before using this API; installation automatically occurs when 'Go to pull request' is clicked from the web interface for a commit's details."
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/commit/{commit}/reports": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_reports"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The commit for which to retrieve reports.",
+ "required": true,
+ "name": "commit",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Reports", "Commits"],
+ "summary": "List reports",
+ "operationId": "getReportsForCommit",
+ "description": "Returns a paginated list of Reports linked to this commit."
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}": {
+ "put": {
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/report"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "The provided Report object is malformed or incomplete.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The commit the report belongs to.",
+ "required": true,
+ "name": "commit",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "Either the uuid or external-id of the report.",
+ "required": true,
+ "name": "reportId",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/report"
+ }
+ }
+ },
+ "description": "The report to create or update",
+ "required": true
+ },
+ "tags": ["Reports", "Commits"],
+ "summary": "Create or update a report",
+ "operationId": "createOrUpdateReport",
+ "description": "Creates or updates a report for the specified commit.\nTo upload a report, make sure to generate an ID that is unique across all reports for that commit. If you want to use an existing id from your own system, we recommend prefixing it with your system's name to avoid collisions, for example, mySystem-001.\n\n### Sample cURL request:\n```\ncurl --request PUT 'https://api.bitbucket.org/2.0/repositories///commit//reports/mysystem-001' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"title\": \"Security scan report\",\n \"details\": \"This pull request introduces 10 new dependency vulnerabilities.\",\n \"report_type\": \"SECURITY\",\n \"reporter\": \"mySystem\",\n \"link\": \"http://www.mysystem.com/reports/001\",\n \"result\": \"FAILED\",\n \"data\": [\n {\n \"title\": \"Duration (seconds)\",\n \"type\": \"DURATION\",\n \"value\": 14\n },\n {\n \"title\": \"Safe to merge?\",\n \"type\": \"BOOLEAN\",\n \"value\": false\n }\n ]\n}'\n```\n\n### Possible field values:\nreport_type: SECURITY, COVERAGE, TEST, BUG\nresult: PASSED, FAILED, PENDING\ndata.type: BOOLEAN, DATE, DURATION, LINK, NUMBER, PERCENTAGE, TEXT\n\n#### Data field formats\n| Type Field | Value Field Type | Value Field Display |\n|:--------------|:------------------|:--------------------|\n| None/ Omitted | Number, String or Boolean (not an array or object) | Plain text |\n| BOOLEAN\t| Boolean | The value will be read as a JSON boolean and displayed as 'Yes' or 'No'. |\n| DATE | Number | The value will be read as a JSON number in the form of a Unix timestamp (milliseconds) and will be displayed as a relative date if the date is less than one week ago, otherwise it will be displayed as an absolute date. |\n| DURATION | Number | The value will be read as a JSON number in milliseconds and will be displayed in a human readable duration format. |\n| LINK | Object: `{\"text\": \"Link text here\", \"href\": \"https://link.to.annotation/in/external/tool\"}` | The value will be read as a JSON object containing the fields \"text\" and \"href\" and will be displayed as a clickable link on the report. |\n| NUMBER | Number | The value will be read as a JSON number and large numbers will be displayed in a human readable format (e.g. 14.3k). |\n| PERCENTAGE | Number (between 0 and 100) | The value will be read as a JSON number between 0 and 100 and will be displayed with a percentage sign. |\n| TEXT | String | The value will be read as a JSON string and will be displayed as-is |\n\nPlease refer to the [Code Insights documentation](https://confluence.atlassian.com/bitbucket/code-insights-994316785.html) for more information.\n"
+ },
+ "get": {
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/report"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The report with the given ID was not found.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The commit the report belongs to.",
+ "required": true,
+ "name": "commit",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "Either the uuid or external-id of the report.",
+ "required": true,
+ "name": "reportId",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Reports", "Commits"],
+ "summary": "Get a report",
+ "operationId": "getReport",
+ "description": "Returns a single Report matching the provided ID."
+ },
+ "delete": {
+ "responses": {
+ "204": {
+ "description": "No content"
+ }
+ },
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The commit the report belongs to.",
+ "required": true,
+ "name": "commit",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "Either the uuid or external-id of the report.",
+ "required": true,
+ "name": "reportId",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Reports", "Commits"],
+ "summary": "Delete a report",
+ "operationId": "deleteReport",
+ "description": "Deletes a single Report matching the provided ID."
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations": {
+ "post": {
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/report_annotation"
+ },
+ "type": "array"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The commit for which to retrieve reports.",
+ "required": true,
+ "name": "commit",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "Uuid or external-if of the report for which to get annotations for.",
+ "required": true,
+ "name": "reportId",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "minItems": 1,
+ "items": {
+ "$ref": "#/components/schemas/report_annotation"
+ },
+ "type": "array",
+ "maxItems": 100
+ }
+ }
+ },
+ "description": "The annotations to create or update",
+ "required": true
+ },
+ "tags": ["Reports", "Commits"],
+ "summary": "Bulk create or update annotations",
+ "operationId": "bulkCreateOrUpdateAnnotations",
+ "description": "Bulk upload of annotations.\nAnnotations are individual findings that have been identified as part of a report, for example, a line of code that represents a vulnerability. These annotations can be attached to a specific file and even a specific line in that file, however, that is optional. Annotations are not mandatory and a report can contain up to 1000 annotations.\n\nAdd the annotations you want to upload as objects in a JSON array and make sure each annotation has the external_id field set to a unique value. If you want to use an existing id from your own system, we recommend prefixing it with your system's name to avoid collisions, for example, mySystem-annotation001. The external id can later be used to identify the report as an alternative to the generated [UUID](https://developer.atlassian.com/bitbucket/api/2/reference/meta/uri-uuid#uuid). You can upload up to 100 annotations per POST request.\n\n### Sample cURL request:\n```\ncurl --location 'https://api.bitbucket.org/2.0/repositories///commit//reports/mysystem-001/annotations' \\\n--header 'Content-Type: application/json' \\\n--data-raw '[\n {\n \"external_id\": \"mysystem-annotation001\",\n \"title\": \"Security scan report\",\n \"annotation_type\": \"VULNERABILITY\",\n \"summary\": \"This line represents a security threat.\",\n \"severity\": \"HIGH\",\n \"path\": \"my-service/src/main/java/com/myCompany/mysystem/logic/Main.java\",\n \"line\": 42\n },\n {\n \"external_id\": \"mySystem-annotation002\",\n \"title\": \"Bug report\",\n \"annotation_type\": \"BUG\",\n \"result\": \"FAILED\",\n \"summary\": \"This line might introduce a bug.\",\n \"severity\": \"MEDIUM\",\n \"path\": \"my-service/src/main/java/com/myCompany/mysystem/logic/Helper.java\",\n \"line\": 13\n }\n]'\n```\n\n### Possible field values:\nannotation_type: VULNERABILITY, CODE_SMELL, BUG\nresult: PASSED, FAILED, IGNORED, SKIPPED\nseverity: HIGH, MEDIUM, LOW, CRITICAL\n\nPlease refer to the [Code Insights documentation](https://confluence.atlassian.com/bitbucket/code-insights-994316785.html) for more information.\n"
+ },
+ "get": {
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_annotations"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The commit for which to retrieve reports.",
+ "required": true,
+ "name": "commit",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "Uuid or external-if of the report for which to get annotations for.",
+ "required": true,
+ "name": "reportId",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Reports", "Commits"],
+ "summary": "List annotations",
+ "operationId": "getAnnotationsForReport",
+ "description": "Returns a paginated list of Annotations for a specified report."
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations/{annotationId}": {
+ "put": {
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/report_annotation"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "The provided Annotation object is malformed or incomplete.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The commit the report belongs to.",
+ "required": true,
+ "name": "commit",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "Either the uuid or external-id of the report.",
+ "required": true,
+ "name": "reportId",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "Either the uuid or external-id of the annotation.",
+ "required": true,
+ "name": "annotationId",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/report_annotation"
+ }
+ }
+ },
+ "description": "The annotation to create or update",
+ "required": true
+ },
+ "tags": ["Reports", "Commits"],
+ "summary": "Create or update an annotation",
+ "operationId": "createOrUpdateAnnotation",
+ "description": "Creates or updates an individual annotation for the specified report.\nAnnotations are individual findings that have been identified as part of a report, for example, a line of code that represents a vulnerability. These annotations can be attached to a specific file and even a specific line in that file, however, that is optional. Annotations are not mandatory and a report can contain up to 1000 annotations.\n\nJust as reports, annotation needs to be uploaded with a unique ID that can later be used to identify the report as an alternative to the generated [UUID](https://developer.atlassian.com/bitbucket/api/2/reference/meta/uri-uuid#uuid). If you want to use an existing id from your own system, we recommend prefixing it with your system's name to avoid collisions, for example, mySystem-annotation001.\n\n### Sample cURL request:\n```\ncurl --request PUT 'https://api.bitbucket.org/2.0/repositories///commit//reports/mySystem-001/annotations/mysystem-annotation001' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"title\": \"Security scan report\",\n \"annotation_type\": \"VULNERABILITY\",\n \"summary\": \"This line represents a security thread.\",\n \"severity\": \"HIGH\",\n \"path\": \"my-service/src/main/java/com/myCompany/mysystem/logic/Main.java\",\n \"line\": 42\n}'\n```\n\n### Possible field values:\nannotation_type: VULNERABILITY, CODE_SMELL, BUG\nresult: PASSED, FAILED, IGNORED, SKIPPED\nseverity: HIGH, MEDIUM, LOW, CRITICAL\n\nPlease refer to the [Code Insights documentation](https://confluence.atlassian.com/bitbucket/code-insights-994316785.html) for more information.\n"
+ },
+ "get": {
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/report_annotation"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The annotation with the given ID was not found.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The commit the report belongs to.",
+ "required": true,
+ "name": "commit",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "Either the uuid or external-id of the report.",
+ "required": true,
+ "name": "reportId",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "Either the uuid or external-id of the annotation.",
+ "required": true,
+ "name": "annotationId",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Reports", "Commits"],
+ "summary": "Get an annotation",
+ "operationId": "getAnnotation",
+ "description": "Returns a single Annotation matching the provided ID."
+ },
+ "delete": {
+ "responses": {
+ "204": {
+ "description": "No content"
+ }
+ },
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The commit the annotation belongs to.",
+ "required": true,
+ "name": "commit",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "Either the uuid or external-id of the annotation.",
+ "required": true,
+ "name": "reportId",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "Either the uuid or external-id of the annotation.",
+ "required": true,
+ "name": "annotationId",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Reports", "Commits"],
+ "summary": "Delete an annotation",
+ "operationId": "deleteAnnotation",
+ "description": "Deletes a single Annotation matching the provided ID."
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/commit/{commit}/statuses": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "A paginated list of all commit statuses for this commit.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_commitstatuses"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "If the repository is private and the request was not authenticated."
+ },
+ "404": {
+ "description": "If the repository or commit does not exist",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "q",
+ "in": "query",
+ "description": "Query string to narrow down the response as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).\n",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "sort",
+ "in": "query",
+ "description": "Field by which the results should be sorted as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).\nDefaults to `created_on`.\n",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Commit statuses"],
+ "summary": "List commit statuses for a commit",
+ "security": [
+ {
+ "oauth2": ["repository"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns all statuses (e.g. build results) for a specific commit."
+ },
+ "parameters": [
+ {
+ "name": "commit",
+ "in": "path",
+ "description": "The commit's SHA1.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/commit/{commit}/statuses/build": {
+ "post": {
+ "responses": {
+ "201": {
+ "description": "The newly created build status object.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/commitstatus"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "If the repository is private and the request was not authenticated."
+ },
+ "404": {
+ "description": "If the repository, commit, or build status key does not exist",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/commitstatus"
+ }
+ }
+ },
+ "description": "The new commit status object."
+ },
+ "tags": ["Commit statuses"],
+ "summary": "Create a build status for a commit",
+ "security": [
+ {
+ "oauth2": ["repository"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Creates a new build status against the specified commit.\n\nIf the specified key already exists, the existing status object will\nbe overwritten.\n\nExample:\n\n```\ncurl https://api.bitbucket.org/2.0/repositories/my-workspace/my-repo/commit/e10dae226959c2194f2b07b077c07762d93821cf/statuses/build/ -X POST -u jdoe -H 'Content-Type: application/json' -d '{\n \"key\": \"MY-BUILD\",\n \"state\": \"SUCCESSFUL\",\n \"description\": \"42 tests passed\",\n \"url\": \"https://www.example.org/my-build-result\"\n }'\n```\n\nWhen creating a new commit status, you can use a URI template for the URL.\nTemplates are URLs that contain variable names that Bitbucket will\nevaluate at runtime whenever the URL is displayed anywhere similar to\nparameter substitution in\n[Bitbucket Connect](https://developer.atlassian.com/bitbucket/concepts/context-parameters.html).\nFor example, one could use `https://foo.com/builds/{repository.full_name}`\nwhich Bitbucket will turn into `https://foo.com/builds/foo/bar` at render time.\nThe context variables available are `repository` and `commit`."
+ },
+ "parameters": [
+ {
+ "name": "commit",
+ "in": "path",
+ "description": "The commit's SHA1.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/commit/{commit}/statuses/build/{key}": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The build status object with the specified key.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/commitstatus"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "If the repository is private and the request was not authenticated."
+ },
+ "404": {
+ "description": "If the repository, commit, or build status key does not exist",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Commit statuses"],
+ "summary": "Get a build status for a commit",
+ "security": [
+ {
+ "oauth2": ["repository"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns the specified build status for a commit."
+ },
+ "put": {
+ "responses": {
+ "200": {
+ "description": "The updated build status object.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/commitstatus"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "If the repository is private and the request was not authenticated."
+ },
+ "404": {
+ "description": "If the repository or build does not exist",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/commitstatus"
+ }
+ }
+ },
+ "description": "The updated build status object"
+ },
+ "tags": ["Commit statuses"],
+ "summary": "Update a build status for a commit",
+ "security": [
+ {
+ "oauth2": ["repository"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Used to update the current status of a build status object on the\nspecific commit.\n\nThis operation can also be used to change other properties of the\nbuild status:\n\n* `state`\n* `name`\n* `description`\n* `url`\n* `refname`\n\nThe `key` cannot be changed."
+ },
+ "parameters": [
+ {
+ "name": "commit",
+ "in": "path",
+ "description": "The commit's SHA1.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "key",
+ "in": "path",
+ "description": "The build status' unique key",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/commits": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "A paginated list of commits",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_changeset"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the specified repository does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Commits"],
+ "summary": "List commits",
+ "security": [
+ {
+ "oauth2": ["repository"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "These are the repository's commits. They are paginated and returned\nin reverse chronological order, similar to the output of `git log`.\nLike these tools, the DAG can be filtered.\n\n#### GET /repositories/{workspace}/{repo_slug}/commits/\n\nReturns all commits in the repo in topological order (newest commit\nfirst). All branches and tags are included (similar to\n`git log --all`).\n\n#### GET /repositories/{workspace}/{repo_slug}/commits/?exclude=master\n\nReturns all commits in the repo that are not on master\n(similar to `git log --all ^master`).\n\n#### GET /repositories/{workspace}/{repo_slug}/commits/?include=foo&include=bar&exclude=fu&exclude=fubar\n\nReturns all commits that are on refs `foo` or `bar`, but not on `fu` or\n`fubar` (similar to `git log foo bar ^fu ^fubar`).\n\nAn optional `path` parameter can be specified that will limit the\nresults to commits that affect that path. `path` can either be a file\nor a directory. If a directory is specified, commits are returned that\nhave modified any file in the directory tree rooted by `path`. It is\nimportant to note that if the `path` parameter is specified, the commits\nreturned by this endpoint may no longer be a DAG, parent commits that\ndo not modify the path will be omitted from the response.\n\n#### GET /repositories/{workspace}/{repo_slug}/commits/?path=README.md&include=foo&include=bar&exclude=master\n\nReturns all commits that are on refs `foo` or `bar`, but not on `master`\nthat changed the file README.md.\n\n#### GET /repositories/{workspace}/{repo_slug}/commits/?path=src/&include=foo&include=bar&exclude=master\n\nReturns all commits that are on refs `foo` or `bar`, but not on `master`\nthat changed to a file in any file in the directory src or its children.\n\nBecause the response could include a very large number of commits, it\nis paginated. Follow the 'next' link in the response to navigate to the\nnext page of commits. As with other paginated resources, do not\nconstruct your own links.\n\nWhen the include and exclude parameters are more than can fit in a\nquery string, clients can use a `x-www-form-urlencoded` POST instead."
+ },
+ "post": {
+ "responses": {
+ "200": {
+ "description": "A paginated list of commits",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_changeset"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the specified repository does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Commits"],
+ "summary": "List commits with include/exclude",
+ "security": [
+ {
+ "oauth2": ["repository"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Identical to `GET /repositories/{workspace}/{repo_slug}/commits`,\nexcept that POST allows clients to place the include and exclude\nparameters in the request body to avoid URL length issues.\n\n**Note that this resource does NOT support new commit creation.**"
+ },
+ "parameters": [
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/commits/{revision}": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "A paginated list of commits",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_changeset"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the specified revision does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Commits"],
+ "summary": "List commits for revision",
+ "security": [
+ {
+ "oauth2": ["repository"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "These are the repository's commits. They are paginated and returned\nin reverse chronological order, similar to the output of `git log`.\nLike these tools, the DAG can be filtered.\n\n#### GET /repositories/{workspace}/{repo_slug}/commits/master\n\nReturns all commits on rev `master` (similar to `git log master`).\n\n#### GET /repositories/{workspace}/{repo_slug}/commits/dev?include=foo&exclude=master\n\nReturns all commits on ref `dev` or `foo`, except those that are reachable on\n`master` (similar to `git log dev foo ^master`).\n\nAn optional `path` parameter can be specified that will limit the\nresults to commits that affect that path. `path` can either be a file\nor a directory. If a directory is specified, commits are returned that\nhave modified any file in the directory tree rooted by `path`. It is\nimportant to note that if the `path` parameter is specified, the commits\nreturned by this endpoint may no longer be a DAG, parent commits that\ndo not modify the path will be omitted from the response.\n\n#### GET /repositories/{workspace}/{repo_slug}/commits/dev?path=README.md&include=foo&include=bar&exclude=master\n\nReturns all commits that are on refs `dev` or `foo` or `bar`, but not on `master`\nthat changed the file README.md.\n\n#### GET /repositories/{workspace}/{repo_slug}/commits/dev?path=src/&include=foo&exclude=master\n\nReturns all commits that are on refs `dev` or `foo`, but not on `master`\nthat changed to a file in any file in the directory src or its children.\n\nBecause the response could include a very large number of commits, it\nis paginated. Follow the 'next' link in the response to navigate to the\nnext page of commits. As with other paginated resources, do not\nconstruct your own links.\n\nWhen the include and exclude parameters are more than can fit in a\nquery string, clients can use a `x-www-form-urlencoded` POST instead."
+ },
+ "post": {
+ "responses": {
+ "200": {
+ "description": "A paginated list of commits",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_changeset"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the specified revision does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Commits"],
+ "summary": "List commits for revision using include/exclude",
+ "security": [
+ {
+ "oauth2": ["repository"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Identical to `GET /repositories/{workspace}/{repo_slug}/commits/{revision}`,\nexcept that POST allows clients to place the include and exclude\nparameters in the request body to avoid URL length issues.\n\n**Note that this resource does NOT support new commit creation.**"
+ },
+ "parameters": [
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "revision",
+ "in": "path",
+ "description": "The commit's SHA1.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/components": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The components that have been defined in the issue tracker.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_components"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The specified repository does not exist or does not have the issue tracker enabled.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Issue tracker"],
+ "summary": "List components",
+ "security": [
+ {
+ "oauth2": ["issue"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns the components that have been defined in the issue tracker.\n\nThis resource is only available on repositories that have the issue\ntracker enabled."
+ },
+ "parameters": [
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/components/{component_id}": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The specified component object.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/component"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The specified repository or component does not exist or does not have the issue tracker enabled.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Issue tracker"],
+ "summary": "Get a component for issues",
+ "security": [
+ {
+ "oauth2": ["issue"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns the specified issue tracker component object."
+ },
+ "parameters": [
+ {
+ "name": "component_id",
+ "in": "path",
+ "description": "The component's id",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/default-reviewers": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The paginated list of default reviewers"
+ },
+ "403": {
+ "description": "If the authenticated user does not have access to view the default reviewers",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Pullrequests"],
+ "summary": "List default reviewers",
+ "security": [
+ {
+ "oauth2": ["pullrequest"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns the repository's default reviewers.\n\nThese are the users that are automatically added as reviewers on every\nnew pull request that is created."
+ },
+ "parameters": [
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/default-reviewers/{target_username}": {
+ "delete": {
+ "responses": {
+ "204": {
+ "description": "The specified user successfully removed from the default reviewers"
+ },
+ "403": {
+ "description": "If the authenticated user does not have access modify the default reviewers",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the specified user does not exist",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Pullrequests"],
+ "summary": "Remove a user from the default reviewers",
+ "security": [
+ {
+ "oauth2": ["repository:admin"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Removes a default reviewer from the repository."
+ },
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The specified user is a default reviewer"
+ },
+ "403": {
+ "description": "If the authenticated user does not have access to check if the specified user is a default reviewer",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the specified user does not exist or is not a default reviewer",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Pullrequests"],
+ "summary": "Get a default reviewer",
+ "security": [
+ {
+ "oauth2": ["pullrequest"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns the specified reviewer.\n\nThis can be used to test whether a user is among the repository's\ndefault reviewers list. A 404 indicates that that specified user is not\na default reviewer."
+ },
+ "put": {
+ "responses": {
+ "200": {
+ "description": "The specified user was successfully added to the default reviewers"
+ },
+ "400": {
+ "description": "If the authenticated user tried to add a team, bot user, or user without access to the repository to the default reviewers",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "If the authenticated user does not have permission to modify the default reviewers",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the specified user does not exist",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Pullrequests"],
+ "summary": "Add a user to the default reviewers",
+ "security": [
+ {
+ "oauth2": ["repository:admin"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Adds the specified user to the repository's list of default\nreviewers.\n\nThis method is idempotent. Adding a user a second time has no effect."
+ },
+ "parameters": [
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "target_username",
+ "in": "path",
+ "description": "This can either be the username or the UUID of the default reviewer,\nsurrounded by curly-braces, for example: `{account UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/deploy-keys": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "Deploy keys matching the repository",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_deploy_keys"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "If the specified user or repository is not accessible to the current user"
+ },
+ "404": {
+ "description": "If the specified user or repository does not exist",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Deployments"],
+ "summary": "List deploy keys",
+ "security": [
+ {
+ "oauth2": ["repository", "repository:admin"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns all deploy-keys belonging to a repository.\n\nExample:\n```\n$ curl -H \"Authorization \" \\\nhttps://api.bitbucket.org/2.0/repositories/mleu/test/deploy-keys\n\nOutput:\n{\n \"pagelen\": 10,\n \"values\": [\n {\n \"id\": 123,\n \"key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAK/b1cHHDr/TEV1JGQl+WjCwStKG6Bhrv0rFpEsYlyTBm1fzN0VOJJYn4ZOPCPJwqse6fGbXntEs+BbXiptR+++HycVgl65TMR0b5ul5AgwrVdZdT7qjCOCgaSV74/9xlHDK8oqgGnfA7ZoBBU+qpVyaloSjBdJfLtPY/xqj4yHnXKYzrtn/uFc4Kp9Tb7PUg9Io3qohSTGJGVHnsVblq/rToJG7L5xIo0OxK0SJSQ5vuId93ZuFZrCNMXj8JDHZeSEtjJzpRCBEXHxpOPhAcbm4MzULgkFHhAVgp4JbkrT99/wpvZ7r9AdkTg7HGqL3rlaDrEcWfL7Lu6TnhBdq5\",\n \"label\": \"mykey\",\n \"type\": \"deploy_key\",\n \"created_on\": \"2018-08-15T23:50:59.993890+00:00\",\n \"repository\": {\n \"full_name\": \"mleu/test\",\n \"name\": \"test\",\n \"type\": \"repository\",\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"links\":{\n \"self\":{\n \"href\": \"https://api.bitbucket.org/2.0/repositories/mleu/test/deploy-keys/123\"\n }\n }\n \"last_used\": null,\n \"comment\": \"mleu@C02W454JHTD8\"\n }\n ],\n \"page\": 1,\n \"size\": 1\n}\n```"
+ },
+ "post": {
+ "responses": {
+ "200": {
+ "description": "The deploy key that was created",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/deploy_key"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Invalid deploy key inputs"
+ },
+ "403": {
+ "description": "If the specified user or repository is not accessible to the current user"
+ },
+ "404": {
+ "description": "If the specified user or repository does not exist",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Deployments"],
+ "summary": "Add a deploy key",
+ "security": [
+ {
+ "oauth2": ["repository", "repository:admin"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Create a new deploy key in a repository. Note: If authenticating a deploy key\nwith an OAuth consumer, any changes to the OAuth consumer will subsequently\ninvalidate the deploy key.\n\n\nExample:\n```\n$ curl -XPOST \\\n-H \"Authorization \" \\\n-H \"Content-type: application/json\" \\\nhttps://api.bitbucket.org/2.0/repositories/mleu/test/deploy-keys -d \\\n'{\n \"key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAK/b1cHHDr/TEV1JGQl+WjCwStKG6Bhrv0rFpEsYlyTBm1fzN0VOJJYn4ZOPCPJwqse6fGbXntEs+BbXiptR+++HycVgl65TMR0b5ul5AgwrVdZdT7qjCOCgaSV74/9xlHDK8oqgGnfA7ZoBBU+qpVyaloSjBdJfLtPY/xqj4yHnXKYzrtn/uFc4Kp9Tb7PUg9Io3qohSTGJGVHnsVblq/rToJG7L5xIo0OxK0SJSQ5vuId93ZuFZrCNMXj8JDHZeSEtjJzpRCBEXHxpOPhAcbm4MzULgkFHhAVgp4JbkrT99/wpvZ7r9AdkTg7HGqL3rlaDrEcWfL7Lu6TnhBdq5 mleu@C02W454JHTD8\",\n \"label\": \"mydeploykey\"\n}'\n\nOutput:\n{\n \"id\": 123,\n \"key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAK/b1cHHDr/TEV1JGQl+WjCwStKG6Bhrv0rFpEsYlyTBm1fzN0VOJJYn4ZOPCPJwqse6fGbXntEs+BbXiptR+++HycVgl65TMR0b5ul5AgwrVdZdT7qjCOCgaSV74/9xlHDK8oqgGnfA7ZoBBU+qpVyaloSjBdJfLtPY/xqj4yHnXKYzrtn/uFc4Kp9Tb7PUg9Io3qohSTGJGVHnsVblq/rToJG7L5xIo0OxK0SJSQ5vuId93ZuFZrCNMXj8JDHZeSEtjJzpRCBEXHxpOPhAcbm4MzULgkFHhAVgp4JbkrT99/wpvZ7r9AdkTg7HGqL3rlaDrEcWfL7Lu6TnhBdq5\",\n \"label\": \"mydeploykey\",\n \"type\": \"deploy_key\",\n \"created_on\": \"2018-08-15T23:50:59.993890+00:00\",\n \"repository\": {\n \"full_name\": \"mleu/test\",\n \"name\": \"test\",\n \"type\": \"repository\",\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"links\":{\n \"self\":{\n \"href\": \"https://api.bitbucket.org/2.0/repositories/mleu/test/deploy-keys/123\"\n }\n }\n \"last_used\": null,\n \"comment\": \"mleu@C02W454JHTD8\"\n}\n```"
+ },
+ "parameters": [
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/deploy-keys/{key_id}": {
+ "delete": {
+ "responses": {
+ "204": {
+ "description": "The key has been deleted"
+ },
+ "403": {
+ "description": "If the current user does not have permission to delete a key for the specified user"
+ },
+ "404": {
+ "description": "If the specified user, repository, or deploy key does not exist",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Deployments"],
+ "summary": "Delete a deploy key",
+ "security": [
+ {
+ "oauth2": ["repository", "repository:admin"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "This deletes a deploy key from a repository.\n\nExample:\n```\n$ curl -XDELETE \\\n-H \"Authorization \" \\\nhttps://api.bitbucket.org/2.0/repositories/mleu/test/deploy-keys/1234\n```"
+ },
+ "get": {
+ "responses": {
+ "200": {
+ "description": "Deploy key matching the key ID",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/deploy_key"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "If the specified user or repository is not accessible to the current user"
+ },
+ "404": {
+ "description": "If the specified user or repository does not exist",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Deployments"],
+ "summary": "Get a deploy key",
+ "security": [
+ {
+ "oauth2": ["repository", "repository:admin"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns the deploy key belonging to a specific key.\n\nExample:\n```\n$ curl -H \"Authorization \" \\\nhttps://api.bitbucket.org/2.0/repositories/mleu/test/deploy-key/1234\n\nOutput:\n{\n \"comment\": \"mleu@C02W454JHTD8\",\n \"last_used\": null,\n \"links\": {\n \"self\": {\n \"href\": https://api.bitbucket.org/2.0/repositories/mleu/test/deploy-key/1234\"\n }\n },\n \"repository\": {\n \"full_name\": \"mleu/test\",\n \"name\": \"test\",\n \"type\": \"repository\",\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"label\": \"mykey\",\n \"created_on\": \"2018-08-15T23:50:59.993890+00:00\",\n \"key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAK/b1cHHDr/TEV1JGQl+WjCwStKG6Bhrv0rFpEsYlyTBm1fzN0VOJJYn4ZOPCPJwqse6fGbXntEs+BbXiptR+++HycVgl65TMR0b5ul5AgwrVdZdT7qjCOCgaSV74/9xlHDK8oqgGnfA7ZoBBU+qpVyaloSjBdJfLtPY/xqj4yHnXKYzrtn/uFc4Kp9Tb7PUg9Io3qohSTGJGVHnsVblq/rToJG7L5xIo0OxK0SJSQ5vuId93ZuFZrCNMXj8JDHZeSEtjJzpRCBEXHxpOPhAcbm4MzULgkFHhAVgp4JbkrT99/wpvZ7r9AdkTg7HGqL3rlaDrEcWfL7Lu6TnhBdq5\",\n \"id\": 1234,\n \"type\": \"deploy_key\"\n}\n```"
+ },
+ "put": {
+ "responses": {
+ "200": {
+ "description": "The newly updated deploy key.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/deploy_key"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "If the submitted key or related value is invalid",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "If the current user does not have permission to add a key for the specified user"
+ },
+ "404": {
+ "description": "If the specified user, repository, or deploy key does not exist",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Deployments"],
+ "summary": "Update a deploy key",
+ "security": [
+ {
+ "oauth2": ["repository", "repository:admin"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Create a new deploy key in a repository.\n\nThe same key needs to be passed in but the comment and label can change.\n\nExample:\n```\n$ curl -XPUT \\\n-H \"Authorization \" \\\n-H \"Content-type: application/json\" \\\nhttps://api.bitbucket.org/2.0/repositories/mleu/test/deploy-keys/1234 -d \\\n'{\n \"label\": \"newlabel\",\n \"key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAK/b1cHHDr/TEV1JGQl+WjCwStKG6Bhrv0rFpEsYlyTBm1fzN0VOJJYn4ZOPCPJwqse6fGbXntEs+BbXiptR+++HycVgl65TMR0b5ul5AgwrVdZdT7qjCOCgaSV74/9xlHDK8oqgGnfA7ZoBBU+qpVyaloSjBdJfLtPY/xqj4yHnXKYzrtn/uFc4Kp9Tb7PUg9Io3qohSTGJGVHnsVblq/rToJG7L5xIo0OxK0SJSQ5vuId93ZuFZrCNMXj8JDHZeSEtjJzpRCBEXHxpOPhAcbm4MzULgkFHhAVgp4JbkrT99/wpvZ7r9AdkTg7HGqL3rlaDrEcWfL7Lu6TnhBdq5 newcomment\",\n}'\n\nOutput:\n{\n \"comment\": \"newcomment\",\n \"last_used\": null,\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/mleu/test/deploy-keys/1234\"\n }\n },\n \"repository\": {\n \"full_name\": \"mleu/test\",\n \"name\": \"test\",\n \"type\": \"repository\",\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"label\": \"newlabel\",\n \"created_on\": \"2018-08-15T23:50:59.993890+00:00\",\n \"key\": \"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDAK/b1cHHDr/TEV1JGQl+WjCwStKG6Bhrv0rFpEsYlyTBm1fzN0VOJJYn4ZOPCPJwqse6fGbXntEs+BbXiptR+++HycVgl65TMR0b5ul5AgwrVdZdT7qjCOCgaSV74/9xlHDK8oqgGnfA7ZoBBU+qpVyaloSjBdJfLtPY/xqj4yHnXKYzrtn/uFc4Kp9Tb7PUg9Io3qohSTGJGVHnsVblq/rToJG7L5xIo0OxK0SJSQ5vuId93ZuFZrCNMXj8JDHZeSEtjJzpRCBEXHxpOPhAcbm4MzULgkFHhAVgp4JbkrT99/wpvZ7r9AdkTg7HGqL3rlaDrEcWfL7Lu6TnhBdq5\",\n \"id\": 1234,\n \"type\": \"deploy_key\"\n}\n```"
+ },
+ "parameters": [
+ {
+ "name": "key_id",
+ "in": "path",
+ "description": "The key ID matching the deploy key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/deployments/": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The matching deployments.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_deployments"
+ }
+ }
+ }
+ }
+ },
+ "description": "Find deployments",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Deployments"],
+ "summary": "List deployments",
+ "operationId": "getDeploymentsForRepository"
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/deployments/{deployment_uuid}": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The deployment.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/deployment"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "No account, repository or deployment with the UUID provided exists.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "description": "Retrieve a deployment",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The deployment UUID.",
+ "required": true,
+ "name": "deployment_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Deployments"],
+ "summary": "Get a deployment",
+ "operationId": "getDeploymentForRepository"
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables": {
+ "post": {
+ "responses": {
+ "201": {
+ "headers": {
+ "Location": {
+ "description": "The URL of the newly created variable.",
+ "schema": {
+ "type": "string"
+ }
+ }
+ },
+ "description": "The variable was created.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/deployment_variable"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The account, repository, environment or variable with the given UUID was not found.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "A variable with the provided key already exists.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "description": "Create a deployment environment level variable.",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The environment.",
+ "required": true,
+ "name": "environment_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/deployment_variable"
+ }
+ }
+ },
+ "description": "The variable to create",
+ "required": true
+ },
+ "tags": ["Pipelines"],
+ "summary": "Create a variable for an environment",
+ "operationId": "createDeploymentVariable"
+ },
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The retrieved deployment variables.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_deployment_variable"
+ }
+ }
+ }
+ }
+ },
+ "description": "Find deployment environment level variables.",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The environment.",
+ "required": true,
+ "name": "environment_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Pipelines"],
+ "summary": "List variables for an environment",
+ "operationId": "getDeploymentVariables"
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/deployments_config/environments/{environment_uuid}/variables/{variable_uuid}": {
+ "put": {
+ "responses": {
+ "200": {
+ "description": "The deployment variable was updated.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/deployment_variable"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The account, repository, environment or variable with the given UUID was not found.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "description": "Update a deployment environment level variable.",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The environment.",
+ "required": true,
+ "name": "environment_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The UUID of the variable to update.",
+ "required": true,
+ "name": "variable_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/deployment_variable"
+ }
+ }
+ },
+ "description": "The updated deployment variable.",
+ "required": true
+ },
+ "tags": ["Pipelines"],
+ "summary": "Update a variable for an environment",
+ "operationId": "updateDeploymentVariable"
+ },
+ "delete": {
+ "responses": {
+ "204": {
+ "description": "The variable was deleted."
+ },
+ "404": {
+ "description": "The account, repository, environment or variable with given UUID was not found.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "description": "Delete a deployment environment level variable.",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The environment.",
+ "required": true,
+ "name": "environment_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The UUID of the variable to delete.",
+ "required": true,
+ "name": "variable_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Pipelines"],
+ "summary": "Delete a variable for an environment",
+ "operationId": "deleteDeploymentVariable"
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/diff/{spec}": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The raw diff"
+ },
+ "555": {
+ "description": "If the diff was too large and timed out.\n\nSince this endpoint does not employ any form of pagination, but\ninstead returns the diff as a single document, it can run into\ntrouble on very large diffs. If Bitbucket times out in cases\nlike these, a 555 status code is returned.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "context",
+ "in": "query",
+ "description": "Generate diffs with lines of context instead of the usual three.",
+ "required": false,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "path",
+ "in": "query",
+ "description": "Limit the diff to a particular file (this parameter\ncan be repeated for multiple paths).",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "ignore_whitespace",
+ "in": "query",
+ "description": "Generate diffs that ignore whitespace.",
+ "required": false,
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "binary",
+ "in": "query",
+ "description": "Generate diffs that include binary files, true if omitted.",
+ "required": false,
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "renames",
+ "in": "query",
+ "description": "Whether to perform rename detection, true if omitted.",
+ "required": false,
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "merge",
+ "in": "query",
+ "description": "This parameter is deprecated and will be removed at the end\nof 2022. The 'topic' parameter should be used instead. The\n'merge' and 'topic' parameters cannot be both used at the same\ntime.\n\nIf true, the source commit is merged into the\ndestination commit, and then a diff from the\ndestination to the merge result is returned. If false,\na simple 'two dot' diff between the source and\ndestination is returned. True if omitted.",
+ "required": false,
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "topic",
+ "in": "query",
+ "description": "If true, returns 2-way 'three-dot' diff.\nThis is a diff between the source commit and the merge base\nof the source commit and the destination commit.\nIf false, a simple 'two dot' diff between the source and\ndestination is returned.",
+ "required": false,
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ ],
+ "tags": ["Commits"],
+ "summary": "Compare two commits",
+ "security": [
+ {
+ "oauth2": ["repository"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Produces a raw git-style diff.\n\n#### Single commit spec\n\nIf the `spec` argument to this API is a single commit, the diff is\nproduced against the first parent of the specified commit.\n\n#### Two commit spec\n\nTwo commits separated by `..` may be provided as the `spec`, e.g.,\n`3a8b42..9ff173`. When two commits are provided and the `topic` query\nparameter is true or absent, this API produces a 2-way three dot diff.\nThis is the diff between source commit and the merge base of the source\ncommit and the destination commit. When the `topic` query param is false,\na simple git-style diff is produced.\n\nThe two commits are interpreted as follows:\n\n* First commit: the commit containing the changes we wish to preview\n* Second commit: the commit representing the state to which we want to\n compare the first commit\n* **Note**: This is the opposite of the order used in `git diff`.\n\n#### Comparison to patches\n\nWhile similar to patches, diffs:\n\n* Don't have a commit header (username, commit message, etc)\n* Support the optional `path=foo/bar.py` query param to filter\n the diff to just that one file diff\n\n#### Response\n\nThe raw diff is returned as-is, in whatever encoding the files in the\nrepository use. It is not decoded into unicode. As such, the\ncontent-type is `text/plain`."
+ },
+ "parameters": [
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "spec",
+ "in": "path",
+ "description": "A commit SHA (e.g. `3a8b42`) or a commit range using double dot\nnotation (e.g. `3a8b42..9ff173`).\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/diffstat/{spec}": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The diff stats",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_diffstats"
+ }
+ }
+ }
+ },
+ "555": {
+ "description": "If generating the diffstat timed out.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Commits"],
+ "summary": "Compare two commit diff stats",
+ "security": [
+ {
+ "oauth2": ["repository"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Produces a response in JSON format with a record for every path\nmodified, including information on the type of the change and the\nnumber of lines added and removed.\n\n#### Single commit spec\n\nIf the `spec` argument to this API is a single commit, the diff is\nproduced against the first parent of the specified commit.\n\n#### Two commit spec\n\nTwo commits separated by `..` may be provided as the `spec`, e.g.,\n`3a8b42..9ff173`. When two commits are provided and the `topic` query\nparameter is true or absent, this API produces a 2-way three dot diff.\nThis is the diff between source commit and the merge base of the source\ncommit and the destination commit. When the `topic` query param is false,\na simple git-style diff is produced.\n\nThe two commits are interpreted as follows:\n\n* First commit: the commit containing the changes we wish to preview\n* Second commit: the commit representing the state to which we want to\n compare the first commit\n* **Note**: This is the opposite of the order used in `git diff`.\n\n#### Sample output\n```\ncurl https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/diffstat/d222fa2..e174964\n{\n \"pagelen\": 500,\n \"values\": [\n {\n \"type\": \"diffstat\",\n \"status\": \"modified\",\n \"lines_removed\": 1,\n \"lines_added\": 2,\n \"old\": {\n \"path\": \"setup.py\",\n \"escaped_path\": \"setup.py\",\n \"type\": \"commit_file\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/src/e1749643d655d7c7014001a6c0f58abaf42ad850/setup.py\"\n }\n }\n },\n \"new\": {\n \"path\": \"setup.py\",\n \"escaped_path\": \"setup.py\",\n \"type\": \"commit_file\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/bitbucket/geordi/src/d222fa235229c55dad20b190b0b571adf737d5a6/setup.py\"\n }\n }\n }\n }\n ],\n \"page\": 1,\n \"size\": 1\n}\n```"
+ },
+ "parameters": [
+ {
+ "name": "ignore_whitespace",
+ "in": "query",
+ "description": "Generate diffs that ignore whitespace",
+ "required": false,
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "merge",
+ "in": "query",
+ "description": "This parameter is deprecated and will be removed at the end\nof 2022. The 'topic' parameter should be used instead. The\n'merge' and 'topic' parameters cannot be both used at the same\ntime.\n\nIf true, the source commit is merged into the\ndestination commit, and then a diffstat from the\ndestination to the merge result is returned. If false,\na simple 'two dot' diffstat between the source and\ndestination is returned. True if omitted.",
+ "required": false,
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "path",
+ "in": "query",
+ "description": "Limit the diffstat to a particular file (this parameter\ncan be repeated for multiple paths).",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "renames",
+ "in": "query",
+ "description": "Whether to perform rename detection, true if omitted.",
+ "required": false,
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "spec",
+ "in": "path",
+ "description": "A commit SHA (e.g. `3a8b42`) or a commit range using double dot\nnotation (e.g. `3a8b42..9ff173`).\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "topic",
+ "in": "query",
+ "description": "If true, returns 2-way 'three-dot' diff.\nThis is a diff between the source commit and the merge base\nof the source commit and the destination commit.\nIf false, a simple 'two dot' diff between the source and\ndestination is returned.",
+ "required": false,
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/downloads": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "Returns a paginated list of the downloads associated with the repository."
+ },
+ "403": {
+ "description": "User is not authorized to read from the repository.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Downloads"],
+ "summary": "List download artifacts",
+ "security": [
+ {
+ "oauth2": ["repository"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns a list of download links associated with the repository."
+ },
+ "post": {
+ "responses": {
+ "201": {
+ "description": "The artifact was uploaded sucessfully."
+ },
+ "400": {
+ "description": "Bad Request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "User is not authorized to write to the repository.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "406": {
+ "description": "Unsupported Content-Type. Use multiplart/form-data.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Downloads"],
+ "summary": "Upload a download artifact",
+ "security": [
+ {
+ "oauth2": ["repository:write"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Upload new download artifacts.\n\nTo upload files, perform a `multipart/form-data` POST containing one\nor more `files` fields:\n\n $ echo Hello World > hello.txt\n $ curl -s -u evzijst -X POST https://api.bitbucket.org/2.0/repositories/evzijst/git-tests/downloads -F files=@hello.txt\n\nWhen a file is uploaded with the same name as an existing artifact,\nthen the existing file will be replaced."
+ },
+ "parameters": [
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/downloads/{filename}": {
+ "delete": {
+ "responses": {
+ "204": {
+ "description": "The specified download artifact was deleted."
+ },
+ "403": {
+ "description": "User is not authorized to write to the repository.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The specified download does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Downloads"],
+ "summary": "Delete a download artifact",
+ "security": [
+ {
+ "oauth2": ["repository:write"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Deletes the specified download artifact from the repository."
+ },
+ "get": {
+ "responses": {
+ "302": {
+ "description": "Redirects to the url of the specified download artifact."
+ },
+ "403": {
+ "description": "User is not authorized to read from the repository.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The specified download artifact does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Downloads"],
+ "summary": "Get a download artifact link",
+ "security": [
+ {
+ "oauth2": ["repository"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Return a redirect to the contents of a download artifact.\n\nThis endpoint returns the actual file contents and not the artifact's\nmetadata.\n\n $ curl -s -L https://api.bitbucket.org/2.0/repositories/evzijst/git-tests/downloads/hello.txt\n Hello World"
+ },
+ "parameters": [
+ {
+ "name": "filename",
+ "in": "path",
+ "description": "Name of the file.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/environments/": {
+ "post": {
+ "responses": {
+ "201": {
+ "headers": {
+ "Location": {
+ "description": "The URL of the newly created environment.",
+ "schema": {
+ "type": "string"
+ }
+ }
+ },
+ "description": "The environment was created.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/deployment_environment"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The account or repository does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "An environment host with the provided name already exists.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "description": "Create an environment.",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/deployment_environment"
+ }
+ }
+ },
+ "description": "The environment to create.",
+ "required": true
+ },
+ "tags": ["Deployments"],
+ "summary": "Create an environment",
+ "operationId": "createEnvironment"
+ },
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The matching environments.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_environments"
+ }
+ }
+ }
+ }
+ },
+ "description": "Find environments",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Deployments"],
+ "summary": "List environments",
+ "operationId": "getEnvironmentsForRepository"
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/environments/{environment_uuid}": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The environment.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/deployment_environment"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "No account, repository or environment with the UUID provided exists.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "description": "Retrieve an environment",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The environment UUID.",
+ "required": true,
+ "name": "environment_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Deployments"],
+ "summary": "Get an environment",
+ "operationId": "getEnvironmentForRepository"
+ },
+ "delete": {
+ "responses": {
+ "204": {
+ "description": "The environment was deleted."
+ },
+ "404": {
+ "description": "No account or repository with the UUID provided exists.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "description": "Delete an environment",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The environment UUID.",
+ "required": true,
+ "name": "environment_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Deployments"],
+ "summary": "Delete an environment",
+ "operationId": "deleteEnvironmentForRepository"
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/environments/{environment_uuid}/changes/": {
+ "post": {
+ "responses": {
+ "202": {
+ "description": "The environment update request was accepted."
+ },
+ "404": {
+ "description": "No account, repository or environment with the UUID provided exists.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "description": "Update an environment",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The environment UUID.",
+ "required": true,
+ "name": "environment_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Deployments"],
+ "summary": "Update an environment",
+ "operationId": "updateEnvironmentForRepository"
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/filehistory/{commit}/{path}": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "A paginated list of commits that modified the specified file",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_files"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the repository does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "renames",
+ "in": "query",
+ "description": "\nWhen `true`, Bitbucket will follow the history of the file across\nrenames (this is the default behavior). This can be turned off by\nspecifying `false`.",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "q",
+ "in": "query",
+ "description": "\nQuery string to narrow down the response as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "sort",
+ "in": "query",
+ "description": "\nName of a response property sort the result by as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#sorting-query-results).\n",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Source", "Repositories"],
+ "summary": "List commits that modified a file",
+ "security": [
+ {
+ "oauth2": ["repository"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns a paginated list of commits that modified the specified file.\n\nCommits are returned in reverse chronological order. This is roughly\nequivalent to the following commands:\n\n $ git log --follow --date-order \n\nBy default, Bitbucket will follow renames and the path name in the\nreturned entries reflects that. This can be turned off using the\n`?renames=false` query parameter.\n\nResults are returned in descending chronological order by default, and\nlike most endpoints you can\n[filter and sort](/cloud/bitbucket/rest/intro/#filtering) the response to\nonly provide exactly the data you want.\n\nFor example, if you wanted to find commits made before 2011-05-18\nagainst a file named `README.rst`, but you only wanted the path and\ndate, your query would look like this:\n\n```\n$ curl 'https://api.bitbucket.org/2.0/repositories/evzijst/dogslow/filehistory/master/README.rst'\\\n '?fields=values.next,values.path,values.commit.date&q=commit.date<=2011-05-18'\n{\n \"values\": [\n {\n \"commit\": {\n \"date\": \"2011-05-17T07:32:09+00:00\"\n },\n \"path\": \"README.rst\"\n },\n {\n \"commit\": {\n \"date\": \"2011-05-16T06:33:28+00:00\"\n },\n \"path\": \"README.txt\"\n },\n {\n \"commit\": {\n \"date\": \"2011-05-16T06:15:39+00:00\"\n },\n \"path\": \"README.txt\"\n }\n ]\n}\n```\n\nIn the response you can see that the file was renamed to `README.rst`\nby the commit made on 2011-05-16, and was previously named `README.txt`."
+ },
+ "parameters": [
+ {
+ "name": "commit",
+ "in": "path",
+ "description": "The commit's SHA1.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "path",
+ "in": "path",
+ "description": "Path to the file.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/forks": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "All forks.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_repositories"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "role",
+ "in": "query",
+ "description": "Filters the result based on the authenticated user's role on each repository.\n\n* **member**: returns repositories to which the user has explicit read access\n* **contributor**: returns repositories to which the user has explicit write access\n* **admin**: returns repositories to which the user has explicit administrator access\n* **owner**: returns all repositories owned by the current user\n",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "enum": ["admin", "contributor", "member", "owner"]
+ }
+ },
+ {
+ "name": "q",
+ "in": "query",
+ "description": "Query string to narrow down the response as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).\n",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "sort",
+ "in": "query",
+ "description": "Field by which the results should be sorted as per [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).\n",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Repositories"],
+ "summary": "List repository forks",
+ "security": [
+ {
+ "oauth2": ["repository"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns a paginated list of all the forks of the specified\nrepository."
+ },
+ "post": {
+ "responses": {
+ "201": {
+ "description": "The newly created fork.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the newly created fork",
+ "schema": {
+ "type": "string"
+ }
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/repository"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/repository"
+ }
+ }
+ },
+ "description": "A repository object. This can be left blank."
+ },
+ "tags": ["Repositories"],
+ "summary": "Fork a repository",
+ "security": [
+ {
+ "oauth2": ["repository:write"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Creates a new fork of the specified repository.\n\n#### Forking a repository\n\nTo create a fork, specify the workspace explicitly as part of the\nrequest body:\n\n```\n$ curl -X POST -u jdoe https://api.bitbucket.org/2.0/repositories/atlassian/bbql/forks \\\n -H 'Content-Type: application/json' -d '{\n \"name\": \"bbql_fork\",\n \"workspace\": {\n \"slug\": \"atlassian\"\n }\n}'\n```\n\nTo fork a repository into the same workspace, also specify a new `name`.\n\nWhen you specify a value for `name`, it will also affect the `slug`.\nThe `slug` is reflected in the repository URL of the new fork. It is\nderived from `name` by substituting non-ASCII characters, removes\nwhitespace, and changes characters to lower case. For example,\n`My repo` would turn into `my_repo`.\n\nYou need contributor access to create new forks within a workspace.\n\n\n#### Change the properties of a new fork\n\nBy default the fork inherits most of its properties from the parent.\nHowever, since the optional POST body document follows the normal\n`repository` JSON schema and you can override the new fork's\nproperties.\n\nProperties that can be overridden include:\n\n* description\n* fork_policy\n* language\n* mainbranch\n* is_private (note that a private repo's fork_policy might prohibit\n the creation of public forks, in which `is_private=False` would fail)\n* has_issues (to initialize or disable the new repo's issue tracker --\n note that the actual contents of the parent repository's issue\n tracker are not copied during forking)\n* has_wiki (to initialize or disable the new repo's wiki --\n note that the actual contents of the parent repository's wiki are not\n copied during forking)\n* project (when forking into a private project, the fork's `is_private`\n must be `true`)\n\nProperties that cannot be modified include:\n\n* scm\n* parent\n* full_name"
+ },
+ "parameters": [
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/hooks": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The paginated list of installed webhooks.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_webhook_subscriptions"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "If the authenticated user does not have permission to access the webhooks.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the repository does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Repositories", "Webhooks"],
+ "summary": "List webhooks for a repository",
+ "security": [
+ {
+ "oauth2": ["webhook"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns a paginated list of webhooks installed on this repository."
+ },
+ "post": {
+ "responses": {
+ "201": {
+ "description": "If the webhook was registered successfully.",
+ "headers": {
+ "Location": {
+ "description": "The URL of new newly created webhook.",
+ "schema": {
+ "type": "string"
+ }
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook_subscription"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "If the authenticated user does not have permission to install webhooks on the specified repository.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the repository does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Repositories", "Webhooks"],
+ "summary": "Create a webhook for a repository",
+ "security": [
+ {
+ "oauth2": ["webhook"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Creates a new webhook on the specified repository.\n\nExample:\n\n```\n$ curl -X POST -u credentials -H 'Content-Type: application/json'\n https://api.bitbucket.org/2.0/repositories/my-workspace/my-repo-slug/hooks\n -d '\n {\n \"description\": \"Webhook Description\",\n \"url\": \"https://example.com/\",\n \"active\": true,\n \"events\": [\n \"repo:push\",\n \"issue:created\",\n \"issue:updated\"\n ]\n }'\n```\n\nNote that this call requires the webhook scope, as well as any scope\nthat applies to the events that the webhook subscribes to. In the\nexample above that means: `webhook`, `repository` and `issue`.\n\nAlso note that the `url` must properly resolve and cannot be an\ninternal, non-routed address."
+ },
+ "parameters": [
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/hooks/{uid}": {
+ "delete": {
+ "responses": {
+ "204": {
+ "description": "When the webhook was deleted successfully"
+ },
+ "403": {
+ "description": "If the authenticated user does not have permission to delete the webhook.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the webhook or repository does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Repositories", "Webhooks"],
+ "summary": "Delete a webhook for a repository",
+ "security": [
+ {
+ "oauth2": ["webhook"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Deletes the specified webhook subscription from the given\nrepository."
+ },
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The webhook subscription object.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook_subscription"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the webhook or repository does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Repositories", "Webhooks"],
+ "summary": "Get a webhook for a repository",
+ "security": [
+ {
+ "oauth2": ["webhook"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns the webhook with the specified id installed on the specified\nrepository."
+ },
+ "put": {
+ "responses": {
+ "200": {
+ "description": "The webhook subscription object.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/webhook_subscription"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "If the authenticated user does not have permission to update the webhook.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the webhook or repository does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Repositories", "Webhooks"],
+ "summary": "Update a webhook for a repository",
+ "security": [
+ {
+ "oauth2": ["webhook"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Updates the specified webhook subscription.\n\nThe following properties can be mutated:\n\n* `description`\n* `url`\n* `active`\n* `events`"
+ },
+ "parameters": [
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "uid",
+ "in": "path",
+ "description": "Installed webhook's ID",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/issues": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "A paginated list of the issues matching any filter criteria that were provided.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_issues"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The specified repository does not exist or does not have the issue tracker enabled.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Issue tracker"],
+ "summary": "List issues",
+ "security": [
+ {
+ "oauth2": ["issue"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns the issues in the issue tracker."
+ },
+ "post": {
+ "responses": {
+ "201": {
+ "description": "The newly created issue.",
+ "headers": {
+ "Location": {
+ "description": "The (absolute) URL of the newly created issue.",
+ "schema": {
+ "type": "string"
+ }
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issue"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "When the request wasn't authenticated.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "When the authenticated user isn't authorized to create the issue.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The specified repository does not exist or does not have the issue tracker enabled.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issue"
+ }
+ }
+ },
+ "description": "The new issue. The only required element is `title`. All other elements can be omitted from the body.",
+ "required": true
+ },
+ "tags": ["Issue tracker"],
+ "summary": "Create an issue",
+ "security": [
+ {
+ "oauth2": ["issue:write"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Creates a new issue.\n\nThis call requires authentication. Private repositories or private\nissue trackers require the caller to authenticate with an account that\nhas appropriate authorization.\n\nThe authenticated user is used for the issue's `reporter` field."
+ },
+ "parameters": [
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/issues/export": {
+ "post": {
+ "responses": {
+ "202": {
+ "description": "The export job has been accepted"
+ },
+ "401": {
+ "description": "The request wasn't authenticated properly",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "When the authenticated user does not have admin permission on the repo",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The repo does not exist or does not have an issue tracker",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/export_options"
+ }
+ }
+ },
+ "description": "The options to apply to the export. Available options include `project_key` and `project_name` which, if specified, are used as the project key and name in the exported Jira json format. Option `send_email` specifies whether an email should be sent upon export result. Option `include_attachments` specifies whether attachments are included in the export."
+ },
+ "tags": ["Issue tracker"],
+ "summary": "Export issues",
+ "security": [
+ {
+ "oauth2": ["issue", "repository:admin"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "A POST request to this endpoint initiates a new background celery task that archives the repo's issues.\n\nFor example, you can run:\n\ncurl -u -X POST http://api.bitbucket.org/2.0/repositories///\nissues/export\n\nWhen the job has been accepted, it will return a 202 (Accepted) along with a unique url to this job in the\n'Location' response header. This url is the endpoint for where the user can obtain their zip files.\""
+ },
+ "parameters": [
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/issues/export/{repo_name}-issues-{task_id}.zip": {
+ "get": {
+ "responses": {
+ "202": {
+ "description": "Export job accepted",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issue_job_status"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "The request wasn't authenticated properly",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "When the authenticated user does not have admin permission on the repo",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "No export job has begun",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Issue tracker"],
+ "summary": "Check issue export status",
+ "security": [
+ {
+ "oauth2": ["issue", "repository:admin"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "This endpoint is used to poll for the progress of an issue export\njob and return the zip file after the job is complete.\nAs long as the job is running, this will return a 200 response\nwith in the response body a description of the current status.\n\nAfter the job has been scheduled, but before it starts executing, this\nendpoint's response is:\n\n{\n \"type\": \"issue_job_status\",\n \"status\": \"ACCEPTED\",\n \"phase\": \"Initializing\",\n \"total\": 0,\n \"count\": 0,\n \"pct\": 0\n}\n\n\nThen once it starts running, it becomes:\n\n{\n \"type\": \"issue_job_status\",\n \"status\": \"STARTED\",\n \"phase\": \"Attachments\",\n \"total\": 15,\n \"count\": 11,\n \"pct\": 73\n}\n\nOnce the job has successfully completed, it returns a stream of the zip file."
+ },
+ "parameters": [
+ {
+ "name": "repo_name",
+ "in": "path",
+ "description": "The name of the repo",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "task_id",
+ "in": "path",
+ "description": "The ID of the export task",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/issues/import": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "Import job complete with either FAILURE or SUCCESS status",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issue_job_status"
+ }
+ }
+ }
+ },
+ "202": {
+ "description": "Import job started",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issue_job_status"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "The request wasn't authenticated properly",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "When the authenticated user does not have admin permission on the repo",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "No export job has begun",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Issue tracker"],
+ "summary": "Check issue import status",
+ "security": [
+ {
+ "oauth2": ["issue:write", "repository:admin"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "When using GET, this endpoint reports the status of the current import task. Request example:\n\n```\n$ curl -u -X GET https://api.bitbucket.org/2.0/repositories///issues/import\n```\n\nAfter the job has been scheduled, but before it starts executing, this endpoint's response is:\n\n```\n< HTTP/1.1 202 Accepted\n{\n \"type\": \"issue_job_status\",\n \"status\": \"PENDING\",\n \"phase\": \"Attachments\",\n \"total\": 15,\n \"count\": 0,\n \"percent\": 0\n}\n```\n\nOnce it starts running, it is a 202 response with status STARTED and progress filled.\n\nAfter it is finished, it becomes a 200 response with status SUCCESS or FAILURE."
+ },
+ "post": {
+ "responses": {
+ "202": {
+ "description": "Import job accepted",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issue_job_status"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "The request wasn't authenticated properly",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "When the authenticated user does not have admin permission on the repo",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "No export job has begun",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "Import already running",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Issue tracker"],
+ "summary": "Import issues",
+ "security": [
+ {
+ "oauth2": ["issue:write", "repository:admin"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "A POST request to this endpoint will import the zip file given by the archive parameter into the repository. All\nexisting issues will be deleted and replaced by the contents of the imported zip file.\n\nImports are done through a multipart/form-data POST. There is one valid and required form field, with the name\n\"archive,\" which needs to be a file field:\n\n```\n$ curl -u -X POST -F archive=@/path/to/file.zip https://api.bitbucket.org/2.0/repositories///issues/import\n```\n\nWhen the import job is accepted, here is example output:\n\n```\n< HTTP/1.1 202 Accepted\n\n{\n \"type\": \"issue_job_status\",\n \"status\": \"ACCEPTED\",\n \"phase\": \"Attachments\",\n \"total\": 15,\n \"count\": 0,\n \"percent\": 0\n}\n```"
+ },
+ "parameters": [
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/issues/{issue_id}": {
+ "delete": {
+ "responses": {
+ "200": {
+ "description": "The issue object.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issue"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "When the authenticated user isn't authorized to delete the issue.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The specified repository or issue does not exist or does not have the issue tracker enabled.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Issue tracker"],
+ "summary": "Delete an issue",
+ "security": [
+ {
+ "oauth2": ["issue:write"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Deletes the specified issue. This requires write access to the\nrepository."
+ },
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The issue object.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issue"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "When the authenticated user isn't authorized to access the issue.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The specified repository or issue does not exist or does not have the issue tracker enabled.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "410": {
+ "description": "The specified issue is unavailable.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Issue tracker"],
+ "summary": "Get an issue",
+ "security": [
+ {
+ "oauth2": ["issue"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns the specified issue."
+ },
+ "put": {
+ "responses": {
+ "200": {
+ "description": "The updated issue object.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issue"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "When the authenticated user isn't authorized to access the issue.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The specified repository or issue does not exist or does not have the issue tracker enabled.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Issue tracker"],
+ "summary": "Update an issue",
+ "security": [
+ {
+ "oauth2": ["issue:write"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Modifies the issue.\n\n```\n$ curl https://api.bitbucket.org/2.0/repostories/evzijst/dogslow/issues/123 \\\n -u evzijst -s -X PUT -H 'Content-Type: application/json' \\\n -d '{\n \"title\": \"Updated title\",\n \"assignee\": {\n \"username\": \"evzijst\"\n },\n \"priority\": \"minor\",\n \"version\": {\n \"name\": \"1.0\"\n },\n \"component\": null\n}'\n```\n\nThis example changes the `title`, `assignee`, `priority` and the\n`version`. It also removes the value of the `component` from the issue\nby setting the field to `null`. Any field not present keeps its existing\nvalue.\n\nEach time an issue is edited in the UI or through the API, an immutable\nchange record is created under the `/issues/123/changes` endpoint. It\nalso has a comment associated with the change."
+ },
+ "parameters": [
+ {
+ "name": "issue_id",
+ "in": "path",
+ "description": "The issue id",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/issues/{issue_id}/attachments": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "A paginated list of all attachments for this issue.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_issue_attachments"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "If the issue tracker is private and the request was not authenticated."
+ },
+ "404": {
+ "description": "The specified repository or issue does not exist or does not have the issue tracker enabled.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Issue tracker"],
+ "summary": "List attachments for an issue",
+ "security": [
+ {
+ "oauth2": ["issue"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns all attachments for this issue.\n\nThis returns the files' meta data. This does not return the files'\nactual contents.\n\nThe files are always ordered by their upload date."
+ },
+ "post": {
+ "responses": {
+ "201": {
+ "description": "An empty response document.",
+ "headers": {
+ "Location": {
+ "description": "The URL to the issue's collection of attachments.",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "If no files were uploaded, or if the wrong `Content-Type` was used."
+ },
+ "401": {
+ "description": "If the issue tracker is private and the request was not authenticated."
+ },
+ "404": {
+ "description": "The specified repository or issue does not exist or does not have the issue tracker enabled.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Issue tracker"],
+ "summary": "Upload an attachment to an issue",
+ "security": [
+ {
+ "oauth2": ["issue:write"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Upload new issue attachments.\n\nTo upload files, perform a `multipart/form-data` POST containing one\nor more file fields.\n\nWhen a file is uploaded with the same name as an existing attachment,\nthen the existing file will be replaced."
+ },
+ "parameters": [
+ {
+ "name": "issue_id",
+ "in": "path",
+ "description": "The issue id",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/issues/{issue_id}/attachments/{path}": {
+ "delete": {
+ "responses": {
+ "204": {
+ "description": "Indicates that the deletion was successful"
+ },
+ "401": {
+ "description": "If the issue tracker is private and the request was not authenticated."
+ },
+ "404": {
+ "description": "The specified repository or issue does not exist or does not have the issue tracker enabled.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Issue tracker"],
+ "summary": "Delete an attachment for an issue",
+ "security": [
+ {
+ "oauth2": ["issue:write"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Deletes an attachment."
+ },
+ "get": {
+ "responses": {
+ "302": {
+ "description": "A redirect to the file's contents",
+ "headers": {
+ "Location": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "If the issue tracker is private and the request was not authenticated."
+ },
+ "404": {
+ "description": "The specified repository or issue does not exist or does not have the issue tracker enabled.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Issue tracker"],
+ "summary": "Get attachment for an issue",
+ "security": [
+ {
+ "oauth2": ["issue"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns the contents of the specified file attachment.\n\nNote that this endpoint does not return a JSON response, but instead\nreturns a redirect pointing to the actual file that in turn will return\nthe raw contents.\n\nThe redirect URL contains a one-time token that has a limited lifetime.\nAs a result, the link should not be persisted, stored, or shared."
+ },
+ "parameters": [
+ {
+ "name": "issue_id",
+ "in": "path",
+ "description": "The issue id",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "path",
+ "in": "path",
+ "description": "Path to the file.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/issues/{issue_id}/changes": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "Returns all the issue changes that were made on the specified issue.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_log_entries"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The specified repository or issue does not exist or does not have the issue tracker enabled.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "q",
+ "in": "query",
+ "description": "\nQuery string to narrow down the response. See\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for details.",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "sort",
+ "in": "query",
+ "description": "\nName of a response property to sort results. See\n[filtering and sorting](/cloud/bitbucket/rest/intro/#sorting-query-results)\nfor details.\n",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Issue tracker"],
+ "summary": "List changes on an issue",
+ "security": [
+ {
+ "oauth2": ["issue"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns the list of all changes that have been made to the specified\nissue. Changes are returned in chronological order with the oldest\nchange first.\n\nEach time an issue is edited in the UI or through the API, an immutable\nchange record is created under the `/issues/123/changes` endpoint. It\nalso has a comment associated with the change.\n\nNote that this operation is changing significantly, due to privacy changes.\nSee the [announcement](https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-changes-gdpr/#changes-to-the-issue-changes-api)\nfor details.\n\n```\n$ curl -s https://api.bitbucket.org/2.0/repositories/evzijst/dogslow/issues/1/changes - | jq .\n\n{\n \"pagelen\": 20,\n \"values\": [\n {\n \"changes\": {\n \"priority\": {\n \"new\": \"trivial\",\n \"old\": \"major\"\n },\n \"assignee\": {\n \"new\": \"\",\n \"old\": \"evzijst\"\n },\n \"assignee_account_id\": {\n \"new\": \"\",\n \"old\": \"557058:c0b72ad0-1cb5-4018-9cdc-0cde8492c443\"\n },\n \"kind\": {\n \"new\": \"enhancement\",\n \"old\": \"bug\"\n }\n },\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/evzijst/dogslow/issues/1/changes/2\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/evzijst/dogslow/issues/1#comment-2\"\n }\n },\n \"issue\": {\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/evzijst/dogslow/issues/1\"\n }\n },\n \"type\": \"issue\",\n \"id\": 1,\n \"repository\": {\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/evzijst/dogslow\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/evzijst/dogslow\"\n },\n \"avatar\": {\n \"href\": \"https://bitbucket.org/evzijst/dogslow/avatar/32/\"\n }\n },\n \"type\": \"repository\",\n \"name\": \"dogslow\",\n \"full_name\": \"evzijst/dogslow\",\n \"uuid\": \"{988b17c6-1a47-4e70-84ee-854d5f012bf6}\"\n },\n \"title\": \"Updated title\"\n },\n \"created_on\": \"2018-03-03T00:35:28.353630+00:00\",\n \"user\": {\n \"username\": \"evzijst\",\n \"nickname\": \"evzijst\",\n \"display_name\": \"evzijst\",\n \"type\": \"user\",\n \"uuid\": \"{aaa7972b-38af-4fb1-802d-6e3854c95778}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/evzijst\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/evzijst/\"\n },\n \"avatar\": {\n \"href\": \"https://bitbucket.org/account/evzijst/avatar/32/\"\n }\n }\n },\n \"message\": {\n \"raw\": \"Removed assignee, changed kind and priority.\",\n \"markup\": \"markdown\",\n \"html\": \"Removed assignee, changed kind and priority.
\",\n \"type\": \"rendered\"\n },\n \"type\": \"issue_change\",\n \"id\": 2\n }\n ],\n \"page\": 1\n}\n```\n\nChanges support [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) that\ncan be used to search for specific changes. For instance, to see\nwhen an issue transitioned to \"resolved\":\n\n```\n$ curl -s https://api.bitbucket.org/2.0/repositories/site/master/issues/1/changes \\\n -G --data-urlencode='q=changes.state.new = \"resolved\"'\n```\n\nThis resource is only available on repositories that have the issue\ntracker enabled.\n\nN.B.\n\nThe `changes.assignee` and `changes.assignee_account_id` fields are not\na `user` object. Instead, they contain the raw `username` and\n`account_id` of the user. This is to protect the integrity of the audit\nlog even after a user account gets deleted.\n\nThe `changes.assignee` field is deprecated will disappear in the\nfuture. Use `changes.assignee_account_id` instead."
+ },
+ "post": {
+ "responses": {
+ "201": {
+ "description": "The newly created issue change.",
+ "headers": {
+ "Location": {
+ "description": "The (absolute) URL of the newly created issue change.",
+ "schema": {
+ "type": "string"
+ }
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issue_change"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "When the request wasn't authenticated.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "When the authenticated user isn't authorized to modify the issue.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The specified repository or issue does not exist or does not have the issue tracker enabled.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issue_change"
+ }
+ }
+ },
+ "description": "The new issue state change. The only required elements are `changes.[].new`. All other elements can be omitted from the body.",
+ "required": true
+ },
+ "tags": ["Issue tracker"],
+ "summary": "Modify the state of an issue",
+ "security": [
+ {
+ "oauth2": ["issue:write"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Makes a change to the specified issue.\n\nFor example, to change an issue's state and assignee, create a new\nchange object that modifies these fields:\n\n```\ncurl https://api.bitbucket.org/2.0/site/master/issues/1234/changes \\\n -s -u evzijst -X POST -H \"Content-Type: application/json\" \\\n -d '{\n \"changes\": {\n \"assignee_account_id\": {\n \"new\": \"557058:c0b72ad0-1cb5-4018-9cdc-0cde8492c443\"\n },\n \"state\": {\n \"new\": 'resolved\"\n }\n }\n \"message\": {\n \"raw\": \"This is now resolved.\"\n }\n }'\n```\n\nThe above example also includes a custom comment to go alongside the\nchange. This comment will also be visible on the issue page in the UI.\n\nThe fields of the `changes` object are strings, not objects. This\nallows for immutable change log records, even after user accounts,\nmilestones, or other objects recorded in a change entry, get renamed or\ndeleted.\n\nThe `assignee_account_id` field stores the account id. When POSTing a\nnew change and changing the assignee, the client should therefore use\nthe user's account_id in the `changes.assignee_account_id.new` field.\n\nThis call requires authentication. Private repositories or private\nissue trackers require the caller to authenticate with an account that\nhas appropriate authorization."
+ },
+ "parameters": [
+ {
+ "name": "issue_id",
+ "in": "path",
+ "description": "The issue id",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/issues/{issue_id}/changes/{change_id}": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The specified issue change object.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issue_change"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The specified repository or issue change does not exist or does not have the issue tracker enabled.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Issue tracker"],
+ "summary": "Get issue change object",
+ "security": [
+ {
+ "oauth2": ["issue"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns the specified issue change object.\n\nThis resource is only available on repositories that have the issue\ntracker enabled."
+ },
+ "parameters": [
+ {
+ "name": "change_id",
+ "in": "path",
+ "description": "The issue change id",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "issue_id",
+ "in": "path",
+ "description": "The issue id",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "A paginated list of issue comments.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_issue_comments"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "q",
+ "in": "query",
+ "description": "\nQuery string to narrow down the response as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Issue tracker"],
+ "summary": "List comments on an issue",
+ "security": [
+ {
+ "oauth2": ["issue"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns a paginated list of all comments that were made on the\nspecified issue.\n\nThe default sorting is oldest to newest and can be overridden with\nthe `sort` query parameter.\n\nThis endpoint also supports filtering and sorting of the results. See\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for more details."
+ },
+ "post": {
+ "responses": {
+ "201": {
+ "description": "The newly created comment.",
+ "headers": {
+ "Location": {
+ "description": "The location of the newly issue comment.",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "If the input was invalid, or if the comment being created is detected as spam ",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issue_comment"
+ }
+ }
+ },
+ "description": "The new issue comment object.",
+ "required": true
+ },
+ "tags": ["Issue tracker"],
+ "summary": "Create a comment on an issue",
+ "security": [
+ {
+ "oauth2": ["issue:write"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Creates a new issue comment.\n\n```\n$ curl https://api.bitbucket.org/2.0/repositories/atlassian/prlinks/issues/42/comments/ \\\n -X POST -u evzijst \\\n -H 'Content-Type: application/json' \\\n -d '{\"content\": {\"raw\": \"Lorem ipsum.\"}}'\n```"
+ },
+ "parameters": [
+ {
+ "name": "issue_id",
+ "in": "path",
+ "description": "The issue id",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/issues/{issue_id}/comments/{comment_id}": {
+ "delete": {
+ "responses": {
+ "204": {
+ "description": "Indicates successful deletion."
+ }
+ },
+ "requestBody": {
+ "$ref": "#/components/requestBodies/issue_comment"
+ },
+ "tags": ["Issue tracker"],
+ "summary": "Delete a comment on an issue",
+ "security": [
+ {
+ "oauth2": ["issue:write"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Deletes the specified comment."
+ },
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The issue comment.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issue_comment"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Issue tracker"],
+ "summary": "Get a comment on an issue",
+ "security": [
+ {
+ "oauth2": ["issue"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns the specified issue comment object."
+ },
+ "put": {
+ "responses": {
+ "200": {
+ "description": "The updated issue comment.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issue_comment"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "If the input was invalid, or if the update to the comment is detected as spam ",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "$ref": "#/components/requestBodies/issue_comment"
+ },
+ "tags": ["Issue tracker"],
+ "summary": "Update a comment on an issue",
+ "security": [
+ {
+ "oauth2": ["issue:write"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Updates the content of the specified issue comment. Note that only\nthe `content.raw` field can be modified.\n\n```\n$ curl https://api.bitbucket.org/2.0/repositories/atlassian/prlinks/issues/42/comments/5728901 \\\n -X PUT -u evzijst \\\n -H 'Content-Type: application/json' \\\n -d '{\"content\": {\"raw\": \"Lorem ipsum.\"}'\n```"
+ },
+ "parameters": [
+ {
+ "name": "comment_id",
+ "in": "path",
+ "description": "The id of the comment.",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "issue_id",
+ "in": "path",
+ "description": "The issue id",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/issues/{issue_id}/vote": {
+ "delete": {
+ "responses": {
+ "default": {
+ "description": "Unexpected error.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Issue tracker"],
+ "summary": "Remove vote for an issue",
+ "security": [
+ {
+ "oauth2": ["account:write", "issue:write"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Retract your vote."
+ },
+ "get": {
+ "responses": {
+ "204": {
+ "description": "If the authenticated user has not voted for this issue.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "When the request wasn't authenticated.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the authenticated user has not voted for this issue, or when the repo does not exist, or does not have an issue tracker.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Issue tracker"],
+ "summary": "Check if current user voted for an issue",
+ "security": [
+ {
+ "oauth2": ["account", "issue"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Check whether the authenticated user has voted for this issue.\nA 204 status code indicates that the user has voted, while a 404\nimplies they haven't."
+ },
+ "put": {
+ "responses": {
+ "204": {
+ "description": "Indicating the authenticated user has cast their vote successfully.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "When the request wasn't authenticated.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The specified repository or issue does not exist or does not have the issue tracker enabled.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Issue tracker"],
+ "summary": "Vote for an issue",
+ "security": [
+ {
+ "oauth2": ["account:write", "issue"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Vote for this issue.\n\nTo cast your vote, do an empty PUT. The 204 status code indicates that\nthe operation was successful."
+ },
+ "parameters": [
+ {
+ "name": "issue_id",
+ "in": "path",
+ "description": "The issue id",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/issues/{issue_id}/watch": {
+ "delete": {
+ "responses": {
+ "204": {
+ "description": "Indicates that the authenticated user successfully stopped watching this issue.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "When the request wasn't authenticated.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The specified repository or issue does not exist or does not have the issue tracker enabled.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Issue tracker"],
+ "summary": "Stop watching an issue",
+ "security": [
+ {
+ "oauth2": ["account:write", "issue:write"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Stop watching this issue."
+ },
+ "get": {
+ "responses": {
+ "204": {
+ "description": "If the authenticated user is watching this issue.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "When the request wasn't authenticated.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the authenticated user is not watching this issue, or when the repo does not exist, or does not have an issue tracker.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Issue tracker"],
+ "summary": "Check if current user is watching a issue",
+ "security": [
+ {
+ "oauth2": ["account", "issue"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Indicated whether or not the authenticated user is watching this\nissue."
+ },
+ "put": {
+ "responses": {
+ "204": {
+ "description": "Indicates that the authenticated user successfully started watching this issue.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "When the request wasn't authenticated.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the authenticated user is not watching this issue, or when the repo does not exist, or does not have an issue tracker.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Issue tracker"],
+ "summary": "Watch an issue",
+ "security": [
+ {
+ "oauth2": ["account:write", "issue"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Start watching this issue.\n\nTo start watching this issue, do an empty PUT. The 204 status code\nindicates that the operation was successful."
+ },
+ "parameters": [
+ {
+ "name": "issue_id",
+ "in": "path",
+ "description": "The issue id",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/merge-base/{revspec}": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The merge base of the provided spec.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/commit"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "If the request was not authenticated.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "If the authenticated user does not have access to any of the repositories specified.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the repository or ref in the spec does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Commits"],
+ "summary": "Get the common ancestor between two commits",
+ "security": [
+ {
+ "oauth2": ["repository"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns the best common ancestor between two commits, specified in a revspec\nof 2 commits (e.g. 3a8b42..9ff173).\n\nIf more than one best common ancestor exists, only one will be returned. It is\nunspecified which will be returned."
+ },
+ "parameters": [
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "revspec",
+ "in": "path",
+ "description": "A commit range using double dot notation (e.g. `3a8b42..9ff173`).\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/milestones": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The milestones that have been defined in the issue tracker.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_milestones"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The specified repository does not exist or does not have the issue tracker enabled.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Issue tracker"],
+ "summary": "List milestones",
+ "security": [
+ {
+ "oauth2": ["issue"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns the milestones that have been defined in the issue tracker.\n\nThis resource is only available on repositories that have the issue\ntracker enabled."
+ },
+ "parameters": [
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/milestones/{milestone_id}": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The specified milestone object.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/milestone"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The specified repository or milestone does not exist or does not have the issue tracker enabled.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Issue tracker"],
+ "summary": "Get a milestone",
+ "security": [
+ {
+ "oauth2": ["issue"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns the specified issue tracker milestone object."
+ },
+ "parameters": [
+ {
+ "name": "milestone_id",
+ "in": "path",
+ "description": "The milestone's id",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/patch/{spec}": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The raw patches"
+ },
+ "555": {
+ "description": "If the diff was too large and timed out.\n\nSince this endpoint does not employ any form of pagination, but\ninstead returns the diff as a single document, it can run into\ntrouble on very large diffs. If Bitbucket times out in cases\nlike these, a 555 status code is returned.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Commits"],
+ "summary": "Get a patch for two commits",
+ "security": [
+ {
+ "oauth2": ["repository"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Produces a raw patch for a single commit (diffed against its first\nparent), or a patch-series for a revspec of 2 commits (e.g.\n`3a8b42..9ff173` where the first commit represents the source and the\nsecond commit the destination).\n\nIn case of the latter (diffing a revspec), a patch series is returned\nfor the commits on the source branch (`3a8b42` and its ancestors in\nour example).\n\nWhile similar to diffs, patches:\n\n* Have a commit header (username, commit message, etc)\n* Do not support the `path=foo/bar.py` query parameter\n\nThe raw patch is returned as-is, in whatever encoding the files in the\nrepository use. It is not decoded into unicode. As such, the\ncontent-type is `text/plain`."
+ },
+ "parameters": [
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "spec",
+ "in": "path",
+ "description": "A commit SHA (e.g. `3a8b42`) or a commit range using double dot\nnotation (e.g. `3a8b42..9ff173`).\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/permissions-config/groups": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "Paginated of explicit group permissions on the repository.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_repository_group_permissions"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "The user couldn't be authenticated.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "The requesting user isn't an admin of the repository.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "One or both of the workspace and repository doesn't exist for the given identifiers.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Repositories"],
+ "summary": "List explicit group permissions for a repository",
+ "security": [
+ {
+ "oauth2": ["repository:admin"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns a paginated list of explicit group permissions for the given repository.\nThis endpoint does not support BBQL features.\n\nExample:\n\n```\n$ curl https://api.bitbucket.org/2.0/repositories/atlassian_tutorial/geordi/permissions-config/groups\n\nHTTP/1.1 200\nLocation: https://api.bitbucket.org/2.0/repositories/atlassian_tutorial/geordi/permissions-config/groups\n\n{\n \"pagelen\": 10,\n \"values\": [\n {\n \"type\": \"repository_group_permission\",\n \"group\": {\n \"type\": \"group\",\n \"name\": \"Administrators\",\n \"slug\": \"administrators\"\n },\n \"permission\": \"admin\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian_tutorial/\n geordi/permissions-config/groups/administrators\"\n }\n }\n },\n {\n \"type\": \"repository_group_permission\",\n \"group\": {\n \"type\": \"group\",\n \"name\": \"Developers\",\n \"slug\": \"developers\"\n },\n \"permission\": \"read\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian_tutorial/\n geordi/permissions-config/groups/developers\"\n }\n }\n }\n ],\n \"page\": 1,\n \"size\": 2\n}\n```"
+ },
+ "parameters": [
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/permissions-config/groups/{group_slug}": {
+ "delete": {
+ "responses": {
+ "204": {
+ "description": "Group permission deleted"
+ },
+ "401": {
+ "description": "The user couldn't be authenticated.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "The requesting user isn't an admin of the repository, or the authentication method was not via app password.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The workspace does not exist, the repository does not exist,or the group does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Repositories"],
+ "summary": "Delete an explicit group permission for a repository",
+ "security": [
+ {
+ "oauth2": ["repository:admin"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Deletes the repository group permission between the requested repository and group, if one exists.\n\nOnly users with admin permission for the repository may access this resource.\n\nExample:\n\n$ curl -X DELETE https://api.bitbucket.org/2.0/repositories/atlassian_tutorial\n/geordi/permissions-config/groups/developers\n\n\nHTTP/1.1 204"
+ },
+ "get": {
+ "responses": {
+ "200": {
+ "description": "Group permission for group slug and repository",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/repository_group_permission"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "The user couldn't be authenticated.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "The requesting user isn't an admin of the repository.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The given user, workspace, and/or repository could not be found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Repositories"],
+ "summary": "Get an explicit group permission for a repository",
+ "security": [
+ {
+ "oauth2": ["repository:admin"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns the group permission for a given group slug and repository\n\nOnly users with admin permission for the repository may access this resource.\n\nPermissions can be:\n\n* `admin`\n* `write`\n* `read`\n* `none`\n\nExample:\n\n```\n$ curl https://api.bitbucket.org/2.0/repositories/atlassian_tutorial/geordi/permissions-config/groups/developers\n\nHTTP/1.1 200\nLocation:\nhttps://api.bitbucket.org/2.0/repositories/atlassian_tutorial/geordi/permissions-config/groups/developers\n\n{\n \"type\": \"repository_group_permission\",\n \"group\": {\n \"type\": \"group\",\n \"name\": \"Developers\",\n \"slug\": \"developers\"\n },\n \"repository\": {\n \"type\": \"repository\",\n \"name\": \"geordi\",\n \"full_name\": \"atlassian_tutorial/geordi\",\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"permission\": \"read\",\n \"links\": {\n \"self\": {\n \"href\":\n \"https://api.bitbucket.org/2.0/repositories/atlassian_tutorial/geordi/permissions-config/groups/developers\"\n }\n }\n}\n```"
+ },
+ "put": {
+ "responses": {
+ "200": {
+ "description": "Group permission updated",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/repository_group_permission"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "No permission value was provided or the value is invalid(not one of read, write, or admin)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "The user couldn't be authenticated.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "The requesting user isn't an admin of the repository, or the authentication method was not via app password.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The workspace does not exist, the repository does not exist,or the group does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Repositories"],
+ "summary": "Update an explicit group permission for a repository",
+ "security": [
+ {
+ "oauth2": ["repository:admin"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Updates the group permission if it exists.\n\nOnly users with admin permission for the repository may access this resource.\n\nThe only authentication method supported for this endpoint is via app passwords.\n\nPermissions can be:\n\n* `admin`\n* `write`\n* `read`\n\nExample:\n```\n$ curl -X PUT -H \"Content-Type: application/json\"\nhttps://api.bitbucket.org/2.0/repositories/atlassian_tutorial/geordi/permissions-config/groups/developers\n-d\n'{\n \"permission\": \"write\"\n}'\n\nHTTP/1.1 200\nLocation:\nhttps://api.bitbucket.org/2.0/repositories/atlassian_tutorial/geordi/permissions-config/groups/developers\n\n{\n \"type\": \"repository_group_permission\",\n \"group\": {\n \"type\": \"group\",\n \"name\": \"Developers\",\n \"slug\": \"developers\"\n },\n \"repository\": {\n \"type\": \"repository\",\n \"name\": \"geordi\",\n \"full_name\": \"atlassian_tutorial/geordi\",\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"permission\": \"write\",\n \"links\": {\n \"self\": {\n \"href\":\n \"https://api.bitbucket.org/2.0/repositories/atlassian_tutorial/geordi/permissions-config/groups/developers\"\n }\n }\n}\n```"
+ },
+ "parameters": [
+ {
+ "name": "group_slug",
+ "in": "path",
+ "description": "Slug of the requested group.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/permissions-config/users": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "Paginated of explicit user permissions on the repository.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_repository_user_permissions"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "The user couldn't be authenticated.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "The requesting user isn't an admin of the repository.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "No repository exists for the given repo slug and workspace.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Repositories"],
+ "summary": "List explicit user permissions for a repository",
+ "security": [
+ {
+ "oauth2": ["repository:admin"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns a paginated list of explicit user permissions for the given repository.\n\nExample:\n\n```\n$ curl https://api.bitbucket.org/2.0/repositories/atlassian_tutorial/geordi/permissions-config/users\n\n{\n \"pagelen\": 10,\n \"values\": [\n {\n \"type\": \"repository_user_permission\",\n \"user\": {\n \"type\": \"user\",\n \"display_name\": \"Colin Cameron\",\n \"uuid\": \"{d301aafa-d676-4ee0-88be-962be7417567}\",\n \"account_id\": \"557058:ba8948b2-49da-43a9-9e8b-e7249b8e324a\"\n },\n \"permission\": \"admin\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian_tutorial/geordi/\n permissions-config/users/557058:ba8948b2-49da-43a9-9e8b-e7249b8e324a\"\n }\n }\n },\n {\n \"type\": \"repository_user_permission\",\n \"user\": {\n \"type\": \"user\",\n \"display_name\": \"Sean Conaty\",\n \"uuid\": \"{504c3b62-8120-4f0c-a7bc-87800b9d6f70}\",\n \"account_id\": \"557058:ba8948b2-49da-43a9-9e8b-e7249b8e324c\"\n },\n \"permission\": \"write\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0//repositories/atlassian_tutorial/geordi/\n permissions-config/users/557058:ba8948b2-49da-43a9-9e8b-e7249b8e324c\"\n }\n }\n }\n ],\n \"page\": 1,\n \"size\": 2\n}\n```"
+ },
+ "parameters": [
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/permissions-config/users/{selected_user_id}": {
+ "delete": {
+ "responses": {
+ "204": {
+ "description": "The repository user permission was deleted and no content returned."
+ },
+ "401": {
+ "description": "The user couldn't be authenticated.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "The requesting user isn't an admin of the repository, or the authentication method was not via app password.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "One or more of the workspace, repository, and user doesn't exist for the given identifiers.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Repositories"],
+ "summary": "Delete an explicit user permission for a repository",
+ "security": [
+ {
+ "oauth2": ["repository:admin"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Deletes the repository user permission between the requested repository and user, if one exists.\n\nOnly users with admin permission for the repository may access this resource.\n\nThe only authentication method for this endpoint is via app passwords.\n\n```\n$ curl -X DELETE https://api.bitbucket.org/2.0/repositories/atlassian_tutorial/geordi/\npermissions-config/users/557058:ba8948b2-49da-43a9-9e8b-e7249b8e324a\n\n\nHTTP/1.1 204\n```"
+ },
+ "get": {
+ "responses": {
+ "200": {
+ "description": "Explicit user permission for user and repository",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/repository_user_permission"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "The user couldn't be authenticated.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "The requesting user isn't an admin of the repository.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "One or both of the workspace and repository doesn't exist for the given identifiers.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Repositories"],
+ "summary": "Get an explicit user permission for a repository",
+ "security": [
+ {
+ "oauth2": ["repository:admin"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns the explicit user permission for a given user and repository.\n\nOnly users with admin permission for the repository may access this resource.\n\nPermissions can be:\n\n* `admin`\n* `write`\n* `read`\n* `none`\n\nExample:\n\n```\n$ curl 'https://api.bitbucket.org/2.0/repositories/atlassian_tutorial/geordi/\n permissions-config/users/557058:ba8948b2-49da-43a9-9e8b-e7249b8e324a'\n\nHTTP/1.1 200\nLocation: 'https://api.bitbucket.org/2.0/repositories/atlassian_tutorial/geordi/\n permissions-config/users/557058:ba8948b2-49da-43a9-9e8b-e7249b8e324a'\n\n{\n \"type\": \"repository_user_permission\",\n \"user\": {\n \"type\": \"user\",\n \"display_name\": \"Colin Cameron\",\n \"uuid\": \"{d301aafa-d676-4ee0-88be-962be7417567}\",\n \"account_id\": \"557058:ba8948b2-49da-43a9-9e8b-e7249b8e324a\"\n },\n \"repository\": {\n \"type\": \"repository\",\n \"name\": \"geordi\",\n \"full_name\": \"atlassian_tutorial/geordi\",\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"permission\": \"admin\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian_tutorial/geordi/\n permissions-config/users/557058:ba8948b2-49da-43a9-9e8b-e7249b8e324a\"\n }\n }\n}\n```"
+ },
+ "put": {
+ "responses": {
+ "200": {
+ "description": "Explicit user permission updated",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/repository_user_permission"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "No permission value was provided or the value is invalid (not one of read, write, or admin), or the selected user is not a valid user to update.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "The user couldn't be authenticated.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "The requesting user isn't an admin of the repository, or the authentication method was not via app password.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "One or more of the workspace, repo, and selected user doesn't exist for the given identifiers.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Repositories"],
+ "summary": "Update an explicit user permission for a repository",
+ "security": [
+ {
+ "oauth2": ["repository:admin"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Updates the explicit user permission for a given user and repository. The selected user must be a member of\nthe workspace, and cannot be the workspace owner.\nOnly users with admin permission for the repository may access this resource.\n\nThe only authentication method for this endpoint is via app passwords.\n\nPermissions can be:\n\n* `admin`\n* `write`\n* `read`\n\nExample:\n\n```\n$ curl -X PUT -H \"Content-Type: application/json\" 'https://api.bitbucket.org/2.0/repositories/\natlassian_tutorial/geordi/permissions-config/users/557058:ba8948b2-49da-43a9-9e8b-e7249b8e324a'\n-d '{\n \"permission\": \"write\"\n}'\n\nHTTP/1.1 200\nLocation: 'https://api.bitbucket.org/2.0/repositories/atlassian_tutorial/geordi/\npermissions-config/users/557058:ba8948b2-49da-43a9-9e8b-e7249b8e324a'\n\n\n{\n \"type\": \"repository_user_permission\",\n \"user\": {\n \"type\": \"user\",\n \"display_name\": \"Colin Cameron\",\n \"uuid\": \"{d301aafa-d676-4ee0-88be-962be7417567}\",\n \"account_id\": \"557058:ba8948b2-49da-43a9-9e8b-e7249b8e324a\"\n },\n \"repository\": {\n \"type\": \"repository\",\n \"name\": \"geordi\",\n \"full_name\": \"atlassian_tutorial/geordi\",\n \"uuid\": \"{85d08b4e-571d-44e9-a507-fa476535aa98}\"\n },\n \"permission\": \"write\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian_tutorial/geordi/\n permissions-config/users/557058:ba8948b2-49da-43a9-9e8b-e7249b8e324a\"\n }\n }\n}\n```"
+ },
+ "parameters": [
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "selected_user_id",
+ "in": "path",
+ "description": "This can either be the UUID of the account, surrounded by curly-braces, for\nexample: `{account UUID}`, OR an Atlassian Account ID.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/pipelines-config/caches/": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The list of caches for the given repository.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_pipeline_caches"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The account or repository was not found.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "description": "Retrieve the repository pipelines caches.",
+ "parameters": [
+ {
+ "description": "The account.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Pipelines"],
+ "summary": "List caches",
+ "operationId": "getRepositoryPipelineCaches"
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid}": {
+ "delete": {
+ "responses": {
+ "204": {
+ "description": "The cache was deleted."
+ },
+ "404": {
+ "description": "The workspace, repository or cache_uuid with given UUID was not found.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "description": "Delete a repository cache.",
+ "parameters": [
+ {
+ "description": "The account.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The UUID of the cache to delete.",
+ "required": true,
+ "name": "cache_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Pipelines"],
+ "summary": "Delete a cache",
+ "operationId": "deleteRepositoryPipelineCache"
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/pipelines-config/caches/{cache_uuid}/content-uri": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The cache content uri.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pipeline_cache_content_uri"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The workspace, repository or cache_uuid with given UUID was not found.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "description": "Retrieve the URI of the content of the specified cache.",
+ "parameters": [
+ {
+ "description": "The account.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The UUID of the cache.",
+ "required": true,
+ "name": "cache_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Pipelines"],
+ "summary": "Get cache content URI",
+ "operationId": "getRepositoryPipelineCacheContentURI"
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/pipelines/": {
+ "post": {
+ "responses": {
+ "201": {
+ "headers": {
+ "Location": {
+ "description": "The URL of the newly created pipeline.",
+ "schema": {
+ "type": "string"
+ }
+ }
+ },
+ "description": "The initiated pipeline.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pipeline"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "The account or repository is not enabled, the yml file does not exist in the repository for the given revision, or the request body contained invalid properties.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The account or repository was not found.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "description": "Endpoint to create and initiate a pipeline.\nThere are a couple of different options to initiate a pipeline, where the payload of the request will determine which type of pipeline will be instantiated.\n# Trigger a Pipeline for a branch\nOne way to trigger pipelines is by specifying the branch for which you want to trigger a pipeline.\nThe specified branch will be used to determine which pipeline definition from the `bitbucket-pipelines.yml` file will be applied to initiate the pipeline. The pipeline will then do a clone of the repository and checkout the latest revision of the specified branch.\n\n### Example\n\n```\n$ curl -X POST -is -u username:password \\\n -H 'Content-Type: application/json' \\\n https://api.bitbucket.org/2.0/repositories/jeroendr/meat-demo2/pipelines/ \\\n -d '\n {\n \"target\": {\n \"ref_type\": \"branch\",\n \"type\": \"pipeline_ref_target\",\n \"ref_name\": \"master\"\n }\n }'\n```\n# Trigger a Pipeline for a commit on a branch or tag\nYou can initiate a pipeline for a specific commit and in the context of a specified reference (e.g. a branch, tag or bookmark).\nThe specified reference will be used to determine which pipeline definition from the bitbucket-pipelines.yml file will be applied to initiate the pipeline. The pipeline will clone the repository and then do a checkout the specified reference.\n\nThe following reference types are supported:\n\n* `branch`\n* `named_branch`\n* `bookmark`\n * `tag`\n\n### Example\n\n```\n$ curl -X POST -is -u username:password \\\n -H 'Content-Type: application/json' \\\n https://api.bitbucket.org/2.0/repositories/jeroendr/meat-demo2/pipelines/ \\\n -d '\n {\n \"target\": {\n \"commit\": {\n \"type\": \"commit\",\n \"hash\": \"ce5b7431602f7cbba007062eeb55225c6e18e956\"\n },\n \"ref_type\": \"branch\",\n \"type\": \"pipeline_ref_target\",\n \"ref_name\": \"master\"\n }\n }'\n```\n# Trigger a specific pipeline definition for a commit\nYou can trigger a specific pipeline that is defined in your `bitbucket-pipelines.yml` file for a specific commit.\nIn addition to the commit revision, you specify the type and pattern of the selector that identifies the pipeline definition. The resulting pipeline will then clone the repository and checkout the specified revision.\n\n### Example\n\n```\n$ curl -X POST -is -u username:password \\\n -H 'Content-Type: application/json' \\\n https://api.bitbucket.org/2.0/repositories/jeroendr/meat-demo2/pipelines/ \\\n -d '\n {\n \"target\": {\n \"commit\": {\n \"hash\":\"a3c4e02c9a3755eccdc3764e6ea13facdf30f923\",\n \"type\":\"commit\"\n },\n \"selector\": {\n \"type\":\"custom\",\n \"pattern\":\"Deploy to production\"\n },\n \"type\":\"pipeline_commit_target\"\n }\n }'\n```\n# Trigger a specific pipeline definition for a commit on a branch or tag\nYou can trigger a specific pipeline that is defined in your `bitbucket-pipelines.yml` file for a specific commit in the context of a specified reference.\nIn addition to the commit revision, you specify the type and pattern of the selector that identifies the pipeline definition, as well as the reference information. The resulting pipeline will then clone the repository a checkout the specified reference.\n\n### Example\n\n```\n$ curl -X POST -is -u username:password \\\n -H 'Content-Type: application/json' \\\n https://api.bitbucket.org/2.0/repositories/jeroendr/meat-demo2/pipelines/ \\\n -d '\n {\n \"target\": {\n \"commit\": {\n \"hash\":\"a3c4e02c9a3755eccdc3764e6ea13facdf30f923\",\n \"type\":\"commit\"\n },\n \"selector\": {\n \"type\": \"custom\",\n \"pattern\": \"Deploy to production\"\n },\n \"type\": \"pipeline_ref_target\",\n \"ref_name\": \"master\",\n \"ref_type\": \"branch\"\n }\n }'\n```\n\n\n# Trigger a custom pipeline with variables\nIn addition to triggering a custom pipeline that is defined in your `bitbucket-pipelines.yml` file as shown in the examples above, you can specify variables that will be available for your build. In the request, provide a list of variables, specifying the following for each variable: key, value, and whether it should be secured or not (this field is optional and defaults to not secured).\n\n### Example\n\n```\n$ curl -X POST -is -u username:password \\\n -H 'Content-Type: application/json' \\\n https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/pipelines/ \\\n -d '\n {\n \"target\": {\n \"type\": \"pipeline_ref_target\",\n \"ref_type\": \"branch\",\n \"ref_name\": \"master\",\n \"selector\": {\n \"type\": \"custom\",\n \"pattern\": \"Deploy to production\"\n }\n },\n \"variables\": [\n {\n \"key\": \"var1key\",\n \"value\": \"var1value\",\n \"secured\": true\n },\n {\n \"key\": \"var2key\",\n \"value\": \"var2value\"\n }\n ]\n }'\n```\n\n# Trigger a pull request pipeline\n\nYou can also initiate a pipeline for a specific pull request.\n\n### Example\n\n```\n$ curl -X POST -is -u username:password \\\n -H 'Content-Type: application/json' \\\n https://api.bitbucket.org/2.0/repositories/{workspace}/{repo_slug}/pipelines/ \\\n -d '\n {\n\t\"target\": {\n \"type\": \"pipeline_pullrequest_target\",\n\t \"source\": \"pull-request-branch\",\n \"destination\": \"master\",\n \"destination_commit\": {\n \t \"hash\" : \"9f848b7\"\n },\n \"commit\": {\n \t\"hash\" : \"1a372fc\"\n },\n \"pullrequest\" : {\n \t\"id\" : \"3\"\n },\n\t \"selector\": {\n \"type\": \"pull-requests\",\n \"pattern\": \"**\"\n }\n }\n }'\n```\n",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pipeline"
+ }
+ }
+ },
+ "description": "The pipeline to initiate.",
+ "required": true
+ },
+ "tags": ["Pipelines"],
+ "summary": "Run a pipeline",
+ "operationId": "createPipelineForRepository"
+ },
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The matching pipelines.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_pipelines"
+ }
+ }
+ }
+ }
+ },
+ "description": "Find pipelines",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Pipelines"],
+ "summary": "List pipelines",
+ "operationId": "getPipelinesForRepository"
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The pipeline.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pipeline"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "No account, repository or pipeline with the UUID provided exists.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "description": "Retrieve a specified pipeline",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The pipeline UUID.",
+ "required": true,
+ "name": "pipeline_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Pipelines"],
+ "summary": "Get a pipeline",
+ "operationId": "getPipelineForRepository"
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The steps.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_pipeline_steps"
+ }
+ }
+ }
+ }
+ },
+ "description": "Find steps for the given pipeline.",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The UUID of the pipeline.",
+ "required": true,
+ "name": "pipeline_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Pipelines"],
+ "summary": "List steps for a pipeline",
+ "operationId": "getPipelineStepsForRepository"
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The step.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pipeline_step"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "No account, repository, pipeline or step with the UUID provided exists for the pipeline with the UUID provided.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "description": "Retrieve a given step of a pipeline.",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The UUID of the pipeline.",
+ "required": true,
+ "name": "pipeline_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The UUID of the step.",
+ "required": true,
+ "name": "step_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Pipelines"],
+ "summary": "Get a step of a pipeline",
+ "operationId": "getPipelineStepForRepository"
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/log": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The raw log file for this pipeline step."
+ },
+ "304": {
+ "description": "The log has the same etag as the provided If-None-Match header.",
+ "content": {
+ "application/octet-stream": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "A pipeline with the given UUID does not exist, a step with the given UUID does not exist in the pipeline or a log file does not exist for the given step.",
+ "content": {
+ "application/octet-stream": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "416": {
+ "description": "The requested range does not exist for requests that specified the [HTTP Range header](https://tools.ietf.org/html/rfc7233#section-3.1).",
+ "content": {
+ "application/octet-stream": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The UUID of the pipeline.",
+ "required": true,
+ "name": "pipeline_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The UUID of the step.",
+ "required": true,
+ "name": "step_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Pipelines"],
+ "summary": "Get log file for a step",
+ "operationId": "getPipelineStepLogForRepository",
+ "description": "Retrieve the log file for a given step of a pipeline.\n\nThis endpoint supports (and encourages!) the use of [HTTP Range requests](https://tools.ietf.org/html/rfc7233) to deal with potentially very large log files."
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/logs/{log_uuid}": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The raw log file for the build container or service container."
+ },
+ "404": {
+ "description": "No account, repository, pipeline, step or log exist for the provided path.",
+ "content": {
+ "application/octet-stream": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The UUID of the pipeline.",
+ "required": true,
+ "name": "pipeline_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The UUID of the step.",
+ "required": true,
+ "name": "step_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "For the main build container specify the step UUID; for a service container specify the service container UUID",
+ "required": true,
+ "name": "log_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Pipelines"],
+ "summary": "Get the logs for the build container or a service container for a given step of a pipeline.",
+ "operationId": "getPipelineContainerLog",
+ "description": "Retrieve the log file for a build container or service container.\n\nThis endpoint supports (and encourages!) the use of [HTTP Range requests](https://tools.ietf.org/html/rfc7233) to deal with potentially very large log files."
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "A summary of test reports for this pipeline step."
+ },
+ "404": {
+ "description": "No account, repository, pipeline, step or test reports exist for the provided path.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The UUID of the pipeline.",
+ "required": true,
+ "name": "pipeline_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The UUID of the step.",
+ "required": true,
+ "name": "step_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Pipelines"],
+ "summary": "Get a summary of test reports for a given step of a pipeline.",
+ "operationId": "getPipelineTestReports"
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports/test_cases": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "Test cases for this pipeline step."
+ },
+ "404": {
+ "description": "No account, repository, pipeline, step or test reports exist for the provided path.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The UUID of the pipeline.",
+ "required": true,
+ "name": "pipeline_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The UUID of the step.",
+ "required": true,
+ "name": "step_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Pipelines"],
+ "summary": "Get test cases for a given step of a pipeline.",
+ "operationId": "getPipelineTestReportTestCases"
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/steps/{step_uuid}/test_reports/test_cases/{test_case_uuid}/test_case_reasons": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "Test case reasons (output)."
+ },
+ "404": {
+ "description": "No account, repository, pipeline, step or test case with the UUID provided exists for the pipeline with the UUID provided.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The UUID of the pipeline.",
+ "required": true,
+ "name": "pipeline_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The UUID of the step.",
+ "required": true,
+ "name": "step_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The UUID of the test case.",
+ "required": true,
+ "name": "test_case_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Pipelines"],
+ "summary": "Get test case reasons (output) for a given test case in a step of a pipeline.",
+ "operationId": "getPipelineTestReportTestCaseReasons"
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/pipelines/{pipeline_uuid}/stopPipeline": {
+ "post": {
+ "responses": {
+ "204": {
+ "description": "The pipeline has been signaled to stop."
+ },
+ "400": {
+ "description": "The specified pipeline has already completed.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Either the account, repository or pipeline with the given UUID does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "description": "Signal the stop of a pipeline and all of its steps that not have completed yet.",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The UUID of the pipeline.",
+ "required": true,
+ "name": "pipeline_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Pipelines"],
+ "summary": "Stop a pipeline",
+ "operationId": "stopPipeline"
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/pipelines_config": {
+ "put": {
+ "responses": {
+ "200": {
+ "description": "The repository pipelines configuration was updated.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pipelines_config"
+ }
+ }
+ }
+ }
+ },
+ "description": "Update the pipelines configuration for a repository.",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pipelines_config"
+ }
+ }
+ },
+ "description": "The updated repository pipelines configuration.",
+ "required": true
+ },
+ "tags": ["Pipelines"],
+ "summary": "Update configuration",
+ "operationId": "updateRepositoryPipelineConfig"
+ },
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The repository pipelines configuration.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pipelines_config"
+ }
+ }
+ }
+ }
+ },
+ "description": "Retrieve the repository pipelines configuration.",
+ "parameters": [
+ {
+ "description": "The account.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Pipelines"],
+ "summary": "Get configuration",
+ "operationId": "getRepositoryPipelineConfig"
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/pipelines_config/build_number": {
+ "put": {
+ "responses": {
+ "200": {
+ "description": "The build number has been configured.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pipeline_build_number"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "The update failed because the next number was invalid (it should be higher than the current number).",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The account or repository was not found.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "description": "Update the next build number that should be assigned to a pipeline. The next build number that will be configured has to be strictly higher than the current latest build number for this repository.",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pipeline_build_number"
+ }
+ }
+ },
+ "description": "The build number to update.",
+ "required": true
+ },
+ "tags": ["Pipelines"],
+ "summary": "Update the next build number",
+ "operationId": "updateRepositoryBuildNumber"
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/pipelines_config/schedules/": {
+ "post": {
+ "responses": {
+ "201": {
+ "description": "The created schedule.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pipeline_schedule"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "There were errors validating the request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "The maximum limit of schedules for this repository was reached.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The account or repository was not found.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "description": "Create a schedule for the given repository.",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pipeline_schedule"
+ }
+ }
+ },
+ "description": "The schedule to create.",
+ "required": true
+ },
+ "tags": ["Pipelines"],
+ "summary": "Create a schedule",
+ "operationId": "createRepositoryPipelineSchedule"
+ },
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The list of schedules.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_pipeline_schedules"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The account or repository was not found.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "description": "Retrieve the configured schedules for the given repository.",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Pipelines"],
+ "summary": "List schedules",
+ "operationId": "getRepositoryPipelineSchedules"
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}": {
+ "put": {
+ "responses": {
+ "200": {
+ "description": "The schedule is updated.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pipeline_schedule"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The account, repository or schedule was not found.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "description": "Update a schedule.",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The uuid of the schedule.",
+ "required": true,
+ "name": "schedule_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pipeline_schedule"
+ }
+ }
+ },
+ "description": "The schedule to update.",
+ "required": true
+ },
+ "tags": ["Pipelines"],
+ "summary": "Update a schedule",
+ "operationId": "updateRepositoryPipelineSchedule"
+ },
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The requested schedule.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pipeline_schedule"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The account, repository or schedule was not found.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "description": "Retrieve a schedule by its UUID.",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The uuid of the schedule.",
+ "required": true,
+ "name": "schedule_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Pipelines"],
+ "summary": "Get a schedule",
+ "operationId": "getRepositoryPipelineSchedule"
+ },
+ "delete": {
+ "responses": {
+ "204": {
+ "description": "The schedule was deleted."
+ },
+ "404": {
+ "description": "The account, repository or schedule was not found.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "description": "Delete a schedule.",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The uuid of the schedule.",
+ "required": true,
+ "name": "schedule_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Pipelines"],
+ "summary": "Delete a schedule",
+ "operationId": "deleteRepositoryPipelineSchedule"
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/pipelines_config/schedules/{schedule_uuid}/executions/": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The list of executions of a schedule.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_pipeline_schedule_executions"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The account or repository was not found.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "description": "Retrieve the executions of a given schedule.",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The uuid of the schedule.",
+ "required": true,
+ "name": "schedule_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Pipelines"],
+ "summary": "List executions of a schedule",
+ "operationId": "getRepositoryPipelineScheduleExecutions"
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/pipelines_config/ssh/key_pair": {
+ "put": {
+ "responses": {
+ "200": {
+ "description": "The SSH key pair was created or updated.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pipeline_ssh_key_pair"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The account, repository or SSH key pair was not found.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "description": "Create or update the repository SSH key pair. The private key will be set as a default SSH identity in your build container.",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pipeline_ssh_key_pair"
+ }
+ }
+ },
+ "description": "The created or updated SSH key pair.",
+ "required": true
+ },
+ "tags": ["Pipelines"],
+ "summary": "Update SSH key pair",
+ "operationId": "updateRepositoryPipelineKeyPair"
+ },
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The SSH key pair.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pipeline_ssh_key_pair"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The account, repository or SSH key pair was not found.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "description": "Retrieve the repository SSH key pair excluding the SSH private key. The private key is a write only field and will never be exposed in the logs or the REST API.",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Pipelines"],
+ "summary": "Get SSH key pair",
+ "operationId": "getRepositoryPipelineSshKeyPair"
+ },
+ "delete": {
+ "responses": {
+ "204": {
+ "description": "The SSH key pair was deleted."
+ },
+ "404": {
+ "description": "The account, repository or SSH key pair was not found.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "description": "Delete the repository SSH key pair.",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Pipelines"],
+ "summary": "Delete SSH key pair",
+ "operationId": "deleteRepositoryPipelineKeyPair"
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/": {
+ "post": {
+ "responses": {
+ "201": {
+ "headers": {
+ "Location": {
+ "description": "The URL of the newly created pipeline known host.",
+ "schema": {
+ "type": "string"
+ }
+ }
+ },
+ "description": "The known host was created.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pipeline_known_host"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The account or repository does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "A known host with the provided hostname already exists.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "description": "Create a repository level known host.",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pipeline_known_host"
+ }
+ }
+ },
+ "description": "The known host to create.",
+ "required": true
+ },
+ "tags": ["Pipelines"],
+ "summary": "Create a known host",
+ "operationId": "createRepositoryPipelineKnownHost"
+ },
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The retrieved known hosts.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_pipeline_known_hosts"
+ }
+ }
+ }
+ }
+ },
+ "description": "Find repository level known hosts.",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Pipelines"],
+ "summary": "List known hosts",
+ "operationId": "getRepositoryPipelineKnownHosts"
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/pipelines_config/ssh/known_hosts/{known_host_uuid}": {
+ "put": {
+ "responses": {
+ "200": {
+ "description": "The known host was updated.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pipeline_known_host"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The account, repository or known host with the given UUID was not found.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "description": "Update a repository level known host.",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The UUID of the known host to update.",
+ "required": true,
+ "name": "known_host_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pipeline_known_host"
+ }
+ }
+ },
+ "description": "The updated known host.",
+ "required": true
+ },
+ "tags": ["Pipelines"],
+ "summary": "Update a known host",
+ "operationId": "updateRepositoryPipelineKnownHost"
+ },
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The known host.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pipeline_known_host"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The account, repository or known host with the specified UUID was not found.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "description": "Retrieve a repository level known host.",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The UUID of the known host to retrieve.",
+ "required": true,
+ "name": "known_host_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Pipelines"],
+ "summary": "Get a known host",
+ "operationId": "getRepositoryPipelineKnownHost"
+ },
+ "delete": {
+ "responses": {
+ "204": {
+ "description": "The known host was deleted."
+ },
+ "404": {
+ "description": "The account, repository or known host with given UUID was not found.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "description": "Delete a repository level known host.",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The UUID of the known host to delete.",
+ "required": true,
+ "name": "known_host_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Pipelines"],
+ "summary": "Delete a known host",
+ "operationId": "deleteRepositoryPipelineKnownHost"
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/pipelines_config/variables/": {
+ "post": {
+ "responses": {
+ "201": {
+ "headers": {
+ "Location": {
+ "description": "The URL of the newly created pipeline variable.",
+ "schema": {
+ "type": "string"
+ }
+ }
+ },
+ "description": "The variable was created.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pipeline_variable"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The account or repository does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "A variable with the provided key already exists.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "description": "Create a repository level variable.",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pipeline_variable"
+ }
+ }
+ },
+ "description": "The variable to create.",
+ "required": true
+ },
+ "tags": ["Pipelines"],
+ "summary": "Create a variable for a repository",
+ "operationId": "createRepositoryPipelineVariable"
+ },
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The retrieved variables.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_pipeline_variables"
+ }
+ }
+ }
+ }
+ },
+ "description": "Find repository level variables.",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Pipelines"],
+ "summary": "List variables for a repository",
+ "operationId": "getRepositoryPipelineVariables"
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/pipelines_config/variables/{variable_uuid}": {
+ "put": {
+ "responses": {
+ "200": {
+ "description": "The variable was updated.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pipeline_variable"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The account, repository or variable with the given UUID was not found.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "description": "Update a repository level variable.",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The UUID of the variable to update.",
+ "required": true,
+ "name": "variable_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pipeline_variable"
+ }
+ }
+ },
+ "description": "The updated variable",
+ "required": true
+ },
+ "tags": ["Pipelines"],
+ "summary": "Update a variable for a repository",
+ "operationId": "updateRepositoryPipelineVariable"
+ },
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The variable.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pipeline_variable"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The account, repository or variable with the specified UUID was not found.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "description": "Retrieve a repository level variable.",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The UUID of the variable to retrieve.",
+ "required": true,
+ "name": "variable_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Pipelines"],
+ "summary": "Get a variable for a repository",
+ "operationId": "getRepositoryPipelineVariable"
+ },
+ "delete": {
+ "responses": {
+ "204": {
+ "description": "The variable was deleted."
+ },
+ "404": {
+ "description": "The account, repository or variable with given UUID was not found.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "description": "Delete a repository level variable.",
+ "parameters": [
+ {
+ "description": "This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example `{workspace UUID}`.",
+ "required": true,
+ "name": "workspace",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The repository.",
+ "required": true,
+ "name": "repo_slug",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The UUID of the variable to delete.",
+ "required": true,
+ "name": "variable_uuid",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Pipelines"],
+ "summary": "Delete a variable for a repository",
+ "operationId": "deleteRepositoryPipelineVariable"
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/properties/{app_key}/{property_name}": {
+ "put": {
+ "responses": {
+ "204": {
+ "description": "An empty response."
+ }
+ },
+ "parameters": [
+ {
+ "required": true,
+ "description": "The repository container; either the workspace slug or the UUID in curly braces.",
+ "in": "path",
+ "name": "workspace",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The repository.",
+ "in": "path",
+ "name": "repo_slug",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The key of the Connect app.",
+ "in": "path",
+ "name": "app_key",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The name of the property.",
+ "in": "path",
+ "name": "property_name",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "$ref": "#/components/requestBodies/application_property"
+ },
+ "tags": ["properties"],
+ "description": "Update an [application property](/cloud/bitbucket/application-properties/) value stored against a repository.",
+ "summary": "Update a repository application property",
+ "operationId": "updateRepositoryHostedPropertyValue"
+ },
+ "delete": {
+ "responses": {
+ "204": {
+ "description": "An empty response."
+ }
+ },
+ "parameters": [
+ {
+ "required": true,
+ "description": "The repository container; either the workspace slug or the UUID in curly braces.",
+ "in": "path",
+ "name": "workspace",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The repository.",
+ "in": "path",
+ "name": "repo_slug",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The key of the Connect app.",
+ "in": "path",
+ "name": "app_key",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The name of the property.",
+ "in": "path",
+ "name": "property_name",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["properties"],
+ "description": "Delete an [application property](/cloud/bitbucket/application-properties/) value stored against a repository.",
+ "summary": "Delete a repository application property",
+ "operationId": "deleteRepositoryHostedPropertyValue"
+ },
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The value of the property.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/application_property"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "required": true,
+ "description": "The repository container; either the workspace slug or the UUID in curly braces.",
+ "in": "path",
+ "name": "workspace",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The repository.",
+ "in": "path",
+ "name": "repo_slug",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The key of the Connect app.",
+ "in": "path",
+ "name": "app_key",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The name of the property.",
+ "in": "path",
+ "name": "property_name",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["properties"],
+ "description": "Retrieve an [application property](/cloud/bitbucket/application-properties/) value stored against a repository.",
+ "summary": "Get a repository application property",
+ "operationId": "getRepositoryHostedPropertyValue"
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/pullrequests": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "All pull requests on the specified repository.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_pullrequests"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "If the repository is private and the request was not authenticated."
+ },
+ "404": {
+ "description": "If the specified repository does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "state",
+ "in": "query",
+ "description": "Only return pull requests that are in this state. This parameter can be repeated.",
+ "schema": {
+ "type": "string",
+ "enum": ["MERGED", "SUPERSEDED", "OPEN", "DECLINED"]
+ }
+ }
+ ],
+ "tags": ["Pullrequests"],
+ "summary": "List pull requests",
+ "security": [
+ {
+ "oauth2": ["pullrequest"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns all pull requests on the specified repository.\n\nBy default only open pull requests are returned. This can be controlled\nusing the `state` query parameter. To retrieve pull requests that are\nin one of multiple states, repeat the `state` parameter for each\nindividual state.\n\nThis endpoint also supports filtering and sorting of the results. See\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for more details."
+ },
+ "post": {
+ "responses": {
+ "201": {
+ "description": "The newly created pull request.",
+ "headers": {
+ "Location": {
+ "description": "The URL of new newly created pull request.",
+ "schema": {
+ "type": "string"
+ }
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pullrequest"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "If the input document was invalid, or if the caller lacks the privilege to create repositories under the targeted account.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "If the request was not authenticated.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pullrequest"
+ }
+ }
+ },
+ "description": "The new pull request.\n\nThe request URL you POST to becomes the destination repository URL. For this reason, you must specify an explicit source repository in the request object if you want to pull from a different repository (fork).\n\nSince not all elements are required or even mutable, you only need to include the elements you want to initialize, such as the source branch and the title."
+ },
+ "tags": ["Pullrequests"],
+ "summary": "Create a pull request",
+ "security": [
+ {
+ "oauth2": ["pullrequest:write"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Creates a new pull request where the destination repository is\nthis repository and the author is the authenticated user.\n\nThe minimum required fields to create a pull request are `title` and\n`source`, specified by a branch name.\n\n```\ncurl https://api.bitbucket.org/2.0/repositories/my-workspace/my-repository/pullrequests \\\n -u my-username:my-password \\\n --request POST \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"title\": \"My Title\",\n \"source\": {\n \"branch\": {\n \"name\": \"staging\"\n }\n }\n }'\n```\n\nIf the pull request's `destination` is not specified, it will default\nto the `repository.mainbranch`. To open a pull request to a\ndifferent branch, say from a feature branch to a staging branch,\nspecify a `destination` (same format as the `source`):\n\n```\n{\n \"title\": \"My Title\",\n \"source\": {\n \"branch\": {\n \"name\": \"my-feature-branch\"\n }\n },\n \"destination\": {\n \"branch\": {\n \"name\": \"staging\"\n }\n }\n}\n```\n\nReviewers can be specified by adding an array of user objects as the\n`reviewers` property.\n\n```\n{\n \"title\": \"My Title\",\n \"source\": {\n \"branch\": {\n \"name\": \"my-feature-branch\"\n }\n },\n \"reviewers\": [\n {\n \"uuid\": \"{504c3b62-8120-4f0c-a7bc-87800b9d6f70}\"\n }\n ]\n}\n```\n\nOther fields:\n\n* `description` - a string\n* `close_source_branch` - boolean that specifies if the source branch should be closed upon merging"
+ },
+ "parameters": [
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/pullrequests/activity": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The pull request activity log"
+ },
+ "401": {
+ "description": "If the repository is private and the request was not authenticated."
+ },
+ "404": {
+ "description": "If the specified repository does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Pullrequests"],
+ "summary": "List a pull request activity log",
+ "security": [
+ {
+ "oauth2": ["pullrequest"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns a paginated list of the pull request's activity log.\n\nThis handler serves both a v20 and internal endpoint. The v20 endpoint\nreturns reviewer comments, updates, approvals and request changes. The internal\nendpoint includes those plus tasks and attachments.\n\nComments created on a file or a line of code have an inline property.\n\nComment example:\n```\n{\n \"pagelen\": 20,\n \"values\": [\n {\n \"comment\": {\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695/comments/118571088\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695/_/diff#comment-118571088\"\n }\n },\n \"deleted\": false,\n \"pullrequest\": {\n \"type\": \"pullrequest\",\n \"id\": 5695,\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695\"\n }\n },\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\"\n },\n \"content\": {\n \"raw\": \"inline with to a dn from lines\",\n \"markup\": \"markdown\",\n \"html\": \"inline with to a dn from lines
\",\n \"type\": \"rendered\"\n },\n \"created_on\": \"2019-09-27T00:33:46.039178+00:00\",\n \"user\": {\n \"display_name\": \"Name Lastname\",\n \"uuid\": \"{}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/users/%7B%7D\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/%7B%7D/\"\n },\n \"avatar\": {\n \"href\": \"https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/:/128\"\n }\n },\n \"type\": \"user\",\n \"nickname\": \"Name\",\n \"account_id\": \"\"\n },\n \"created_on\": \"2019-09-27T00:33:46.039178+00:00\",\n \"user\": {\n \"display_name\": \"Name Lastname\",\n \"uuid\": \"{}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/users/%7B%7D\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/%7B%7D/\"\n },\n \"avatar\": {\n \"href\": \"https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/:/128\"\n }\n },\n \"type\": \"user\",\n \"nickname\": \"Name\",\n \"account_id\": \"\"\n },\n \"updated_on\": \"2019-09-27T00:33:46.055384+00:00\",\n \"inline\": {\n \"context_lines\": \"\",\n \"to\": null,\n \"path\": \"\",\n \"outdated\": false,\n \"from\": 211\n },\n \"type\": \"pullrequest_comment\",\n \"id\": 118571088\n },\n \"pull_request\": {\n \"type\": \"pullrequest\",\n \"id\": 5695,\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695\"\n }\n },\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\"\n }\n }\n ]\n}\n```\n\nUpdates include a state property of OPEN, MERGED, or DECLINED.\n\nUpdate example:\n```\n{\n \"pagelen\": 20,\n \"values\": [\n {\n \"update\": {\n \"description\": \"\",\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\",\n \"destination\": {\n \"commit\": {\n \"type\": \"commit\",\n \"hash\": \"6a2c16e4a152\",\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2/commit/6a2c16e4a152\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/commits/6a2c16e4a152\"\n }\n }\n },\n \"branch\": {\n \"name\": \"master\"\n },\n \"repository\": {\n \"name\": \"Atlaskit-MK-2\",\n \"type\": \"repository\",\n \"full_name\": \"atlassian/atlaskit-mk-2\",\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2\"\n },\n \"avatar\": {\n \"href\": \"https://bytebucket.org/ravatar/%7B%7D?ts=js\"\n }\n },\n \"uuid\": \"{}\"\n }\n },\n \"reason\": \"\",\n \"source\": {\n \"commit\": {\n \"type\": \"commit\",\n \"hash\": \"728c8bad1813\",\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2/commit/728c8bad1813\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/commits/728c8bad1813\"\n }\n }\n },\n \"branch\": {\n \"name\": \"username/NONE-add-onClick-prop-for-accessibility\"\n },\n \"repository\": {\n \"name\": \"Atlaskit-MK-2\",\n \"type\": \"repository\",\n \"full_name\": \"atlassian/atlaskit-mk-2\",\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2\"\n },\n \"avatar\": {\n \"href\": \"https://bytebucket.org/ravatar/%7B%7D?ts=js\"\n }\n },\n \"uuid\": \"{}\"\n }\n },\n \"state\": \"OPEN\",\n \"author\": {\n \"display_name\": \"Name Lastname\",\n \"uuid\": \"{}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/users/%7B%7D\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/%7B%7D/\"\n },\n \"avatar\": {\n \"href\": \"https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/:/128\"\n }\n },\n \"type\": \"user\",\n \"nickname\": \"Name\",\n \"account_id\": \"\"\n },\n \"date\": \"2019-05-10T06:48:25.305565+00:00\"\n },\n \"pull_request\": {\n \"type\": \"pullrequest\",\n \"id\": 5695,\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695\"\n }\n },\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\"\n }\n }\n ]\n}\n```\n\nApproval example:\n```\n{\n \"pagelen\": 20,\n \"values\": [\n {\n \"approval\": {\n \"date\": \"2019-09-27T00:37:19.849534+00:00\",\n \"pullrequest\": {\n \"type\": \"pullrequest\",\n \"id\": 5695,\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695\"\n }\n },\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\"\n },\n \"user\": {\n \"display_name\": \"Name Lastname\",\n \"uuid\": \"{}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/users/%7B%7D\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/%7B%7D/\"\n },\n \"avatar\": {\n \"href\": \"https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/:/128\"\n }\n },\n \"type\": \"user\",\n \"nickname\": \"Name\",\n \"account_id\": \"\"\n }\n },\n \"pull_request\": {\n \"type\": \"pullrequest\",\n \"id\": 5695,\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695\"\n }\n },\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\"\n }\n }\n ]\n}\n```"
+ },
+ "parameters": [
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The pull request object",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pullrequest"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "If the repository is private and the request was not authenticated."
+ },
+ "404": {
+ "description": "If the repository or pull request does not exist",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Pullrequests"],
+ "summary": "Get a pull request",
+ "security": [
+ {
+ "oauth2": ["pullrequest"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns the specified pull request."
+ },
+ "put": {
+ "responses": {
+ "200": {
+ "description": "The updated pull request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pullrequest"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "If the input document was invalid.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "If the request was not authenticated.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the repository or pull request id does not exist",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pullrequest"
+ }
+ }
+ },
+ "description": "The pull request that is to be updated."
+ },
+ "tags": ["Pullrequests"],
+ "summary": "Update a pull request",
+ "security": [
+ {
+ "oauth2": ["pullrequest:write"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Mutates the specified pull request.\n\nThis can be used to change the pull request's branches or description.\n\nOnly open pull requests can be mutated."
+ },
+ "parameters": [
+ {
+ "name": "pull_request_id",
+ "in": "path",
+ "description": "The id of the pull request.",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/activity": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The pull request activity log"
+ },
+ "401": {
+ "description": "If the repository is private and the request was not authenticated."
+ },
+ "404": {
+ "description": "If the specified repository does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Pullrequests"],
+ "summary": "List a pull request activity log",
+ "security": [
+ {
+ "oauth2": ["pullrequest"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns a paginated list of the pull request's activity log.\n\nThis handler serves both a v20 and internal endpoint. The v20 endpoint\nreturns reviewer comments, updates, approvals and request changes. The internal\nendpoint includes those plus tasks and attachments.\n\nComments created on a file or a line of code have an inline property.\n\nComment example:\n```\n{\n \"pagelen\": 20,\n \"values\": [\n {\n \"comment\": {\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695/comments/118571088\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695/_/diff#comment-118571088\"\n }\n },\n \"deleted\": false,\n \"pullrequest\": {\n \"type\": \"pullrequest\",\n \"id\": 5695,\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695\"\n }\n },\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\"\n },\n \"content\": {\n \"raw\": \"inline with to a dn from lines\",\n \"markup\": \"markdown\",\n \"html\": \"inline with to a dn from lines
\",\n \"type\": \"rendered\"\n },\n \"created_on\": \"2019-09-27T00:33:46.039178+00:00\",\n \"user\": {\n \"display_name\": \"Name Lastname\",\n \"uuid\": \"{}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/users/%7B%7D\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/%7B%7D/\"\n },\n \"avatar\": {\n \"href\": \"https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/:/128\"\n }\n },\n \"type\": \"user\",\n \"nickname\": \"Name\",\n \"account_id\": \"\"\n },\n \"created_on\": \"2019-09-27T00:33:46.039178+00:00\",\n \"user\": {\n \"display_name\": \"Name Lastname\",\n \"uuid\": \"{}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/users/%7B%7D\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/%7B%7D/\"\n },\n \"avatar\": {\n \"href\": \"https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/:/128\"\n }\n },\n \"type\": \"user\",\n \"nickname\": \"Name\",\n \"account_id\": \"\"\n },\n \"updated_on\": \"2019-09-27T00:33:46.055384+00:00\",\n \"inline\": {\n \"context_lines\": \"\",\n \"to\": null,\n \"path\": \"\",\n \"outdated\": false,\n \"from\": 211\n },\n \"type\": \"pullrequest_comment\",\n \"id\": 118571088\n },\n \"pull_request\": {\n \"type\": \"pullrequest\",\n \"id\": 5695,\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695\"\n }\n },\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\"\n }\n }\n ]\n}\n```\n\nUpdates include a state property of OPEN, MERGED, or DECLINED.\n\nUpdate example:\n```\n{\n \"pagelen\": 20,\n \"values\": [\n {\n \"update\": {\n \"description\": \"\",\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\",\n \"destination\": {\n \"commit\": {\n \"type\": \"commit\",\n \"hash\": \"6a2c16e4a152\",\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2/commit/6a2c16e4a152\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/commits/6a2c16e4a152\"\n }\n }\n },\n \"branch\": {\n \"name\": \"master\"\n },\n \"repository\": {\n \"name\": \"Atlaskit-MK-2\",\n \"type\": \"repository\",\n \"full_name\": \"atlassian/atlaskit-mk-2\",\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2\"\n },\n \"avatar\": {\n \"href\": \"https://bytebucket.org/ravatar/%7B%7D?ts=js\"\n }\n },\n \"uuid\": \"{}\"\n }\n },\n \"reason\": \"\",\n \"source\": {\n \"commit\": {\n \"type\": \"commit\",\n \"hash\": \"728c8bad1813\",\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2/commit/728c8bad1813\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/commits/728c8bad1813\"\n }\n }\n },\n \"branch\": {\n \"name\": \"username/NONE-add-onClick-prop-for-accessibility\"\n },\n \"repository\": {\n \"name\": \"Atlaskit-MK-2\",\n \"type\": \"repository\",\n \"full_name\": \"atlassian/atlaskit-mk-2\",\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2\"\n },\n \"avatar\": {\n \"href\": \"https://bytebucket.org/ravatar/%7B%7D?ts=js\"\n }\n },\n \"uuid\": \"{}\"\n }\n },\n \"state\": \"OPEN\",\n \"author\": {\n \"display_name\": \"Name Lastname\",\n \"uuid\": \"{}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/users/%7B%7D\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/%7B%7D/\"\n },\n \"avatar\": {\n \"href\": \"https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/:/128\"\n }\n },\n \"type\": \"user\",\n \"nickname\": \"Name\",\n \"account_id\": \"\"\n },\n \"date\": \"2019-05-10T06:48:25.305565+00:00\"\n },\n \"pull_request\": {\n \"type\": \"pullrequest\",\n \"id\": 5695,\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695\"\n }\n },\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\"\n }\n }\n ]\n}\n```\n\nApproval example:\n```\n{\n \"pagelen\": 20,\n \"values\": [\n {\n \"approval\": {\n \"date\": \"2019-09-27T00:37:19.849534+00:00\",\n \"pullrequest\": {\n \"type\": \"pullrequest\",\n \"id\": 5695,\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695\"\n }\n },\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\"\n },\n \"user\": {\n \"display_name\": \"Name Lastname\",\n \"uuid\": \"{}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/users/%7B%7D\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/%7B%7D/\"\n },\n \"avatar\": {\n \"href\": \"https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/:/128\"\n }\n },\n \"type\": \"user\",\n \"nickname\": \"Name\",\n \"account_id\": \"\"\n }\n },\n \"pull_request\": {\n \"type\": \"pullrequest\",\n \"id\": 5695,\n \"links\": {\n \"self\": {\n \"href\": \"https://bitbucket.org/!api/2.0/repositories/atlassian/atlaskit-mk-2/pullrequests/5695\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/atlaskit-mk-2/pull-requests/5695\"\n }\n },\n \"title\": \"username/NONE: small change from onFocus to onClick to handle tabbing through the page and not expand the editor unless a click event triggers it\"\n }\n }\n ]\n}\n```"
+ },
+ "parameters": [
+ {
+ "name": "pull_request_id",
+ "in": "path",
+ "description": "The id of the pull request.",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/approve": {
+ "delete": {
+ "responses": {
+ "204": {
+ "description": "An empty response indicating the authenticated user's approval has been withdrawn."
+ },
+ "401": {
+ "description": "The request wasn't authenticated.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The specified pull request or the repository does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Pullrequests"],
+ "summary": "Unapprove a pull request",
+ "security": [
+ {
+ "oauth2": ["pullrequest:write"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Redact the authenticated user's approval of the specified pull\nrequest."
+ },
+ "post": {
+ "responses": {
+ "200": {
+ "description": "The `participant` object recording that the authenticated user approved the pull request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/participant"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "The request wasn't authenticated.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The specified pull request or the repository does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Pullrequests"],
+ "summary": "Approve a pull request",
+ "security": [
+ {
+ "oauth2": ["pullrequest:write"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Approve the specified pull request as the authenticated user."
+ },
+ "parameters": [
+ {
+ "name": "pull_request_id",
+ "in": "path",
+ "description": "The id of the pull request.",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "A paginated list of comments made on the given pull request, in chronological order.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_pullrequest_comments"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "If the authenticated user does not have access to the pull request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the pull request does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Pullrequests"],
+ "summary": "List comments on a pull request",
+ "security": [
+ {
+ "oauth2": ["pullrequest"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns a paginated list of the pull request's comments.\n\nThis includes both global, inline comments and replies.\n\nThe default sorting is oldest to newest and can be overridden with\nthe `sort` query parameter.\n\nThis endpoint also supports filtering and sorting of the results. See\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering) for more\ndetails."
+ },
+ "post": {
+ "responses": {
+ "201": {
+ "description": "The newly created comment.",
+ "headers": {
+ "Location": {
+ "description": "The URL of the new comment",
+ "schema": {
+ "type": "string"
+ }
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pullrequest_comment"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "If the authenticated user does not have access to the pull request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the pull request does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pullrequest_comment"
+ }
+ }
+ },
+ "description": "The comment object.",
+ "required": true
+ },
+ "tags": ["Pullrequests"],
+ "summary": "Create a comment on a pull request",
+ "security": [
+ {
+ "oauth2": ["pullrequest"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Creates a new pull request comment.\n\nReturns the newly created pull request comment."
+ },
+ "parameters": [
+ {
+ "name": "pull_request_id",
+ "in": "path",
+ "description": "The id of the pull request.",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id}": {
+ "delete": {
+ "responses": {
+ "204": {
+ "description": "Successful deletion."
+ },
+ "403": {
+ "description": "If the authenticated user does not have access to delete the comment.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the comment does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Pullrequests"],
+ "summary": "Delete a comment on a pull request",
+ "security": [
+ {
+ "oauth2": ["pullrequest"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Deletes a specific pull request comment."
+ },
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The comment.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pullrequest_comment"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "If the authenticated user does not have access to the pull request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the comment does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Pullrequests"],
+ "summary": "Get a comment on a pull request",
+ "security": [
+ {
+ "oauth2": ["pullrequest"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns a specific pull request comment."
+ },
+ "put": {
+ "responses": {
+ "200": {
+ "description": "The updated comment.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pullrequest_comment"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "If the authenticated user does not have access to the comment.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the comment does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pullrequest_comment"
+ }
+ }
+ },
+ "description": "The contents of the updated comment.",
+ "required": true
+ },
+ "tags": ["Pullrequests"],
+ "summary": "Update a comment on a pull request",
+ "security": [
+ {
+ "oauth2": ["pullrequest"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Updates a specific pull request comment."
+ },
+ "parameters": [
+ {
+ "name": "comment_id",
+ "in": "path",
+ "description": "The id of the comment.",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "pull_request_id",
+ "in": "path",
+ "description": "The id of the pull request.",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/commits": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "A paginated list of commits made on the given pull request, in chronological order. This list will be empty if the source branch no longer exists."
+ },
+ "403": {
+ "description": "If the authenticated user does not have access to the pull request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "If the pull request does not exist or the source branch is from a forked repository which no longer exists.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Pullrequests"],
+ "summary": "List commits on a pull request",
+ "security": [
+ {
+ "oauth2": ["pullrequest"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns a paginated list of the pull request's commits.\n\nThese are the commits that are being merged into the destination\nbranch when the pull requests gets accepted."
+ },
+ "parameters": [
+ {
+ "name": "pull_request_id",
+ "in": "path",
+ "description": "The id of the pull request.",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/decline": {
+ "post": {
+ "responses": {
+ "200": {
+ "description": "The pull request was successfully declined.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pullrequest"
+ }
+ }
+ }
+ },
+ "555": {
+ "description": "If the decline took too long and timed out.\nIn this case the caller should retry the request later.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Pullrequests"],
+ "summary": "Decline a pull request",
+ "security": [
+ {
+ "oauth2": ["pullrequest:write"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Declines the pull request."
+ },
+ "parameters": [
+ {
+ "name": "pull_request_id",
+ "in": "path",
+ "description": "The id of the pull request.",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/diff": {
+ "get": {
+ "responses": {
+ "302": {
+ "description": "Redirects to the [repository diff](/cloud/bitbucket/rest/api-group-commits/#api-repositories-workspace-repo-slug-diff-spec-get) with the\nrevspec that corresponds to the pull request.\n"
+ }
+ },
+ "tags": ["Pullrequests"],
+ "summary": "List changes in a pull request",
+ "security": [
+ {
+ "oauth2": ["pullrequest"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Redirects to the [repository diff](/cloud/bitbucket/rest/api-group-commits/#api-repositories-workspace-repo-slug-diff-spec-get)\nwith the revspec that corresponds to the pull request."
+ },
+ "parameters": [
+ {
+ "name": "pull_request_id",
+ "in": "path",
+ "description": "The id of the pull request.",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/diffstat": {
+ "get": {
+ "responses": {
+ "302": {
+ "description": "Redirects to the [repository diffstat](/cloud/bitbucket/rest/api-group-commits/#api-repositories-workspace-repo-slug-diffstat-spec-get) with\nthe revspec that corresponds to pull request.\n"
+ }
+ },
+ "tags": ["Pullrequests"],
+ "summary": "Get the diff stat for a pull request",
+ "security": [
+ {
+ "oauth2": ["pullrequest"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Redirects to the [repository diffstat](/cloud/bitbucket/rest/api-group-commits/#api-repositories-workspace-repo-slug-diffstat-spec-get)\nwith the revspec that corresponds to the pull request."
+ },
+ "parameters": [
+ {
+ "name": "pull_request_id",
+ "in": "path",
+ "description": "The id of the pull request.",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/merge": {
+ "post": {
+ "responses": {
+ "200": {
+ "description": "The pull request object.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pullrequest"
+ }
+ }
+ }
+ },
+ "202": {
+ "description": "In the Location header, the URL to poll for the pull request merge status"
+ },
+ "555": {
+ "description": "If the merge took too long and timed out.\nIn this case the caller should retry the request later",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "async",
+ "in": "query",
+ "description": "Default value is false.\n\n\nWhen set to true, runs merge asynchronously and\nimmediately returns a 202 with polling link to\nthe task-status API in the Location header.\n\n\nWhen set to false, runs merge and waits for it to\ncomplete, returning 200 when it succeeds. If the\nduration of the merge exceeds a timeout threshold,\nthe API returns a 202 with polling link to the\ntask-status API in the Location header.",
+ "required": false,
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/pullrequest_merge_parameters"
+ }
+ }
+ }
+ },
+ "tags": ["Pullrequests"],
+ "summary": "Merge a pull request",
+ "security": [
+ {
+ "oauth2": ["pullrequest:write"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Merges the pull request."
+ },
+ "parameters": [
+ {
+ "name": "pull_request_id",
+ "in": "path",
+ "description": "The id of the pull request.",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/merge/task-status/{task_id}": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "Returns a task status if the merge is either pending or successful, and if it is successful, a pull request"
+ },
+ "400": {
+ "description": "If the provided task ID does not relate to this pull request, or if something went wrong during the merge operation"
+ },
+ "403": {
+ "description": "The user making the request does not have permission to the repo and is different from the user who queued the task"
+ }
+ },
+ "tags": ["Pullrequests"],
+ "summary": "Get the merge task status for a pull request",
+ "security": [
+ {
+ "oauth2": ["pullrequest"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "When merging a pull request takes too long, the client receives a\ntask ID along with a 202 status code. The task ID can be used in a call\nto this endpoint to check the status of a merge task.\n\n```\ncurl -X GET https://api.bitbucket.org/2.0/repositories/atlassian/bitbucket/pullrequests/2286/merge/task-status/\n```\n\nIf the merge task is not yet finished, a PENDING status will be returned.\n\n```\nHTTP/2 200\n{\n \"task_status\": \"PENDING\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/bitbucket/pullrequests/2286/merge/task-status/\"\n }\n }\n}\n```\n\nIf the merge was successful, a SUCCESS status will be returned.\n\n```\nHTTP/2 200\n{\n \"task_status\": \"SUCCESS\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/bitbucket/pullrequests/2286/merge/task-status/\"\n }\n },\n \"merge_result\": \n}\n```\n\nIf the merge task failed, an error will be returned.\n\n```\n{\n \"type\": \"error\",\n \"error\": {\n \"message\": \"\"\n }\n}\n```"
+ },
+ "parameters": [
+ {
+ "name": "pull_request_id",
+ "in": "path",
+ "description": "The id of the pull request.",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "task_id",
+ "in": "path",
+ "description": "ID of the merge task",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/patch": {
+ "get": {
+ "responses": {
+ "302": {
+ "description": "Redirects to the [repository patch](/cloud/bitbucket/rest/api-group-commits/#api-repositories-workspace-repo-slug-patch-spec-get) with\nthe revspec that corresponds to pull request.\n"
+ }
+ },
+ "tags": ["Pullrequests"],
+ "summary": "Get the patch for a pull request",
+ "security": [
+ {
+ "oauth2": ["pullrequest"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Redirects to the [repository patch](/cloud/bitbucket/rest/api-group-commits/#api-repositories-workspace-repo-slug-patch-spec-get)\nwith the revspec that corresponds to pull request."
+ },
+ "parameters": [
+ {
+ "name": "pull_request_id",
+ "in": "path",
+ "description": "The id of the pull request.",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/request-changes": {
+ "delete": {
+ "responses": {
+ "204": {
+ "description": "An empty response indicating the authenticated user's request for change has been withdrawn."
+ },
+ "401": {
+ "description": "The request wasn't authenticated.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The specified pull request or the repository does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Pullrequests"],
+ "summary": "Remove change request for a pull request",
+ "security": [
+ {
+ "oauth2": ["pullrequest:write"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": ""
+ },
+ "post": {
+ "responses": {
+ "200": {
+ "description": "The `participant` object recording that the authenticated user requested changes on the pull request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/participant"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "The request wasn't authenticated.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The specified pull request or the repository does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Pullrequests"],
+ "summary": "Request changes for a pull request",
+ "security": [
+ {
+ "oauth2": ["pullrequest:write"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": ""
+ },
+ "parameters": [
+ {
+ "name": "pull_request_id",
+ "in": "path",
+ "description": "The id of the pull request.",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/statuses": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "A paginated list of all commit statuses for this pull request.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_commitstatuses"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "If the repository is private and the request was not authenticated."
+ },
+ "404": {
+ "description": "If the specified repository or pull request does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "q",
+ "in": "query",
+ "description": "Query string to narrow down the response as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).\n",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "sort",
+ "in": "query",
+ "description": "Field by which the results should be sorted as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).\nDefaults to `created_on`.\n",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Pullrequests", "Commit statuses"],
+ "summary": "List commit statuses for a pull request",
+ "security": [
+ {
+ "oauth2": ["pullrequest"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns all statuses (e.g. build results) for the given pull\nrequest."
+ },
+ "parameters": [
+ {
+ "name": "pull_request_id",
+ "in": "path",
+ "description": "The id of the pull request.",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/pullrequests/{pullrequest_id}/properties/{app_key}/{property_name}": {
+ "put": {
+ "responses": {
+ "204": {
+ "description": "An empty response."
+ }
+ },
+ "parameters": [
+ {
+ "required": true,
+ "description": "The repository container; either the workspace slug or the UUID in curly braces.",
+ "in": "path",
+ "name": "workspace",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The repository.",
+ "in": "path",
+ "name": "repo_slug",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The pull request ID.",
+ "in": "path",
+ "name": "pullrequest_id",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The key of the Connect app.",
+ "in": "path",
+ "name": "app_key",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The name of the property.",
+ "in": "path",
+ "name": "property_name",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "$ref": "#/components/requestBodies/application_property"
+ },
+ "tags": ["properties"],
+ "description": "Update an [application property](/cloud/bitbucket/application-properties/) value stored against a pull request.",
+ "summary": "Update a pull request application property",
+ "operationId": "updatePullRequestHostedPropertyValue"
+ },
+ "delete": {
+ "responses": {
+ "204": {
+ "description": "An empty response."
+ }
+ },
+ "parameters": [
+ {
+ "required": true,
+ "description": "The repository container; either the workspace slug or the UUID in curly braces.",
+ "in": "path",
+ "name": "workspace",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The repository.",
+ "in": "path",
+ "name": "repo_slug",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The pull request ID.",
+ "in": "path",
+ "name": "pullrequest_id",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The key of the Connect app.",
+ "in": "path",
+ "name": "app_key",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The name of the property.",
+ "in": "path",
+ "name": "property_name",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["properties"],
+ "description": "Delete an [application property](/cloud/bitbucket/application-properties/) value stored against a pull request.",
+ "summary": "Delete a pull request application property",
+ "operationId": "deletePullRequestHostedPropertyValue"
+ },
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The value of the property.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/application_property"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "required": true,
+ "description": "The repository container; either the workspace slug or the UUID in curly braces.",
+ "in": "path",
+ "name": "workspace",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The repository.",
+ "in": "path",
+ "name": "repo_slug",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The pull request ID.",
+ "in": "path",
+ "name": "pullrequest_id",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The key of the Connect app.",
+ "in": "path",
+ "name": "app_key",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "required": true,
+ "description": "The name of the property.",
+ "in": "path",
+ "name": "property_name",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["properties"],
+ "description": "Retrieve an [application property](/cloud/bitbucket/application-properties/) value stored against a pull request.",
+ "summary": "Get a pull request application property",
+ "operationId": "getPullRequestHostedPropertyValue"
+ }
+ },
+ "/repositories/{workspace}/{repo_slug}/refs": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "A paginated list of refs matching any filter criteria that were provided.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_refs"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "If the repository is private and the authenticated user does not have\naccess to it.\n",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The specified repository does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "q",
+ "in": "query",
+ "description": "\nQuery string to narrow down the response as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "sort",
+ "in": "query",
+ "description": "\nField by which the results should be sorted as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering). The `name`\nfield is handled specially for refs in that, if specified as the sort field, it\nuses a natural sort order instead of the default lexicographical sort order. For example,\nit will return ['1.1', '1.2', '1.10'] instead of ['1.1', '1.10', '1.2'].",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Refs"],
+ "summary": "List branches and tags",
+ "security": [
+ {
+ "oauth2": ["repository"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns the branches and tags in the repository.\n\nBy default, results will be in the order the underlying source control system returns them and identical to\nthe ordering one sees when running \"$ git show-ref\". Note that this follows simple\nlexical ordering of the ref names.\n\nThis can be undesirable as it does apply any natural sorting semantics, meaning for instance that refs are\nsorted [\"branch1\", \"branch10\", \"branch2\", \"v10\", \"v11\", \"v9\"] instead of [\"branch1\", \"branch2\",\n\"branch10\", \"v9\", \"v10\", \"v11\"].\n\nSorting can be changed using the ?sort= query parameter. When using ?sort=name to explicitly sort on ref name,\nBitbucket will apply natural sorting and interpret numerical values as numbers instead of strings."
+ },
+ "parameters": [
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/refs/branches": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "A paginated list of branches matching any filter criteria that were provided.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_branches"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "If the repository is private and the authenticated user does not have\naccess to it.\n",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The specified repository does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "q",
+ "in": "query",
+ "description": "\nQuery string to narrow down the response as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "sort",
+ "in": "query",
+ "description": "\nField by which the results should be sorted as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering). The `name`\nfield is handled specially for branches in that, if specified as the sort field, it\nuses a natural sort order instead of the default lexicographical sort order. For example,\nit will return ['branch1', 'branch2', 'branch10'] instead of ['branch1', 'branch10', 'branch2'].",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Refs"],
+ "summary": "List open branches",
+ "security": [
+ {
+ "oauth2": ["repository"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns a list of all open branches within the specified repository.\n Results will be in the order the source control manager returns them.\n\n ```\n $ curl -s https://api.bitbucket.org/2.0/repositories/atlassian/aui/refs/branches?pagelen=1 | jq .\n {\n \"pagelen\": 1,\n \"size\": 187,\n \"values\": [\n {\n \"name\": \"issue-9.3/AUI-5343-assistive-class\",\n \"links\": {\n \"commits\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commits/issue-9.3/AUI-5343-assistive-class\"\n },\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/refs/branches/issue-9.3/AUI-5343-assistive-class\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/aui/branch/issue-9.3/AUI-5343-assistive-class\"\n }\n },\n \"default_merge_strategy\": \"squash\",\n \"merge_strategies\": [\n \"merge_commit\",\n \"squash\",\n \"fast_forward\"\n ],\n \"type\": \"branch\",\n \"target\": {\n \"hash\": \"e5d1cde9069fcb9f0af90403a4de2150c125a148\",\n \"repository\": {\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/aui\"\n },\n \"avatar\": {\n \"href\": \"https://bytebucket.org/ravatar/%7B585074de-7b60-4fd1-81ed-e0bc7fafbda5%7D?ts=86317\"\n }\n },\n \"type\": \"repository\",\n \"name\": \"aui\",\n \"full_name\": \"atlassian/aui\",\n \"uuid\": \"{585074de-7b60-4fd1-81ed-e0bc7fafbda5}\"\n },\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/e5d1cde9069fcb9f0af90403a4de2150c125a148\"\n },\n \"comments\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/e5d1cde9069fcb9f0af90403a4de2150c125a148/comments\"\n },\n \"patch\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/patch/e5d1cde9069fcb9f0af90403a4de2150c125a148\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/aui/commits/e5d1cde9069fcb9f0af90403a4de2150c125a148\"\n },\n \"diff\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/diff/e5d1cde9069fcb9f0af90403a4de2150c125a148\"\n },\n \"approve\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/e5d1cde9069fcb9f0af90403a4de2150c125a148/approve\"\n },\n \"statuses\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/e5d1cde9069fcb9f0af90403a4de2150c125a148/statuses\"\n }\n },\n \"author\": {\n \"raw\": \"Marcin Konopka \",\n \"type\": \"author\",\n \"user\": {\n \"display_name\": \"Marcin Konopka\",\n \"uuid\": \"{47cc24f4-2a05-4420-88fe-0417535a110a}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/%7B47cc24f4-2a05-4420-88fe-0417535a110a%7D\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/%7B47cc24f4-2a05-4420-88fe-0417535a110a%7D/\"\n },\n \"avatar\": {\n \"href\": \"https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/initials/MK-1.png\"\n }\n },\n \"nickname\": \"Marcin Konopka\",\n \"type\": \"user\",\n \"account_id\": \"60113d2b47a9540069f4de03\"\n }\n },\n \"parents\": [\n {\n \"hash\": \"87f7fc92b00464ae47b13ef65c91884e4ac9be51\",\n \"type\": \"commit\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/87f7fc92b00464ae47b13ef65c91884e4ac9be51\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/aui/commits/87f7fc92b00464ae47b13ef65c91884e4ac9be51\"\n }\n }\n }\n ],\n \"date\": \"2021-04-13T13:44:49+00:00\",\n \"message\": \"wip\n\",\n \"type\": \"commit\"\n }\n }\n ],\n \"page\": 1,\n \"next\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/refs/branches?pagelen=1&page=2\"\n }\n ```\n\n Branches support [filtering and sorting](/cloud/bitbucket/rest/intro/#filtering)\n that can be used to search for specific branches. For instance, to find\n all branches that have \"stab\" in their name:\n\n ```\n curl -s https://api.bitbucket.org/2.0/repositories/atlassian/aui/refs/branches -G --data-urlencode 'q=name ~ \"stab\"'\n ```\n\n By default, results will be in the order the underlying source control system returns them and identical to\n the ordering one sees when running \"$ git branch --list\". Note that this follows simple\n lexical ordering of the ref names.\n\n This can be undesirable as it does apply any natural sorting semantics, meaning for instance that tags are\n sorted [\"v10\", \"v11\", \"v9\"] instead of [\"v9\", \"v10\", \"v11\"].\n\n Sorting can be changed using the ?q= query parameter. When using ?q=name to explicitly sort on ref name,\n Bitbucket will apply natural sorting and interpret numerical values as numbers instead of strings."
+ },
+ "post": {
+ "responses": {
+ "201": {
+ "description": "The newly created branch object.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/branch"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "If the repository is private and the authenticated user does not have\naccess to it.\n",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The specified repository or branch does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Refs"],
+ "summary": "Create a branch",
+ "security": [
+ {
+ "oauth2": ["repository:write"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Creates a new branch in the specified repository.\n\nThe payload of the POST should consist of a JSON document that\ncontains the name of the tag and the target hash.\n\n```\ncurl https://api.bitbucket.org/2.0/repositories/seanfarley/hg/refs/branches \\\n-s -u seanfarley -X POST -H \"Content-Type: application/json\" \\\n-d '{\n \"name\" : \"smf/create-feature\",\n \"target\" : {\n \"hash\" : \"default\",\n }\n}'\n```\n\nThis call requires authentication. Private repositories require the\ncaller to authenticate with an account that has appropriate\nauthorization.\n\nThe branch name should not include any prefixes (e.g.\nrefs/heads). This endpoint does support using short hash prefixes for\nthe commit hash, but it may return a 400 response if the provided\nprefix is ambiguous. Using a full commit hash is the preferred\napproach."
+ },
+ "parameters": [
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/refs/branches/{name}": {
+ "delete": {
+ "responses": {
+ "204": {
+ "description": "Indicates that the specified branch was successfully deleted."
+ },
+ "403": {
+ "description": "If the repository is private and the authenticated user does not have\naccess to it.\n",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The specified repository or branch does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Refs"],
+ "summary": "Delete a branch",
+ "security": [
+ {
+ "oauth2": ["repository:write"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Delete a branch in the specified repository.\n\nThe main branch is not allowed to be deleted and will return a 400\nresponse.\n\nThe branch name should not include any prefixes (e.g.\nrefs/heads)."
+ },
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The branch object.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/branch"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "If the repository is private and the authenticated user does not have\naccess to it.\n",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The specified repository or branch does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Refs"],
+ "summary": "Get a branch",
+ "security": [
+ {
+ "oauth2": ["repository"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns a branch object within the specified repository.\n\n ```\n $ curl -s https://api.bitbucket.org/2.0/repositories/atlassian/aui/refs/branches/master | jq .\n {\n \"name\": \"master\",\n \"links\": {\n \"commits\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commits/master\"\n },\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/refs/branches/master\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/aui/branch/master\"\n }\n },\n \"default_merge_strategy\": \"squash\",\n \"merge_strategies\": [\n \"merge_commit\",\n \"squash\",\n \"fast_forward\"\n ],\n \"type\": \"branch\",\n \"target\": {\n \"hash\": \"e7d158ff7ed5538c28f94cd97a9ad569680fc94e\",\n \"repository\": {\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/aui\"\n },\n \"avatar\": {\n \"href\": \"https://bytebucket.org/ravatar/%7B585074de-7b60-4fd1-81ed-e0bc7fafbda5%7D?ts=86317\"\n }\n },\n \"type\": \"repository\",\n \"name\": \"aui\",\n \"full_name\": \"atlassian/aui\",\n \"uuid\": \"{585074de-7b60-4fd1-81ed-e0bc7fafbda5}\"\n },\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/e7d158ff7ed5538c28f94cd97a9ad569680fc94e\"\n },\n \"comments\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/e7d158ff7ed5538c28f94cd97a9ad569680fc94e/comments\"\n },\n \"patch\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/patch/e7d158ff7ed5538c28f94cd97a9ad569680fc94e\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/aui/commits/e7d158ff7ed5538c28f94cd97a9ad569680fc94e\"\n },\n \"diff\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/diff/e7d158ff7ed5538c28f94cd97a9ad569680fc94e\"\n },\n \"approve\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/e7d158ff7ed5538c28f94cd97a9ad569680fc94e/approve\"\n },\n \"statuses\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/e7d158ff7ed5538c28f94cd97a9ad569680fc94e/statuses\"\n }\n },\n \"author\": {\n \"raw\": \"psre-renovate-bot \",\n \"type\": \"author\",\n \"user\": {\n \"display_name\": \"psre-renovate-bot\",\n \"uuid\": \"{250a442a-3ab3-4fcb-87c3-3c8f3df65ec7}\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/users/%7B250a442a-3ab3-4fcb-87c3-3c8f3df65ec7%7D\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/%7B250a442a-3ab3-4fcb-87c3-3c8f3df65ec7%7D/\"\n },\n \"avatar\": {\n \"href\": \"https://secure.gravatar.com/avatar/6972ee037c9f36360170a86f544071a2?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FP-3.png\"\n }\n },\n \"nickname\": \"Renovate Bot\",\n \"type\": \"user\",\n \"account_id\": \"5d5355e8c6b9320d9ea5b28d\"\n }\n },\n \"parents\": [\n {\n \"hash\": \"eab868a309e75733de80969a7bed1ec6d4651e06\",\n \"type\": \"commit\",\n \"links\": {\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/atlassian/aui/commit/eab868a309e75733de80969a7bed1ec6d4651e06\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/atlassian/aui/commits/eab868a309e75733de80969a7bed1ec6d4651e06\"\n }\n }\n }\n ],\n \"date\": \"2021-04-12T06:44:38+00:00\",\n \"message\": \"Merged in issue/NONE-renovate-master-babel-monorepo (pull request #2883)\n\nchore(deps): update babel monorepo to v7.13.15 (master)\n\nApproved-by: Chris \"Daz\" Darroch\n\",\n \"type\": \"commit\"\n }\n }\n ```\n\n This call requires authentication. Private repositories require the\n caller to authenticate with an account that has appropriate\n authorization.\n\n For Git, the branch name should not include any prefixes (e.g.\n refs/heads)."
+ },
+ "parameters": [
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The name of the branch.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/refs/tags": {
+ "get": {
+ "responses": {
+ "200": {
+ "description": "A paginated list of tags matching any filter criteria that were provided.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/paginated_tags"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "If the repository is private and the authenticated user does not have\naccess to it.\n",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The specified repository does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "q",
+ "in": "query",
+ "description": "\nQuery string to narrow down the response as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering).",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "sort",
+ "in": "query",
+ "description": "\nField by which the results should be sorted as per\n[filtering and sorting](/cloud/bitbucket/rest/intro/#filtering). The `name`\nfield is handled specially for tags in that, if specified as the sort field, it\nuses a natural sort order instead of the default lexicographical sort order. For example,\nit will return ['1.1', '1.2', '1.10'] instead of ['1.1', '1.10', '1.2'].",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "tags": ["Refs"],
+ "summary": "List tags",
+ "security": [
+ {
+ "oauth2": ["repository"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns the tags in the repository.\n\nBy default, results will be in the order the underlying source control system returns them and identical to\nthe ordering one sees when running \"$ git tag --list\". Note that this follows simple\nlexical ordering of the ref names.\n\nThis can be undesirable as it does apply any natural sorting semantics, meaning for instance that tags are\nsorted [\"v10\", \"v11\", \"v9\"] instead of [\"v9\", \"v10\", \"v11\"].\n\nSorting can be changed using the ?sort= query parameter. When using ?sort=name to explicitly sort on ref name,\nBitbucket will apply natural sorting and interpret numerical values as numbers instead of strings."
+ },
+ "post": {
+ "responses": {
+ "201": {
+ "description": "The newly created tag.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/tag"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "If the target hash is missing, ambiguous, or invalid, or if the name is not provided.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/tag"
+ }
+ }
+ },
+ "required": true
+ },
+ "tags": ["Refs"],
+ "summary": "Create a tag",
+ "security": [
+ {
+ "oauth2": ["repository:write"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Creates a new tag in the specified repository.\n\nThe payload of the POST should consist of a JSON document that\ncontains the name of the tag and the target hash.\n\n```\ncurl https://api.bitbucket.org/2.0/repositories/jdoe/myrepo/refs/tags \\\n-s -u jdoe -X POST -H \"Content-Type: application/json\" \\\n-d '{\n \"name\" : \"new-tag-name\",\n \"target\" : {\n \"hash\" : \"a1b2c3d4e5f6\",\n }\n}'\n```\n\nThis endpoint does support using short hash prefixes for the commit\nhash, but it may return a 400 response if the provided prefix is\nambiguous. Using a full commit hash is the preferred approach."
+ },
+ "parameters": [
+ {
+ "name": "repo_slug",
+ "in": "path",
+ "description": "This can either be the repository slug or the UUID of the repository,\nsurrounded by curly-braces, for example: `{repository UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "workspace",
+ "in": "path",
+ "description": "This can either be the workspace ID (slug) or the workspace UUID\nsurrounded by curly-braces, for example: `{workspace UUID}`.\n",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "/repositories/{workspace}/{repo_slug}/refs/tags/{name}": {
+ "delete": {
+ "responses": {
+ "204": {
+ "description": "Indicates the specified tag was successfully deleted."
+ },
+ "403": {
+ "description": "If the repository is private and the authenticated user does not have\naccess to it.\n",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The specified repository or tag does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Refs"],
+ "summary": "Delete a tag",
+ "security": [
+ {
+ "oauth2": ["repository:write"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Delete a tag in the specified repository.\n\nThe tag name should not include any prefixes (e.g. refs/tags)."
+ },
+ "get": {
+ "responses": {
+ "200": {
+ "description": "The tag object.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/tag"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "If the repository is private and the authenticated user does not have\naccess to it.\n",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The specified repository or tag does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ }
+ }
+ },
+ "tags": ["Refs"],
+ "summary": "Get a tag",
+ "security": [
+ {
+ "oauth2": ["repository"]
+ },
+ {
+ "basic": []
+ },
+ {
+ "api_key": []
+ }
+ ],
+ "description": "Returns the specified tag.\n\n```\n$ curl -s https://api.bitbucket.org/2.0/repositories/seanfarley/hg/refs/tags/3.8 -G | jq .\n{\n \"name\": \"3.8\",\n \"links\": {\n \"commits\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/seanfarley/hg/commits/3.8\"\n },\n \"self\": {\n \"href\": \"https://api.bitbucket.org/2.0/repositories/seanfarley/hg/refs/tags/3.8\"\n },\n \"html\": {\n \"href\": \"https://bitbucket.org/seanfarley/hg/commits/tag/3.8\"\n }\n },\n \"tagger\": {\n \"raw\": \"Matt Mackall