# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Checkly Public Accounts API
  version: 1.0.0
extends: openapi/checkly-accounts-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: 11
- target: $.paths['/v1/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List accounts my API key can access
      effect: read
      questions:
      - Which Checkly accounts does my API key have access to?
      - Can I see every account tied to this key at once?
      instructions:
      - text: List all accounts available to my API key.
      - text: Show the accounts this key can reach.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/accounts/me'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the current account's details
      effect: read
      questions:
      - What are the details of the account I'm currently using?
      - How can I confirm which account my requests run against?
      instructions:
      - text: Show details for my current account.
      - text: Get the account profile for the account I'm signed in to.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/accounts/me/entitlements'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the current account's plan entitlements
      effect: read
      questions:
      - What features and limits does my current plan include?
      - Am I near any plan limits on the account I'm using now?
      instructions:
      - text: Show the entitlements for my current account.
      - text: List the feature access and limits of my own plan.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/accounts/me/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List members and invites of my account
      effect: read
      questions:
      - Who are the members of my current account, and who still has an invite pending?
      - Can I filter my own account's members by role or status?
      instructions:
      - text: List members and pending invites on my current account.
      - text: Find members of my account matching {search} with role {role}.
        slots:
          search: query.search
          role: query.role
      - text: Show {limit} members of my account with status {status}.
        slots:
          limit: query.limit
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/accounts/me/members/{userId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a member from my account
      effect: destructive
      questions:
      - How do I remove someone from the account I'm currently using?
      - Can I revoke a user's access to my own account?
      instructions:
      - text: Remove user {userId} from my current account.
        slots:
          userId: path.userId
      - text: Kick member {userId} out of my account.
        slots:
          userId: path.userId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/accounts/me/members/{userId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a member's role on my account
      effect: write
      questions:
      - Can I promote a member of my current account to a different role?
      - What's the way to change someone's role on the account I'm using?
      instructions:
      - text: Change the role of user {userId} on my account to {role}.
        slots:
          userId: path.userId
          role: requestBody.role
      - text: Make member {userId} a {role} in my current account.
        slots:
          userId: path.userId
          role: requestBody.role
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/accounts/{accountId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a specific account's details
      effect: read
      questions:
      - What are the details of a particular account by its ID?
      - Can I look up another account I have access to?
      instructions:
      - text: Show details for account {accountId}.
        slots:
          accountId: path.accountId
      - text: Fetch account {accountId}.
        slots:
          accountId: path.accountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/accounts/{accountId}/entitlements'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a specific account's plan entitlements
      effect: read
      questions:
      - Which features and limits does a given account's plan allow?
      - Can I check the entitlements of an account other than my current one?
      instructions:
      - text: Show the entitlements for account {accountId}.
        slots:
          accountId: path.accountId
      - text: List plan features and limits for account {accountId}.
        slots:
          accountId: path.accountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/accounts/{accountId}/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List members and invites of an account
      effect: read
      questions:
      - Who belongs to a specific account, including pending invites?
      - Can I search the members of an account by name or email?
      instructions:
      - text: List members and pending invites of account {accountId}.
        slots:
          accountId: path.accountId
      - text: Search account {accountId} members for {search}.
        slots:
          accountId: path.accountId
          search: query.search
      - text: Show members of account {accountId} with role {role}.
        slots:
          accountId: path.accountId
          role: query.role
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/accounts/{accountId}/members/{userId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a member from an account
      effect: destructive
      questions:
      - How do I take a user out of a specific account by its ID?
      - Is removing someone from a named account permanent?
      instructions:
      - text: Remove user {userId} from account {accountId}.
        slots:
          userId: path.userId
          accountId: path.accountId
      - text: Revoke member {userId}'s access to account {accountId}.
        slots:
          userId: path.userId
          accountId: path.accountId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/accounts/{accountId}/members/{userId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a member's role on an account
      effect: write
      questions:
      - Can I change a user's role on a specific account?
      - Which call updates a member's role when I know the account ID?
      instructions:
      - text: Set user {userId}'s role on account {accountId} to {role}.
        slots:
          userId: path.userId
          accountId: path.accountId
          role: requestBody.role
      - text: Update member {userId} in account {accountId} to be a {role}.
        slots:
          userId: path.userId
          accountId: path.accountId
          role: requestBody.role
      method: generated
      generated: '2026-09-26'