Chuyển tới nội dung chính

Publish release

POST/api/projects/{projectId}/releases/{releaseId}/publish
Thành viên đã đăng nhập

REST client gọi POST /api/projects/{projectId}/releases/{releaseId}/publish. Lời gọi trả về release với status, publishedAt, publisherName và notes. Trước khi publish, preview nhóm các thay đổi hiện có của release vào các section của release note; sau khi publish, preview rỗng và các release note nằm trong notes. markdown là null, trừ release được publish trước Flyway V13. Publish một release chưa duyệt trả về 409 release_status_conflict; mọi thao tác trên một release đã publish trả về 409 release_published.

Đọc thêm: PublishMã nguồn: ReleaseApiController#publish(mở trong thẻ mới)

Tham số đường dẫn​

TênKiểuBắt buộcGhi chú
projectIdstring (uuid)Bắt buộc
releaseIdstring (uuid)Bắt buộc

Response​

Thành công: 200

TrườngKiểuBắt buộcGhi chú
idstring (uuid)Tùy chọn
projectIdstring (uuid)Tùy chọn
versionstringTùy chọn
summarystringTùy chọn
statusenum ReleaseStatusTùy chọnDRAFTIN_REVIEWAPPROVEDPUBLISHED
createdAtstring (date-time)Tùy chọn
updatedAtstring (date-time)Tùy chọn
plannedReleaseAtstring (date-time)Tùy chọn
upgradeGuideUrlstringTùy chọn
previousReleaseIdstring (uuid)Tùy chọn
previousVersionstringTùy chọn
changesarray of ChangeViewTùy chọn
changes[].idstring (uuid)Tùy chọn
changes[].pullRequestNumberintegerTùy chọn
changes[].titlestringTùy chọn
changes[].descriptionstringTùy chọn
changes[].authorLoginstringTùy chọn
changes[].labelsarray of stringTùy chọn
changes[].targetBranchstringTùy chọn
changes[].mergeCommitShastringTùy chọn
changes[].mergedAtstring (date-time)Tùy chọn
changes[].urlstringTùy chọn
changes[].categorystringTùy chọn
changes[].categoryNamestringTùy chọn
changes[].categoryGroupenum CategoryGroupTùy chọnFEATUREFIXPERFORMANCEDOCUMENTATIONMAINTENANCEOTHER
changes[].breakingbooleanTùy chọn
changes[].securitybooleanTùy chọn
changes[].needsReviewbooleanTùy chọn
changes[].reasonsarray of stringTùy chọn
changes[].classificationSourceenum ClassificationSourceTùy chọnRULESAISUGGESTIONHUMAN
changes[].aiStatusenum AiStatusTùy chọnNOT_REQUESTEDSUCCEEDEDFAILED
changes[].aiModelstringTùy chọn
changes[].aiFailurestringTùy chọn
changes[].aiEligiblebooleanTùy chọn
changes[].reviewedBystring (uuid)Tùy chọn
changes[].reviewerNamestringTùy chọn
changes[].reviewedAtstring (date-time)Tùy chọn
changes[].processingStatusenum ProcessingStatusTùy chọnPROCESSINGCOMPLETED
changes[].changedFileStatusenum ChangedFileStatusTùy chọnCOLLECTEDUNAVAILABLENOT_SUPPORTED
changes[].linkedContextStatusenum LinkedContextStatusTùy chọnNOT_SUPPORTEDNOT_CONFIGUREDNOT_FOUNDPARTIALUNAVAILABLECOLLECTED
changes[].linkedIssuesarray of LinkedIssueTùy chọn
changes[].changedFilesarray of ChangedFileTùy chọn
changes[].reviewTriggersarray of ReviewTriggerTùy chọn
changes[].neutralSummaryNeutralSummaryTùy chọn
changes[].contentLanguagestringTùy chọn
changes[].aiProviderenum AiProviderTùy chọnOPENAIANTHROPICDEEPSEEK
changes[].audienceNarrativeDetailsmap of AudienceNarrativeTùy chọn
changes[].summaryEditorNamestringTùy chọn
changes[].summaryEditedAtstring (date-time)Tùy chọn
changes[].contextContextAssessmentTùy chọn
changes[].sourceIdstring (uuid)Tùy chọn
changes[].originenum ChangeOriginTùy chọnWEBHOOKIMPORT
changes[].sourceTypeenum SourceTypeTùy chọnGITHUBGITLABLINEARJIRA
changes[].exclusionChangeExclusionTùy chọn
decisionsarray of ReleaseDecisionViewTùy chọn
decisions[].changeIdstring (uuid)Tùy chọn
decisions[].actionenum ReviewActionTùy chọnAPPROVEEDIT
decisions[].reviewerNamestringTùy chọn
decisions[].notestringTùy chọn
decisions[].decidedAtstring (date-time)Tùy chọn
decisions[].foldedChangeIdstring (uuid)Tùy chọn
reviewedCountintegerTùy chọn
previewarray of ReleaseNoteSectionTùy chọn
preview[].titlestringTùy chọn
preview[].itemsarray of ReleaseNoteItemTùy chọn
approvedAtstring (date-time)Tùy chọn
approverNamestringTùy chọn
publishedAtstring (date-time)Tùy chọn
publisherNamestringTùy chọn
markdownstringTùy chọn
notesarray of AudienceNoteViewTùy chọn
notes[].idstring (uuid)Tùy chọn
notes[].audienceIdstring (uuid)Tùy chọn
notes[].audienceCodestringTùy chọn
notes[].audienceNamestringTùy chọn
notes[].languagestringTùy chọn
notes[].contentstringTùy chọn
notes[].autoRerenderbooleanTùy chọn
notes[].lastEditorNamestringTùy chọn
notes[].updatedAtstring (date-time)Tùy chọn
notes[].translationStatusenum TranslationState.StatusTùy chọnREADYPENDINGFAILED
notes[].glossaryStatusenum GlossaryUse.StatusTùy chọnNONEPENDINGAPPLIEDNOT_APPLIED
notes[].glossaryReasonstringTùy chọn
glossariesarray of ReleaseGlossaryViewTùy chọn
glossaries[].languagestringTùy chọn
glossaries[].statusenum GlossaryUse.StatusTùy chọnNONEPENDINGAPPLIEDNOT_APPLIED
glossaries[].reasonstringTùy chọn
linkedIssuesarray of LinkedIssueStatusViewTùy chọn
linkedIssues[].trackerstringTùy chọn
linkedIssues[].keystringTùy chọn
linkedIssues[].titlestringTùy chọn
linkedIssues[].urlstringTùy chọn
linkedIssues[].changeReferencesarray of stringTùy chọn
linkedIssues[].recordedStatusstringTùy chọn
linkedIssues[].statusAtReviewstringTùy chọn
linkedIssues[].readbooleanTùy chọn
linkedIssues[].statusstringTùy chọn
linkedIssues[].openbooleanTùy chọn
linkedIssues[].acceptedbooleanTùy chọn
linkedIssues[].accepterNamestringTùy chọn
linkedIssues[].acceptedAtstring (date-time)Tùy chọn
linkedIssueReadstringTùy chọn
foldingSuggestionsarray of FoldingSuggestionTùy chọn
foldingSuggestions[].trackerChangeIdstring (uuid)Tùy chọn
foldingSuggestions[].trackerReferencestringTùy chọn
foldingSuggestions[].trackerTitlestringTùy chọn
foldingSuggestions[].codeChangeIdstring (uuid)Tùy chọn
foldingSuggestions[].codeReferencestringTùy chọn
foldingSuggestions[].codeTitlestringTùy chọn
foldingSuggestions[].evidenceenum ReleaseFoldDecision.EvidenceTùy chọnLINKED_KEYCONFIRMED_DUPLICATE
foldingSuggestions[].issueKeystringTùy chọn
foldingSuggestions[].confirmedBystringTùy chọn
foldingSuggestions[].addsBreakingbooleanTùy chọn
foldingSuggestions[].addsSecuritybooleanTùy chọn
foldDecisionsarray of FoldDecisionViewTùy chọn
foldDecisions[].trackerChangeIdstring (uuid)Tùy chọn
foldDecisions[].codeChangeIdstring (uuid)Tùy chọn
foldDecisions[].evidenceenum ReleaseFoldDecision.EvidenceTùy chọnLINKED_KEYCONFIRMED_DUPLICATE
foldDecisions[].issueKeystringTùy chọn
foldDecisions[].decisionenum ReleaseFoldDecision.DecisionTùy chọnACCEPTEDDISMISSED
foldDecisions[].removalenum ReleaseFoldDecision.RemovalTùy chọnREJECTEDEXCLUDED
foldDecisions[].reasonstringTùy chọn
foldDecisions[].deciderNamestringTùy chọn
foldDecisions[].decidedAtstring (date-time)Tùy chọn
foldDecisions[].addsBreakingbooleanTùy chọn
foldDecisions[].addsSecuritybooleanTùy chọn
missingNarrativesarray of MissingNarrativeTùy chọn
missingNarratives[].changeIdstring (uuid)Tùy chọn
missingNarratives[].referencestringTùy chọn
missingNarratives[].titlestringTùy chọn
missingNarratives[].audienceNamesarray of stringTùy chọn
missingNarratives[].estimatedTokensintegerTùy chọn

