Review change
/api/projects/{projectId}/changes/{changeId}/reviewREST client gọi POST /api/projects/{projectId}/changes/{changeId}/review với phiên đăng nhập, CSRF token và {"category": "fix", "breaking": false, "security": true}. Category là một mã trong danh mục, không phân biệt hoa thường. Có thể bỏ security, như các client viết trước khi có nó: khi đó review xác nhận cờ mà thay đổi đang có, còn false tường minh sẽ gỡ cờ. Mọi thay đổi API trả về đều có security. Lời gọi trả về thay đổi đã cập nhật; 400 invalid_change_review cho unknown, một category đã lưu trữ, hoặc một mã không có trong danh mục; 400 validation_failed khi thiếu trường; và 404 change_not_found cho thay đổi của Organization khác.
Tham số đường dẫn
| Tên | Kiểu | Bắt buộc | Ghi chú |
|---|---|---|---|
projectId | string (uuid) | Bắt buộc | |
changeId | string (uuid) | Bắt buộc |
Request body
application/json
| Trường | Kiểu | Bắt buộc | Ghi chú |
|---|---|---|---|
category | string | Bắt buộc | |
breaking | boolean | Bắt buộc | |
security | boolean | Tùy chọn |
Response
Thành công: 200
| Trường | Kiểu | Bắt buộc | Ghi chú |
|---|---|---|---|
id | string (uuid) | Tùy chọn | |
pullRequestNumber | integer | Tùy chọn | |
title | string | Tùy chọn | |
description | string | Tùy chọn | |
authorLogin | string | Tùy chọn | |
labels | array of string | Tùy chọn | |
targetBranch | string | Tùy chọn | |
mergeCommitSha | string | Tùy chọn | |
mergedAt | string (date-time) | Tùy chọn | |
url | string | Tùy chọn | |
category | string | Tùy chọn | |
categoryName | string | Tùy chọn | |
categoryGroup | enum CategoryGroup | Tùy chọn | FEATUREFIXPERFORMANCEDOCUMENTATIONMAINTENANCEOTHER |
breaking | boolean | Tùy chọn | |
security | boolean | Tùy chọn | |
needsReview | boolean | Tùy chọn | |
reasons | array of string | Tùy chọn | |
classificationSource | enum ClassificationSource | Tùy chọn | RULESAISUGGESTIONHUMAN |
aiStatus | enum AiStatus | Tùy chọn | NOT_REQUESTEDSUCCEEDEDFAILED |
aiModel | string | Tùy chọn | |
aiFailure | string | Tùy chọn | |
aiEligible | boolean | Tùy chọn | |
reviewedBy | string (uuid) | Tùy chọn | |
reviewerName | string | Tùy chọn | |
reviewedAt | string (date-time) | Tùy chọn | |
processingStatus | enum ProcessingStatus | Tùy chọn | PROCESSINGCOMPLETED |
changedFileStatus | enum ChangedFileStatus | Tùy chọn | COLLECTEDUNAVAILABLENOT_SUPPORTED |
linkedContextStatus | enum LinkedContextStatus | Tùy chọn | NOT_SUPPORTEDNOT_CONFIGUREDNOT_FOUNDPARTIALUNAVAILABLECOLLECTED |
linkedIssues | array of LinkedIssue | Tùy chọn | |
linkedIssues[].key | string | Tùy chọn | |
linkedIssues[].title | string | Tùy chọn | |
linkedIssues[].description | string | Tùy chọn | |
linkedIssues[].type | string | Tùy chọn | |
linkedIssues[].status | string | Tùy chọn | |
linkedIssues[].url | string | Tùy chọn | |
linkedIssues[].tracker | string | Tùy chọn | |
linkedIssues[].statusCategory | string | Tùy chọn | |
changedFiles | array of ChangedFile | Tùy chọn | |
changedFiles[].path | string | Tùy chọn | |
changedFiles[].previousPath | string | Tùy chọn | |
changedFiles[].kind | enum ChangedFileKind | Tùy chọn | ADDEDMODIFIEDREMOVEDRENAMEDOTHER |
reviewTriggers | array of ReviewTrigger | Tùy chọn | |
reviewTriggers[].type | enum ReviewTriggerType | Tùy chọn | SENSITIVE_PATHCHANGED_FILES_UNAVAILABLESENSITIVE_KEYWORDCLASSIFIER_FALLBACKCATEGORY_SUGGESTION_PENDINGCONTEXT_INSUFFICIENTLINKED_CONTEXT_UNAVAILABLEDUPLICATE_CANDIDATEMIGRATION_KIND_MISMATCH |
reviewTriggers[].detail | string | Tùy chọn | |
neutralSummary | NeutralSummary | Tùy chọn | |
neutralSummary.whatChanged | string | Tùy chọn | |
neutralSummary.whyChanged | string | Tùy chọn | |
neutralSummary.technicalDetail | string | Tùy chọn | |
neutralSummary.migrationStep | string | Tùy chọn | |
neutralSummary.migrationKind | enum MigrationKind | Tùy chọn | NONEREQUIREDCONDITIONALRECOMMENDEDUNSPECIFIED |
neutralSummary.limitations | string | Tùy chọn | |
contentLanguage | string | Tùy chọn | |
aiProvider | enum AiProvider | Tùy chọn | OPENAIANTHROPICDEEPSEEK |
audienceNarrativeDetails | map of AudienceNarrative | Tùy chọn | |
summaryEditorName | string | Tùy chọn | |
summaryEditedAt | string (date-time) | Tùy chọn | |
context | ContextAssessment | Tùy chọn | |
context.score | integer | Tùy chọn | |
context.status | enum ContextStatus | Tùy chọn | SUFFICIENTINSUFFICIENT |
context.reasons | array of string | Tùy chọn | |
sourceId | string (uuid) | Tùy chọn | |
origin | enum ChangeOrigin | Tùy chọn | WEBHOOKIMPORT |
sourceType | enum SourceType | Tùy chọn | GITHUBGITLABLINEARJIRA |
exclusion | ChangeExclusion | Tùy chọn | |
exclusion.excludedBy | string (uuid) | Tùy chọn | |
exclusion.excluderName | string | Tùy chọn | |
exclusion.excludedAt | string (date-time) | Tùy chọn | |
exclusion.reason | string | Tùy chọn |
Lỗi
| Trạng thái | Mã | Áp dụng cho |
|---|---|---|
400 | validation_failedthiếu trường hoặc giá trị nằm ngoài khoảng cho phép | Mọi endpoint |
400 | malformed_requestkhông đọc được body | Mọi endpoint |
400 | invalid_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 UUID | Mọi endpoint |
401 | authentication_requiredchưa có phiên đăng nhập | Mọi endpoint |
403 | access_deniedendpoint dành cho quản trị viên, hoặc CSRF token thiếu hay đã cũ | Mọi endpoint |
404 | not_foundkhông có địa chỉ đó | Mọi endpoint |
405 | method_not_allowedđịa chỉ không nhận phương thức đó | Mọi endpoint |
415 | unsupported_media_typeđịa chỉ không đọc body thuộc kiểu đó | Mọi endpoint |
500 | internal_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 |
400 | invalid_change_filter | Khu vực Changes |
400 | invalid_change_review | Khu vực Changes |
400 | invalid_sensitive_paths | Khu vực Changes |
404 | change_not_found | Khu vực Changes |
404 | duplicate_candidate_not_found | Khu vực Changes |
409 | change_processing | Khu vực Changes |
409 | change_not_eligible_for_ai | Khu vực Changes |
409 | duplicate_candidate_decided | Khu vực Changes |
409 | change_excluded | Khu vực Changes |
409 | change_in_release | Khu vực Changes |
502 | ai_classification_failed | Khu vực Changes |
503 | ai_classification_unavailable | Khu vực Changes |
404 | category_not_found | Khu vực Categories |
404 | category_suggestion_not_found | Khu vực Categories |
409 | category_code_taken | Khu vực Categories |
409 | category_system | Khu vực Categories |
409 | category_suggestion_decided | Khu vực Categories |
Request
# 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/changes/$CHANGE_ID/review" \
-b cookies.txt -c cookies.txt \
-H "$CSRF_HEADER: $CSRF_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"category": "<string>",
"breaking": false,
"security": false
}'
Request body là ví dụ dựng từ schema; thay mọi giá trị giữ chỗ trước khi gửi.
Response
200Ví 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>"
}
}