Skip to main content

Approve release

POST/api/projects/{projectId}/releases/{releaseId}/approve
Signed-in member

Read more: Folding a tracker change into its code changeSource: ReleaseApiController#approve(opens in new tab)

Path parameters​

NameTypeRequiredNotes
projectIdstring (uuid)Required
releaseIdstring (uuid)Required

Response​

Success: 200

FieldTypeRequiredNotes
idstring (uuid)Optional
projectIdstring (uuid)Optional
versionstringOptional
summarystringOptional
statusenum ReleaseStatusOptionalDRAFTIN_REVIEWAPPROVEDPUBLISHED
createdAtstring (date-time)Optional
updatedAtstring (date-time)Optional
plannedReleaseAtstring (date-time)Optional
upgradeGuideUrlstringOptional
previousReleaseIdstring (uuid)Optional
previousVersionstringOptional
changesarray of ChangeViewOptional
changes[].idstring (uuid)Optional
changes[].pullRequestNumberintegerOptional
changes[].titlestringOptional
changes[].descriptionstringOptional
changes[].authorLoginstringOptional
changes[].labelsarray of stringOptional
changes[].targetBranchstringOptional
changes[].mergeCommitShastringOptional
changes[].mergedAtstring (date-time)Optional
changes[].urlstringOptional
changes[].categorystringOptional
changes[].categoryNamestringOptional
changes[].categoryGroupenum CategoryGroupOptionalFEATUREFIXPERFORMANCEDOCUMENTATIONMAINTENANCEOTHER
changes[].breakingbooleanOptional
changes[].securitybooleanOptional
changes[].needsReviewbooleanOptional
changes[].reasonsarray of stringOptional
changes[].classificationSourceenum ClassificationSourceOptionalRULESAISUGGESTIONHUMAN
changes[].aiStatusenum AiStatusOptionalNOT_REQUESTEDSUCCEEDEDFAILED
changes[].aiModelstringOptional
changes[].aiFailurestringOptional
changes[].aiEligiblebooleanOptional
changes[].reviewedBystring (uuid)Optional
changes[].reviewerNamestringOptional
changes[].reviewedAtstring (date-time)Optional
changes[].processingStatusenum ProcessingStatusOptionalPROCESSINGCOMPLETED
changes[].changedFileStatusenum ChangedFileStatusOptionalCOLLECTEDUNAVAILABLENOT_SUPPORTED
changes[].linkedContextStatusenum LinkedContextStatusOptionalNOT_SUPPORTEDNOT_CONFIGUREDNOT_FOUNDPARTIALUNAVAILABLECOLLECTED
changes[].linkedIssuesarray of LinkedIssueOptional
changes[].changedFilesarray of ChangedFileOptional
changes[].reviewTriggersarray of ReviewTriggerOptional
changes[].neutralSummaryNeutralSummaryOptional
changes[].contentLanguagestringOptional
changes[].aiProviderenum AiProviderOptionalOPENAIANTHROPICDEEPSEEK
changes[].audienceNarrativeDetailsmap of AudienceNarrativeOptional
changes[].summaryEditorNamestringOptional
changes[].summaryEditedAtstring (date-time)Optional
changes[].contextContextAssessmentOptional
changes[].sourceIdstring (uuid)Optional
changes[].originenum ChangeOriginOptionalWEBHOOKIMPORT
changes[].sourceTypeenum SourceTypeOptionalGITHUBGITLABLINEARJIRA
changes[].exclusionChangeExclusionOptional
decisionsarray of ReleaseDecisionViewOptional
decisions[].changeIdstring (uuid)Optional
decisions[].actionenum ReviewActionOptionalAPPROVEEDIT
decisions[].reviewerNamestringOptional
decisions[].notestringOptional
decisions[].decidedAtstring (date-time)Optional
decisions[].foldedChangeIdstring (uuid)Optional
reviewedCountintegerOptional
previewarray of ReleaseNoteSectionOptional
preview[].titlestringOptional
preview[].itemsarray of ReleaseNoteItemOptional
approvedAtstring (date-time)Optional
approverNamestringOptional
publishedAtstring (date-time)Optional
publisherNamestringOptional
markdownstringOptional
notesarray of AudienceNoteViewOptional
notes[].idstring (uuid)Optional
notes[].audienceIdstring (uuid)Optional
notes[].audienceCodestringOptional
notes[].audienceNamestringOptional
notes[].languagestringOptional
notes[].contentstringOptional
notes[].autoRerenderbooleanOptional
notes[].lastEditorNamestringOptional
notes[].updatedAtstring (date-time)Optional
notes[].translationStatusenum TranslationState.StatusOptionalREADYPENDINGFAILED
notes[].glossaryStatusenum GlossaryUse.StatusOptionalNONEPENDINGAPPLIEDNOT_APPLIED
notes[].glossaryReasonstringOptional
glossariesarray of ReleaseGlossaryViewOptional
glossaries[].languagestringOptional
glossaries[].statusenum GlossaryUse.StatusOptionalNONEPENDINGAPPLIEDNOT_APPLIED
glossaries[].reasonstringOptional
linkedIssuesarray of LinkedIssueStatusViewOptional
linkedIssues[].trackerstringOptional
linkedIssues[].keystringOptional
linkedIssues[].titlestringOptional
linkedIssues[].urlstringOptional
linkedIssues[].changeReferencesarray of stringOptional
linkedIssues[].recordedStatusstringOptional
linkedIssues[].statusAtReviewstringOptional
linkedIssues[].readbooleanOptional
linkedIssues[].statusstringOptional
linkedIssues[].openbooleanOptional
linkedIssues[].acceptedbooleanOptional
linkedIssues[].accepterNamestringOptional
linkedIssues[].acceptedAtstring (date-time)Optional
linkedIssueReadstringOptional
foldingSuggestionsarray of FoldingSuggestionOptional
foldingSuggestions[].trackerChangeIdstring (uuid)Optional
foldingSuggestions[].trackerReferencestringOptional
foldingSuggestions[].trackerTitlestringOptional
foldingSuggestions[].codeChangeIdstring (uuid)Optional
foldingSuggestions[].codeReferencestringOptional
foldingSuggestions[].codeTitlestringOptional
foldingSuggestions[].evidenceenum ReleaseFoldDecision.EvidenceOptionalLINKED_KEYCONFIRMED_DUPLICATE
foldingSuggestions[].issueKeystringOptional
foldingSuggestions[].confirmedBystringOptional
foldingSuggestions[].addsBreakingbooleanOptional
foldingSuggestions[].addsSecuritybooleanOptional
foldDecisionsarray of FoldDecisionViewOptional
foldDecisions[].trackerChangeIdstring (uuid)Optional
foldDecisions[].codeChangeIdstring (uuid)Optional
foldDecisions[].evidenceenum ReleaseFoldDecision.EvidenceOptionalLINKED_KEYCONFIRMED_DUPLICATE
foldDecisions[].issueKeystringOptional
foldDecisions[].decisionenum ReleaseFoldDecision.DecisionOptionalACCEPTEDDISMISSED
foldDecisions[].removalenum ReleaseFoldDecision.RemovalOptionalREJECTEDEXCLUDED
foldDecisions[].reasonstringOptional
foldDecisions[].deciderNamestringOptional
foldDecisions[].decidedAtstring (date-time)Optional
foldDecisions[].addsBreakingbooleanOptional
foldDecisions[].addsSecuritybooleanOptional
missingNarrativesarray of MissingNarrativeOptional
missingNarratives[].changeIdstring (uuid)Optional
missingNarratives[].referencestringOptional
missingNarratives[].titlestringOptional
missingNarratives[].audienceNamesarray of stringOptional
missingNarratives[].estimatedTokensintegerOptional

