# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Jira Cloud platform REST Status API
  version: 1.0.0
extends: openapi/jira-status-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/rest/api/3/statuses'].get
  update:
    x-apievangelist-phrasing:
      intent: Get statuses by ID
      effect: read
      questions:
      - How do I look up several workflow statuses by their IDs?
      - Can I fetch status details for a list of status IDs in one call?
      instructions:
      - text: Get statuses {id}.
        slots:
          id: query.id
      - text: Show the details of status IDs {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/statuses'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk update statuses
      effect: write
      questions:
      - How do I rename several workflow statuses at once?
      - Can I change the category of existing statuses in bulk?
      instructions:
      - text: 'Update these existing statuses: {statuses}.'
        slots:
          statuses: requestBody.statuses
      - text: Bulk edit the names and categories of statuses {statuses}.
        slots:
          statuses: requestBody.statuses
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/statuses'].post
  update:
    x-apievangelist-phrasing:
      intent: Create statuses globally or for a project
      effect: write
      questions:
      - How do I add new workflow statuses for one project only?
      - Can I create global statuses in bulk?
      instructions:
      - text: Create statuses {statuses} with scope {scope}.
        slots:
          statuses: requestBody.statuses
          scope: requestBody.scope
      - text: Add new statuses {statuses} scoped to {scope}.
        slots:
          statuses: requestBody.statuses
          scope: requestBody.scope
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/statuses'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete statuses
      effect: destructive
      questions:
      - How do I delete workflow statuses I no longer need?
      - Can I remove several statuses by ID in one request?
      instructions:
      - text: Delete statuses {id}.
        slots:
          id: query.id
      - text: Permanently remove status IDs {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/statuses/byNames'].get
  update:
    x-apievangelist-phrasing:
      intent: Get statuses by name
      effect: read
      questions:
      - How do I find a status's ID when I only know its name?
      - Can I look up statuses by name within a single project?
      instructions:
      - text: Get the statuses named {name}.
        slots:
          name: query.name
      - text: Look up statuses {name} in project {projectId}.
        slots:
          name: query.name
          projectId: query.projectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/statuses/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search statuses by name, project or category
      effect: read
      questions:
      - Which statuses are in the Done category?
      - Can I search statuses by partial name with paging?
      - What statuses does a project use, with or without global ones included?
      instructions:
      - text: Search statuses matching {searchString}.
        slots:
          searchString: query.searchString
      - text: List statuses in category {statusCategory} for project {projectId}.
        slots:
          statusCategory: query.statusCategory
          projectId: query.projectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/statuses/{statusId}/project/{projectId}/issueTypeUsages'].get
  update:
    x-apievangelist-phrasing:
      intent: List issue types using a status in a project
      effect: read
      questions:
      - Which issue types in a project use a given status?
      - Can I check whether a status is used by any issue type in my project?
      instructions:
      - text: List issue types in project {projectId} that use status {statusId}.
        slots:
          projectId: path.projectId
          statusId: path.statusId
      - text: Show where status {statusId} appears across issue types of project {projectId}.
        slots:
          statusId: path.statusId
          projectId: path.projectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/statuses/{statusId}/projectUsages'].get
  update:
    x-apievangelist-phrasing:
      intent: List projects using a status
      effect: read
      questions:
      - Which projects use a particular status?
      - Is a status still used by any project before I delete it?
      instructions:
      - text: List the projects using status {statusId}.
        slots:
          statusId: path.statusId
      - text: Show the next {maxResults} projects that use status {statusId}.
        slots:
          maxResults: query.maxResults
          statusId: path.statusId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/statuses/{statusId}/workflowUsages'].get
  update:
    x-apievangelist-phrasing:
      intent: List workflows using a status
      effect: read
      questions:
      - Which workflows include a given status?
      - Can I see all workflows a status appears in, page by page?
      instructions:
      - text: List the workflows that use status {statusId}.
        slots:
          statusId: path.statusId
      - text: Show workflows containing status {statusId}, continuing from cursor {nextPageToken}.
        slots:
          statusId: path.statusId
          nextPageToken: query.nextPageToken
      method: generated
      generated: '2026-09-26'