{"componentChunkName":"component---src-templates-api-page-tsx","path":"/api/releases/update-an-organizations-release/","result":{"data":{"openApi":{"id":"7309351d-4701-5ea8-8588-f404d878d3c5","path":{"description":"Update a release for a given organization.","method":"put","operationId":"Update an Organization's Release","summary":null,"tags":["Releases"],"apiPath":"/api/0/organizations/{organization_slug}/releases/{version}/","readableUrl":"/api/releases/update-an-organizations-release/","parameters":[{"schema":{"type":"string","format":null,"enum":null},"name":"organization_slug","in":"path","description":"The slug of the organization the release belongs to.","required":true},{"schema":{"type":"string","format":null,"enum":null},"name":"version","in":"path","description":"The version identifier of the release.","required":true}],"responses":[{"content":{"content_type":"application/json","example":"{\n  \"authors\": [],\n  \"commitCount\": 0,\n  \"data\": {},\n  \"dateCreated\": \"2019-01-03T00:12:55.109Z\",\n  \"dateReleased\": null,\n  \"deployCount\": 0,\n  \"firstEvent\": null,\n  \"lastCommit\": null,\n  \"lastDeploy\": null,\n  \"lastEvent\": null,\n  \"newGroups\": 0,\n  \"owner\": null,\n  \"projects\": [\n    {\n      \"name\": \"Pump Station\",\n      \"slug\": \"pump-station\"\n    }\n  ],\n  \"ref\": \"6ba09a7c53235ee8a8fa5ee4c1ca8ca886e7fdbb\",\n  \"shortVersion\": \"2.0rc2\",\n  \"url\": null,\n  \"version\": \"2.0rc2\"\n}","schema":"{\n  \"type\": \"object\",\n  \"required\": [\n    \"authors\",\n    \"commitCount\",\n    \"data\",\n    \"dateCreated\",\n    \"dateReleased\",\n    \"deployCount\",\n    \"firstEvent\",\n    \"lastCommit\",\n    \"lastDeploy\",\n    \"lastEvent\",\n    \"newGroups\",\n    \"owner\",\n    \"projects\",\n    \"ref\",\n    \"shortVersion\",\n    \"version\",\n    \"url\"\n  ],\n  \"properties\": {\n    \"authors\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"object\"\n      }\n    },\n    \"commitCount\": {\n      \"type\": \"integer\",\n      \"format\": \"int64\"\n    },\n    \"data\": {\n      \"type\": \"object\"\n    },\n    \"dateCreated\": {\n      \"type\": \"string\",\n      \"format\": \"date-time\"\n    },\n    \"dateReleased\": {\n      \"type\": \"string\",\n      \"format\": \"date-time\",\n      \"nullable\": true\n    },\n    \"deployCount\": {\n      \"type\": \"integer\",\n      \"format\": \"int64\"\n    },\n    \"firstEvent\": {\n      \"type\": \"string\",\n      \"format\": \"date-time\",\n      \"nullable\": true\n    },\n    \"lastCommit\": {\n      \"type\": \"object\",\n      \"nullable\": true\n    },\n    \"lastDeploy\": {\n      \"type\": \"object\",\n      \"required\": [\n        \"environment\",\n        \"name\",\n        \"dateStarted\",\n        \"dateFinished\",\n        \"url\",\n        \"id\"\n      ],\n      \"properties\": {\n        \"environment\": {\n          \"type\": \"string\"\n        },\n        \"name\": {\n          \"type\": \"string\",\n          \"nullable\": true\n        },\n        \"dateStarted\": {\n          \"type\": \"string\",\n          \"format\": \"date-time\",\n          \"nullable\": true\n        },\n        \"dateFinished\": {\n          \"type\": \"string\",\n          \"format\": \"date-time\"\n        },\n        \"url\": {\n          \"type\": \"string\",\n          \"nullable\": true\n        },\n        \"id\": {\n          \"type\": \"string\"\n        }\n      }\n    },\n    \"lastEvent\": {\n      \"type\": \"string\",\n      \"format\": \"date-time\",\n      \"nullable\": true\n    },\n    \"newGroups\": {\n      \"type\": \"integer\",\n      \"format\": \"int64\"\n    },\n    \"owner\": {\n      \"type\": \"object\",\n      \"nullable\": true\n    },\n    \"projects\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"name\": {\n            \"type\": \"string\"\n          },\n          \"slug\": {\n            \"type\": \"string\"\n          }\n        }\n      }\n    },\n    \"ref\": {\n      \"type\": \"string\",\n      \"nullable\": true\n    },\n    \"shortVersion\": {\n      \"type\": \"string\"\n    },\n    \"version\": {\n      \"type\": \"string\"\n    },\n    \"url\": {\n      \"type\": \"string\",\n      \"nullable\": true\n    }\n  }\n}"},"description":"Success","status_code":"200"},{"content":null,"description":"Forbidden","status_code":"403"},{"content":null,"description":"Not Found","status_code":"404"}],"requestBody":{"content":{"content_type":"application/json","schema":"{\n  \"type\": \"object\",\n  \"properties\": {\n    \"ref\": {\n      \"type\": \"string\",\n      \"description\": \"An optional commit reference. This is useful if a tagged version has been provided.\",\n      \"example\": \"freshtofu\"\n    },\n    \"url\": {\n      \"type\": \"string\",\n      \"description\": \"A URL that points to the release. This can be the path to an online interface to the source code for instance.\",\n      \"example\": \"https://vcshub.invalid/user/project/refs/freshtofu\"\n    },\n    \"dateReleased\": {\n      \"type\": \"string\",\n      \"format\": \"date-time\",\n      \"description\": \"An optional date that indicates when the release went live. If not provided the current time is assumed.\"\n    },\n    \"commits\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"object\"\n      },\n      \"description\": \"An optional list of commit data to be associated with the release. Commits must include parameters `id` (the sha of the commit), and can optionally include `repository`, `message`, `author_name`, `author_email`, and `timestamp`.\"\n    },\n    \"refs\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"object\"\n      },\n      \"description\": \"An optional way to indicate the start and end commits for each repository included in a release. Head commits must include parameters `repository` and `commit` (the HEAD sha). They can optionally include `previousCommit` (the sha of the HEAD of the previous release), which should be specified if this is the first time you've sent commit data.\"\n    }\n  }\n}"},"required":null},"security":[{"auth_token":["project:releases"]}]}}},"pageContext":{"id":"7309351d-4701-5ea8-8588-f404d878d3c5","title":"Update an Organization's Release"}},"staticQueryHashes":["1218203755","1222113826","1222113826","1766336459","2158593473","3990806462","4015007367","4192517163"]}