API Evangelist conversational phrasing for Jira Software Cloud Board API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Jira Software Cloud Board API
  version: 1.0.0
extends: openapi/jira-board-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: 33
- target: $.paths['/rest/agile/1.0/board'].get
  update:
    x-apievangelist-phrasing:
      intent: List the boards I can see
      effect: read
      questions:
      - Which Jira boards do I have permission to view?
      - Can I filter boards to only scrum or only kanban ones?
      - Is there a way to find the boards that belong to a particular project?
      instructions:
      - text: List all the boards I can view.
      - text: List {type} boards whose name contains {name}.
        slots:
          type: query.type
          name: query.name
      - text: Find the boards located in project {projectKeyOrId}.
        slots:
          projectKeyOrId: query.projectKeyOrId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/agile/1.0/board'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a scrum or kanban board
      effect: write
      questions:
      - How do I create a new scrum board from a saved filter?
      - What do I need to supply to set up a kanban board in Jira?
      instructions:
      - text: Create a {type} board called {name} using filter {filterId}.
        slots:
          type: requestBody.type
          name: requestBody.name
          filterId: requestBody.filterId
      - text: Set up a new kanban board named {name} based on saved filter {filterId}.
        slots:
          name: requestBody.name
          filterId: requestBody.filterId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/agile/1.0/board/filter/{filterId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Find boards that use a filter
      effect: read
      questions:
      - Which boards are built on a particular saved filter?
      - Can I check whether any board still depends on a filter before I change it?
      instructions:
      - text: Find every board that uses filter {filterId}.
        slots:
          filterId: path.filterId
      - text: Show me which boards are driven by saved filter {filterId}.
        slots:
          filterId: path.filterId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/agile/1.0/board/{boardId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a board's details
      effect: read
      questions:
      - What are the name, type and location of a specific board?
      - Can I look up a single board by its ID?
      instructions:
      - text: Get the details of board {boardId}.
        slots:
          boardId: path.boardId
      - text: Show me board {boardId}'s type and location.
        slots:
          boardId: path.boardId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/agile/1.0/board/{boardId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a board
      effect: destructive
      questions:
      - Can I permanently remove a board I no longer use?
      - What happens when an admin deletes a board they can't view?
      instructions:
      - text: Delete board {boardId}.
        slots:
          boardId: path.boardId
      - text: Remove the unused board {boardId} from Jira.
        slots:
          boardId: path.boardId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/agile/1.0/board/{boardId}/backlog'].get
  update:
    x-apievangelist-phrasing:
      intent: List backlog issues on a board
      effect: read
      questions:
      - What issues are sitting in a board's backlog, not in any sprint?
      - Can I narrow a board's backlog with a JQL query using offset paging?
      instructions:
      - text: List the backlog issues for board {boardId}.
        slots:
          boardId: path.boardId
      - text: Show backlog issues on board {boardId} matching {jql}, starting at {startAt}.
        slots:
          boardId: path.boardId
          jql: query.jql
          startAt: query.startAt
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/software/1.0/board/{boardId}/backlog'].get
  update:
    x-apievangelist-phrasing:
      intent: List backlog issues with token paging
      effect: read
      questions:
      - Is there a backlog endpoint that pages with a nextPageToken instead of startAt?
      - Can I get a board's backlog with read-after-write reconciliation of recently edited issues?
      instructions:
      - text: List backlog issues for board {boardId} using the enhanced token-paged endpoint.
        slots:
          boardId: path.boardId
      - text: Fetch the next page of board {boardId}'s backlog with token {nextPageToken}.
        slots:
          boardId: path.boardId
          nextPageToken: query.nextPageToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/software/1.0/board/{boardId}/backlog/approximate-count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count backlog issues on a board
      effect: read
      questions:
      - Roughly how many issues are in a board's backlog?
      - Can I get an approximate backlog count without paging through every issue?
      instructions:
      - text: Estimate how many issues are in board {boardId}'s backlog.
        slots:
          boardId: path.boardId
      - text: Count backlog issues on board {boardId} that match {jql}.
        slots:
          boardId: path.boardId
          jql: query.jql
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/agile/1.0/board/{boardId}/configuration'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a board's configuration
      effect: read
      questions:
      - What columns, estimation field and filter does a board use?
      - How is a board's column-to-status mapping configured?
      instructions:
      - text: Get the configuration of board {boardId}.
        slots:
          boardId: path.boardId
      - text: Show me the columns and estimation settings for board {boardId}.
        slots:
          boardId: path.boardId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/agile/1.0/board/{boardId}/epic'].get
  update:
    x-apievangelist-phrasing:
      intent: List epics on a board
      effect: read
      questions:
      - Which epics appear on a given board?
      - Can I list only the epics that are not done yet on a board?
      instructions:
      - text: List the epics on board {boardId}.
        slots:
          boardId: path.boardId
      - text: Show epics on board {boardId} filtered by done status {done}.
        slots:
          boardId: path.boardId
          done: query.done
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/agile/1.0/board/{boardId}/epic/none/issue'].get
  update:
    x-apievangelist-phrasing:
      intent: List board issues with no epic
      effect: read
      questions:
      - Which issues on a board aren't assigned to any epic?
      - Can I find orphaned board issues without an epic using offset paging?
      instructions:
      - text: List issues on board {boardId} that don't belong to an epic.
        slots:
          boardId: path.boardId
      - text: Find epic-less issues on board {boardId} matching {jql}.
        slots:
          boardId: path.boardId
          jql: query.jql
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/software/1.0/board/{boardId}/epic/none/issue'].get
  update:
    x-apievangelist-phrasing:
      intent: List board issues with no epic, token paged
      effect: read
      questions:
      - Is there a token-paginated way to fetch board issues that have no epic?
      - Can I reconcile recently updated issues when listing ones without an epic?
      instructions:
      - text: Use the enhanced endpoint to list issues without an epic on board {boardId}.
        slots:
          boardId: path.boardId
      - text: Get the next page of no-epic issues on board {boardId} with token {nextPageToken}.
        slots:
          boardId: path.boardId
          nextPageToken: query.nextPageToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/agile/1.0/board/{boardId}/epic/{epicId}/issue'].get
  update:
    x-apievangelist-phrasing:
      intent: List a board's issues in an epic
      effect: read
      questions:
      - What issues belong to a specific epic on a board?
      - Can I see an epic's child issues on one board using startAt paging?
      instructions:
      - text: List issues in epic {epicId} on board {boardId}.
        slots:
          epicId: path.epicId
          boardId: path.boardId
      - text: Show open work in epic {epicId} on board {boardId} matching {jql}.
        slots:
          epicId: path.epicId
          boardId: path.boardId
          jql: query.jql
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/software/1.0/board/{boardId}/epic/{epicId}/issue'].get
  update:
    x-apievangelist-phrasing:
      intent: List a board's epic issues, token paged
      effect: read
      questions:
      - Is there an enhanced, token-paged endpoint for an epic's issues on a board?
      - Can I page an epic's board issues with nextPageToken and reconcile fresh edits?
      instructions:
      - text: Use the enhanced endpoint to list issues in epic {epicId} on board {boardId}.
        slots:
          epicId: path.epicId
          boardId: path.boardId
      - text: Fetch the next token page {nextPageToken} of epic {epicId} issues on board {boardId}.
        slots:
          nextPageToken: query.nextPageToken
          epicId: path.epicId
          boardId: path.boardId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/agile/1.0/board/{boardId}/features'].get
  update:
    x-apievangelist-phrasing:
      intent: List a board's features
      effect: read
      questions:
      - Which board features, like estimation or the backlog, are turned on for a board?
      - Can I check which features are enabled on a specific board?
      instructions:
      - text: List the features available on board {boardId}.
        slots:
          boardId: path.boardId
      - text: Show which features are enabled for board {boardId}.
        slots:
          boardId: path.boardId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/agile/1.0/board/{boardId}/features'].put
  update:
    x-apievangelist-phrasing:
      intent: Turn a board feature on or off
      effect: write
      questions:
      - Can I enable or disable a feature on a board through the API?
      - What's needed to switch off a board feature programmatically?
      instructions:
      - text: Turn feature {feature} on or off for board {boardId}.
        slots:
          feature: requestBody.feature
          boardId: path.boardId
      - text: Set feature {feature} on board {boardId} to enabled={enabling}.
        slots:
          feature: requestBody.feature
          boardId: path.boardId
          enabling: requestBody.enabling
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/agile/1.0/board/{boardId}/issue'].get
  update:
    x-apievangelist-phrasing:
      intent: List all issues on a board
      effect: read
      questions:
      - Which issues are currently on a board's columns?
      - Can I list a board's issues with a JQL filter and offset paging?
      instructions:
      - text: List all issues on board {boardId}.
        slots:
          boardId: path.boardId
      - text: Show issues on board {boardId} matching {jql}, {maxResults} at a time.
        slots:
          boardId: path.boardId
          jql: query.jql
          maxResults: query.maxResults
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/agile/1.0/board/{boardId}/issue'].post
  update:
    x-apievangelist-phrasing:
      intent: Move backlog issues onto a board
      effect: write
      questions:
      - Can I move issues from the backlog onto a kanban board?
      - Is it possible to rank issues while moving them to the board?
      instructions:
      - text: Move issues {issues} from the backlog onto board {boardId}.
        slots:
          issues: requestBody.issues
          boardId: path.boardId
      - text: Move {issues} to board {boardId} and rank them after {rankAfterIssue}.
        slots:
          issues: requestBody.issues
          boardId: path.boardId
          rankAfterIssue: requestBody.rankAfterIssue
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/software/1.0/board/{boardId}/issue'].get
  update:
    x-apievangelist-phrasing:
      intent: List board issues with token paging
      effect: read
      questions:
      - Is there a token-based paginated version of listing all issues on a board?
      - Can I list board issues with reconcileIssues for read-after-write consistency?
      instructions:
      - text: Use the enhanced endpoint to list every issue on board {boardId}.
        slots:
          boardId: path.boardId
      - text: Get board {boardId}'s next issue page using token {nextPageToken}.
        slots:
          boardId: path.boardId
          nextPageToken: query.nextPageToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/software/1.0/board/{boardId}/issue/approximate-count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count issues on a board
      effect: read
      questions:
      - About how many issues are on a board right now?
      - Can I get an estimated board issue count for a JQL filter?
      instructions:
      - text: Estimate the number of issues on board {boardId}.
        slots:
          boardId: path.boardId
      - text: Count issues on board {boardId} matching {jql}.
        slots:
          boardId: path.boardId
          jql: query.jql
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/agile/1.0/board/{boardId}/project'].get
  update:
    x-apievangelist-phrasing:
      intent: List projects linked to a board
      effect: read
      questions:
      - Which projects are associated with a board?
      - Can I page through the projects a board pulls issues from?
      instructions:
      - text: List the projects associated with board {boardId}.
        slots:
          boardId: path.boardId
      - text: Show the first {maxResults} projects linked to board {boardId}.
        slots:
          maxResults: query.maxResults
          boardId: path.boardId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/agile/1.0/board/{boardId}/project/full'].get
  update:
    x-apievangelist-phrasing:
      intent: List projects statically tied to a board
      effect: read
      questions:
      - Which projects does a board's filter reference directly, rather than through a subquery?
      - Can I get the full, unpaginated list of projects statically bound to a board?
      instructions:
      - text: Get the full list of projects statically referenced by board {boardId}'s filter.
        slots:
          boardId: path.boardId
      - text: Show every project board {boardId}'s filter explicitly includes.
        slots:
          boardId: path.boardId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/agile/1.0/board/{boardId}/properties'].get
  update:
    x-apievangelist-phrasing:
      intent: List a board's property keys
      effect: read
      questions:
      - What custom property keys are stored on a board?
      - Can I see which app data keys have been saved against a board?
      instructions:
      - text: List the property keys stored on board {boardId}.
        slots:
          boardId: path.boardId
      - text: Show me all custom data keys on board {boardId}.
        slots:
          boardId: path.boardId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/agile/1.0/board/{boardId}/properties/{propertyKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a board property value
      effect: read
      questions:
      - What value is stored under a particular property key on a board?
      - Can I read custom data saved on a board by key?
      instructions:
      - text: Get property {propertyKey} from board {boardId}.
        slots:
          propertyKey: path.propertyKey
          boardId: path.boardId
      - text: Read the value of board {boardId}'s {propertyKey} property.
        slots:
          boardId: path.boardId
          propertyKey: path.propertyKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/agile/1.0/board/{boardId}/properties/{propertyKey}'].put
  update:
    x-apievangelist-phrasing:
      intent: Store a property on a board
      effect: write
      questions:
      - Can I save my own custom data against a board?
      - What permission do I need to write a board property?
      instructions:
      - text: Set property {propertyKey} on board {boardId}.
        slots:
          propertyKey: path.propertyKey
          boardId: path.boardId
      - text: Store custom data under key {propertyKey} for board {boardId}.
        slots:
          propertyKey: path.propertyKey
          boardId: path.boardId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/agile/1.0/board/{boardId}/properties/{propertyKey}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a board property
      effect: destructive
      questions:
      - Can I delete a custom property I stored on a board?
      - Who is allowed to remove a board property?
      instructions:
      - text: Delete property {propertyKey} from board {boardId}.
        slots:
          propertyKey: path.propertyKey
          boardId: path.boardId
      - text: Remove the {propertyKey} custom data from board {boardId}.
        slots:
          propertyKey: path.propertyKey
          boardId: path.boardId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/agile/1.0/board/{boardId}/quickfilter'].get
  update:
    x-apievangelist-phrasing:
      intent: List a board's quick filters
      effect: read
      questions:
      - What quick filters are defined on a board?
      - Can I page through all the quick filters for one board?
      instructions:
      - text: List the quick filters on board {boardId}.
        slots:
          boardId: path.boardId
      - text: Show all quick filter buttons configured for board {boardId}.
        slots:
          boardId: path.boardId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/agile/1.0/board/{boardId}/quickfilter/{quickFilterId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one quick filter on a board
      effect: read
      questions:
      - What JQL does a specific quick filter on a board apply?
      - Can I look up a single quick filter by its ID?
      instructions:
      - text: Get quick filter {quickFilterId} from board {boardId}.
        slots:
          quickFilterId: path.quickFilterId
          boardId: path.boardId
      - text: Show the JQL behind quick filter {quickFilterId} on board {boardId}.
        slots:
          quickFilterId: path.quickFilterId
          boardId: path.boardId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/agile/1.0/board/{boardId}/reports'].get
  update:
    x-apievangelist-phrasing:
      intent: List reports available for a board
      effect: read
      questions:
      - Which agile reports can I view for a board?
      - Are burndown or velocity style reports available on a particular board?
      instructions:
      - text: List the reports available for board {boardId}.
        slots:
          boardId: path.boardId
      - text: Show me what reports board {boardId} offers.
        slots:
          boardId: path.boardId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/agile/1.0/board/{boardId}/sprint'].get
  update:
    x-apievangelist-phrasing:
      intent: List sprints on a board
      effect: read
      questions:
      - What sprints exist on a board?
      - Can I list only the active or future sprints for a board?
      instructions:
      - text: List all sprints on board {boardId}.
        slots:
          boardId: path.boardId
      - text: Show the {state} sprints on board {boardId}.
        slots:
          state: query.state
          boardId: path.boardId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/agile/1.0/board/{boardId}/sprint/{sprintId}/issue'].get
  update:
    x-apievangelist-phrasing:
      intent: List a board's issues in a sprint
      effect: read
      questions:
      - Which issues are in a given sprint on a board, in rank order?
      - Can I filter a sprint's board issues by JQL using offset paging?
      instructions:
      - text: List issues in sprint {sprintId} on board {boardId}.
        slots:
          sprintId: path.sprintId
          boardId: path.boardId
      - text: Show sprint {sprintId} issues on board {boardId} matching {jql}.
        slots:
          sprintId: path.sprintId
          boardId: path.boardId
          jql: query.jql
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/software/1.0/board/{boardId}/sprint/{sprintId}/issue'].get
  update:
    x-apievangelist-phrasing:
      intent: List a board's sprint issues, token paged
      effect: read
      questions:
      - Is there an enhanced sprint-issues endpoint that uses nextPageToken?
      - Can I get a sprint's board issues with reconciliation of just-edited issues?
      instructions:
      - text: Use the enhanced endpoint to list sprint {sprintId} issues on board {boardId}.
        slots:
          sprintId: path.sprintId
          boardId: path.boardId
      - text: Fetch token page {nextPageToken} of sprint {sprintId} issues on board {boardId}.
        slots:
          nextPageToken: query.nextPageToken
          sprintId: path.sprintId
          boardId: path.boardId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/agile/1.0/board/{boardId}/version'].get
  update:
    x-apievangelist-phrasing:
      intent: List versions on a board
      effect: read
      questions:
      - Which release versions show up on a board?
      - Can I list only the unreleased versions for a board?
      instructions:
      - text: List the versions on board {boardId}.
        slots:
          boardId: path.boardId
      - text: Show versions on board {boardId} with released set to {released}.
        slots:
          boardId: path.boardId
          released: query.released
      method: generated
      generated: '2026-09-26'