# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Test Observer Teams API
  version: 1.0.0
extends: openapi/canonical-teams-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: 6
- target: $.paths['/v1/teams'].get
  update:
    x-apievangelist-phrasing:
      intent: List teams
      effect: read
      questions:
      - Which teams are set up in Test Observer?
      - What teams exist and what permissions do they have?
      instructions:
      - text: List all teams.
      - text: Show every team with its permissions.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/teams'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a team
      effect: write
      questions:
      - How do I create a new review team?
      - Can a team be given artefact matching rules when it is created?
      instructions:
      - text: Create team {name}.
        slots:
          name: requestBody.name
      - text: Create team {name} with permissions {permissions}.
        slots:
          name: requestBody.name
          permissions: requestBody.permissions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/teams/{team_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a team
      effect: read
      questions:
      - Who is on a particular team and what can they do?
      - Which artefacts does a given team match?
      instructions:
      - text: Show team {team_id}.
        slots:
          team_id: path.team_id
      - text: Get the members and permissions of team {team_id}.
        slots:
          team_id: path.team_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/teams/{team_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a team's permissions or matching rules
      effect: write
      questions:
      - Can I change the permissions of an existing team?
      - How do I update which artefacts a team is responsible for?
      instructions:
      - text: Set team {team_id} permissions to {permissions}.
        slots:
          team_id: path.team_id
          permissions: requestBody.permissions
      - text: Update artefact matching rules of team {team_id} to {rules}.
        slots:
          team_id: path.team_id
          rules: requestBody.artefact_matching_rules
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/teams/{team_id}/members/{user_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a user to a team
      effect: write
      questions:
      - How do I add a reviewer to a team?
      - Can a user belong to more than one team?
      instructions:
      - text: Add user {user_id} to team {team_id}.
        slots:
          user_id: path.user_id
          team_id: path.team_id
      - text: Make {user_id} a member of team {team_id}.
        slots:
          user_id: path.user_id
          team_id: path.team_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/teams/{team_id}/members/{user_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user from a team
      effect: destructive
      questions:
      - How do I take someone off a team?
      - Does removing a member from a team delete the user account?
      instructions:
      - text: Remove user {user_id} from team {team_id}.
        slots:
          user_id: path.user_id
          team_id: path.team_id
      - text: Drop {user_id} from team {team_id} membership.
        slots:
          user_id: path.user_id
          team_id: path.team_id
      method: generated
      generated: '2026-09-26'