release

Update step run approval

Update the metadata or screenshots approval status of a specific step run in a release.

put/app/{appId}/release/{releaseId}/stepRun/{stepRunId}/approval

Request

  • Base URL
    https://api.runway.team
  • URL
    https://api.runway.team/app/{appId}/release/{releaseId}/stepRun/{stepRunId}/approval
  • Auth
    API key in header X-API-Key

Path parameters

appIdstring required

The id of the app

releaseIdstring required

The id of the release. Constructed from the app's id and the release version like so: {appId}:{version}. For the GET single release endpoint, the following keywords are also accepted: live (latest completed release), next or current (current active release).

stepRunIdstring required

The id of the step run

Request body

isApprovedboolean required

The updated approval status of the metadata or screenshots for the release

Response

A release step response

stepIdunknown
type'kickoff' | 'featureReadiness' | 'releaseCandidate' | 'regressionTesting' | 'betaTesting' | 'metadata' | 'screenshots' | 'approvals' | 'submission' | 'storeReview' | 'takeoff' | 'ciDistribution' required

The type of release step

displayNamestring required

The display name of the step

status'ready' | 'pending' | 'pendingChecklist' | 'blocked' | 'inactive' required

The status of a release step

statusReasonStringstring required

The user-friendly description of the reason for the status of the step

Example response

{
  "data": {
    "approvalItems": [
      {
        "title": "Gather new release notes",
        "description": "Contact sully@demo.com on the copywriting team to get new release notes together.",
        "oneOffForVersion": "1.1.0",
        "status": {
          "createdAt": "2022-03-02T01:15:00Z"
        }
      }
    ]
  },
  "checklistItems": [
    {
      "title": "Gather new release notes",
      "description": "Contact sully@demo.com on the copywriting team to get new release notes together.",
      "oneOffForVersion": "1.1.0",
      "status": {
        "createdAt": "2022-03-02T01:15:00Z"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.