# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Elation Health Staff Groups API
  version: 1.0.0
extends: openapi/elation-health-staff-groups-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: 10
- target: $.paths['/staff_groups/'].get
  update:
    x-apievangelist-phrasing:
      intent: Find staff groups (legacy)
      effect: read
      questions:
      - How do I look up a staff group by name on the older endpoint?
      - Which legacy call lists staff groups in a practice?
      instructions:
      - text: Find legacy staff groups named {name}.
        slots:
          name: query.name
      - text: Search older staff groups in practice {practice}.
        slots:
          practice: query.practice
      method: generated
      generated: '2026-09-26'
- target: $.paths['/staff_groups/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a staff group (legacy)
      effect: write
      questions:
      - How do I group front-desk users together through the unversioned route?
      - Can a legacy staff group be marked as an Elation group?
      instructions:
      - text: Create a legacy staff group {name} with users {users}.
        slots:
          name: requestBody.name
          users: requestBody.users
      - text: Add an older-style staff group for practice {practice}, Elation group {is_elation_group}.
        slots:
          practice: requestBody.practice
          is_elation_group: requestBody.is_elation_group
      method: generated
      generated: '2026-09-26'
- target: $.paths['/staff_groups/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a staff group (legacy)
      effect: destructive
      questions:
      - How do I remove a staff group with the older delete call?
      - Which unversioned endpoint deletes a staff group?
      instructions:
      - text: Delete legacy staff group {id}.
        slots:
          id: path.id
      - text: Remove old staff group {id} via the unversioned route.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/staff_groups/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a staff group (legacy)
      effect: write
      questions:
      - How do I change a staff group's members on the older PUT route?
      - Can I rename a legacy staff group?
      instructions:
      - text: Update legacy staff group {id} to include users {users}.
        slots:
          id: path.id
          users: requestBody.users
      - text: Rename older staff group {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/staff_groups/'].get
  update:
    x-apievangelist-phrasing:
      intent: List staff groups with paging
      effect: read
      questions:
      - How do I page through staff groups in the v2.0 API?
      - Can I filter /api/2.0 staff groups by name and sort them?
      instructions:
      - text: List v2.0 staff groups in practice {practice}, {limit} per page.
        slots:
          practice: query.practice
          limit: query.limit
      - text: Page through /api/2.0 staff groups named {name} from offset {offset}, ordered by {order_by}.
        slots:
          name: query.name
          offset: query.offset
          order_by: query.order_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/staff_groups/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a staff group in the v2.0 API
      effect: write
      questions:
      - What does /api/2.0 require to create a staff group?
      - How do I set up a new team of staff users in the v2.0 API?
      instructions:
      - text: Create v2.0 staff group {name} for practice {practice} with users {users}.
        slots:
          name: requestBody.name
          practice: requestBody.practice
          users: requestBody.users
      - text: Set up an /api/2.0 staff team {name}, Elation group {is_elation_group}.
        slots:
          name: requestBody.name
          is_elation_group: requestBody.is_elation_group
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/staff_groups/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a staff group from the v2.0 API
      effect: read
      questions:
      - How do I fetch one staff group and its members from /api/2.0?
      - Who belongs to a given v2.0 staff group?
      instructions:
      - text: Retrieve v2.0 staff group {id}.
        slots:
          id: path.id
      - text: Show the members of /api/2.0 staff group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/staff_groups/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a staff group in the v2.0 API
      effect: write
      questions:
      - How do I fully replace a staff group's name, practice and users in /api/2.0?
      - Which v2.0 call overwrites a staff group entirely?
      instructions:
      - text: Replace v2.0 staff group {id} with name {name}, practice {practice} and users {users}.
        slots:
          id: path.id
          name: requestBody.name
          practice: requestBody.practice
          users: requestBody.users
      - text: Overwrite /api/2.0 staff group {id} in full.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/staff_groups/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a staff group in the v2.0 API
      effect: destructive
      questions:
      - How do I delete a staff group through /api/2.0?
      - Can I retire an unused v2.0 staff group?
      instructions:
      - text: Delete v2.0 staff group {id}.
        slots:
          id: path.id
      - text: Retire /api/2.0 staff team {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/staff_groups/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a staff group in v2.0
      effect: write
      questions:
      - Can I change only the members of a v2.0 staff group?
      - How do I rename an /api/2.0 staff group without resending users?
      instructions:
      - text: Set the members of v2.0 staff group {id} to {users}.
        slots:
          id: path.id
          users: requestBody.users
      - text: Rename /api/2.0 staff team {id} to {name} and keep its members.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'