Skip to main content

Available changes

GET/api/projects/{projectId}/releases/{releaseId}/available-changes
Signed-in memberRead-only

Read more: Folding a tracker change into its code changeSource: ReleaseApiController#availableChanges(opens in new tab)

Path parameters​

NameTypeRequiredNotes
projectIdstring (uuid)Required
releaseIdstring (uuid)Required

Response​

Success: 200

An array of ChangeView, each with:

FieldTypeRequiredNotes
idstring (uuid)Optional
pullRequestNumberintegerOptional
titlestringOptional
descriptionstringOptional
authorLoginstringOptional
labelsarray of stringOptional
targetBranchstringOptional
mergeCommitShastringOptional
mergedAtstring (date-time)Optional
urlstringOptional
categorystringOptional
categoryNamestringOptional
categoryGroupenum CategoryGroupOptionalFEATUREFIXPERFORMANCEDOCUMENTATIONMAINTENANCEOTHER
breakingbooleanOptional
securitybooleanOptional
needsReviewbooleanOptional
reasonsarray of stringOptional
classificationSourceenum ClassificationSourceOptionalRULESAISUGGESTIONHUMAN
aiStatusenum AiStatusOptionalNOT_REQUESTEDSUCCEEDEDFAILED
aiModelstringOptional
aiFailurestringOptional
aiEligiblebooleanOptional
reviewedBystring (uuid)Optional
reviewerNamestringOptional
reviewedAtstring (date-time)Optional
processingStatusenum ProcessingStatusOptionalPROCESSINGCOMPLETED
changedFileStatusenum ChangedFileStatusOptionalCOLLECTEDUNAVAILABLENOT_SUPPORTED
linkedContextStatusenum LinkedContextStatusOptionalNOT_SUPPORTEDNOT_CONFIGUREDNOT_FOUNDPARTIALUNAVAILABLECOLLECTED
linkedIssuesarray of LinkedIssueOptional
linkedIssues[].keystringOptional
linkedIssues[].titlestringOptional
linkedIssues[].descriptionstringOptional
linkedIssues[].typestringOptional
linkedIssues[].statusstringOptional
linkedIssues[].urlstringOptional
linkedIssues[].trackerstringOptional
linkedIssues[].statusCategorystringOptional
changedFilesarray of ChangedFileOptional
changedFiles[].pathstringOptional
changedFiles[].previousPathstringOptional
changedFiles[].kindenum ChangedFileKindOptionalADDEDMODIFIEDREMOVEDRENAMEDOTHER
reviewTriggersarray of ReviewTriggerOptional
reviewTriggers[].typeenum ReviewTriggerTypeOptionalSENSITIVE_PATHCHANGED_FILES_UNAVAILABLESENSITIVE_KEYWORDCLASSIFIER_FALLBACKCATEGORY_SUGGESTION_PENDINGCONTEXT_INSUFFICIENTLINKED_CONTEXT_UNAVAILABLEDUPLICATE_CANDIDATEMIGRATION_KIND_MISMATCH
reviewTriggers[].detailstringOptional
neutralSummaryNeutralSummaryOptional
neutralSummary.whatChangedstringOptional
neutralSummary.whyChangedstringOptional
neutralSummary.technicalDetailstringOptional
neutralSummary.migrationStepstringOptional
neutralSummary.migrationKindenum MigrationKindOptionalNONEREQUIREDCONDITIONALRECOMMENDEDUNSPECIFIED
neutralSummary.limitationsstringOptional
contentLanguagestringOptional
aiProviderenum AiProviderOptionalOPENAIANTHROPICDEEPSEEK
audienceNarrativeDetailsmap of AudienceNarrativeOptional
summaryEditorNamestringOptional
summaryEditedAtstring (date-time)Optional
contextContextAssessmentOptional
context.scoreintegerOptional
context.statusenum ContextStatusOptionalSUFFICIENTINSUFFICIENT
context.reasonsarray of stringOptional
sourceIdstring (uuid)Optional
originenum ChangeOriginOptionalWEBHOOKIMPORT
sourceTypeenum SourceTypeOptionalGITHUBGITLABLINEARJIRA
exclusionChangeExclusionOptional
exclusion.excludedBystring (uuid)Optional
exclusion.excluderNamestringOptional
exclusion.excludedAtstring (date-time)Optional
exclusion.reasonstringOptional

Errors​

StatusCodeApplies to
400validation_faileda field is missing or out of rangeAny endpoint
400invalid_parametera path or query parameter is missing or does not convert, such as an ID that is not a UUIDAny endpoint
401authentication_requiredno sessionAny endpoint
404not_foundno such addressAny endpoint
405method_not_allowedthe address does not take that methodAny endpoint
415unsupported_media_typethe address does not read a body of that typeAny endpoint
500internal_errora fault ReleaseFlow did not foresee; the body never carries the exception behind itAny endpoint
400template_invalidAudiences area
400template_narratives_pathAudiences area
400template_language_not_targetedAudiences area
400invalid_release_languagesAudiences area
404audience_not_foundAudiences area
409audience_code_takenAudiences area
409audience_limitAudiences area
409audience_lastAudiences area
409audience_last_activeAudiences area
409audience_already_retiredAudiences area
409audience_not_retiredAudiences area
409audience_in_useAudiences area
409audience_not_presetAudiences area
404glossary_term_not_foundGlossary area
409glossary_term_takenGlossary area
409glossary_limitGlossary area
400invalid_release_scheduleReleases area
400invalid_upgrade_guide_urlReleases area
400invalid_previous_releaseReleases area
400invalid_fold_decisionReleases area
404release_not_foundReleases area
404release_note_not_foundReleases area
404folding_suggestion_not_foundReleases area
404linked_issue_not_foundReleases area
409release_status_conflictReleases area
409release_publishedReleases area
409release_emptyReleases area
409release_review_incompleteReleases area
409change_summary_requiredReleases area
409release_version_takenReleases area
409classification_changedReleases area
409change_not_releasableReleases area
409change_excludedReleases area
409release_note_render_failedReleases area
409release_notes_missingReleases area
409translations_not_readyReleases area
409linked_issue_status_changedReleases area

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

Example

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