# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Chef Automate API Documentation Teams API
  version: 1.0.0
extends: openapi/progress-software-teams-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/apis/iam/v2/teams'].get
  update:
    x-apievangelist-phrasing:
      intent: List local teams
      effect: read
      questions:
      - What local teams exist in Chef Automate?
      - Can I see all teams used in IAM policies?
      instructions:
      - text: List all local teams.
      - text: Show me every IAM team.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/apis/iam/v2/teams'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a local team
      effect: write
      questions:
      - How do I create a team to group users for IAM policies?
      - Can a new team be assigned to projects?
      instructions:
      - text: Create team {id} named {name}.
        slots:
          id: requestBody.id
          name: requestBody.name
      - text: Create team {id} called {name} in projects {projects}.
        slots:
          id: requestBody.id
          name: requestBody.name
          projects: requestBody.projects
      method: generated
      generated: '2026-10-01'
- target: $.paths['/apis/iam/v2/teams/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a team
      effect: read
      questions:
      - What are the details of a specific team?
      - Which projects is a team assigned to?
      instructions:
      - text: Show team {id}.
        slots:
          id: path.id
      - text: Get details of team {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/apis/iam/v2/teams/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a local team
      effect: write
      questions:
      - How do I rename a team?
      - Can I change the projects a team belongs to?
      instructions:
      - text: Rename team {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set team {id}'s projects to {projects}.
        slots:
          id: path.id
          projects: requestBody.projects
      method: generated
      generated: '2026-10-01'
- target: $.paths['/apis/iam/v2/teams/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a local team
      effect: destructive
      questions:
      - Does deleting a team remove it from policies?
      - How do I delete a team I no longer need?
      instructions:
      - text: Delete team {id}.
        slots:
          id: path.id
      - text: Remove team {id} and its policy memberships.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/apis/iam/v2/teams/{id}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List a team's members
      effect: read
      questions:
      - Who is on a particular team?
      - Are team members listed by membership ID?
      instructions:
      - text: List the members of team {id}.
        slots:
          id: path.id
      - text: Show which users belong to team {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/apis/iam/v2/teams/{id}/users:add'].post
  update:
    x-apievangelist-phrasing:
      intent: Add users to a team
      effect: write
      questions:
      - How do I add users to a team?
      - Does adding team members check that the membership IDs are real users?
      instructions:
      - text: Add users {membership_ids} to team {id}.
        slots:
          membership_ids: requestBody.membership_ids
          id: path.id
      - text: Put membership IDs {membership_ids} on team {id}.
        slots:
          membership_ids: requestBody.membership_ids
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/apis/iam/v2/teams/{id}/users:remove'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove users from a team
      effect: write
      questions:
      - How do I take users off a team?
      - Can I remove several members from a team at once?
      instructions:
      - text: Remove users {membership_ids} from team {id}.
        slots:
          membership_ids: requestBody.membership_ids
          id: path.id
      - text: Take membership IDs {membership_ids} off team {id}.
        slots:
          membership_ids: requestBody.membership_ids
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/apis/iam/v2/users/{membership_id}/teams'].get
  update:
    x-apievangelist-phrasing:
      intent: List teams a user belongs to
      effect: read
      questions:
      - Which teams is a given user on?
      - Can I find a user's teams using their membership ID?
      instructions:
      - text: List the teams for user {membership_id}.
        slots:
          membership_id: path.membership_id
      - text: Show which teams membership {membership_id} belongs to.
        slots:
          membership_id: path.membership_id
      method: generated
      generated: '2026-10-01'