RUrunway
release

Search Feature Readiness items

Search the Feature Readiness work items on a release by keyword. Returns only items whose ticket identifier, ticket description, PR/commit title or message, author, or branch name contain the query string (case-insensitive). Returns an empty array when nothing matches. Use this instead of fetching the full featureReadiness step when you need to find items matching a specific ticket, author, or keyword.

get/app/{appId}/release/{releaseId}/featureReadiness/search

Request

  • Base URL
    https://api.runway.team
  • URL
    https://api.runway.team/app/{appId}/release/{releaseId}/featureReadiness/search
  • 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).

Query parameters

querystring required

Case-insensitive substring to search for. Matched against ticket identifier, ticket description, PR/commit title or message, author, and branch name.

Response

Paginated search results for Feature Readiness items

hasMoreboolean required

Whether more results exist beyond the current page

totalinteger required

Total number of matching items across all pages

Example response

{
  "items": [
    {
      "code": {
        "createdAt": "2022-03-02T01:15:00Z",
        "updatedAt": "2022-03-02T01:15:00Z"
      }
    }
  ]
}

Changes

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