# 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 Plans API
  version: 1.0.0
extends: openapi/jira-plans-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: 7
- target: $.paths['/rest/api/3/plans/plan'].get
  update:
    x-apievangelist-phrasing:
      intent: List plans
      effect: read
      questions:
      - What plans exist in Jira?
      - Can I include archived or trashed plans when listing plans?
      instructions:
      - text: List all plans.
      - text: List plans including archived ({includeArchived}) and trashed ({includeTrashed}) ones.
        slots:
          includeArchived: query.includeArchived
          includeTrashed: query.includeTrashed
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/plans/plan'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a plan
      effect: write
      questions:
      - How do I create a new plan from boards, projects or filters?
      - What scheduling settings must I provide when creating a plan?
      instructions:
      - text: Create a plan named {name} with issue sources {issueSources} and scheduling {scheduling}.
        slots:
          name: requestBody.name
          issueSources: requestBody.issueSources
          scheduling: requestBody.scheduling
      - text: Create plan {name} led by {leadAccountId} from sources {issueSources} using scheduling {scheduling}.
        slots:
          name: requestBody.name
          leadAccountId: requestBody.leadAccountId
          issueSources: requestBody.issueSources
          scheduling: requestBody.scheduling
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/plans/plan/{planId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a plan
      effect: read
      questions:
      - What are the issue sources and scheduling settings of a plan?
      - Can I look up one plan by its ID?
      instructions:
      - text: Get plan {planId}.
        slots:
          planId: path.planId
      - text: Show the configuration of plan {planId}.
        slots:
          planId: path.planId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/plans/plan/{planId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a plan's details
      effect: write
      questions:
      - Can I change a plan's name, lead or estimation unit?
      - Does updating a plan use JSON Patch operations?
      instructions:
      - text: Update plan {planId} with the provided JSON Patch changes.
        slots:
          planId: path.planId
      - text: Change the scheduling settings of plan {planId}.
        slots:
          planId: path.planId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/plans/plan/{planId}/archive'].put
  update:
    x-apievangelist-phrasing:
      intent: Archive a plan
      effect: write
      questions:
      - How do I archive a plan that's finished?
      - Can a plan be archived instead of deleted?
      instructions:
      - text: Archive plan {planId}.
        slots:
          planId: path.planId
      - text: Move plan {planId} into the archive.
        slots:
          planId: path.planId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/plans/plan/{planId}/duplicate'].post
  update:
    x-apievangelist-phrasing:
      intent: Duplicate a plan
      effect: write
      questions:
      - Can I make a copy of an existing plan?
      - How would I clone a plan under a different name?
      instructions:
      - text: Duplicate plan {planId} as {name}.
        slots:
          planId: path.planId
          name: requestBody.name
      - text: Copy plan {planId} into a new plan called {name}.
        slots:
          planId: path.planId
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/plans/plan/{planId}/trash'].put
  update:
    x-apievangelist-phrasing:
      intent: Move a plan to trash
      effect: destructive
      questions:
      - How do I send a plan to the trash?
      - What happens to a plan I trash rather than archive?
      instructions:
      - text: Trash plan {planId}.
        slots:
          planId: path.planId
      - text: Move plan {planId} to the trash.
        slots:
          planId: path.planId
      method: generated
      generated: '2026-09-26'