# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Swetrix Admin Organisations API
  version: 1.0.0
extends: openapi/swetrix-organisations-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: 8
- target: $.paths['/v1/organisation'].get
  update:
    x-apievangelist-phrasing:
      intent: List the organisations I belong to
      effect: read
      questions:
      - Which organisations am I a member of?
      - Can I see all the Swetrix teams my account belongs to?
      instructions:
      - text: List every organisation I'm a member of.
      - text: Show my organisations.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organisation'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new organisation
      effect: write
      questions:
      - How do I set up a new organisation to share analytics projects with a team?
      - What do I need to provide to create an organisation?
      instructions:
      - text: Create an organisation named {name}.
        slots:
          name: requestBody.name
      - text: Set up a new team organisation called {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organisation/{orgId}'].get
  update:
    x-apievangelist-phrasing:
      intent: View details of one organisation
      effect: read
      questions:
      - What are the details of a specific organisation I belong to?
      - Can I look up a single organisation by its ID?
      instructions:
      - text: Get the details of organisation {orgId}.
        slots:
          orgId: path.orgId
      - text: Show me organisation {orgId}.
        slots:
          orgId: path.orgId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organisation/{orgId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Permanently delete an organisation
      effect: destructive
      questions:
      - Who is allowed to permanently delete an organisation?
      - Can I shut down an organisation for good?
      instructions:
      - text: Permanently delete organisation {orgId}.
        slots:
          orgId: path.orgId
      - text: Remove organisation {orgId} entirely.
        slots:
          orgId: path.orgId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organisation/{orgId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename an organisation
      effect: write
      questions:
      - How do I rename an organisation?
      - Is the organisation name the only thing I can change after creating it?
      instructions:
      - text: Rename organisation {orgId} to {name}.
        slots:
          orgId: path.orgId
          name: requestBody.name
      - text: Change the name of organisation {orgId} to {name}.
        slots:
          orgId: path.orgId
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organisation/{orgId}/invite'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite someone to an organisation with a role
      effect: write
      questions:
      - How do I invite a colleague by email to my organisation?
      - Can I choose a role for someone when inviting them to an organisation?
      instructions:
      - text: Invite {email} to organisation {orgId} as {role}.
        slots:
          email: requestBody.email
          orgId: path.orgId
          role: requestBody.role
      - text: Send an invitation to {email} to join organisation {orgId} with the {role} role.
        slots:
          email: requestBody.email
          orgId: path.orgId
          role: requestBody.role
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organisation/member/{memberId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a member from an organisation
      effect: destructive
      questions:
      - What's the way to kick someone out of my organisation?
      - Can I revoke a teammate's organisation membership?
      instructions:
      - text: Remove member {memberId} from the organisation.
        slots:
          memberId: path.memberId
      - text: Take organisation member {memberId} off the team.
        slots:
          memberId: path.memberId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organisation/member/{memberId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change an organisation member's role
      effect: write
      questions:
      - Can I promote an existing organisation member to a different role?
      - Which call changes the role of someone already in my organisation?
      instructions:
      - text: Change the role of member {memberId} to {role}.
        slots:
          memberId: path.memberId
          role: requestBody.role
      - text: Set organisation member {memberId}'s role to {role}.
        slots:
          memberId: path.memberId
          role: requestBody.role
      method: generated
      generated: '2026-09-26'