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

Available changes

GET/api/projects/{projectId}/releases/{releaseId}/available-changes
Thành viên đã đăng nhậpChỉ đọc

Đọc thêm: Gộp thay đổi tracker vào thay đổi mãMã nguồn: ReleaseApiController#availableChanges(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

Một mảng ChangeView, mỗi phần tử gồm:

TrườngKiểuBắt buộcGhi chú
idstring (uuid)Tùy chọn
pullRequestNumberintegerTùy chọn
titlestringTùy chọn
descriptionstringTùy chọn
authorLoginstringTùy chọn
labelsarray of stringTùy chọn
targetBranchstringTùy chọn
mergeCommitShastringTùy chọn
mergedAtstring (date-time)Tùy chọn
urlstringTùy chọn
categorystringTùy chọn
categoryNamestringTùy chọn
categoryGroupenum CategoryGroupTùy chọnFEATUREFIXPERFORMANCEDOCUMENTATIONMAINTENANCEOTHER
breakingbooleanTùy chọn
securitybooleanTùy chọn
needsReviewbooleanTùy chọn
reasonsarray of stringTùy chọn
classificationSourceenum ClassificationSourceTùy chọnRULESAISUGGESTIONHUMAN
aiStatusenum AiStatusTùy chọnNOT_REQUESTEDSUCCEEDEDFAILED
aiModelstringTùy chọn
aiFailurestringTùy chọn
aiEligiblebooleanTùy chọn
reviewedBystring (uuid)Tùy chọn
reviewerNamestringTùy chọn
reviewedAtstring (date-time)Tùy chọn
processingStatusenum ProcessingStatusTùy chọnPROCESSINGCOMPLETED
changedFileStatusenum ChangedFileStatusTùy chọnCOLLECTEDUNAVAILABLENOT_SUPPORTED
linkedContextStatusenum LinkedContextStatusTùy chọnNOT_SUPPORTEDNOT_CONFIGUREDNOT_FOUNDPARTIALUNAVAILABLECOLLECTED
linkedIssuesarray of LinkedIssueTùy chọn
linkedIssues[].keystringTùy chọn
linkedIssues[].titlestringTùy chọn
linkedIssues[].descriptionstringTùy chọn
linkedIssues[].typestringTùy chọn
linkedIssues[].statusstringTùy chọn
linkedIssues[].urlstringTùy chọn
linkedIssues[].trackerstringTùy chọn
linkedIssues[].statusCategorystringTùy chọn
changedFilesarray of ChangedFileTùy chọn
changedFiles[].pathstringTùy chọn
changedFiles[].previousPathstringTùy chọn
changedFiles[].kindenum ChangedFileKindTùy chọnADDEDMODIFIEDREMOVEDRENAMEDOTHER
reviewTriggersarray of ReviewTriggerTùy chọn
reviewTriggers[].typeenum ReviewTriggerTypeTùy chọnSENSITIVE_PATHCHANGED_FILES_UNAVAILABLESENSITIVE_KEYWORDCLASSIFIER_FALLBACKCATEGORY_SUGGESTION_PENDINGCONTEXT_INSUFFICIENTLINKED_CONTEXT_UNAVAILABLEDUPLICATE_CANDIDATEMIGRATION_KIND_MISMATCH
reviewTriggers[].detailstringTùy chọn
neutralSummaryNeutralSummaryTùy chọn
neutralSummary.whatChangedstringTùy chọn
neutralSummary.whyChangedstringTùy chọn
neutralSummary.technicalDetailstringTùy chọn
neutralSummary.migrationStepstringTùy chọn
neutralSummary.migrationKindenum MigrationKindTùy chọnNONEREQUIREDCONDITIONALRECOMMENDEDUNSPECIFIED
neutralSummary.limitationsstringTùy chọn
contentLanguagestringTùy chọn
aiProviderenum AiProviderTùy chọnOPENAIANTHROPICDEEPSEEK
audienceNarrativeDetailsmap of AudienceNarrativeTùy chọn
summaryEditorNamestringTùy chọn
summaryEditedAtstring (date-time)Tùy chọn
contextContextAssessmentTùy chọn
context.scoreintegerTùy chọn
context.statusenum ContextStatusTùy chọnSUFFICIENTINSUFFICIENT
context.reasonsarray of stringTùy chọn
sourceIdstring (uuid)Tùy chọn
originenum ChangeOriginTùy chọnWEBHOOKIMPORT
sourceTypeenum SourceTypeTùy chọnGITHUBGITLABLINEARJIRA
exclusionChangeExclusionTùy chọn
exclusion.excludedBystring (uuid)Tùy chọn
exclusion.excluderNamestringTùy chọn
exclusion.excludedAtstring (date-time)Tùy chọn
exclusion.reasonstringTù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
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).
curl "http://localhost:8080/api/projects/$PROJECT_ID/releases/$RELEASE_ID/available-changes" \
-b cookies.txt -c cookies.txt

Response

200

Ví dụ

[
  {
    "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": [
      {
        "key": "<string>",
        "title": "<string>",
        "description": "<string>",
        "type": "<string>",
        "status": "<string>",
        "url": "<string>",
        "tracker": "<string>",
        "statusCategory": "<string>"
      }
    ],
    "changedFiles": [
      {
        "path": "<string>",
        "previousPath": "<string>",
        "kind": "ADDED"
      }
    ],
    "reviewTriggers": [
      {
        "type": "SENSITIVE_PATH",
        "detail": "<string>"
      }
    ],
    "neutralSummary": {
      "whatChanged": "<string>",
      "whyChanged": "<string>",
      "technicalDetail": "<string>",
      "migrationStep": "<string>",
      "migrationKind": "NONE",
      "limitations": "<string>"
    },
    "contentLanguage": "<string>",
    "aiProvider": "OPENAI",
    "audienceNarrativeDetails": {
      "<key>": {
        "relevance": "NONE",
        "headline": "<string>",
        "body": "<string>"
      }
    },
    "summaryEditorName": "<string>",
    "summaryEditedAt": "<date-time>",
    "context": {
      "score": 0,
      "status": "SUFFICIENT",
      "reasons": [
        "<string>"
      ]
    },
    "sourceId": "<uuid>",
    "origin": "WEBHOOK",
    "sourceType": "GITHUB",
    "exclusion": {
      "excludedBy": "<uuid>",
      "excluderName": "<string>",
      "excludedAt": "<date-time>",
      "reason": "<string>"
    }
  }
]