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

List changes

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

Mở /changes để xem hộp thay đổi (Change Inbox) của một Project, hoặc gọi GET /api/projects/{projectId}/changes. Cả hai đều nhận category (một mã category như feature hoặc security, không phân biệt hoa thường), status (needs-review; classified cho những thay đổi được quy tắc quyết định mà không cần người; reviewed), và context=insufficient (xem Tín hiệu review). Một giá trị không phải mã hay trạng thái hợp lệ trả về 400 invalid_change_filter, và Project của Organization khác trả về 404 project_not_found. Mỗi thay đổi trả về mã category cùng categoryName và categoryGroup, đúng như lúc nó được phân loại.

Đọc thêm: Hộp thay đổiMã nguồn: ChangeApiController#list(mở trong thẻ mới)

Tham số đường dẫn​

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

Tham số truy vấn​

TênKiểuBắt buộcGhi chú
categorystringTùy chọn
statusstringTùy chọn
contextstringTùy chọn
releasestringTùy chọn

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
400invalid_change_filterKhu vực Changes
400invalid_change_reviewKhu vực Changes
400invalid_sensitive_pathsKhu vực Changes
404change_not_foundKhu vực Changes
404duplicate_candidate_not_foundKhu vực Changes
409change_processingKhu vực Changes
409change_not_eligible_for_aiKhu vực Changes
409duplicate_candidate_decidedKhu vực Changes
409change_excludedKhu vực Changes
409change_in_releaseKhu vực Changes
502ai_classification_failedKhu vực Changes
503ai_classification_unavailableKhu vực Changes
404category_not_foundKhu vực Categories
404category_suggestion_not_foundKhu vực Categories
409category_code_takenKhu vực Categories
409category_systemKhu vực Categories
409category_suggestion_decidedKhu vực Categories

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