Errors​

StatusCodeApplies to
400validation_faileda field is missing or out of rangeAny endpoint
400invalid_parametera path or query parameter is missing or does not convert, such as an ID that is not a UUIDAny endpoint
401authentication_requiredno sessionAny endpoint
403access_deniedan administrator endpoint, or a missing or stale CSRF tokenAny endpoint
404not_foundno such addressAny endpoint
405method_not_allowedthe address does not take that methodAny endpoint
415unsupported_media_typethe address does not read a body of that typeAny endpoint
500internal_errora fault ReleaseFlow did not foresee; the body never carries the exception behind itAny endpoint
400template_invalidAudiences area
400template_narratives_pathAudiences area
400template_language_not_targetedAudiences area
400invalid_release_languagesAudiences area
404audience_not_foundAudiences area
409audience_code_takenAudiences area
409audience_limitAudiences area
409audience_lastAudiences area
409audience_last_activeAudiences area
409audience_already_retiredAudiences area
409audience_not_retiredAudiences area
409audience_in_useAudiences area
409audience_not_presetAudiences area
404glossary_term_not_foundGlossary area
409glossary_term_takenGlossary area
409glossary_limitGlossary area
400invalid_release_scheduleReleases area
400invalid_upgrade_guide_urlReleases area
400invalid_previous_releaseReleases area
400invalid_fold_decisionReleases area
404release_not_foundReleases area
404release_note_not_foundReleases area
404folding_suggestion_not_foundReleases area
404linked_issue_not_foundReleases area
409release_status_conflictReleases area
409release_publishedReleases area
409release_emptyReleases area
409release_review_incompleteReleases area
409change_summary_requiredReleases area
409release_version_takenReleases area
409classification_changedReleases area
409change_not_releasableReleases area
409change_excludedReleases area
409release_note_render_failedReleases area
409release_notes_missingReleases area
409translations_not_readyReleases area
409linked_issue_status_changedReleases 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/$RELEASE_ID/approve" \
-b cookies.txt -c cookies.txt \
-H "$CSRF_HEADER: $CSRF_TOKEN"

Response

200

Example

{
  "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
    }
  ]
}