Create release
POST
/api/projects/{projectId}/releasesSigned-in member
Path parameters
| Name | Type | Required | Notes |
|---|---|---|---|
projectId | string (uuid) | Required |
Request body
application/json
| Field | Type | Required | Notes |
|---|---|---|---|
version | string | Required | max 50 |
summary | string | Optional | max 2000 |
upgradeGuideUrl | string | Optional | |
previousReleaseId | string (uuid) | Optional | |
plannedReleaseAt | string | Optional |
Response
Success: 201
| Field | Type | Required | Notes |
|---|---|---|---|
id | string (uuid) | Optional | |
projectId | string (uuid) | Optional | |
version | string | Optional | |
summary | string | Optional | |
status | enum ReleaseStatus | Optional | DRAFTIN_REVIEWAPPROVEDPUBLISHED |
createdAt | string (date-time) | Optional | |
updatedAt | string (date-time) | Optional | |
plannedReleaseAt | string (date-time) | Optional | |
upgradeGuideUrl | string | Optional | |
previousReleaseId | string (uuid) | Optional | |
previousVersion | string | Optional | |
changes | array of ChangeView | Optional | |
changes[].id | string (uuid) | Optional | |
changes[].pullRequestNumber | integer | Optional | |
changes[].title | string | Optional | |
changes[].description | string | Optional | |
changes[].authorLogin | string | Optional | |
changes[].labels | array of string | Optional | |
changes[].targetBranch | string | Optional | |
changes[].mergeCommitSha | string | Optional | |
changes[].mergedAt | string (date-time) | Optional | |
changes[].url | string | Optional | |
changes[].category | string | Optional | |
changes[].categoryName | string | Optional | |
changes[].categoryGroup | enum CategoryGroup | Optional | FEATUREFIXPERFORMANCEDOCUMENTATIONMAINTENANCEOTHER |
changes[].breaking | boolean | Optional | |
changes[].security | boolean | Optional | |
changes[].needsReview | boolean | Optional | |
changes[].reasons | array of string | Optional | |
changes[].classificationSource | enum ClassificationSource | Optional | RULESAISUGGESTIONHUMAN |
changes[].aiStatus | enum AiStatus | Optional | NOT_REQUESTEDSUCCEEDEDFAILED |
changes[].aiModel | string | Optional | |
changes[].aiFailure | string | Optional | |
changes[].aiEligible | boolean | Optional | |
changes[].reviewedBy | string (uuid) | Optional | |
changes[].reviewerName | string | Optional | |
changes[].reviewedAt | string (date-time) | Optional | |
changes[].processingStatus | enum ProcessingStatus | Optional | PROCESSINGCOMPLETED |
changes[].changedFileStatus | enum ChangedFileStatus | Optional | COLLECTEDUNAVAILABLENOT_SUPPORTED |
changes[].linkedContextStatus | enum LinkedContextStatus | Optional | NOT_SUPPORTEDNOT_CONFIGUREDNOT_FOUNDPARTIALUNAVAILABLECOLLECTED |
changes[].linkedIssues | array of LinkedIssue | Optional | |
changes[].changedFiles | array of ChangedFile | Optional | |
changes[].reviewTriggers | array of ReviewTrigger | Optional | |
changes[].neutralSummary | NeutralSummary | Optional | |
changes[].contentLanguage | string | Optional | |
changes[].aiProvider | enum AiProvider | Optional | OPENAIANTHROPICDEEPSEEK |
changes[].audienceNarrativeDetails | map of AudienceNarrative | Optional | |
changes[].summaryEditorName | string | Optional | |
changes[].summaryEditedAt | string (date-time) | Optional | |
changes[].context | ContextAssessment | Optional | |
changes[].sourceId | string (uuid) | Optional | |
changes[].origin | enum ChangeOrigin | Optional | WEBHOOKIMPORT |
changes[].sourceType | enum SourceType | Optional | GITHUBGITLABLINEARJIRA |
changes[].exclusion | ChangeExclusion | Optional | |
decisions | array of ReleaseDecisionView | Optional | |
decisions[].changeId | string (uuid) | Optional | |
decisions[].action | enum ReviewAction | Optional | APPROVEEDIT |
decisions[].reviewerName | string | Optional | |
decisions[].note | string | Optional | |
decisions[].decidedAt | string (date-time) | Optional | |
decisions[].foldedChangeId | string (uuid) | Optional | |
reviewedCount | integer | Optional | |
preview | array of ReleaseNoteSection | Optional | |
preview[].title | string | Optional | |
preview[].items | array of ReleaseNoteItem | Optional | |
approvedAt | string (date-time) | Optional | |
approverName | string | Optional | |
publishedAt | string (date-time) | Optional | |
publisherName | string | Optional | |
markdown | string | Optional | |
notes | array of AudienceNoteView | Optional | |
notes[].id | string (uuid) | Optional | |
notes[].audienceId | string (uuid) | Optional | |
notes[].audienceCode | string | Optional | |
notes[].audienceName | string | Optional | |
notes[].language | string | Optional | |
notes[].content | string | Optional | |
notes[].autoRerender | boolean | Optional | |
notes[].lastEditorName | string | Optional | |
notes[].updatedAt | string (date-time) | Optional | |
notes[].translationStatus | enum TranslationState.Status | Optional | READYPENDINGFAILED |
notes[].glossaryStatus | enum GlossaryUse.Status | Optional | NONEPENDINGAPPLIEDNOT_APPLIED |
notes[].glossaryReason | string | Optional | |
glossaries | array of ReleaseGlossaryView | Optional | |
glossaries[].language | string | Optional | |
glossaries[].status | enum GlossaryUse.Status | Optional | NONEPENDINGAPPLIEDNOT_APPLIED |
glossaries[].reason | string | Optional | |
linkedIssues | array of LinkedIssueStatusView | Optional | |
linkedIssues[].tracker | string | Optional | |
linkedIssues[].key | string | Optional | |
linkedIssues[].title | string | Optional | |
linkedIssues[].url | string | Optional | |
linkedIssues[].changeReferences | array of string | Optional | |
linkedIssues[].recordedStatus | string | Optional | |
linkedIssues[].statusAtReview | string | Optional | |
linkedIssues[].read | boolean | Optional | |
linkedIssues[].status | string | Optional | |
linkedIssues[].open | boolean | Optional | |
linkedIssues[].accepted | boolean | Optional | |
linkedIssues[].accepterName | string | Optional | |
linkedIssues[].acceptedAt | string (date-time) | Optional | |
linkedIssueRead | string | Optional | |
foldingSuggestions | array of FoldingSuggestion | Optional | |
foldingSuggestions[].trackerChangeId | string (uuid) | Optional | |
foldingSuggestions[].trackerReference | string | Optional | |
foldingSuggestions[].trackerTitle | string | Optional | |
foldingSuggestions[].codeChangeId | string (uuid) | Optional | |
foldingSuggestions[].codeReference | string | Optional | |
foldingSuggestions[].codeTitle | string | Optional | |
foldingSuggestions[].evidence | enum ReleaseFoldDecision.Evidence | Optional | LINKED_KEYCONFIRMED_DUPLICATE |
foldingSuggestions[].issueKey | string | Optional | |
foldingSuggestions[].confirmedBy | string | Optional | |
foldingSuggestions[].addsBreaking | boolean | Optional | |
foldingSuggestions[].addsSecurity | boolean | Optional | |
foldDecisions | array of FoldDecisionView | Optional | |
foldDecisions[].trackerChangeId | string (uuid) | Optional | |
foldDecisions[].codeChangeId | string (uuid) | Optional | |
foldDecisions[].evidence | enum ReleaseFoldDecision.Evidence | Optional | LINKED_KEYCONFIRMED_DUPLICATE |
foldDecisions[].issueKey | string | Optional | |
foldDecisions[].decision | enum ReleaseFoldDecision.Decision | Optional | ACCEPTEDDISMISSED |
foldDecisions[].removal | enum ReleaseFoldDecision.Removal | Optional | REJECTEDEXCLUDED |
foldDecisions[].reason | string | Optional | |
foldDecisions[].deciderName | string | Optional | |
foldDecisions[].decidedAt | string (date-time) | Optional | |
foldDecisions[].addsBreaking | boolean | Optional | |
foldDecisions[].addsSecurity | boolean | Optional | |
missingNarratives | array of MissingNarrative | Optional | |
missingNarratives[].changeId | string (uuid) | Optional | |
missingNarratives[].reference | string | Optional | |
missingNarratives[].title | string | Optional | |
missingNarratives[].audienceNames | array of string | Optional | |
missingNarratives[].estimatedTokens | integer | Optional |
Errors
| Status | Code | Applies to |
|---|---|---|
400 | validation_faileda field is missing or out of range | Any endpoint |
400 | malformed_requestthe body cannot be read | Any endpoint |
400 | invalid_parametera path or query parameter is missing or does not convert, such as an ID that is not a UUID | Any endpoint |
401 | authentication_requiredno session | Any endpoint |
403 | access_deniedan administrator endpoint, or a missing or stale CSRF token | Any endpoint |
404 | not_foundno such address | Any endpoint |
405 | method_not_allowedthe address does not take that method | Any endpoint |
415 | unsupported_media_typethe address does not read a body of that type | Any endpoint |
500 | internal_errora fault ReleaseFlow did not foresee; the body never carries the exception behind it | Any endpoint |
400 | template_invalid | Audiences area |
400 | template_narratives_path | Audiences area |
400 | template_language_not_targeted | Audiences area |
400 | invalid_release_languages | Audiences area |
404 | audience_not_found | Audiences area |
409 | audience_code_taken | Audiences area |
409 | audience_limit | Audiences area |
409 | audience_last | Audiences area |
409 | audience_last_active | Audiences area |
409 | audience_already_retired | Audiences area |
409 | audience_not_retired | Audiences area |
409 | audience_in_use | Audiences area |
409 | audience_not_preset | Audiences area |
404 | glossary_term_not_found | Glossary area |
409 | glossary_term_taken | Glossary area |
409 | glossary_limit | Glossary area |
400 | invalid_release_schedule | Releases area |
400 | invalid_upgrade_guide_url | Releases area |
400 | invalid_previous_release | Releases area |
400 | invalid_fold_decision | Releases area |
404 | release_not_found | Releases area |
404 | release_note_not_found | Releases area |
404 | folding_suggestion_not_found | Releases area |
404 | linked_issue_not_found | Releases area |
409 | release_status_conflict | Releases area |
409 | release_published | Releases area |
409 | release_empty | Releases area |
409 | release_review_incomplete | Releases area |
409 | change_summary_required | Releases area |
409 | release_version_taken | Releases area |
409 | classification_changed | Releases area |
409 | change_not_releasable | Releases area |
409 | change_excluded | Releases area |
409 | release_note_render_failed | Releases area |
409 | release_notes_missing | Releases area |
409 | translations_not_ready | Releases area |
409 | linked_issue_status_changed | Releases area |
Request
bash
# Sign in first and keep the session cookie in cookies.txt (see Sessions and CSRF).
# CSRF_HEADER and CSRF_TOKEN are the headerName and token GET /api/csrf returned.
curl -X POST "http://localhost:8080/api/projects/$PROJECT_ID/releases" \
-b cookies.txt -c cookies.txt \
-H "$CSRF_HEADER: $CSRF_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"version": "<string>",
"summary": "<string>",
"upgradeGuideUrl": "<string>",
"previousReleaseId": "<uuid>",
"plannedReleaseAt": "<string>"
}'
The request body is an example built from the schema; replace every placeholder.
Response
201Example
{
"id": "<uuid>",
"projectId": "<uuid>",
"version": "<string>",
"summary": "<string>",
"status": "DRAFT",
"createdAt": "<date-time>",
"updatedAt": "<date-time>",
"plannedReleaseAt": "<date-time>",
"upgradeGuideUrl": "<string>",
"previousReleaseId": "<uuid>",
"previousVersion": "<string>",
"changes": [
{
"id": "<uuid>",
"pullRequestNumber": 0,
"title": "<string>",
"description": "<string>",
"authorLogin": "<string>",
"labels": [
"<string>"
],
"targetBranch": "<string>",
"mergeCommitSha": "<string>",
"mergedAt": "<date-time>",
"url": "<string>",
"category": "<string>",
"categoryName": "<string>",
"categoryGroup": "FEATURE",
"breaking": false,
"security": false,
"needsReview": false,
"reasons": [
"<string>"
],
"classificationSource": "RULES",
"aiStatus": "NOT_REQUESTED",
"aiModel": "<string>",
"aiFailure": "<string>",
"aiEligible": false,
"reviewedBy": "<uuid>",
"reviewerName": "<string>",
"reviewedAt": "<date-time>",
"processingStatus": "PROCESSING",
"changedFileStatus": "COLLECTED",
"linkedContextStatus": "NOT_SUPPORTED",
"linkedIssues": [
{}
],
"changedFiles": [
{}
],
"reviewTriggers": [
{}
],
"neutralSummary": {
"whatChanged": "<string>",
"whyChanged": "<string>",
"technicalDetail": "<string>",
"migrationStep": "<string>",
"migrationKind": "NONE",
"limitations": "<string>"
},
"contentLanguage": "<string>",
"aiProvider": "OPENAI",
"audienceNarrativeDetails": {
"<key>": {}
},
"summaryEditorName": "<string>",
"summaryEditedAt": "<date-time>",
"context": {
"score": 0,
"status": "SUFFICIENT",
"reasons": []
},
"sourceId": "<uuid>",
"origin": "WEBHOOK",
"sourceType": "GITHUB",
"exclusion": {
"excludedBy": "<uuid>",
"excluderName": "<string>",
"excludedAt": "<date-time>",
"reason": "<string>"
}
}
],
"decisions": [
{
"changeId": "<uuid>",
"action": "APPROVE",
"reviewerName": "<string>",
"note": "<string>",
"decidedAt": "<date-time>",
"foldedChangeId": "<uuid>"
}
],
"reviewedCount": 0,
"preview": [
{
"title": "<string>",
"items": [
{}
]
}
],
"approvedAt": "<date-time>",
"approverName": "<string>",
"publishedAt": "<date-time>",
"publisherName": "<string>",
"markdown": "<string>",
"notes": [
{
"id": "<uuid>",
"audienceId": "<uuid>",
"audienceCode": "<string>",
"audienceName": "<string>",
"language": "<string>",
"content": "<string>",
"autoRerender": false,
"lastEditorName": "<string>",
"updatedAt": "<date-time>",
"translationStatus": "READY",
"glossaryStatus": "NONE",
"glossaryReason": "<string>"
}
],
"glossaries": [
{
"language": "<string>",
"status": "NONE",
"reason": "<string>"
}
],
"linkedIssues": [
{
"tracker": "<string>",
"key": "<string>",
"title": "<string>",
"url": "<string>",
"changeReferences": [
"<string>"
],
"recordedStatus": "<string>",
"statusAtReview": "<string>",
"read": false,
"status": "<string>",
"open": false,
"accepted": false,
"accepterName": "<string>",
"acceptedAt": "<date-time>"
}
],
"linkedIssueRead": "<string>",
"foldingSuggestions": [
{
"trackerChangeId": "<uuid>",
"trackerReference": "<string>",
"trackerTitle": "<string>",
"codeChangeId": "<uuid>",
"codeReference": "<string>",
"codeTitle": "<string>",
"evidence": "LINKED_KEY",
"issueKey": "<string>",
"confirmedBy": "<string>",
"addsBreaking": false,
"addsSecurity": false
}
],
"foldDecisions": [
{
"trackerChangeId": "<uuid>",
"codeChangeId": "<uuid>",
"evidence": "LINKED_KEY",
"issueKey": "<string>",
"decision": "ACCEPTED",
"removal": "REJECTED",
"reason": "<string>",
"deciderName": "<string>",
"decidedAt": "<date-time>",
"addsBreaking": false,
"addsSecurity": false
}
],
"missingNarratives": [
{
"changeId": "<uuid>",
"reference": "<string>",
"title": "<string>",
"audienceNames": [
"<string>"
],
"estimatedTokens": 0
}
]
}