Available changes
GET
/api/projects/{projectId}/releases/{releaseId}/available-changesThành viên đã đăng nhậpChỉ đọc
Tham số đường dẫn
| Tên | Kiểu | Bắt buộc | Ghi chú |
|---|---|---|---|
projectId | string (uuid) | Bắt buộc | |
releaseId | string (uuid) | Bắt buộc |
Response
Thành công: 200
Một mảng ChangeView, mỗi phần tử gồm:
| 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 | 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 |
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 | template_invalid | Khu vực Audiences |
400 | template_narratives_path | Khu vực Audiences |
400 | template_language_not_targeted | Khu vực Audiences |
400 | invalid_release_languages | Khu vực Audiences |
404 | audience_not_found | Khu vực Audiences |
409 | audience_code_taken | Khu vực Audiences |
409 | audience_limit | Khu vực Audiences |
409 | audience_last | Khu vực Audiences |
409 | audience_last_active | Khu vực Audiences |
409 | audience_already_retired | Khu vực Audiences |
409 | audience_not_retired | Khu vực Audiences |
409 | audience_in_use | Khu vực Audiences |
409 | audience_not_preset | Khu vực Audiences |
404 | glossary_term_not_found | Khu vực Glossary |
409 | glossary_term_taken | Khu vực Glossary |
409 | glossary_limit | Khu vực Glossary |
400 | invalid_release_schedule | Khu vực Releases |
400 | invalid_upgrade_guide_url | Khu vực Releases |
400 | invalid_previous_release | Khu vực Releases |
400 | invalid_fold_decision | Khu vực Releases |
404 | release_not_found | Khu vực Releases |
404 | release_note_not_found | Khu vực Releases |
404 | folding_suggestion_not_found | Khu vực Releases |
404 | linked_issue_not_found | Khu vực Releases |
409 | release_status_conflict | Khu vực Releases |
409 | release_published | Khu vực Releases |
409 | release_empty | Khu vực Releases |
409 | release_review_incomplete | Khu vực Releases |
409 | change_summary_required | Khu vực Releases |
409 | release_version_taken | Khu vực Releases |
409 | classification_changed | Khu vực Releases |
409 | change_not_releasable | Khu vực Releases |
409 | change_excluded | Khu vực Releases |
409 | release_note_render_failed | Khu vực Releases |
409 | release_notes_missing | Khu vực Releases |
409 | translations_not_ready | Khu vực Releases |
409 | linked_issue_status_changed | Khu 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
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>"
}
}
]