````json { "openapi": "3.0.0", "info": { "contact": { "name": "Cloud Content Delivery Team" }, "description": "# Overview\nCloud Content Delivery (CCD) is a managed cloud service that hosts and delivers content to your applications users worldwide without having to reinstall a new version of the application.\nThe service is fully integrated into the Unity development platform, saving you months of building and maintaining your own similar service.\nCCD is most valuable for content-rich, live games or applications that require content updates on a regular basis. It is intended to be used by developers at build time for managing content.\n\n# Environments\nEnvironments can be created in the Unity Developer Dashboard. A project can exist in several different environments with completely different data sets. Org and User routes are not impacted by environments, but any project or bucket level route is. To find a list of environments for your project and their corresponding IDs visit the Dashboard. If you signed up for UGS Beta, click on Projects. Find your Project and then click on Environments under Project Settings. When environments were introduced all existing data was put into the 'production' environment. If you did not sign up, you can see the environment Id in the LiveOps page. In the Cloud Content Delivery section, click on buckets and you will see the Environment ID in the GUIDS tabs. If you make an API call without an environment ID or environment name you will get data from that default - 'production' - environment.\n\nRoutes in the management API take an environment ID. Routes in the client API take an environment name which is then resolved by the API to the proper ID.\n\nAll of the old routes without an environment specified have been marked deprecated. They still work and will continue to be supported. We just wanted to make it clear in the documentation which routes you should use going forward.\n\n# Authentication\nThe Content Delivery Management API requires an API key associated with your Unity developer account. To access your API Key, please visit the developer dashboard.\nTo authenticate requests, include a Basic Authentication header as a base64-encoded string 'username:password', using your API key as the password (and empty username).\nFor example, an API key value of ```d6d2c026bac44b1ea7ac0332694a830e``` would include an Authorization header like ```Authorization Basic OmQ2ZDJjMDI2YmFjNDRiMWVhN2FjMDMzMjY5NGE4MzBl```.\n\n

The Content Delivery Management API is deprecating API Key Authentication and now recommends using Service Account Authentication instead.

\n

To create a new service account please follow the instructions available in the Create a service account section of the Service Account Authentication documentation.

\n

Under Organization roles, you must assign the Cloud Content Delivery API Public Editor role to your service account to grant read and write access to public endpoints of CCD Management API.

\n

To use service account please follow the instructions available in the Authenticate an API using service account credentials section of the Service Account Authentication documentation.

\n

As mentioned in the documentation linked above, for CCD Management API endpoints use https://services.api.unity.com/ccd/management/v1/ as the URL host + base path.

\n\n# Workflow for Uploading Content to a Bucket\nIf a user wants to upload content to a Bucket, they need to first create a new Entry for that bucket\nand using that Bucket ID and Entry ID they can upload the content(file).\n\n\"Create\n\nIf a user wants to upload new content for an existing file path, they first update the Entry for the file then upload the content.\n\n\"Update \n\n

We recommend using the Entry parameter signed_url set to \"true\" when creating or updating an Entry to get back a signed URL that can be use to upload the content directly to the cloud storage.\nThe signed URL will be returned in the response Entry parameter signed_url. The content can then be uploaded using a request like this:

\n

curl -i -X PUT -H \\'Content-Type: CONTENT_TYPE_HERE\\' --upload-file \\'FOLDER/PATH/TO/YOUR/FILE/samplefile.txt\\' \\'SIGNED_URL_HERE\\'

\n

Note that signed URLs are valid for 5 mins and cannot be used for chunked or resumable uploads.

\n\n# Permissions\nA Permission is set on a bucket and is composed of a role and an action that can be allowed or denied.\nSome actions require permissions to be performed. The available roles are 'user' for the management API and 'client' for the client API.\nThe current actions possible are 'write' and 'list-releases'. For example, 'list-releases' is currently denied by default in the client API.\nTo enable the list releases endpoints for the client API, a permission must be added with the role 'client', the action 'list-releases' and the permission 'allow'.\n\n# Generate difference between releases\n

When you create a release, CCD automatically generates a difference between the new release and the previous one. However, if you want to get the diff between two versions with a jump (for example, /?fromreleasenum=0&toreleasenum=4), and it was never previously generated, then you must calculate the diff asynchronously.\nNote: The difference releases entries route returns an empty set if the difference was not generated first.\nFirst, generate the diff using the following route:\n/diff/releases/?fromreleasenum=0&toreleasenum=4\nIt returns a response with a flag, for example:\n

\n{\n \"unchanged\": 0,\n \"add\": 0,\n \"update\": 0,\n \"delete\": 0,\n \"loading\": true\n}\n

\nThe loading flag is true if the task is not yet completed. To learn the status of the task, poll the releases' routes until the flag is false, as in the following example:\n

\n{\n \"unchanged\": 1,\n \"add\": 1,\n \"update\": 2,\n \"delete\": 0,\n \"loading\": false\n}\n

\nYou could now see the entries listed using the following route:\n{bucket_id}/diff/releases/entries/?fromreleasenum=0&toreleasenum=4

\n\n# Useful links & Information\n- For more information on CCD, visit [Unity CCD Documentation](https://docs.unity.com/ccd/en/manual/UnityCCD.html).\n- The Content Delivery can also be managed using the CLI. For more information, visit [Unity CCD command-line interface](https://docs.unity.com/ccd/en/manual/UnityCCDCLI.html).\n- Unity Cloud Build contains an integration with CCD. For more information, visit [Unity Cloud Build documentation](https://docs.unity.com/devops/manual/addressables-in-build-automation.html).", "license": { "name": "Unity Legal", "url": "https://unity.com/legal" }, "title": "Content Delivery Management API", "version": "1.7.42" }, "servers": [ { "description": "Production", "url": "https://services.api.unity.com/ccd/management/v1" } ], "paths": { "/organizations/{orgid}": { "parameters": [ { "description": "Path parameter orgid", "in": "path", "name": "orgid", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Gets organization details.", "operationId": "GetOrg", "parameters": [ { "description": "Organization ID", "in": "path", "name": "orgid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.org" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Gets organization details.", "tags": [ "Orgs" ] }, "put": { "description": "Updates the bucket details by ID.", "operationId": "SaveTosAccepted", "parameters": [ { "description": "Organization ID", "in": "path", "name": "orgid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.orgTosUpdate" } } }, "description": "Org", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.org" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Update tos accepted on a organization", "tags": [ "Orgs" ] } }, "/organizations/{orgid}/usage": { "parameters": [ { "description": "Path parameter orgid", "in": "path", "name": "orgid", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Gets an organization usage details.", "operationId": "GetOrgUsage", "parameters": [ { "description": "Organization ID", "in": "path", "name": "orgid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.orgusage" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Gets organization Usage Details.", "tags": [ "Orgs" ] } }, "/projects/{projectid}/buckets": { "parameters": [ { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "deprecated": true, "description": "Gets all buckets for a project.", "operationId": "ListBucketsByProject", "parameters": [ { "description": "Current Page", "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "description": "Items Per Page", "in": "query", "name": "per_page", "schema": { "default": 10, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "resource name", "in": "query", "name": "name", "schema": { "type": "string" } }, { "description": "bucket description", "in": "query", "name": "description", "schema": { "type": "string" } }, { "description": "Sort By", "in": "query", "name": "sort_by", "schema": { "enum": [ "name", "created" ], "type": "string" } }, { "description": "Sort Order", "in": "query", "name": "sort_order", "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ccd.bucket" }, "type": "array" } } }, "description": "OK", "headers": { "Content-Range": { "description": "paging in the format - items [start]-[end]/[total]", "schema": { "type": "string" } } } }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get buckets for project", "tags": [ "Buckets" ] }, "post": { "deprecated": true, "description": "Create a bucket for a project.", "operationId": "CreateBucketByProject", "parameters": [ { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.bucketCreate" } } }, "description": "Bucket", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.bucket" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Create bucket", "tags": [ "Buckets" ] } }, "/projects/{projectid}/buckets/{bucketid}": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "deprecated": true, "description": "Gets the bucket details by ID.", "operationId": "GetBucket", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.bucket" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get a bucket", "tags": [ "Buckets" ] }, "put": { "deprecated": true, "description": "Updates the bucket details by ID.", "operationId": "UpdateBucket", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.bucketUpdate" } } }, "description": "Bucket", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.bucket" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Update a bucket", "tags": [ "Buckets" ] }, "delete": { "deprecated": true, "description": "Removes a bucket by ID. All files that are no longer referred to by another bucket in a project are removed.", "operationId": "DeleteBucket", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Delete a bucket", "tags": [ "Buckets" ] } }, "/projects/{projectid}/buckets/{bucketid}/accesstokens": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "deprecated": true, "description": "List bucket access tokens.", "operationId": "ListBucketAccessTokens", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Current Page", "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "description": "Items Per Page", "in": "query", "name": "per_page", "schema": { "default": 10, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ccd.bucketaccesstoken" }, "type": "array" } } }, "description": "OK", "headers": { "Content-Range": { "description": "paging in the format - items [start]-[end]/[total]", "schema": { "type": "string" } } } }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "List bucket access tokens", "tags": [ "BucketAccessTokens" ] }, "post": { "deprecated": true, "description": "Create a bucket access token. By default, bucket access tokens grant access to all content in the bucket including all releases. To restrict access to a single release, specify a 'releaseid' in the post body.", "operationId": "CreateBucketAccessToken", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.bucketaccesstokenCreate" } } }, "description": "BucketAccessToken", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.bucketaccesstoken" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Create bucket access token", "tags": [ "BucketAccessTokens" ] } }, "/projects/{projectid}/buckets/{bucketid}/accesstokens/{tokenid}": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter tokenid", "in": "path", "name": "tokenid", "required": true, "schema": { "type": "string" } } ], "get": { "deprecated": true, "description": "Get bucket access token info.", "operationId": "GetBucketAccessToken", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Token ID", "in": "path", "name": "tokenid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.bucketaccesstoken" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "get bucket access token", "tags": [ "BucketAccessTokens" ] }, "put": { "deprecated": true, "description": "Update bucket access token info.", "operationId": "UpdateBucketAccessTokenInfo", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Token ID", "in": "path", "name": "tokenid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.bucketaccesstokenUpdate" } } }, "description": "BucketAccessToken", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.bucketaccesstoken" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Update bucket access token info", "tags": [ "BucketAccessTokens" ] }, "delete": { "deprecated": true, "description": "Delete a bucket's access token by key.", "operationId": "DeleteBucketAccessToken", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Token ID", "in": "path", "name": "tokenid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Delete a bucket access token", "tags": [ "BucketAccessTokens" ] } }, "/projects/{projectid}/buckets/{bucketid}/badges": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "deprecated": true, "description": "Gets all badges for a bucket.", "operationId": "ListBadges", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Current Page", "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "description": "Items Per Page", "in": "query", "name": "per_page", "schema": { "default": 10, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "resource name", "in": "query", "name": "name", "schema": { "type": "string" } }, { "description": "release number", "in": "query", "name": "releasenum", "schema": { "type": "string" } }, { "description": "Sort By", "in": "query", "name": "sort_by", "schema": { "enum": [ "name", "releasenum", "created" ], "type": "string" } }, { "description": "Sort Order", "in": "query", "name": "sort_order", "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ccd.badge" }, "type": "array" } } }, "description": "OK", "headers": { "Content-Range": { "description": "paging in the format - items [start]-[end]/[total]", "schema": { "type": "string" } } } }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get badges", "tags": [ "Badges" ] }, "put": { "deprecated": true, "description": "Assigns a badge to a release.", "operationId": "UpdateBadge", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.badgeAssign" } } }, "description": "Badge", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.badge" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Assign a badge", "tags": [ "Badges" ] } }, "/projects/{projectid}/buckets/{bucketid}/badges/{badgename}": { "parameters": [ { "description": "Path parameter badgename", "in": "path", "name": "badgename", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "deprecated": true, "description": "Gets a badge by name.", "operationId": "GetBadge", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Badge Name", "in": "path", "name": "badgename", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.badge" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get badge", "tags": [ "Badges" ] }, "delete": { "deprecated": true, "description": "Removes a badge by name.", "operationId": "DeleteBadge", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Badge Name", "in": "path", "name": "badgename", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Delete a badge", "tags": [ "Badges" ] } }, "/projects/{projectid}/buckets/{bucketid}/batch/delete/entries": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "post": { "deprecated": true, "description": "Removes up to 200 entries from a given bucket. When DELETE is called on an entry we just mark it as deleted but all previous versions of the file still exist. No file content is removed.", "operationId": "DeleteEntryBatch", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ccd.entryDeleteBatch" }, "maxItems": 200, "minItems": 1, "type": "array" } } }, "description": "Array of Entries", "required": true }, "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Batch delete entries", "tags": [ "Entries" ] } }, "/projects/{projectid}/buckets/{bucketid}/batch/entries": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "post": { "deprecated": true, "description": "Creates or update up to 200 entries in a given bucket via Signed URLs; Will update the entry if the path already exists. Content Hash and Content Size are not mandatory.", "operationId": "CreateOrUpdateEntryBatch", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ccd.entryCreateBatch" }, "maxItems": 200, "minItems": 1, "type": "array" } } }, "description": "Array of Entries", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ccd.entry" }, "type": "array" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Batch Create or Update Entries", "tags": [ "Entries" ] } }, "/projects/{projectid}/buckets/{bucketid}/diff/releases": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "deprecated": true, "description": "Gets the change count between two releases.", "operationId": "GetReleaseDiff", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "From Release ID, specify 'latest' to use the most recent release. Either fromreleaseid or fromreleasenum can be specified, but not both.\n", "in": "query", "name": "fromreleaseid", "schema": { "type": "string" } }, { "description": "From Release Number. To query against an empty bucket you may set fromreleasenum to zero. Either fromreleaseid or fromreleasenum can be specified, but not both.\n", "in": "query", "name": "fromreleasenum", "schema": { "format": "int64", "type": "integer" } }, { "description": "To Release ID, when not specified the most recent state of the bucket will be used. Either toreleaseid or toreleasenum can be specified, but not both.\n", "in": "query", "name": "toreleaseid", "schema": { "type": "string" } }, { "description": "To Release ID, when not specified the most recent state of the bucket will be used. Either toreleaseid or toreleasenum can be specified, but not both.\n", "in": "query", "name": "toreleasenum", "schema": { "format": "int64", "type": "integer" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.changecount" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get counts of changes between releases", "tags": [ "Releases" ] } }, "/projects/{projectid}/buckets/{bucketid}/diff/releases/entries": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "deprecated": true, "description": "Gets the list of changed entries between two releases.", "operationId": "GetReleaseDiffEntries", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "From Release ID, specify 'latest' to use the most recent release. Either fromreleaseid or fromreleasenum can be specified, but not both.\n", "in": "query", "name": "fromreleaseid", "schema": { "type": "string" } }, { "description": "From Release Number. To query against an empty bucket you may set fromreleasenum to zero. Either fromreleaseid or fromreleasenum can be specified, but not both.\n", "in": "query", "name": "fromreleasenum", "schema": { "format": "int64", "type": "integer" } }, { "description": "To Release ID, when not specified the most recent state of the bucket will be used. Either toreleaseid or toreleasenum can be specified, but not both.\n", "in": "query", "name": "toreleaseid", "schema": { "type": "string" } }, { "description": "To Release ID, when not specified the most recent state of the bucket will be used. Either toreleaseid or toreleasenum can be specified, but not both.\n", "in": "query", "name": "toreleasenum", "schema": { "format": "int64", "type": "integer" } }, { "description": "Current Page", "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "description": "Items Per Page", "in": "query", "name": "per_page", "schema": { "default": 10, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Path", "in": "query", "name": "path", "schema": { "type": "string" } }, { "description": "Include change states, one or more can be specified. The default is all states.", "explode": false, "in": "query", "name": "include_states", "schema": { "items": { "enum": [ "Unchanged", "Add", "Delete", "Update" ], "type": "string" }, "type": "array" }, "style": "form" }, { "description": "content type", "in": "query", "name": "content_type", "schema": { "type": "string" } }, { "description": "Label", "in": "query", "name": "label", "schema": { "type": "string" } }, { "description": "is content upload completed or not", "in": "query", "name": "complete", "schema": { "type": "boolean" } }, { "description": "Sort By", "in": "query", "name": "sort_by", "schema": { "enum": [ "path", "content_size", "content_type", "last_modified" ], "type": "string" } }, { "description": "Sort Order", "in": "query", "name": "sort_order", "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ccd.releaseentry" }, "type": "array" } } }, "description": "OK", "headers": { "Content-Range": { "description": "paging in the format - items [start]-[end]/[total]", "schema": { "type": "string" } } } }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get changed entries between releases", "tags": [ "Releases" ] } }, "/projects/{projectid}/buckets/{bucketid}/diff/unreleased": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "deprecated": true, "description": "Gets change count since the last release.", "operationId": "GetDiff", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.changecount" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get counts of changes since last release", "tags": [ "Buckets" ] } }, "/projects/{projectid}/buckets/{bucketid}/diff/unreleased/entries": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "deprecated": true, "description": "Gets changed entries since the last release.", "operationId": "GetDiffEntries", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Current Page", "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "description": "Items Per Page", "in": "query", "name": "per_page", "schema": { "default": 10, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Path", "in": "query", "name": "path", "schema": { "type": "string" } }, { "description": "Include change states, one or more can be specified. The default is all states.", "explode": false, "in": "query", "name": "include_states", "schema": { "items": { "enum": [ "Unchanged", "Add", "Delete", "Update" ], "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Label", "in": "query", "name": "label", "schema": { "type": "string" } }, { "description": "content type", "in": "query", "name": "content_type", "schema": { "type": "string" } }, { "description": "is content upload completed or not", "in": "query", "name": "complete", "schema": { "type": "boolean" } }, { "description": "Sort By", "in": "query", "name": "sort_by", "schema": { "enum": [ "path", "content_size", "content_type", "last_modified" ], "type": "string" } }, { "description": "Sort Order", "in": "query", "name": "sort_order", "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ccd.releaseentry" }, "type": "array" } } }, "description": "OK", "headers": { "Content-Range": { "description": "paging in the format - items [start]-[end]/[total]", "schema": { "type": "string" } } } }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get changed entries since last releases", "tags": [ "Buckets" ] } }, "/projects/{projectid}/buckets/{bucketid}/entries": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "deprecated": true, "description": "Gets all entries for a given bucket. Entries can be searched/queried by path or label. For example, to search by path you can do \"/buckets/{bucketid}/entries/?path=asset.bundle\" To search by label you can do \"/buckets/{bucketid}/entries/?label=android\" To search by path and label both you can do \"/buckets/{bucketid}/entries/?path=asset.bundle&label=android\". In this case the entries will need to match both filters.", "operationId": "GetEntries", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Current Page", "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "description": "returns items listed after the named ID", "in": "query", "name": "starting_after", "schema": { "format": "uuid", "type": "string" } }, { "description": "Items Per Page", "in": "query", "name": "per_page", "schema": { "default": 10, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Path", "in": "query", "name": "path", "schema": { "type": "string" } }, { "description": "Label", "in": "query", "name": "label", "schema": { "type": "string" } }, { "description": "content type", "in": "query", "name": "content_type", "schema": { "type": "string" } }, { "description": "is content upload completed or not", "in": "query", "name": "complete", "schema": { "type": "boolean" } }, { "description": "Sort By", "in": "query", "name": "sort_by", "schema": { "enum": [ "path", "content_size", "content_type", "last_modified" ], "type": "string" } }, { "description": "Sort Order", "in": "query", "name": "sort_order", "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ccd.entry" }, "type": "array" } } }, "description": "OK [The \"current_versionid\" is the versionid for the most recent file entry. The \"complete\" flag represents that the content has been fully uploaded and that the file size and md5sum match to what was specified when the entry was created or updated.]", "headers": { "Content-Range": { "description": "paging in the format - items [start]-[end]/[total]", "schema": { "type": "string" } } } }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get entries for bucket", "tags": [ "Entries" ] }, "post": { "deprecated": true, "description": "Creates a new entry for a given bucket. Content Hash and Content Size are not mandatory when using Signed URLs.", "operationId": "CreateEntry", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.entryCreate" } } }, "description": "Entry", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.entry" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Create entry", "tags": [ "Entries" ] } }, "/projects/{projectid}/buckets/{bucketid}/entries/{entryid}": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter entryid", "in": "path", "name": "entryid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "deprecated": true, "description": "Gets a single entry for a given bucket.", "operationId": "GetEntry", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Entry ID", "in": "path", "name": "entryid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.entry" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get entry", "tags": [ "Entries" ] }, "put": { "deprecated": true, "description": "Updates a single entry for a given bucket.", "operationId": "UpdateEntry", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Entry ID", "in": "path", "name": "entryid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.entryUpdate" } } }, "description": "Entry", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.entry" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Update entry", "tags": [ "Entries" ] }, "delete": { "deprecated": true, "description": "Removes a single entry for a given bucket. When DELETE is called on an entry we just mark it as deleted but all previous versions of the file still exist. No file content is removed.", "operationId": "DeleteEntry", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Entry ID", "in": "path", "name": "entryid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Delete entry", "tags": [ "Entries" ] } }, "/projects/{projectid}/buckets/{bucketid}/entries/{entryid}/content": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter entryid", "in": "path", "name": "entryid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "deprecated": true, "description": "Gets the content for a given entry.", "operationId": "GetContent", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Entry ID", "in": "path", "name": "entryid", "required": true, "schema": { "type": "string" } }, { "description": "Version ID", "in": "query", "name": "versionid", "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "OK", "headers": { "content-disposition": { "description": "Indicate the content disposition and filename, example (attachment; filename=\"model.obj\")", "schema": { "type": "string" } } } }, "206": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "OK" }, "307": { "description": "Temporary Redirect" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get content by entryid", "tags": [ "Content" ] }, "post": { "deprecated": true, "description": "Simply returns the content upload URL in the Location header for TUS (a resumable file upload implementation). This endpoint is not required for most file uploads.", "operationId": "CreateContent", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Entry ID", "in": "path", "name": "entryid", "required": true, "schema": { "type": "string" } }, { "description": "Version ID", "in": "query", "name": "versionid", "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "201": { "description": "File was created, check the Location header." }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Create content upload for TUS", "tags": [ "Content" ] }, "patch": { "deprecated": true, "description": "Uploads or resumes uploading content for an entry. There are two content-types supported for uploading content for an entry. One is \"multipart/form-data\" which is not available through the Internal API and the other is \"application/offset+octet-stream\" which uses the tus protocol. Please refer to https://tus.io/ for more details. Note that the Internal API also has a 100mb limitation. This API is now deprecated. We recommend using signed URLs as it uploads directly to the cloud storage and has no size limitations. Signed URLs are returned by the create and/or update entry endpoints by using the entry parameter signed_url set to \"true\".", "operationId": "UploadContent", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Entry ID", "in": "path", "name": "entryid", "required": true, "schema": { "type": "string" } }, { "description": "Version ID", "in": "query", "name": "versionid", "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/offset+octet-stream": { "schema": { "properties": { "file": { "description": "File content", "format": "binary", "type": "string" } }, "required": [ "file" ], "type": "object" } }, "multipart/form-data": { "schema": { "properties": { "file": { "description": "File content", "format": "binary", "type": "string" } }, "required": [ "file" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "204": { "description": "To verify if the file was successfully uploaded, compare the upload hash and upload link headers and make sure they match to the uploaded content." }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Upload content for entry", "tags": [ "Content" ] }, "head": { "deprecated": true, "description": "Gets the status of uploaded content.", "operationId": "GetContentStatus", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Entry ID", "in": "path", "name": "entryid", "required": true, "schema": { "type": "string" } }, { "description": "Version ID", "in": "query", "name": "versionid", "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Upload-Hash": { "description": "md5sum of expected upload", "schema": { "type": "string" } }, "Upload-Length": { "description": "total expected size of upload", "schema": { "format": "int64", "type": "integer" } }, "Upload-Offset": { "description": "actual amount uploaded", "schema": { "format": "int64", "type": "integer" } } } }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get content status by entryid", "tags": [ "Content" ] } }, "/projects/{projectid}/buckets/{bucketid}/entries/{entryid}/versions": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter entryid", "in": "path", "name": "entryid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "deprecated": true, "description": "Gets all versions of an entry.", "operationId": "GetEntryVersions", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Entry ID", "in": "path", "name": "entryid", "required": true, "schema": { "type": "string" } }, { "description": "Label", "in": "query", "name": "label", "schema": { "type": "string" } }, { "description": "Current Page", "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "description": "Items Per Page", "in": "query", "name": "per_page", "schema": { "default": 10, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ccd.version" }, "type": "array" } } }, "description": "OK", "headers": { "Content-Range": { "description": "paging in the format - items [start]-[end]/[total]", "schema": { "type": "string" } } } }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get entry versions", "tags": [ "Entries" ] } }, "/projects/{projectid}/buckets/{bucketid}/entries/{entryid}/versions/{versionid}": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter entryid", "in": "path", "name": "entryid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter versionid", "in": "path", "name": "versionid", "required": true, "schema": { "type": "string" } } ], "get": { "deprecated": true, "description": "Gets a specific version of an entry.", "operationId": "GetEntryVersion", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Entry ID", "in": "path", "name": "entryid", "required": true, "schema": { "type": "string" } }, { "description": "Version ID", "in": "path", "name": "versionid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.entry" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get entry version", "tags": [ "Entries" ] } }, "/projects/{projectid}/buckets/{bucketid}/entries/{entryid}/versions/{versionid}/content": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter entryid", "in": "path", "name": "entryid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter versionid", "in": "path", "name": "versionid", "required": true, "schema": { "type": "string" } } ], "get": { "deprecated": true, "description": "Gets the content for a specific version of an entry.", "operationId": "GetContentVersion", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Entry ID", "in": "path", "name": "entryid", "required": true, "schema": { "type": "string" } }, { "description": "Version ID", "in": "path", "name": "versionid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "OK", "headers": { "content-disposition": { "description": "Indicate the content disposition and filename, example (attachment; filename=\"model.obj\")", "schema": { "type": "string" } } } }, "206": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "OK" }, "307": { "description": "Temporary Redirect" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get content for version of entry", "tags": [ "Content" ] }, "head": { "deprecated": true, "description": "Gets the status of uploaded content for a specific version of an entry.", "operationId": "GetContentStatusVersion", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Entry ID", "in": "path", "name": "entryid", "required": true, "schema": { "type": "string" } }, { "description": "Version ID", "in": "path", "name": "versionid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Upload-Hash": { "description": "md5sum of expected upload", "schema": { "type": "string" } }, "Upload-Length": { "description": "total expected size of upload", "schema": { "format": "int64", "type": "integer" } }, "Upload-Offset": { "description": "actual amount uploaded", "schema": { "format": "int64", "type": "integer" } } } }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get content status for version of entry", "tags": [ "Content" ] } }, "/projects/{projectid}/buckets/{bucketid}/entry_by_path": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "deprecated": true, "description": "Gets a single entry by path for a given bucket.", "operationId": "GetEntryByPath", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path", "in": "query", "name": "path", "required": true, "schema": { "type": "string" } }, { "description": "Version ID", "in": "query", "name": "versionid", "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.entry" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get entry by path", "tags": [ "Entries" ] }, "post": { "deprecated": true, "description": "Creates a new entry for a given bucket; can update the entry if the path already exists. Content Hash and Content Size are not mandatory when using Signed URLs.", "operationId": "CreateOrUpdateEntryByPath", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path", "in": "query", "name": "path", "required": true, "schema": { "type": "string" } }, { "description": "Set to 'true' if you want to update the existing entries", "in": "query", "name": "updateIfExists", "schema": { "default": false, "type": "boolean" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.entryCreateByPath" } } }, "description": "Entry", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.entry" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Create or update entry by path", "tags": [ "Entries" ] }, "put": { "deprecated": true, "description": "Update the entry by path", "operationId": "UpdateEntryByPath", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path", "in": "query", "name": "path", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.entryUpdate" } } }, "description": "Entry", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.entry" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Update entry by path", "tags": [ "Entries" ] } }, "/projects/{projectid}/buckets/{bucketid}/permissions": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "deprecated": true, "description": "Gets all permissions for a bucket.", "operationId": "GetAllByBucket", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ccd.permission" }, "type": "array" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get permissions for bucket", "tags": [ "Permissions" ] }, "post": { "deprecated": true, "description": "Create a permission for a bucket.", "operationId": "CreatePermissionByBucket", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.permissionCreate" } } }, "description": "Permission", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.permission" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Create a permission", "tags": [ "Permissions" ] }, "put": { "deprecated": true, "description": "Update a permission for a bucket.", "operationId": "UpdatePermissionByBucket", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.permissionUpdate" } } }, "description": "Permission", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.permission" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Update a permission", "tags": [ "Permissions" ] }, "delete": { "deprecated": true, "description": "delete a permission for a bucket.", "operationId": "DeletePermissionByBucket", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Permission role: user, client.\n", "in": "query", "name": "role", "schema": { "type": "string" } }, { "description": "Permission of resource: allow, deny.\n", "in": "query", "name": "permission", "schema": { "type": "string" } }, { "description": "Permission action: write, read.\n", "in": "query", "name": "action", "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "204": { "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "delete a permission", "tags": [ "Permissions" ] } }, "/projects/{projectid}/buckets/{bucketid}/promote": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "deprecated": true, "description": "Get promotions for a bucket", "operationId": "GetPromotions", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Current Page", "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "description": "Items Per Page", "in": "query", "name": "per_page", "schema": { "default": 10, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Promotion status, one or more can be specified. The default is all statuses.", "explode": false, "in": "query", "name": "promotion_status", "schema": { "items": { "enum": [ "InProgress", "Complete", "Failed" ], "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Filter to get only incoming/only outgoing promotions for a bucket. If nothing is specified, both, incoming and outgoing, promotions are returned", "in": "query", "name": "promotion_filter", "schema": { "enum": [ "incoming", "outgoing" ], "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ccd.promotion" }, "type": "array" } } }, "description": "OK", "headers": { "Content-Range": { "description": "paging in the format - items [start]-[end]/[total]", "schema": { "type": "string" } } } }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get promotions for a bucket", "tags": [ "Buckets" ] }, "post": { "deprecated": true, "description": "Promotes a release from one bucket to another.", "operationId": "PromoteBucket", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.promotebucket" } } }, "description": "PromoteBucketEnv", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.release" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Promote release between buckets", "tags": [ "Buckets" ] } }, "/projects/{projectid}/buckets/{bucketid}/promote/{promotionid}": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter promotionid", "in": "path", "name": "promotionid", "required": true, "schema": { "type": "string" } } ], "get": { "deprecated": true, "description": "Get information about the promotion job started from a bucket", "operationId": "GetPromotion", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Promotion ID", "in": "path", "name": "promotionid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.promotion" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get information about the promotion job", "tags": [ "Buckets" ] } }, "/projects/{projectid}/buckets/{bucketid}/promoteasync": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "post": { "deprecated": true, "description": "Promotes a release asynchronously from one bucket to another.", "operationId": "PromoteBucketAsync", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.promotebucket" } } }, "description": "PromoteBucketAsync", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.promoteBucketResponse" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Promote release asynchronously between buckets", "tags": [ "Buckets" ] } }, "/projects/{projectid}/buckets/{bucketid}/release_by_badge/{badgename}": { "parameters": [ { "description": "Path parameter badgename", "in": "path", "name": "badgename", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "deprecated": true, "description": "Gets a badged release for a given bucket.", "operationId": "GetReleaseByBadge", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Badge Name", "in": "path", "name": "badgename", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.release" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get release by badge", "tags": [ "Releases" ] } }, "/projects/{projectid}/buckets/{bucketid}/release_by_badge/{badgename}/entries": { "parameters": [ { "description": "Path parameter badgename", "in": "path", "name": "badgename", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "deprecated": true, "description": "Gets all entries for a badged release.", "operationId": "GetReleaseEntriesByBadge", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Badge Name", "in": "path", "name": "badgename", "required": true, "schema": { "type": "string" } }, { "description": "Label", "in": "query", "name": "label", "schema": { "type": "string" } }, { "description": "Current Page", "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "description": "Items Per Page", "in": "query", "name": "per_page", "schema": { "default": 10, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ccd.releaseentry" }, "type": "array" } } }, "description": "OK", "headers": { "Content-Range": { "description": "paging in the format - items [start]-[end]/[total]", "schema": { "type": "string" } } } }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get badged release entries", "tags": [ "Releases" ] } }, "/projects/{projectid}/buckets/{bucketid}/releases": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "deprecated": true, "description": "Gets all releases for a given bucket.", "operationId": "GetReleases", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Current Page", "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "description": "Items Per Page", "in": "query", "name": "per_page", "schema": { "default": 10, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "release number", "in": "query", "name": "releasenum", "schema": { "type": "string" } }, { "description": "Release notes\n", "in": "query", "name": "notes", "schema": { "type": "string" } }, { "description": "Bucket where release promoted from.\n", "in": "query", "name": "promoted_from_bucket", "schema": { "type": "string" } }, { "description": "Release where release promoted from.\n", "in": "query", "name": "promoted_from_release", "schema": { "type": "string" } }, { "description": "Badge names.\n", "in": "query", "name": "badges", "schema": { "type": "string" } }, { "description": "Sort By", "in": "query", "name": "sort_by", "schema": { "enum": [ "releasenum", "created" ], "type": "string" } }, { "description": "Sort Order", "in": "query", "name": "sort_order", "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ccd.release" }, "type": "array" } } }, "description": "OK", "headers": { "Content-Range": { "description": "paging in the format - items [start]-[end]/[total]", "schema": { "type": "string" } } } }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get releases for bucket", "tags": [ "Releases" ] }, "post": { "deprecated": true, "description": "Creates a new release for a given bucket. If you don't specify the snapshot or entries fields all entries currently in the bucket will be added to the release. Otherwise you can use the snapshot field to create a release with all entries prior to a given date, or the entries field to provide a list of entryids and versionids to add.", "operationId": "CreateRelease", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.releaseCreate" } } }, "description": "Release", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.release" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Create release", "tags": [ "Releases" ] } }, "/projects/{projectid}/buckets/{bucketid}/releases/{releaseid}": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter releaseid", "in": "path", "name": "releaseid", "required": true, "schema": { "type": "string" } } ], "get": { "deprecated": true, "description": "Gets a single release for a given bucket.", "operationId": "GetRelease", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Release ID", "in": "path", "name": "releaseid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.release" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get release", "tags": [ "Releases" ] }, "put": { "deprecated": true, "description": "Update fields on a single release for a given bucket.", "operationId": "UpdateRelease", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Release ID", "in": "path", "name": "releaseid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.releaseUpdate" } } }, "description": "Release fields to update", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.release" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Update release", "tags": [ "Releases" ] } }, "/projects/{projectid}/buckets/{bucketid}/releases/{releaseid}/entries": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter releaseid", "in": "path", "name": "releaseid", "required": true, "schema": { "type": "string" } } ], "get": { "deprecated": true, "description": "Gets all entries for a single release.", "operationId": "GetReleaseEntries", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Release ID", "in": "path", "name": "releaseid", "required": true, "schema": { "type": "string" } }, { "description": "Label", "in": "query", "name": "label", "schema": { "type": "string" } }, { "description": "Current Page", "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "description": "Items Per Page", "in": "query", "name": "per_page", "schema": { "default": 10, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ccd.releaseentry" }, "type": "array" } } }, "description": "OK", "headers": { "Content-Range": { "description": "paging in the format - items [start]-[end]/[total]", "schema": { "type": "string" } } } }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get release entries", "tags": [ "Releases" ] } }, "/projects/{projectid}/buckets/{bucketid}/releases/{releaseid}/stats": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter releaseid", "in": "path", "name": "releaseid", "required": true, "schema": { "type": "string" } } ], "get": { "deprecated": true, "description": "Get stats for a release for a given metric and time interval.", "operationId": "GetStats", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Release ID", "in": "path", "name": "releaseid", "required": true, "schema": { "type": "string" } }, { "description": "Select the metric for which you want the stats.", "in": "query", "name": "metric", "required": true, "schema": { "enum": [ "downloads", "errors" ], "type": "string" } }, { "description": "Select the time interval for which you want the stats.\nday indicates last 24 hrs\nweek indicates last 7 days\nmonth indicates last 30 days\n", "in": "query", "name": "interval", "required": true, "schema": { "enum": [ "day", "week", "month" ], "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.metricQuantity" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get stats for a release", "tags": [ "Releases" ] } }, "/projects/{projectid}/buckets/{bucketid}/releases/{releaseid}/stats/details/errors": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter releaseid", "in": "path", "name": "releaseid", "required": true, "schema": { "type": "string" } } ], "get": { "deprecated": true, "description": "Get the given number of latest errors in a release with their status code, timestamp and URL in a csv format", "operationId": "GetErrorDetails", "parameters": [ { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Release ID", "in": "path", "name": "releaseid", "required": true, "schema": { "type": "string" } }, { "description": "Items Per Page", "in": "query", "name": "per_page", "schema": { "default": 10, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Select the time interval for which you want the stats.\nday indicates last 24 hrs\nweek indicates last 7 days\nmonth indicates last 30 days\n", "in": "query", "name": "interval", "required": true, "schema": { "enum": [ "day", "week", "month" ], "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "text/csv": { "schema": { "example": "Response_Status_Code,Submit_Time,URL\n404,2021-07-27 04:29:59.830 UTC,https://example.com/api/v1/endpoint\n403,2021-07-26 02:13:59.830 UTC,https://example.com/api/v1/endpoint", "type": "string" } } }, "description": "OK", "headers": { "Access-Control-Allow-Origin": { "description": "The literal value \"*\" can be specified, as a wildcard; the value tells browsers to allow requesting code from any origin to access the resource.", "schema": { "type": "string" } }, "Content-Type": { "description": "Indicates the content type of the returned content", "schema": { "type": "string" } } } }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get detail error information", "tags": [ "Releases" ] } }, "/projects/{projectid}/environments": { "parameters": [ { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Gets all environments for a project.", "operationId": "ListEnvironmentsByProject", "parameters": [ { "description": "Current Page", "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "description": "returns items listed after the named ID", "in": "query", "name": "starting_after", "schema": { "format": "uuid", "type": "string" } }, { "description": "Items Per Page", "in": "query", "name": "per_page", "schema": { "default": 10, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ccd.environment" }, "type": "array" } } }, "description": "OK", "headers": { "Content-Range": { "description": "paging in the format - items [start]-[end]/[total]", "schema": { "type": "string" } } } }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get environments for project", "tags": [ "Environments" ] } }, "/projects/{projectid}/environments/{environmentid}": { "parameters": [ { "description": "Path parameter environmentid", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Gets environment details.", "operationId": "GetEnvironment", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.environment" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Gets environment details.", "tags": [ "Environments" ] } }, "/projects/{projectid}/environments/{environmentid}/buckets": { "parameters": [ { "description": "Path parameter environmentid", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Gets all buckets for a project.", "operationId": "ListBucketsByProjectEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Current Page", "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "description": "Items Per Page", "in": "query", "name": "per_page", "schema": { "default": 10, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "resource name", "in": "query", "name": "name", "schema": { "type": "string" } }, { "description": "bucket description", "in": "query", "name": "description", "schema": { "type": "string" } }, { "description": "Sort By", "in": "query", "name": "sort_by", "schema": { "enum": [ "name", "created" ], "type": "string" } }, { "description": "Sort Order", "in": "query", "name": "sort_order", "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ccd.bucket" }, "type": "array" } } }, "description": "OK", "headers": { "Content-Range": { "description": "paging in the format - items [start]-[end]/[total]", "schema": { "type": "string" } } } }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get buckets for project", "tags": [ "Buckets" ] }, "post": { "description": "Create a bucket for a project.", "operationId": "CreateBucketByProjectEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.bucketCreate" } } }, "description": "Bucket", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.bucket" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Create bucket", "tags": [ "Buckets" ] } }, "/projects/{projectid}/environments/{environmentid}/buckets/{bucketid}": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter environmentid", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Gets the bucket details by ID.", "operationId": "GetBucketEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.bucket" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get a bucket", "tags": [ "Buckets" ] }, "put": { "description": "Updates the bucket details by ID.", "operationId": "UpdateBucketEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.bucketUpdate" } } }, "description": "Bucket", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.bucket" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Update a bucket", "tags": [ "Buckets" ] }, "delete": { "description": "Removes a bucket by ID. All files that are no longer referred to by another bucket in a project are removed.", "operationId": "DeleteBucketEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Delete a bucket", "tags": [ "Buckets" ] } }, "/projects/{projectid}/environments/{environmentid}/buckets/{bucketid}/accesstokens": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter environmentid", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "description": "List bucket access tokens.", "operationId": "ListBucketAccessTokensEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Current Page", "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "description": "Items Per Page", "in": "query", "name": "per_page", "schema": { "default": 10, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ccd.bucketaccesstoken" }, "type": "array" } } }, "description": "OK", "headers": { "Content-Range": { "description": "paging in the format - items [start]-[end]/[total]", "schema": { "type": "string" } } } }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "List bucket access tokens", "tags": [ "BucketAccessTokens" ] }, "post": { "description": "Create a bucket access token. By default, bucket access tokens grant access to all content in the bucket including all releases. To restrict access to a single release, specify a 'releaseid' in the post body.", "operationId": "CreateBucketAccessTokenEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.bucketaccesstokenCreate" } } }, "description": "BucketAccessToken", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.bucketaccesstoken" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Create bucket access token", "tags": [ "BucketAccessTokens" ] } }, "/projects/{projectid}/environments/{environmentid}/buckets/{bucketid}/accesstokens/{tokenid}": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter environmentid", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter tokenid", "in": "path", "name": "tokenid", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get bucket access token info.", "operationId": "GetBucketAccessTokenEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Token ID", "in": "path", "name": "tokenid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.bucketaccesstoken" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "get bucket access token", "tags": [ "BucketAccessTokens" ] }, "put": { "description": "Update bucket access token info.", "operationId": "UpdateBucketAccessTokenInfoEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Token ID", "in": "path", "name": "tokenid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.bucketaccesstokenUpdate" } } }, "description": "BucketAccessToken", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.bucketaccesstoken" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Update bucket access token info", "tags": [ "BucketAccessTokens" ] }, "delete": { "description": "Delete a bucket's access token by key.", "operationId": "DeleteBucketAccessTokenEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Token ID", "in": "path", "name": "tokenid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Delete a bucket access token", "tags": [ "BucketAccessTokens" ] } }, "/projects/{projectid}/environments/{environmentid}/buckets/{bucketid}/badges": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter environmentid", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Gets all badges for a bucket.", "operationId": "ListBadgesEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Current Page", "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "description": "Items Per Page", "in": "query", "name": "per_page", "schema": { "default": 10, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "resource name", "in": "query", "name": "name", "schema": { "type": "string" } }, { "description": "release number", "in": "query", "name": "releasenum", "schema": { "type": "string" } }, { "description": "Sort By", "in": "query", "name": "sort_by", "schema": { "enum": [ "name", "releasenum", "created" ], "type": "string" } }, { "description": "Sort Order", "in": "query", "name": "sort_order", "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ccd.badge" }, "type": "array" } } }, "description": "OK", "headers": { "Content-Range": { "description": "paging in the format - items [start]-[end]/[total]", "schema": { "type": "string" } } } }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get badges", "tags": [ "Badges" ] }, "put": { "description": "Assigns a badge to a release.", "operationId": "UpdateBadgeEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.badgeAssign" } } }, "description": "Badge", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.badge" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Assign a badge", "tags": [ "Badges" ] } }, "/projects/{projectid}/environments/{environmentid}/buckets/{bucketid}/badges/{badgename}": { "parameters": [ { "description": "Path parameter badgename", "in": "path", "name": "badgename", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter environmentid", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Gets a badge by name.", "operationId": "GetBadgeEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Badge Name", "in": "path", "name": "badgename", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.badge" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get badge", "tags": [ "Badges" ] }, "delete": { "description": "Removes a badge by name.", "operationId": "DeleteBadgeEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Badge Name", "in": "path", "name": "badgename", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Delete a badge", "tags": [ "Badges" ] } }, "/projects/{projectid}/environments/{environmentid}/buckets/{bucketid}/batch/delete/entries": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter environmentid", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "post": { "description": "Removes up to 200 entries from a given bucket. When DELETE is called on an entry we just mark it as deleted but all previous versions of the file still exist. No file content is removed.", "operationId": "DeleteEntryBatchEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ccd.entryDeleteBatch" }, "maxItems": 200, "minItems": 1, "type": "array" } } }, "description": "Array of Entries", "required": true }, "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Batch delete entries", "tags": [ "Entries" ] } }, "/projects/{projectid}/environments/{environmentid}/buckets/{bucketid}/batch/entries": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter environmentid", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "post": { "description": "Creates or update up to 200 entries in a given bucket via Signed URLs; Will update the entry if the path already exists. Content Hash and Content Size are not mandatory.", "operationId": "CreateOrUpdateEntryBatchEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ccd.entryCreateBatch" }, "maxItems": 200, "minItems": 1, "type": "array" } } }, "description": "Array of Entries", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ccd.entry" }, "type": "array" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Batch Create or Update Entries", "tags": [ "Entries" ] } }, "/projects/{projectid}/environments/{environmentid}/buckets/{bucketid}/diff/releases": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter environmentid", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Gets the change count between two releases.", "operationId": "GetReleaseDiffEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "From Release ID, specify 'latest' to use the most recent release. Either fromreleaseid or fromreleasenum can be specified, but not both.\n", "in": "query", "name": "fromreleaseid", "schema": { "type": "string" } }, { "description": "From Release Number. To query against an empty bucket you may set fromreleasenum to zero. Either fromreleaseid or fromreleasenum can be specified, but not both.\n", "in": "query", "name": "fromreleasenum", "schema": { "format": "int64", "type": "integer" } }, { "description": "To Release ID, when not specified the most recent state of the bucket will be used. Either toreleaseid or toreleasenum can be specified, but not both.\n", "in": "query", "name": "toreleaseid", "schema": { "type": "string" } }, { "description": "To Release ID, when not specified the most recent state of the bucket will be used. Either toreleaseid or toreleasenum can be specified, but not both.\n", "in": "query", "name": "toreleasenum", "schema": { "format": "int64", "type": "integer" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.changecount" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get counts of changes between releases", "tags": [ "Releases" ] } }, "/projects/{projectid}/environments/{environmentid}/buckets/{bucketid}/diff/releases/entries": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter environmentid", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Gets the list of changed entries between two releases.", "operationId": "GetReleaseDiffEntriesEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "From Release ID, specify 'latest' to use the most recent release. Either fromreleaseid or fromreleasenum can be specified, but not both.\n", "in": "query", "name": "fromreleaseid", "schema": { "type": "string" } }, { "description": "From Release Number. To query against an empty bucket you may set fromreleasenum to zero. Either fromreleaseid or fromreleasenum can be specified, but not both.\n", "in": "query", "name": "fromreleasenum", "schema": { "format": "int64", "type": "integer" } }, { "description": "To Release ID, when not specified the most recent state of the bucket will be used. Either toreleaseid or toreleasenum can be specified, but not both.\n", "in": "query", "name": "toreleaseid", "schema": { "type": "string" } }, { "description": "To Release ID, when not specified the most recent state of the bucket will be used. Either toreleaseid or toreleasenum can be specified, but not both.\n", "in": "query", "name": "toreleasenum", "schema": { "format": "int64", "type": "integer" } }, { "description": "Current Page", "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "description": "Items Per Page", "in": "query", "name": "per_page", "schema": { "default": 10, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Path", "in": "query", "name": "path", "schema": { "type": "string" } }, { "description": "Include change states, one or more can be specified. The default is all states.", "explode": false, "in": "query", "name": "include_states", "schema": { "items": { "enum": [ "Unchanged", "Add", "Delete", "Update" ], "type": "string" }, "type": "array" }, "style": "form" }, { "description": "content type", "in": "query", "name": "content_type", "schema": { "type": "string" } }, { "description": "Label", "in": "query", "name": "label", "schema": { "type": "string" } }, { "description": "is content upload completed or not", "in": "query", "name": "complete", "schema": { "type": "boolean" } }, { "description": "Sort By", "in": "query", "name": "sort_by", "schema": { "enum": [ "path", "content_size", "content_type", "last_modified" ], "type": "string" } }, { "description": "Sort Order", "in": "query", "name": "sort_order", "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ccd.releaseentry" }, "type": "array" } } }, "description": "OK", "headers": { "Content-Range": { "description": "paging in the format - items [start]-[end]/[total]", "schema": { "type": "string" } } } }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get changed entries between releases", "tags": [ "Releases" ] } }, "/projects/{projectid}/environments/{environmentid}/buckets/{bucketid}/diff/unreleased": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter environmentid", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Gets change count since the last release.", "operationId": "GetDiffEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.changecount" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get counts of changes since last release", "tags": [ "Buckets" ] } }, "/projects/{projectid}/environments/{environmentid}/buckets/{bucketid}/diff/unreleased/entries": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter environmentid", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Gets changed entries since the last release.", "operationId": "GetDiffEntriesEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Current Page", "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "description": "Items Per Page", "in": "query", "name": "per_page", "schema": { "default": 10, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Path", "in": "query", "name": "path", "schema": { "type": "string" } }, { "description": "Include change states, one or more can be specified. The default is all states.", "explode": false, "in": "query", "name": "include_states", "schema": { "items": { "enum": [ "Unchanged", "Add", "Delete", "Update" ], "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Label", "in": "query", "name": "label", "schema": { "type": "string" } }, { "description": "content type", "in": "query", "name": "content_type", "schema": { "type": "string" } }, { "description": "is content upload completed or not", "in": "query", "name": "complete", "schema": { "type": "boolean" } }, { "description": "Sort By", "in": "query", "name": "sort_by", "schema": { "enum": [ "path", "content_size", "content_type", "last_modified" ], "type": "string" } }, { "description": "Sort Order", "in": "query", "name": "sort_order", "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ccd.releaseentry" }, "type": "array" } } }, "description": "OK", "headers": { "Content-Range": { "description": "paging in the format - items [start]-[end]/[total]", "schema": { "type": "string" } } } }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get changed entries since last releases", "tags": [ "Buckets" ] } }, "/projects/{projectid}/environments/{environmentid}/buckets/{bucketid}/entries": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter environmentid", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Gets all entries for a given bucket. Entries can be searched/queried by path or label. For example, to search by path you can do \"/buckets/{bucketid}/entries/?path=asset.bundle\" To search by label you can do \"/buckets/{bucketid}/entries/?label=android\" To search by path and label both you can do \"/buckets/{bucketid}/entries/?path=asset.bundle&label=android\". In this case the entries will need to match both filters.", "operationId": "GetEntriesEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Current Page", "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "description": "returns items listed after the named ID", "in": "query", "name": "starting_after", "schema": { "format": "uuid", "type": "string" } }, { "description": "Items Per Page", "in": "query", "name": "per_page", "schema": { "default": 10, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Path", "in": "query", "name": "path", "schema": { "type": "string" } }, { "description": "Label", "in": "query", "name": "label", "schema": { "type": "string" } }, { "description": "content type", "in": "query", "name": "content_type", "schema": { "type": "string" } }, { "description": "is content upload completed or not", "in": "query", "name": "complete", "schema": { "type": "boolean" } }, { "description": "Sort By", "in": "query", "name": "sort_by", "schema": { "enum": [ "path", "content_size", "content_type", "last_modified" ], "type": "string" } }, { "description": "Sort Order", "in": "query", "name": "sort_order", "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ccd.entry" }, "type": "array" } } }, "description": "OK [The \"current_versionid\" is the versionid for the most recent file entry. The \"complete\" flag represents that the content has been fully uploaded and that the file size and md5sum match to what was specified when the entry was created or updated.]", "headers": { "Content-Range": { "description": "paging in the format - items [start]-[end]/[total]", "schema": { "type": "string" } } } }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get entries for bucket", "tags": [ "Entries" ] }, "post": { "description": "Creates a new entry for a given bucket. Content Hash and Content Size are not mandatory when using Signed URLs.", "operationId": "CreateEntryEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.entryCreate" } } }, "description": "Entry", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.entry" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Create entry", "tags": [ "Entries" ] } }, "/projects/{projectid}/environments/{environmentid}/buckets/{bucketid}/entries/{entryid}": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter entryid", "in": "path", "name": "entryid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter environmentid", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Gets a single entry for a given bucket.", "operationId": "GetEntryEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Entry ID", "in": "path", "name": "entryid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.entry" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get entry", "tags": [ "Entries" ] }, "put": { "description": "Updates a single entry for a given bucket.", "operationId": "UpdateEntryEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Entry ID", "in": "path", "name": "entryid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.entryUpdate" } } }, "description": "Entry", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.entry" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Update entry", "tags": [ "Entries" ] }, "delete": { "description": "Removes a single entry for a given bucket. When DELETE is called on an entry we just mark it as deleted but all previous versions of the file still exist. No file content is removed.", "operationId": "DeleteEntryEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Entry ID", "in": "path", "name": "entryid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Delete entry", "tags": [ "Entries" ] } }, "/projects/{projectid}/environments/{environmentid}/buckets/{bucketid}/entries/{entryid}/content": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter entryid", "in": "path", "name": "entryid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter environmentid", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Gets the content for a given entry.", "operationId": "GetContentEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Entry ID", "in": "path", "name": "entryid", "required": true, "schema": { "type": "string" } }, { "description": "Version ID", "in": "query", "name": "versionid", "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "OK", "headers": { "content-disposition": { "description": "Indicate the content disposition and filename, example (attachment; filename=\"model.obj\")", "schema": { "type": "string" } } } }, "206": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "OK" }, "307": { "description": "Temporary Redirect" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get content by entryid", "tags": [ "Content" ] }, "post": { "description": "Simply returns the content upload URL in the Location header for TUS implementation. This endpoint is not required for most file uploads.", "operationId": "CreateContentEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Entry ID", "in": "path", "name": "entryid", "required": true, "schema": { "type": "string" } }, { "description": "Version ID", "in": "query", "name": "versionid", "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "201": { "description": "File was created, check the Location header." }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Create content upload for TUS", "tags": [ "Content" ] }, "patch": { "deprecated": true, "description": "Uploads or resumes uploading content for an entry. There are two content-types supported for uploading content for an entry. One is \"multipart/form-data\" which is not available through the Internal API and the other is \"application/offset+octet-stream\" which uses the tus protocol. Please refer to https://tus.io/ for more details. Note that the Internal API also has a 100mb limitation. This API is now deprecated. We recommend using signed URLs as it uploads directly to the cloud storage and has no size limitations. Signed URLs are returned by the create and/or update entry endpoints by using the entry parameter signed_url set to \"true\".", "operationId": "UploadContentEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Entry ID", "in": "path", "name": "entryid", "required": true, "schema": { "type": "string" } }, { "description": "Version ID", "in": "query", "name": "versionid", "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/offset+octet-stream": { "schema": { "properties": { "file": { "description": "File content", "format": "binary", "type": "string" } }, "required": [ "file" ], "type": "object" } }, "multipart/form-data": { "schema": { "properties": { "file": { "description": "File content", "format": "binary", "type": "string" } }, "required": [ "file" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "204": { "description": "To verify if the file was successfully uploaded, compare the upload hash and upload link headers and make sure they match to the uploaded content." }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Upload content for entry", "tags": [ "Content" ] }, "head": { "description": "Gets the status of uploaded content.", "operationId": "GetContentStatusEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Entry ID", "in": "path", "name": "entryid", "required": true, "schema": { "type": "string" } }, { "description": "Version ID", "in": "query", "name": "versionid", "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Upload-Hash": { "description": "md5sum of expected upload", "schema": { "type": "string" } }, "Upload-Length": { "description": "total expected size of upload", "schema": { "format": "int64", "type": "integer" } }, "Upload-Offset": { "description": "actual amount uploaded", "schema": { "format": "int64", "type": "integer" } } } }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get content status by entryid", "tags": [ "Content" ] } }, "/projects/{projectid}/environments/{environmentid}/buckets/{bucketid}/entries/{entryid}/versions": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter entryid", "in": "path", "name": "entryid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter environmentid", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Gets all versions of an entry.", "operationId": "GetEntryVersionsEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Entry ID", "in": "path", "name": "entryid", "required": true, "schema": { "type": "string" } }, { "description": "Label", "in": "query", "name": "label", "schema": { "type": "string" } }, { "description": "Current Page", "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "description": "Items Per Page", "in": "query", "name": "per_page", "schema": { "default": 10, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ccd.version" }, "type": "array" } } }, "description": "OK", "headers": { "Content-Range": { "description": "paging in the format - items [start]-[end]/[total]", "schema": { "type": "string" } } } }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get entry versions", "tags": [ "Entries" ] } }, "/projects/{projectid}/environments/{environmentid}/buckets/{bucketid}/entries/{entryid}/versions/{versionid}": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter entryid", "in": "path", "name": "entryid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter environmentid", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter versionid", "in": "path", "name": "versionid", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Gets a specific version of an entry.", "operationId": "GetEntryVersionEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Entry ID", "in": "path", "name": "entryid", "required": true, "schema": { "type": "string" } }, { "description": "Version ID", "in": "path", "name": "versionid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.entry" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get entry version", "tags": [ "Entries" ] } }, "/projects/{projectid}/environments/{environmentid}/buckets/{bucketid}/entries/{entryid}/versions/{versionid}/content": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter entryid", "in": "path", "name": "entryid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter environmentid", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter versionid", "in": "path", "name": "versionid", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Gets the content for a specific version of an entry.", "operationId": "GetContentVersionEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Entry ID", "in": "path", "name": "entryid", "required": true, "schema": { "type": "string" } }, { "description": "Version ID", "in": "path", "name": "versionid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "OK", "headers": { "content-disposition": { "description": "Indicate the content disposition and filename, example (attachment; filename=\"model.obj\")", "schema": { "type": "string" } } } }, "206": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "OK" }, "307": { "description": "Temporary Redirect" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get content for version of entry", "tags": [ "Content" ] }, "head": { "description": "Gets the status of uploaded content for a specific version of an entry.", "operationId": "GetContentStatusVersionEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Entry ID", "in": "path", "name": "entryid", "required": true, "schema": { "type": "string" } }, { "description": "Version ID", "in": "path", "name": "versionid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Upload-Hash": { "description": "md5sum of expected upload", "schema": { "type": "string" } }, "Upload-Length": { "description": "total expected size of upload", "schema": { "format": "int64", "type": "integer" } }, "Upload-Offset": { "description": "actual amount uploaded", "schema": { "format": "int64", "type": "integer" } } } }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get content status for version of entry", "tags": [ "Content" ] } }, "/projects/{projectid}/environments/{environmentid}/buckets/{bucketid}/entry_by_path": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter environmentid", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Gets a single entry by path for a given bucket.", "operationId": "GetEntryByPathEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path", "in": "query", "name": "path", "required": true, "schema": { "type": "string" } }, { "description": "Version ID", "in": "query", "name": "versionid", "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.entry" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get entry by path", "tags": [ "Entries" ] }, "post": { "description": "Creates a new entry for a given bucket; can update the entry if the path already exists. Content Hash and Content Size are not mandatory when using Signed URLs.", "operationId": "CreateOrUpdateEntryByPathEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path", "in": "query", "name": "path", "required": true, "schema": { "type": "string" } }, { "description": "Set to 'true' if you want to update the existing entries", "in": "query", "name": "updateIfExists", "schema": { "default": false, "type": "boolean" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.entryCreateByPath" } } }, "description": "Entry", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.entry" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Create or update entry by path", "tags": [ "Entries" ] }, "put": { "description": "Update the entry by path", "operationId": "UpdateEntryByPathEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path", "in": "query", "name": "path", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.entryUpdate" } } }, "description": "Entry", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.entry" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Update entry by path", "tags": [ "Entries" ] } }, "/projects/{projectid}/environments/{environmentid}/buckets/{bucketid}/permissions": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter environmentid", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Gets all permissions for a bucket.", "operationId": "GetAllByBucketEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ccd.permission" }, "type": "array" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get permissions for bucket", "tags": [ "Permissions" ] }, "post": { "description": "Create a permission for a bucket.", "operationId": "CreatePermissionByBucketEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.permissionCreate" } } }, "description": "Permission", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.permission" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Create a permission", "tags": [ "Permissions" ] }, "put": { "description": "Update a permission for a bucket.", "operationId": "UpdatePermissionByBucketEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.permissionUpdate" } } }, "description": "Permission", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.permission" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Update a permission", "tags": [ "Permissions" ] }, "delete": { "description": "delete a permission for a bucket.", "operationId": "DeletePermissionByBucketEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Permission role: user, client.\n", "in": "query", "name": "role", "schema": { "type": "string" } }, { "description": "Permission of resource: allow, deny.\n", "in": "query", "name": "permission", "schema": { "type": "string" } }, { "description": "Permission action: write, read.\n", "in": "query", "name": "action", "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "204": { "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "delete a permission", "tags": [ "Permissions" ] } }, "/projects/{projectid}/environments/{environmentid}/buckets/{bucketid}/promote": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter environmentid", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get promotions for a bucket", "operationId": "GetPromotionsEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Current Page", "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "description": "Items Per Page", "in": "query", "name": "per_page", "schema": { "default": 10, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Promotion status, one or more can be specified. The default is all statuses.", "explode": false, "in": "query", "name": "promotion_status", "schema": { "items": { "enum": [ "InProgress", "Complete", "Failed" ], "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Filter to get only incoming/only outgoing promotions for a bucket. If nothing is specified, both, incoming and outgoing, promotions are returned", "in": "query", "name": "promotion_filter", "schema": { "enum": [ "incoming", "outgoing" ], "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ccd.promotion" }, "type": "array" } } }, "description": "OK", "headers": { "Content-Range": { "description": "paging in the format - items [start]-[end]/[total]", "schema": { "type": "string" } } } }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get promotions for a bucket", "tags": [ "Buckets" ] }, "post": { "description": "Promotes a release from one bucket to another.", "operationId": "PromoteBucketEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.promotebucket" } } }, "description": "PromoteBucketEnv", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.release" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Promote release between buckets", "tags": [ "Buckets" ] } }, "/projects/{projectid}/environments/{environmentid}/buckets/{bucketid}/promote/{promotionid}": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter environmentid", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter promotionid", "in": "path", "name": "promotionid", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get information about the promotion job started from a bucket", "operationId": "GetPromotionEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Promotion ID", "in": "path", "name": "promotionid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.promotion" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get information about the promotion job", "tags": [ "Buckets" ] } }, "/projects/{projectid}/environments/{environmentid}/buckets/{bucketid}/promoteasync": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter environmentid", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "post": { "description": "Promotes a release asynchronously from one bucket to another.", "operationId": "PromoteBucketAsyncEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.promotebucket" } } }, "description": "PromoteBucketAsync", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.promoteBucketResponse" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Promote release asynchronously between buckets", "tags": [ "Buckets" ] } }, "/projects/{projectid}/environments/{environmentid}/buckets/{bucketid}/release_by_badge/{badgename}": { "parameters": [ { "description": "Path parameter badgename", "in": "path", "name": "badgename", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter environmentid", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Gets a badged release for a given bucket.", "operationId": "GetReleaseByBadgeEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Badge Name", "in": "path", "name": "badgename", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.release" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get release by badge", "tags": [ "Releases" ] } }, "/projects/{projectid}/environments/{environmentid}/buckets/{bucketid}/release_by_badge/{badgename}/entries": { "parameters": [ { "description": "Path parameter badgename", "in": "path", "name": "badgename", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter environmentid", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Gets all entries for a badged release.", "operationId": "GetReleaseEntriesByBadgeEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Badge Name", "in": "path", "name": "badgename", "required": true, "schema": { "type": "string" } }, { "description": "Label", "in": "query", "name": "label", "schema": { "type": "string" } }, { "description": "Current Page", "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "description": "Items Per Page", "in": "query", "name": "per_page", "schema": { "default": 10, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ccd.releaseentry" }, "type": "array" } } }, "description": "OK", "headers": { "Content-Range": { "description": "paging in the format - items [start]-[end]/[total]", "schema": { "type": "string" } } } }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get badged release entries", "tags": [ "Releases" ] } }, "/projects/{projectid}/environments/{environmentid}/buckets/{bucketid}/releases": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter environmentid", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Gets all releases for a given bucket.", "operationId": "GetReleasesEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Current Page", "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "description": "Items Per Page", "in": "query", "name": "per_page", "schema": { "default": 10, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "release number", "in": "query", "name": "releasenum", "schema": { "type": "string" } }, { "description": "Release notes\n", "in": "query", "name": "notes", "schema": { "type": "string" } }, { "description": "Bucket where release promoted from.\n", "in": "query", "name": "promoted_from_bucket", "schema": { "type": "string" } }, { "description": "Release where release promoted from.\n", "in": "query", "name": "promoted_from_release", "schema": { "type": "string" } }, { "description": "Badge names.\n", "in": "query", "name": "badges", "schema": { "type": "string" } }, { "description": "Sort By", "in": "query", "name": "sort_by", "schema": { "enum": [ "releasenum", "created" ], "type": "string" } }, { "description": "Sort Order", "in": "query", "name": "sort_order", "schema": { "enum": [ "asc", "desc" ], "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ccd.release" }, "type": "array" } } }, "description": "OK", "headers": { "Content-Range": { "description": "paging in the format - items [start]-[end]/[total]", "schema": { "type": "string" } } } }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get releases for bucket", "tags": [ "Releases" ] }, "post": { "description": "Creates a new release for a given bucket. If you don't specify the snapshot or entries fields all entries currently in the bucket will be added to the release. Otherwise you can use the snapshot field to create a release with all entries prior to a given date, or the entries field to provide a list of entryids and versionids to add.", "operationId": "CreateReleaseEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.releaseCreate" } } }, "description": "Release", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.release" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Create release", "tags": [ "Releases" ] } }, "/projects/{projectid}/environments/{environmentid}/buckets/{bucketid}/releases/{releaseid}": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter environmentid", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter releaseid", "in": "path", "name": "releaseid", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Gets a single release for a given bucket.", "operationId": "GetReleaseEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Release ID", "in": "path", "name": "releaseid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.release" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get release", "tags": [ "Releases" ] }, "put": { "description": "Update fields on a single release for a given bucket.", "operationId": "UpdateReleaseEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Release ID", "in": "path", "name": "releaseid", "required": true, "schema": { "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.releaseUpdate" } } }, "description": "Release fields to update", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.release" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Update release", "tags": [ "Releases" ] } }, "/projects/{projectid}/environments/{environmentid}/buckets/{bucketid}/releases/{releaseid}/entries": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter environmentid", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter releaseid", "in": "path", "name": "releaseid", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Gets all entries for a single release.", "operationId": "GetReleaseEntriesEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Release ID", "in": "path", "name": "releaseid", "required": true, "schema": { "type": "string" } }, { "description": "Label", "in": "query", "name": "label", "schema": { "type": "string" } }, { "description": "Current Page", "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "description": "Items Per Page", "in": "query", "name": "per_page", "schema": { "default": 10, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ccd.releaseentry" }, "type": "array" } } }, "description": "OK", "headers": { "Content-Range": { "description": "paging in the format - items [start]-[end]/[total]", "schema": { "type": "string" } } } }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get release entries", "tags": [ "Releases" ] } }, "/projects/{projectid}/environments/{environmentid}/buckets/{bucketid}/releases/{releaseid}/stats": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter environmentid", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter releaseid", "in": "path", "name": "releaseid", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get stats for a release for a given metric and time interval.", "operationId": "GetStatsEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Release ID", "in": "path", "name": "releaseid", "required": true, "schema": { "type": "string" } }, { "description": "Select the metric for which you want the stats.", "in": "query", "name": "metric", "required": true, "schema": { "enum": [ "downloads", "errors" ], "type": "string" } }, { "description": "Select the time interval for which you want the stats.\nday indicates last 24 hrs\nweek indicates last 7 days\nmonth indicates last 30 days\n", "in": "query", "name": "interval", "required": true, "schema": { "enum": [ "day", "week", "month" ], "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ccd.metricQuantity" } } }, "description": "OK" }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get stats for a release", "tags": [ "Releases" ] } }, "/projects/{projectid}/environments/{environmentid}/buckets/{bucketid}/releases/{releaseid}/stats/details/errors": { "parameters": [ { "description": "Path parameter bucketid", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter environmentid", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter projectid", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } }, { "description": "Path parameter releaseid", "in": "path", "name": "releaseid", "required": true, "schema": { "type": "string" } } ], "get": { "description": "Get the given number of latest errors in a release with their status code, timestamp and URL in a csv format", "operationId": "GetErrorDetailsEnv", "parameters": [ { "description": "Environment ID", "in": "path", "name": "environmentid", "required": true, "schema": { "type": "string" } }, { "description": "Bucket ID", "in": "path", "name": "bucketid", "required": true, "schema": { "type": "string" } }, { "description": "Release ID", "in": "path", "name": "releaseid", "required": true, "schema": { "type": "string" } }, { "description": "Items Per Page", "in": "query", "name": "per_page", "schema": { "default": 10, "format": "int32", "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Select the time interval for which you want the stats.\nday indicates last 24 hrs\nweek indicates last 7 days\nmonth indicates last 30 days\n", "in": "query", "name": "interval", "required": true, "schema": { "enum": [ "day", "week", "month" ], "type": "string" } }, { "description": "Project ID", "in": "path", "name": "projectid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "text/csv": { "schema": { "example": "Response_Status_Code,Submit_Time,URL\n404,2021-07-27 04:29:59.830 UTC,https://example.com/api/v1/endpoint\n403,2021-07-26 02:13:59.830 UTC,https://example.com/api/v1/endpoint", "type": "string" } } }, "description": "OK", "headers": { "Access-Control-Allow-Origin": { "description": "The literal value \"*\" can be specified, as a wildcard; the value tells browsers to allow requesting code from any origin to access the resource.", "schema": { "type": "string" } }, "Content-Type": { "description": "Indicates the content type of the returned content", "schema": { "type": "string" } } } }, "400": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "details": { "items": { "example": { "code": "ERROR_CODE_123", "message": "Invalid value", "path": "nested.value" }, "type": "object" }, "type": "array" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 400, "type": "integer" }, "title": { "example": "Bad Request", "type": "string" } }, "type": "object" } } }, "description": "Bad Request" }, "401": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 401, "type": "integer" }, "title": { "example": "Unauthorized", "type": "string" } }, "type": "object" } } }, "description": "Unauthorized" }, "403": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 403, "type": "integer" }, "title": { "example": "Forbidden", "type": "string" } }, "type": "object" } } }, "description": "Forbidden" }, "404": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 404, "type": "integer" }, "title": { "example": "Not Found", "type": "string" } }, "type": "object" } } }, "description": "Not Found" }, "429": { "content": { "application/problem+json": { "schema": { "properties": { "detail": { "example": "Something is wrong", "type": "string" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 429, "type": "integer" }, "title": { "example": "Too Many Requests", "type": "string" } }, "type": "object" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/problem+json": { "schema": { "properties": { "code": { "example": 1, "type": "integer" }, "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 500, "type": "integer" }, "title": { "example": "Internal Server Error", "type": "string" } }, "type": "object" } } }, "description": "Internal Server Error" }, "503": { "content": { "application/problem+json": { "schema": { "properties": { "requestId": { "description": "Request correlation ID", "example": "aad109f8-033f-4a24-8b77-5032eb3a6158", "format": "uuid", "type": "string" }, "status": { "example": 503, "type": "integer" }, "title": { "example": "Service Unavailable", "type": "string" } }, "type": "object" } } }, "description": "Service Unavailable" } }, "summary": "Get detail error information", "tags": [ "Releases" ] } } }, "components": { "schemas": { "ccd.badge": { "properties": { "created": { "format": "date-time", "type": "string", "x-go-custom-tag": "db-model:\"PersistentModel.CreatedAt\" db-composite:\"PersistentModel\"", "x-isnullable": true, "x-order": 3 }, "created_by": { "type": "string", "x-go-custom-tag": "db-model:\"CreatedBy\"", "x-isnullable": true, "x-order": 4 }, "created_by_name": { "type": "string", "x-go-custom-tag": "populate-method:\"GetCreatedByName\"", "x-isnullable": true, "x-order": 5 }, "name": { "example": "QATesting", "maxLength": 50, "minLength": 1, "pattern": "^[0-9a-zA-Z-_]+$", "type": "string", "x-go-custom-tag": "db-model:\"Name\"", "x-isnullable": true, "x-order": 1 }, "releaseid": { "example": "123e4567-e89b-12d3-a456-426655440000", "format": "uuid", "type": "string", "x-go-custom-tag": "db-model:\"ReleaseID\" db-is-pointer:\"false\"", "x-go-name": "ReleaseID", "x-isnullable": true, "x-order": 2 }, "releasenum": { "format": "int64", "type": "integer", "x-go-custom-tag": "db-model:\"Release.ReleaseNumber\" db-composite:\"Release\"", "x-go-name": "ReleaseNumber", "x-order": 6 } }, "type": "object" }, "ccd.badgeAssign": { "properties": { "name": { "example": "QATesting", "maxLength": 50, "minLength": 1, "pattern": "^[0-9a-zA-Z-_]+$", "type": "string", "x-go-custom-tag": "db-model:\"Name\"", "x-isnullable": true, "x-order": 1 }, "releaseid": { "example": "123e4567-e89b-12d3-a456-426655440000", "format": "uuid", "type": "string", "x-go-custom-tag": "db-model:\"ReleaseID\"", "x-go-name": "ReleaseID", "x-order": 2 }, "releasenum": { "example": 2, "format": "int64", "type": "integer", "x-go-custom-tag": "db-skip:\"true\"", "x-go-name": "ReleaseNumber", "x-isnullable": false, "x-order": 3 } }, "required": [ "name" ], "type": "object" }, "ccd.bucket": { "properties": { "attributes": { "$ref": "#/components/schemas/ccd.bucketAttributes" }, "changes": { "$ref": "#/components/schemas/ccd.changecount" }, "created": { "format": "date-time", "type": "string", "x-go-custom-tag": "db-model:\"PersistentModel.CreatedAt\" db-composite:\"PersistentModel\"", "x-isnullable": true, "x-order": 5 }, "description": { "example": "Something that describes this bucket", "type": "string", "x-go-custom-tag": "db-model:\"Description\"", "x-isnullable": true, "x-order": 4 }, "environment_id": { "example": "b9a0657d-b223-4507-9206-ead33ac06c6d", "format": "uuid", "type": "string", "x-go-custom-tag": "db-model:\"EnvironmentId\" json:\",omitempty\"", "x-isnullable": true, "x-order": 9 }, "environment_name": { "example": "test_environment", "type": "string", "x-go-custom-tag": "db-model:\"EnvironmentName\"", "x-isnullable": true, "x-order": 10 }, "id": { "example": "b9a0657d-b223-4507-9206-ead33ac06c6d", "format": "uuid", "type": "string", "x-go-custom-tag": "db-model:\"PersistentModel.ID\" db-composite:\"PersistentModel\" json:\",omitempty\"", "x-order": 1 }, "last_release": { "$ref": "#/components/schemas/ccd.release" }, "name": { "example": "android_staging", "maxLength": 50, "type": "string", "x-go-custom-tag": "db-model:\"Name\" db-model-allow:\"update\"", "x-isnullable": true, "x-order": 2 }, "permissions": { "$ref": "#/components/schemas/ccd.bucketPermissions" }, "private": { "example": true, "type": "boolean", "x-go-custom-tag": "db-model:\"Private\" db-is-pointer:\"false\"", "x-isnullable": false, "x-omitempty": false, "x-order": 8 }, "projectguid": { "example": "123e4567-e89b-12d3-a456-426655440000", "format": "uuid", "type": "string", "x-go-custom-tag": "db-model:\"ProjectGuid\" json:\",omitempty\" db-is-pointer:\"false\"", "x-go-name": "ProjectGuid", "x-order": 3 } }, "type": "object" }, "ccd.bucketAttributes": { "properties": { "promote_only": { "example": true, "type": "boolean", "x-go-custom-tag": "db-model:\"PromoteOnly\"", "x-isnullable": true, "x-order": 1 } }, "type": "object" }, "ccd.bucketCreate": { "properties": { "description": { "example": "Something that describes this bucket", "type": "string", "x-go-custom-tag": "db-model:\"Description\"", "x-isnullable": true, "x-order": 3 }, "name": { "example": "android_staging", "maxLength": 50, "minLength": 1, "pattern": "^\\S.*$", "type": "string", "x-go-custom-tag": "db-model:\"Name\"", "x-isnullable": true, "x-order": 1 }, "private": { "default": false, "example": true, "type": "boolean", "x-go-custom-tag": "db-model:\"Private\" db-is-pointer:\"false\"", "x-isnullable": false, "x-omitempty": false, "x-order": 4 }, "projectguid": { "example": "123e4567-e89b-12d3-a456-426655440000", "format": "uuid", "type": "string", "x-go-custom-tag": "db-model:\"ProjectGuid\" json:\",omitempty\" db-is-pointer:\"false\"", "x-go-name": "ProjectGuid", "x-order": 2 } }, "required": [ "name", "projectguid" ], "type": "object" }, "ccd.bucketPermissions": { "properties": { "bucket_promote": { "example": false, "type": "boolean", "x-go-custom-tag": "db-model:\"BucketPromote\"", "x-isnullable": true, "x-order": 2 }, "bucket_read": { "example": true, "type": "boolean", "x-go-custom-tag": "db-model:\"BucketRead\"", "x-isnullable": true, "x-order": 1 }, "bucket_release": { "example": false, "type": "boolean", "x-go-custom-tag": "db-model:\"BucketRelease\"", "x-isnullable": true, "x-order": 3 }, "bucket_write": { "example": false, "type": "boolean", "x-go-custom-tag": "db-model:\"BucketWrite\"", "x-isnullable": true, "x-order": 4 } }, "type": "object" }, "ccd.bucketUpdate": { "properties": { "description": { "example": "Something that describes this bucket", "type": "string", "x-go-custom-tag": "db-model:\"Description\" db-model-allow:\"update\"", "x-isnullable": true }, "name": { "example": "android_staging", "maxLength": 50, "minLength": 1, "pattern": "^\\S.*$", "type": "string", "x-go-custom-tag": "db-model:\"Name\" db-model-allow:\"update\"", "x-isnullable": true, "x-order": 2 } }, "type": "object" }, "ccd.bucketaccesstoken": { "properties": { "created": { "format": "date-time", "type": "string", "x-go-custom-tag": "db-model:\"PersistentModel.CreatedAt\" db-composite:\"PersistentModel\"", "x-isnullable": true, "x-order": 5 }, "description": { "type": "string", "x-go-custom-tag": "db-model:\"Description\"", "x-isnullable": true, "x-order": 4 }, "id": { "example": "b9a0657d-b223-4507-9206-ead33ac06c6d", "format": "uuid", "type": "string", "x-go-custom-tag": "db-model:\"PersistentModel.ID\" db-composite:\"PersistentModel\" json:\",omitempty\"", "x-order": 1 }, "releaseid": { "description": "If not specified, the access token will be valid for all releases in the bucket.", "example": "123e4567-e89b-12d3-a456-426655440000", "format": "uuid", "type": "string", "x-go-custom-tag": "db-model:\"ReleaseId\" json:\",omitempty\"", "x-go-name": "ReleaseId", "x-isnullable": true, "x-order": 3 }, "token": { "type": "string", "x-go-custom-tag": "db-model:\"Token\"", "x-go-name": "Token", "x-isnullable": true, "x-order": 2 } }, "type": "object", "x-go-name": "BucketAccessToken" }, "ccd.bucketaccesstokenCreate": { "properties": { "description": { "example": "Shared with internal devs", "maxLength": 50, "minLength": 1, "type": "string", "x-go-custom-tag": "db-model:\"Description\"", "x-isnullable": true, "x-order": 2 }, "releaseid": { "description": "If not specified, the access token will be valid for all releases in the bucket.", "example": "123e4567-e89b-12d3-a456-426655440000", "format": "uuid", "type": "string", "x-go-custom-tag": "db-model:\"ReleaseId\" json:\",omitempty\"", "x-go-name": "ReleaseId", "x-isnullable": true, "x-order": 1 } }, "type": "object", "x-go-name": "BucketAccessTokenCreate" }, "ccd.bucketaccesstokenUpdate": { "properties": { "description": { "example": "Shared with internal devs", "maxLength": 50, "minLength": 1, "type": "string", "x-go-custom-tag": "db-model:\"Description\"", "x-isnullable": true, "x-order": 2 } }, "type": "object", "x-go-name": "BucketAccessTokenUpdate" }, "ccd.changecount": { "properties": { "add": { "example": 3, "format": "int64", "minimum": 0, "type": "integer", "x-go-custom-tag": "db-model:\"Added\"", "x-isnullable": false, "x-omitempty": false, "x-order": 2 }, "delete": { "example": 1, "format": "int64", "minimum": 0, "type": "integer", "x-go-custom-tag": "db-model:\"Deleted\"", "x-isnullable": false, "x-omitempty": false, "x-order": 4 }, "last_modified": { "format": "date-time", "type": "string", "x-go-custom-tag": "db-model:\"UpdatedAt\"", "x-isnullable": true, "x-order": 6 }, "last_modified_by": { "type": "string", "x-go-custom-tag": "db-model:\"LastModifiedBy\"", "x-isnullable": true, "x-order": 7 }, "last_modified_by_name": { "type": "string", "x-go-custom-tag": "populate-method:\"GetLastModifiedByName\"", "x-isnullable": true, "x-order": 8 }, "loading": { "type": "boolean", "x-go-custom-tag": "db-model:\"Loading\"", "x-omitempty": false, "x-order": 9 }, "unchanged": { "example": 3, "format": "int64", "minimum": 0, "type": "integer", "x-go-custom-tag": "db-model:\"Unchanged\"", "x-isnullable": false, "x-omitempty": false, "x-order": 1 }, "update": { "example": 5, "format": "int64", "minimum": 0, "type": "integer", "x-go-custom-tag": "db-model:\"Updated\"", "x-isnullable": false, "x-omitempty": false, "x-order": 3 } }, "type": "object", "x-go-name": "ReleaseChangeVersion" }, "ccd.entry": { "properties": { "complete": { "type": "boolean", "x-go-custom-tag": "populate-method:\"IsUploadComplete\"", "x-omitempty": false }, "content_hash": { "description": "The \"content_hash\" should be MD5sum hash value.", "example": "c76580fa26181bfa8d8952826bd334d5", "pattern": "^[a-fA-F0-9]+$", "type": "string", "x-go-custom-tag": "db-model:\"CurrentVersion.ContentHash\" db-model-allow:\"update\" db-composite:\"Version\"", "x-isnullable": true, "x-order": 5 }, "content_link": { "type": "string", "x-go-custom-tag": "populate-method:\"GetContentLink\" json:\",omitempty\"", "x-order": 9 }, "content_size": { "example": 1234567, "format": "int64", "minimum": 0, "type": "integer", "x-go-custom-tag": "db-model:\"CurrentVersion.ContentSize\" db-model-allow:\"update\" db-composite:\"Version\"", "x-isnullable": true, "x-order": 6 }, "content_type": { "example": "image/jpeg", "type": "string", "x-go-custom-tag": "db-model:\"CurrentVersion.ContentType\" db-model-allow:\"update\" db-composite:\"Version\"", "x-isnullable": true, "x-order": 7 }, "current_versionid": { "example": "b9a0657d-b223-4507-9206-ead33ac06c6d", "format": "uuid", "type": "string", "x-go-custom-tag": "db-model:\"CurrentVersion.ID\" db-composite:\"Version\"", "x-go-name": "VersionId", "x-order": 2 }, "entryid": { "example": "b9a0657d-b223-4507-9206-ead33ac06c6d", "format": "uuid", "type": "string", "x-go-custom-tag": "db-model:\"PersistentModel.ID\" db-composite:\"PersistentModel\" json:\",omitempty\"", "x-go-name": "Id", "x-order": 1 }, "labels": { "items": { "maxLength": 250, "type": "string", "x-isnullable": true }, "type": "array", "x-go-custom-tag": "db-model:\"CurrentVersion.Labels\" db-model-allow:\"update\" db-transform:\"Version\" db-composite:\"Version\" delegate:\"Labels\"", "x-order": 8 }, "last_modified": { "format": "date-time", "type": "string", "x-go-custom-tag": "db-model:\"CurrentVersion.UpdatedAt\" db-composite:\"Version\"", "x-isnullable": true }, "last_modified_by": { "type": "string", "x-go-custom-tag": "db-model:\"CurrentVersion.LastModifiedBy\" db-composite:\"Version\"", "x-isnullable": true }, "last_modified_by_name": { "type": "string", "x-go-custom-tag": "populate-method:\"GetLastModifiedByName\"", "x-isnullable": true }, "link": { "type": "string", "x-go-custom-tag": "populate-method:\"GetLink\"", "x-order": 10 }, "metadata": { "type": "object", "x-go-custom-tag": "db-model:\"CurrentVersion.Metadata\" db-model-allow:\"update\" db-composite:\"Version\" marshal-on-transform:\"true\"", "x-isnullable": true, "x-order": 4 }, "path": { "example": "ios/character1.bundle", "maxLength": 65535, "pattern": "^\\S.*$", "type": "string", "x-go-custom-tag": "db-model:\"Path\"", "x-isnullable": true, "x-order": 3 }, "signed_url": { "type": "string", "x-go-custom-tag": "db-model:\"SignedUrl\" json:\",omitempty\"", "x-isnullable": true, "x-order": 11 }, "updated_at": { "format": "date-time", "type": "string", "x-go-custom-tag": "db-model:\"UpdatedAt\"", "x-isnullable": true } }, "type": "object" }, "ccd.entryCreate": { "properties": { "content_hash": { "description": "The \"content_hash\" should be MD5sum hash value.", "example": "c76580fa26181bfa8d8952826bd334d5", "pattern": "^[a-fA-F0-9]+$", "type": "string", "x-go-custom-tag": "db-model:\"CurrentVersion.ContentHash\" db-model-allow:\"update\" db-composite:\"Version\"", "x-isnullable": true, "x-order": 2 }, "content_size": { "example": 1234567, "format": "int64", "minimum": 0, "type": "integer", "x-go-custom-tag": "db-model:\"CurrentVersion.ContentSize\" db-model-allow:\"update\" db-composite:\"Version\"", "x-isnullable": true, "x-order": 3 }, "content_type": { "example": "image/jpeg", "type": "string", "x-go-custom-tag": "db-model:\"CurrentVersion.ContentType\" db-model-allow:\"update\" db-composite:\"Version\"", "x-isnullable": true, "x-order": 4 }, "labels": { "items": { "maxLength": 250, "type": "string", "x-isnullable": true }, "type": "array", "x-go-custom-tag": "db-model:\"CurrentVersion.Labels\" db-model-allow:\"update\" db-transform:\"Version\" db-composite:\"Version\" delegate:\"Labels\"", "x-order": 5 }, "metadata": { "type": "object", "x-go-custom-tag": "db-model:\"CurrentVersion.Metadata\" db-model-allow:\"update\" db-composite:\"Version\" marshal-on-transform:\"true\"", "x-isnullable": true, "x-order": 6 }, "path": { "example": "ios/character1.bundle", "maxLength": 65535, "pattern": "^\\S.*$", "type": "string", "x-go-custom-tag": "db-model:\"Path\"", "x-isnullable": true, "x-order": 1 }, "signed_url": { "description": "Set to 'true' if you want to return a signed URL for direct upload. Otherwise defaults to 'false'.", "type": "boolean", "x-go-custom-tag": "db-skip:\"true\"", "x-isnullable": false, "x-omitempty": false, "x-order": 7 } }, "required": [ "path" ], "type": "object" }, "ccd.entryCreateBatch": { "properties": { "content_hash": { "description": "The \"content_hash\" should be MD5sum hash value.", "example": "c76580fa26181bfa8d8952826bd334d5", "pattern": "^[a-fA-F0-9]+$", "type": "string", "x-go-custom-tag": "db-model:\"CurrentVersion.ContentHash\" db-model-allow:\"update\" db-composite:\"Version\"", "x-isnullable": true, "x-order": 2 }, "content_size": { "example": 1234567, "format": "int64", "minimum": 0, "type": "integer", "x-go-custom-tag": "db-model:\"CurrentVersion.ContentSize\" db-model-allow:\"update\" db-composite:\"Version\"", "x-isnullable": true, "x-order": 3 }, "content_type": { "example": "image/jpeg", "type": "string", "x-go-custom-tag": "db-model:\"CurrentVersion.ContentType\" db-model-allow:\"update\" db-composite:\"Version\"", "x-isnullable": true, "x-order": 4 }, "labels": { "items": { "maxLength": 250, "type": "string", "x-isnullable": true }, "type": "array", "x-go-custom-tag": "db-model:\"CurrentVersion.Labels\" db-model-allow:\"update\" db-transform:\"Version\" db-composite:\"Version\" delegate:\"Labels\"", "x-order": 5 }, "metadata": { "type": "object", "x-go-custom-tag": "db-model:\"CurrentVersion.Metadata\" db-model-allow:\"update\" db-composite:\"Version\" marshal-on-transform:\"true\"", "x-isnullable": true, "x-order": 6 }, "path": { "example": "ios/character1.bundle", "maxLength": 65535, "pattern": "^\\S.*$", "type": "string", "x-go-custom-tag": "db-model:\"Path\"", "x-isnullable": true, "x-order": 1 } }, "required": [ "path" ], "type": "object" }, "ccd.entryCreateByPath": { "properties": { "content_hash": { "description": "The \"content_hash\" should be MD5sum hash value.", "example": "c76580fa26181bfa8d8952826bd334d5", "pattern": "^[a-fA-F0-9]+$", "type": "string", "x-go-custom-tag": "db-model:\"CurrentVersion.ContentHash\" db-model-allow:\"update\" db-composite:\"Version\"", "x-isnullable": true, "x-order": 2 }, "content_size": { "example": 1234567, "format": "int64", "minimum": 0, "type": "integer", "x-go-custom-tag": "db-model:\"CurrentVersion.ContentSize\" db-model-allow:\"update\" db-composite:\"Version\"", "x-isnullable": true, "x-order": 3 }, "content_type": { "example": "image/jpeg", "type": "string", "x-go-custom-tag": "db-model:\"CurrentVersion.ContentType\" db-model-allow:\"update\" db-composite:\"Version\"", "x-isnullable": true, "x-order": 4 }, "labels": { "items": { "maxLength": 250, "type": "string", "x-isnullable": true }, "type": "array", "x-go-custom-tag": "db-model:\"CurrentVersion.Labels\" db-model-allow:\"update\" db-transform:\"Version\" db-composite:\"Version\" delegate:\"Labels\"", "x-order": 5 }, "metadata": { "type": "object", "x-go-custom-tag": "db-model:\"CurrentVersion.Metadata\" db-model-allow:\"update\" db-composite:\"Version\" marshal-on-transform:\"true\"", "x-isnullable": true, "x-order": 6 }, "signed_url": { "description": "Set to 'true' if you want to return a signed URL for direct upload. Otherwise defaults to 'false'.", "type": "boolean", "x-go-custom-tag": "db-skip:\"true\"", "x-isnullable": false, "x-omitempty": false, "x-order": 7 } }, "type": "object" }, "ccd.entryDeleteBatch": { "properties": { "entryid": { "example": "b9a0657d-b223-4507-9206-ead33ac06c6d", "format": "uuid", "type": "string", "x-go-custom-tag": "db-model:\"PersistentModel.ID\" db-composite:\"PersistentModel\" json:\",omitempty\"", "x-go-name": "Id", "x-order": 1 } }, "required": [ "entryid" ], "type": "object" }, "ccd.entryUpdate": { "properties": { "content_hash": { "description": "The \"content_hash\" should be MD5sum hash value.", "example": "c76580fa26181bfa8d8952826bd334d5", "pattern": "^[a-fA-F0-9]+$", "type": "string", "x-go-custom-tag": "db-model:\"CurrentVersion.ContentHash\" db-model-allow:\"update\" db-composite:\"Version\"", "x-isnullable": true, "x-order": 5 }, "content_size": { "example": 1234567, "format": "int64", "minimum": 0, "type": "integer", "x-go-custom-tag": "db-model:\"CurrentVersion.ContentSize\" db-model-allow:\"update\" db-composite:\"Version\"", "x-isnullable": true, "x-order": 6 }, "content_type": { "example": "image/jpeg", "type": "string", "x-go-custom-tag": "db-model:\"CurrentVersion.ContentType\" db-model-allow:\"update\" db-composite:\"Version\"", "x-isnullable": true, "x-order": 7 }, "labels": { "items": { "maxLength": 250, "type": "string", "x-isnullable": true }, "type": "array", "x-go-custom-tag": "db-model:\"CurrentVersion.Labels\" db-model-allow:\"update\" db-transform:\"Version\" db-composite:\"Version\" delegate:\"Labels\"", "x-order": 8 }, "metadata": { "type": "object", "x-go-custom-tag": "db-model:\"CurrentVersion.Metadata\" db-model-allow:\"update\" db-composite:\"Version\" marshal-on-transform:\"true\"", "x-isnullable": true, "x-order": 4 }, "signed_url": { "description": "Set to 'true' if you want to return a signed URL for direct upload. Otherwise defaults to 'false'.", "type": "boolean", "x-go-custom-tag": "db-skip:\"true\"", "x-isnullable": false, "x-omitempty": false, "x-order": 9 } }, "type": "object" }, "ccd.environment": { "properties": { "id": { "example": "11111111-1111-1111-1111-111111111111", "format": "uuid", "type": "string", "x-go-custom-tag": "db-model:\"PersistentModel.ID\" db-composite:\"PersistentModel\" json:\",omitempty\"", "x-order": 1 }, "is_default": { "example": true, "type": "boolean", "x-go-custom-tag": "db-model:\"IsDefault\" db-is-pointer:\"false\"", "x-omitempty": false, "x-order": 4 }, "name": { "example": "An Environment", "type": "string", "x-go-custom-tag": "db-model:\"Name\"", "x-isnullable": true, "x-order": 2 }, "project_id": { "example": "22222222-2222-2222-2222-222222222222", "format": "uuid", "type": "string", "x-go-custom-tag": "db-model:\"ProjectId\" db-is-pointer:\"false\"", "x-order": 3 } }, "type": "object" }, "ccd.metricQuantity": { "properties": { "quantity": { "example": 142312, "format": "int64", "minimum": 0, "type": "integer", "x-go-custom-tag": "db-model:\"Quantity\" db-is-pointer:\"false\"", "x-go-name": "Quantity", "x-isnullable": false, "x-omitempty": false } }, "type": "object", "x-go-name": "MetricQuantity" }, "ccd.org": { "properties": { "id": { "example": "an-organization", "type": "string" }, "name": { "example": "An Organization", "type": "string" }, "orgid": { "example": "12345678", "type": "string" }, "tos_accepted": { "example": true, "type": "boolean", "x-omitempty": false } }, "type": "object" }, "ccd.orgTosUpdate": { "properties": { "tos_version": { "example": 1, "format": "int64", "type": "integer", "x-omitempty": false } }, "type": "object" }, "ccd.orgusage": { "properties": { "id": { "example": "an-organization", "type": "string", "x-go-custom-tag": "db-model:\"OrgID\"", "x-go-name": "OrgID", "x-isnullable": false }, "start_time": { "format": "date-time", "type": "string", "x-go-custom-tag": "db-model:\"Start\"", "x-go-name": "Start", "x-isnullable": true }, "usage": { "items": { "$ref": "#/components/schemas/ccd.usage" }, "type": "array", "x-go-custom-tag": "db-model:\"Usage\" db-composite:\"Usage\"", "x-go-name": "Usage" } }, "type": "object", "x-go-name": "OrgUsage" }, "ccd.permission": { "properties": { "action": { "example": "write", "type": "string", "x-go-custom-tag": "db-model:\"Action\"", "x-isnullable": true }, "permission": { "example": "allow", "type": "string", "x-go-custom-tag": "db-model:\"Permission\"", "x-isnullable": true }, "resource": { "example": "bucket/0000-0000-0000-0000", "type": "string", "x-go-custom-tag": "db-model:\"Resource\"", "x-isnullable": true }, "role": { "example": "user", "type": "string", "x-go-custom-tag": "db-model:\"Role\"", "x-isnullable": true } }, "type": "object" }, "ccd.permissionCreate": { "properties": { "action": { "enum": [ "write", "list-entries", "list-releases" ], "example": "write", "type": "string", "x-go-custom-tag": "db-model:\"PermissionRule.Action\"", "x-order": 2 }, "permission": { "enum": [ "allow", "deny" ], "example": "allow", "type": "string", "x-go-custom-tag": "db-model:\"PermissionRule.Permission\"", "x-order": 3 }, "role": { "default": "user", "enum": [ "user", "client" ], "example": "user", "type": "string", "x-go-custom-tag": "db-model:\"PermissionRule.Role\"", "x-order": 1 } }, "required": [ "action", "permission" ], "type": "object" }, "ccd.permissionUpdate": { "properties": { "action": { "enum": [ "write", "list-entries", "list-releases" ], "example": "write", "type": "string", "x-go-custom-tag": "db-model:\"PermissionRule.Action\"", "x-order": 2 }, "permission": { "enum": [ "allow", "deny" ], "example": "allow", "type": "string", "x-go-custom-tag": "db-model:\"PermissionRule.Permission\"", "x-order": 3 }, "role": { "default": "user", "enum": [ "user", "client" ], "example": "user", "type": "string", "x-go-custom-tag": "db-model:\"PermissionRule.Role\"", "x-order": 1 } }, "required": [ "action", "permission" ], "type": "object" }, "ccd.promoteBucketResponse": { "properties": { "promotion_id": { "example": "b9a0657d-b223-4507-9206-ead33ac06c6d", "format": "uuid", "type": "string", "x-go-custom-tag": "db-model:\"PromotionID\" db-is-pointer:\"false\"", "x-go-name": "PromotionID", "x-isnullable": false, "x-omitempty": false } }, "type": "object", "x-go-name": "PromoteBucketResponse" }, "ccd.promotebucket": { "properties": { "from_release": { "example": "b9a0657d-b223-4507-9206-ead33ac06c6d", "format": "uuid", "type": "string" }, "notes": { "description": "If unset, the release notes of the \"from release\" will be used.", "type": "string", "x-isnullable": true }, "to_bucket": { "example": "b9a0657d-b223-4507-9206-ead33ac06c6d", "format": "uuid", "type": "string" }, "to_environment": { "description": "If unset, the environment of the \"from_release\" will be used.", "example": "b9a0657d-b223-4507-9206-ead33ac06c6d", "format": "uuid", "type": "string" } }, "required": [ "from_release", "to_bucket" ], "type": "object", "x-go-name": "PromoteBucket" }, "ccd.promotion": { "properties": { "error": { "type": "string", "x-go-custom-tag": "db-model:\"Error\"", "x-isnullable": true, "x-omitempty": true, "x-order": 7 }, "from_bucket_id": { "example": "a9b0657d-b223-4075-9206-ead33ac06d6c", "format": "uuid", "type": "string", "x-go-custom-tag": "db-model:\"FromBucketID\"", "x-isnullable": false, "x-omitempty": false, "x-order": 3 }, "from_bucket_name": { "type": "string", "x-go-custom-tag": "db-model:\"FromBucketName\"", "x-isnullable": false, "x-omitempty": false, "x-order": 8 }, "from_environment_id": { "example": "a9b0657d-b223-4075-9206-ead33ac06d6c", "format": "uuid", "type": "string", "x-go-custom-tag": "db-model:\"FromEnvironmentID\"", "x-isnullable": false, "x-omitempty": false, "x-order": 11 }, "from_environment_name": { "type": "string", "x-go-custom-tag": "db-model:\"FromEnvironmentName\"", "x-isnullable": false, "x-omitempty": false, "x-order": 12 }, "from_release_id": { "example": "b9a0657d-b223-4507-9206-ead33ac06c6d", "format": "uuid", "type": "string", "x-go-custom-tag": "db-model:\"FromReleaseID\"", "x-isnullable": false, "x-omitempty": false, "x-order": 2 }, "from_release_number": { "format": "int64", "type": "integer", "x-go-custom-tag": "db-model:\"FromReleaseNumber\"", "x-isnullable": false, "x-omitempty": false, "x-order": 10 }, "promotion_id": { "example": "b9a0657d-b223-4507-9206-ead33ac06c6d", "format": "uuid", "type": "string", "x-go-custom-tag": "db-model:\"PersistentModel.ID\" db-composite:\"PersistentModel\"", "x-isnullable": false, "x-omitempty": false, "x-order": 1 }, "promotion_status": { "enum": [ "NotFound", "Complete", "InProgress", "Failed" ], "example": "Complete", "type": "string", "x-go-custom-tag": "db-model:\"PromotionStatus\" enum:\"true\"", "x-isnullable": true, "x-omitempty": false, "x-order": 6 }, "to_bucket_id": { "example": "d950657d-2b23-4907-9206-ead33ac17d7a", "format": "uuid", "type": "string", "x-go-custom-tag": "db-model:\"ToBucketID\"", "x-isnullable": false, "x-omitempty": false, "x-order": 5 }, "to_bucket_name": { "type": "string", "x-go-custom-tag": "db-model:\"ToBucketName\"", "x-isnullable": false, "x-omitempty": false, "x-order": 9 }, "to_environment_id": { "example": "a9b0657d-b223-4075-9206-ead33ac06d6c", "format": "uuid", "type": "string", "x-go-custom-tag": "db-model:\"ToEnvironmentID\"", "x-isnullable": false, "x-omitempty": false, "x-order": 13 }, "to_environment_name": { "type": "string", "x-go-custom-tag": "db-model:\"ToEnvironmentName\"", "x-isnullable": false, "x-omitempty": false, "x-order": 14 }, "to_release_id": { "example": "609a57dd-b223-4507-9206-ca36ead03c6d", "format": "uuid", "type": "string", "x-go-custom-tag": "db-model:\"ToReleaseID\"", "x-isnullable": true, "x-omitempty": false, "x-order": 4 } }, "type": "object", "x-go-name": "Promotion" }, "ccd.release": { "properties": { "badges": { "items": { "$ref": "#/components/schemas/ccd.badge" }, "type": "array", "x-go-custom-tag": "db-model:\"Badges\" db-composite:\"Badge\"", "x-go-name": "Badges", "x-isnullable": true, "x-order": 13 }, "changes": { "$ref": "#/components/schemas/ccd.changecount" }, "content_hash": { "example": "c76580fa26181bfa8d8952826bd334d5", "type": "string", "x-go-custom-tag": "db-model:\"ContentHash\"", "x-isnullable": true, "x-order": 11 }, "content_size": { "example": 1234567, "format": "int64", "type": "integer", "x-go-custom-tag": "db-model:\"ContentSize\"", "x-isnullable": true, "x-order": 12 }, "created": { "format": "date-time", "type": "string", "x-go-custom-tag": "db-model:\"PersistentModel.CreatedAt\" db-composite:\"PersistentModel\"", "x-isnullable": true, "x-order": 3 }, "created_by": { "type": "string", "x-go-custom-tag": "db-model:\"CreatedBy\"", "x-isnullable": true, "x-order": 4 }, "created_by_name": { "type": "string", "x-go-custom-tag": "populate-method:\"GetCreatedByName\"", "x-isnullable": true, "x-order": 5 }, "entries_link": { "type": "string", "x-go-custom-tag": "populate-method:\"GetEntriesLink\"", "x-order": 10 }, "metadata": { "type": "object", "x-go-custom-tag": "db-model:\"Metadata\" marshal-on-transform:\"true\"", "x-isnullable": true, "x-order": 7 }, "notes": { "type": "string", "x-go-custom-tag": "db-model:\"Notes\"", "x-isnullable": true, "x-order": 6 }, "promoted_from_bucket": { "format": "uuid", "type": "string", "x-go-custom-tag": "db-model:\"PromotedFromBucket\" db-is-pointer:\"true\"", "x-isnullable": true, "x-order": 8 }, "promoted_from_release": { "format": "uuid", "type": "string", "x-go-custom-tag": "db-model:\"PromotedFromRelease\" db-is-pointer:\"true\"", "x-isnullable": true, "x-order": 9 }, "releaseid": { "example": "b9a0657d-b223-4507-9206-ead33ac06c6d", "format": "uuid", "type": "string", "x-go-custom-tag": "db-model:\"PersistentModel.ID\" db-composite:\"PersistentModel\"", "x-go-name": "ID", "x-order": 1 }, "releasenum": { "format": "int64", "type": "integer", "x-go-custom-tag": "db-model:\"ReleaseNumber\"", "x-go-name": "ReleaseNumber", "x-order": 2 } }, "type": "object" }, "ccd.releaseCreate": { "properties": { "entries": { "items": { "$ref": "#/components/schemas/ccd.releaseentryCreate" }, "type": "array", "x-go-custom-tag": "db-model:\"ReleaseEntriesCreate\" db-composite:\"ReleaseEntryCreate\"", "x-go-name": "ReleaseEntriesCreate", "x-isnullable": true }, "metadata": { "type": "object", "x-go-custom-tag": "db-model:\"Metadata\" marshal-on-transform:\"true\"", "x-isnullable": true, "x-order": 7 }, "notes": { "type": "string", "x-go-custom-tag": "db-model:\"Notes\"", "x-isnullable": true, "x-order": 6 }, "snapshot": { "example": "2017-07-21T17:32:28Z", "format": "date-time", "type": "string", "x-go-custom-tag": "db-skip:\"true\"", "x-isnullable": true } }, "type": "object", "x-go-name": "ReleaseCreate" }, "ccd.releaseUpdate": { "properties": { "notes": { "type": "string", "x-go-custom-tag": "db-model:\"Notes\"", "x-isnullable": true, "x-order": 6 } }, "type": "object", "x-go-name": "ReleaseUpdate" }, "ccd.releaseentry": { "properties": { "change_state": { "enum": [ "Unchanged", "Add", "Delete", "Update" ], "type": "string", "x-go-custom-tag": "db-model:\"ChangeState\" enum:\"true\"", "x-isnullable": true }, "complete": { "type": "boolean", "x-go-custom-tag": "populate-method:\"IsUploadComplete\"", "x-omitempty": false }, "content_hash": { "example": "c76580fa26181bfa8d8952826bd334d5", "pattern": "^[a-fA-F0-9]+$", "type": "string", "x-go-custom-tag": "db-model:\"Version.ContentHash\" db-composite:\"Version\"", "x-isnullable": true, "x-order": 5 }, "content_link": { "type": "string", "x-go-custom-tag": "populate-method:\"GetContentLink\"", "x-order": 9 }, "content_size": { "format": "int64", "type": "integer", "x-go-custom-tag": "db-model:\"Version.ContentSize\" db-composite:\"Version\"", "x-isnullable": true, "x-order": 6 }, "content_type": { "example": "image/jpeg", "type": "string", "x-go-custom-tag": "db-model:\"Version.ContentType\" db-composite:\"Version\"", "x-isnullable": true, "x-order": 7 }, "entryid": { "example": "b9a0657d-b223-4507-9206-ead33ac06c6d", "format": "uuid", "type": "string", "x-go-custom-tag": "json:\"-\" db-model:\"Entry.ID\" db-composite:\"Entry\"", "x-go-name": "Id", "x-order": 1 }, "labels": { "items": { "type": "string", "x-isnullable": true }, "type": "array", "x-go-custom-tag": "db-model:\"Version.Labels\" db-transform:\"Version\" db-composite:\"Version\" delegate:\"Labels\"", "x-order": 8 }, "last_modified": { "format": "date-time", "type": "string", "x-go-custom-tag": "db-model:\"Version.UpdatedAt\" db-composite:\"Version\"", "x-isnullable": true }, "last_modified_by": { "type": "string", "x-go-custom-tag": "db-model:\"Version.LastModifiedBy\" db-composite:\"Version\"", "x-isnullable": true }, "last_modified_by_name": { "type": "string", "x-go-custom-tag": "populate-method:\"GetLastModifiedByName\"", "x-isnullable": true }, "link": { "type": "string", "x-go-custom-tag": "populate-method:\"GetLink\"", "x-order": 10 }, "metadata": { "type": "object", "x-go-custom-tag": "db-model:\"Version.Metadata\" db-composite:\"Version\" marshal-on-transform:\"true\"", "x-isnullable": true, "x-order": 4 }, "path": { "example": "ios/character1.bundle", "pattern": "^\\S.*$", "type": "string", "x-go-custom-tag": "db-model:\"Entry.Path\" db-composite:\"Entry\"", "x-isnullable": true, "x-order": 3 }, "updated_at": { "format": "date-time", "type": "string", "x-go-custom-tag": "db-model:\"Entry.UpdatedAt\" db-composite:\"Entry\"", "x-isnullable": true }, "versionid": { "example": "b9a0657d-b223-4507-9206-ead33ac06c6d", "format": "uuid", "type": "string", "x-go-custom-tag": "db-model:\"Version.ID\" db-composite:\"Version\"", "x-go-name": "VersionId", "x-order": 2 } }, "type": "object", "x-go-name": "ReleaseEntry" }, "ccd.releaseentryCreate": { "properties": { "entryid": { "example": "b9a0657d-b223-4507-9206-ead33ac06c6d", "format": "uuid", "type": "string", "x-go-custom-tag": "json:\"-\" db-model:\"Entry.ID\" db-composite:\"Entry\" db-is-pointer:\"false\"", "x-go-name": "Id", "x-order": 1 }, "versionid": { "example": "b9a0657d-b223-4507-9206-ead33ac06c6d", "format": "uuid", "type": "string", "x-go-custom-tag": "db-model:\"Version.ID\" db-composite:\"Version\" db-is-pointer:\"false\"", "x-go-name": "VersionId", "x-order": 2 } }, "required": [ "versionid", "entryid" ], "type": "object", "x-go-name": "ReleaseEntryCreate" }, "ccd.usage": { "properties": { "projectguid": { "format": "uuid", "type": "string", "x-go-custom-tag": "db-model:\"ProjectId\" db-guid-string:\"true\"", "x-go-name": "ProjectGUID" }, "quantity": { "example": 50.45434434, "format": "double", "minimum": 0, "type": "number", "x-go-custom-tag": "db-model:\"Quantity\"", "x-go-name": "Quantity", "x-isnullable": false, "x-omitempty": false } }, "type": "object" }, "ccd.version": { "properties": { "content_hash": { "example": "c76580fa26181bfa8d8952826bd334d5", "type": "string", "x-go-custom-tag": "db-model:\"ContentHash\"", "x-isnullable": true }, "content_link": { "type": "string", "x-go-custom-tag": "populate-method:\"GetContentLink\"", "x-order": 5 }, "content_size": { "example": 1234567, "format": "int64", "type": "integer", "x-go-custom-tag": "db-model:\"ContentSize\"", "x-isnullable": true }, "content_type": { "example": "image/jpeg", "type": "string", "x-go-custom-tag": "db-model:\"ContentType\"", "x-isnullable": true }, "labels": { "items": { "type": "string", "x-isnullable": true }, "type": "array", "x-go-custom-tag": "db-model:\"Labels\" delegate:\"Labels\"", "x-isnullable": true, "x-order": 4 }, "last_modified": { "format": "date-time", "type": "string", "x-go-custom-tag": "db-model:\"PersistentModel.UpdatedAt\" db-composite:\"PersistentModel\"", "x-isnullable": true, "x-order": 2 }, "link": { "type": "string", "x-go-custom-tag": "populate-method:\"GetLink\"", "x-order": 6 }, "metadata": { "type": "object", "x-go-custom-tag": "db-model:\"Metadata\" marshal-on-transform:\"true\"", "x-isnullable": true }, "path": { "example": "ios/character1.bundle", "type": "string", "x-go-custom-tag": "db-model:\"Path\"", "x-isnullable": true, "x-order": 3 }, "versionid": { "example": "b9a0657d-b223-4507-9206-ead33ac06c6d", "format": "uuid", "type": "string", "x-go-custom-tag": "db-model:\"PersistentModel.ID\" db-composite:\"PersistentModel\"", "x-order": 1 } }, "type": "object" } } }, "tags": [ { "description": "An organization is the billing entity for a collection of projects and their buckets.", "name": "Orgs" }, { "description": "A bucket is a single context for publishing content, which might include things like platform and environment (for example, “ios_staging” or “ios_production”).", "name": "Buckets" }, { "description": "Bucket access token is the concept for private bucket only. A token is needed when accessing contents in a private bucket via Client API.", "name": "BucketAccessTokens" }, { "description": "An entry is a single piece of content within a bucket. Entries are versioned and support adding associated labels / metadata.", "name": "Entries" }, { "description": "Content endpoints are used to push the actual file data for a specific entry.", "name": "Content" }, { "description": "Releases are a snapshot of the entries contained within a bucket at a single point in time.", "name": "Releases" }, { "name": "Badges" }, { "name": "Environments" }, { "name": "Permissions" } ] } ````