Lỗi​

Trạng tháiMãÁp dụng cho
400validation_failedthiếu trường hoặc giá trị nằm ngoài khoảng cho phépMọi endpoint
400invalid_parametermột tham số trên đường dẫn hoặc query bị thiếu hoặc không chuyển đổi được, chẳng hạn một ID không phải UUIDMọi endpoint
401authentication_requiredchưa có phiên đăng nhậpMọi endpoint
403access_deniedendpoint dành cho quản trị viên, hoặc CSRF token thiếu hay đã cũMọi endpoint
404not_foundkhông có địa chỉ đóMọi endpoint
405method_not_allowedđịa chỉ không nhận phương thức đóMọi endpoint
415unsupported_media_typeđịa chỉ không đọc body thuộc kiểu đóMọi endpoint
500internal_errormột lỗi ReleaseFlow không lường trước; body không bao giờ chứa exception gây ra nóMọi endpoint
400template_invalidKhu vực Audiences
400template_narratives_pathKhu vực Audiences
400template_language_not_targetedKhu vực Audiences
400invalid_release_languagesKhu vực Audiences
404audience_not_foundKhu vực Audiences
409audience_code_takenKhu vực Audiences
409audience_limitKhu vực Audiences
409audience_lastKhu vực Audiences
409audience_last_activeKhu vực Audiences
409audience_already_retiredKhu vực Audiences
409audience_not_retiredKhu vực Audiences
409audience_in_useKhu vực Audiences
409audience_not_presetKhu vực Audiences
404glossary_term_not_foundKhu vực Glossary
409glossary_term_takenKhu vực Glossary
409glossary_limitKhu vực Glossary
400invalid_release_scheduleKhu vực Releases
400invalid_upgrade_guide_urlKhu vực Releases
400invalid_previous_releaseKhu vực Releases
400invalid_fold_decisionKhu vực Releases
404release_not_foundKhu vực Releases
404release_note_not_foundKhu vực Releases
404folding_suggestion_not_foundKhu vực Releases
404linked_issue_not_foundKhu vực Releases
409release_status_conflictKhu vực Releases
409release_publishedKhu vực Releases
409release_emptyKhu vực Releases
409release_review_incompleteKhu vực Releases
409change_summary_requiredKhu vực Releases
409release_version_takenKhu vực Releases
409classification_changedKhu vực Releases
409change_not_releasableKhu vực Releases
409change_excludedKhu vực Releases
409release_note_render_failedKhu vực Releases
409release_notes_missingKhu vực Releases
409translations_not_readyKhu vực Releases
409linked_issue_status_changedKhu vực Releases

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/publish" \
-b cookies.txt -c cookies.txt \
-H "$CSRF_HEADER: $CSRF_TOKEN"

Response

200

Ví dụ

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