# 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 Teams in plan API
  version: 1.0.0
extends: openapi/jira-teams-in-plan-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/plans/plan/{planId}/team'].get
  update:
    x-apievangelist-phrasing:
      intent: List teams in a plan
      effect: read
      questions:
      - Which teams are part of a Jira plan?
      - Does a plan's team list include both plan-only and Atlassian teams?
      instructions:
      - text: List the teams in plan {planId}.
        slots:
          planId: path.planId
      - text: Show the next page of teams in plan {planId} from cursor {cursor}.
        slots:
          planId: path.planId
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/plans/plan/{planId}/team/atlassian'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an Atlassian team to a plan
      effect: write
      questions:
      - Can I bring an existing Atlassian team into a plan with a scrum or kanban planning style?
      - What planning settings can I set when adding a team to a plan?
      instructions:
      - text: Add Atlassian team {id} to plan {planId} with planning style {planningStyle}.
        slots:
          id: requestBody.id
          planId: path.planId
          planningStyle: requestBody.planningStyle
      - text: Add team {id} to plan {planId} as {planningStyle} with capacity {capacity}.
        slots:
          id: requestBody.id
          planId: path.planId
          planningStyle: requestBody.planningStyle
          capacity: requestBody.capacity
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/plans/plan/{planId}/team/atlassian/{atlassianTeamId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an Atlassian team's plan settings
      effect: read
      questions:
      - What capacity and sprint length is an Atlassian team configured with in a plan?
      - Can I see one shared team's planning settings?
      instructions:
      - text: Get the planning settings for Atlassian team {atlassianTeamId} in plan {planId}.
        slots:
          planId: path.planId
          atlassianTeamId: path.atlassianTeamId
      - text: Show Atlassian team {atlassianTeamId}'s capacity in plan {planId}.
        slots:
          planId: path.planId
          atlassianTeamId: path.atlassianTeamId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/plans/plan/{planId}/team/atlassian/{atlassianTeamId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an Atlassian team's plan settings
      effect: write
      questions:
      - Can I change an Atlassian team's capacity or sprint length in a plan?
      - Which planning settings of a shared team can be patched?
      instructions:
      - text: Update Atlassian team {atlassianTeamId}'s planning settings in plan {planId}.
        slots:
          planId: path.planId
          atlassianTeamId: path.atlassianTeamId
      - text: Change the sprint length for Atlassian team {atlassianTeamId} in plan {planId}.
        slots:
          planId: path.planId
          atlassianTeamId: path.atlassianTeamId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/plans/plan/{planId}/team/atlassian/{atlassianTeamId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an Atlassian team from a plan
      effect: destructive
      questions:
      - Can I take an Atlassian team out of a plan?
      - Are a team's planning settings lost when it's removed from a plan?
      instructions:
      - text: Remove Atlassian team {atlassianTeamId} from plan {planId}.
        slots:
          planId: path.planId
          atlassianTeamId: path.atlassianTeamId
      - text: Take Atlassian team {atlassianTeamId} out of plan {planId} and drop its settings.
        slots:
          planId: path.planId
          atlassianTeamId: path.atlassianTeamId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/plans/plan/{planId}/team/planonly'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a plan-only team
      effect: write
      questions:
      - How do I create a team that exists only inside one plan?
      - Can I add members when creating a plan-only team?
      instructions:
      - text: Create plan-only team {name} in plan {planId} using {planningStyle}.
        slots:
          name: requestBody.name
          planId: path.planId
          planningStyle: requestBody.planningStyle
      - text: Create plan-only team {name} in plan {planId} as {planningStyle} with members {memberAccountIds}.
        slots:
          name: requestBody.name
          planId: path.planId
          planningStyle: requestBody.planningStyle
          memberAccountIds: requestBody.memberAccountIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/plans/plan/{planId}/team/planonly/{planOnlyTeamId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a plan-only team's settings
      effect: read
      questions:
      - What are the members and capacity of a plan-only team?
      - Can I look up a plan-only team's planning style?
      instructions:
      - text: Get plan-only team {planOnlyTeamId} in plan {planId}.
        slots:
          planId: path.planId
          planOnlyTeamId: path.planOnlyTeamId
      - text: Show members and capacity of plan-only team {planOnlyTeamId} in plan {planId}.
        slots:
          planId: path.planId
          planOnlyTeamId: path.planOnlyTeamId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/plans/plan/{planId}/team/planonly/{planOnlyTeamId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a plan-only team
      effect: write
      questions:
      - Can I rename a plan-only team or change its members?
      - Which settings of a plan-only team can be updated with JSON Patch?
      instructions:
      - text: Update plan-only team {planOnlyTeamId} in plan {planId}.
        slots:
          planId: path.planId
          planOnlyTeamId: path.planOnlyTeamId
      - text: Change the members of plan-only team {planOnlyTeamId} in plan {planId}.
        slots:
          planId: path.planId
          planOnlyTeamId: path.planOnlyTeamId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/plans/plan/{planId}/team/planonly/{planOnlyTeamId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a plan-only team
      effect: destructive
      questions:
      - Can I delete a team that only exists in one plan?
      - What gets removed when a plan-only team is deleted?
      instructions:
      - text: Delete plan-only team {planOnlyTeamId} from plan {planId}.
        slots:
          planId: path.planId
          planOnlyTeamId: path.planOnlyTeamId
      - text: Permanently remove plan-only team {planOnlyTeamId} and its settings in plan {planId}.
        slots:
          planId: path.planId
          planOnlyTeamId: path.planOnlyTeamId
      method: generated
      generated: '2026-09-26'