# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Snyk Service Accounts API
  version: 1.0.0
extends: openapi/snyk-service-accounts-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: 12
- target: $.paths['/groups/{group_id}/service_accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List a group's service accounts
      effect: read
      questions:
      - Which service accounts exist at the group level in Snyk?
      - Can I page through all the service accounts my group owns?
      instructions:
      - text: List the service accounts in group {group_id}.
        slots:
          group_id: path.group_id
      - text: Show the first {limit} group service accounts for group {group_id}.
        slots:
          limit: query.limit
          group_id: path.group_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group_id}/service_accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a group-level service account
      effect: write
      questions:
      - How do I create a service account that can call the Snyk API for a whole group?
      - Can a service account be scoped to a group instead of one organization?
      instructions:
      - text: Create a service account for group {group_id}.
        slots:
          group_id: path.group_id
      - text: Set up a new group-level API service account in group {group_id} for our CI pipeline.
        slots:
          group_id: path.group_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group_id}/service_accounts/{serviceaccount_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a group service account by ID
      effect: read
      questions:
      - Can I look up the details of one group-level service account?
      - What does a single group service account record show?
      instructions:
      - text: Get service account {serviceaccount_id} in group {group_id}.
        slots:
          serviceaccount_id: path.serviceaccount_id
          group_id: path.group_id
      - text: Show the details of group {group_id}'s service account {serviceaccount_id}.
        slots:
          group_id: path.group_id
          serviceaccount_id: path.serviceaccount_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group_id}/service_accounts/{serviceaccount_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Permanently delete a group service account
      effect: destructive
      questions:
      - Can I permanently remove a service account from my group?
      - Is deleting a group-level service account reversible?
      instructions:
      - text: Delete service account {serviceaccount_id} from group {group_id}.
        slots:
          serviceaccount_id: path.serviceaccount_id
          group_id: path.group_id
      - text: Permanently remove group {group_id}'s service account {serviceaccount_id}.
        slots:
          group_id: path.group_id
          serviceaccount_id: path.serviceaccount_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group_id}/service_accounts/{serviceaccount_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a group service account
      effect: write
      questions:
      - Can I rename a service account that belongs to my group?
      - What can I change on an existing group-level service account?
      instructions:
      - text: Rename service account {serviceaccount_id} in group {group_id}.
        slots:
          serviceaccount_id: path.serviceaccount_id
          group_id: path.group_id
      - text: Change the name of group {group_id}'s service account {serviceaccount_id} to something clearer.
        slots:
          group_id: path.group_id
          serviceaccount_id: path.serviceaccount_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group_id}/service_accounts/{serviceaccount_id}/secrets'].post
  update:
    x-apievangelist-phrasing:
      intent: Manage a group service account's client secret
      effect: write
      questions:
      - Can I manage the client secret of a group service account through the API?
      - Where do I rotate the OAuth client secret for a group-level service account?
      instructions:
      - text: Manage the client secret for service account {serviceaccount_id} in group {group_id}.
        slots:
          serviceaccount_id: path.serviceaccount_id
          group_id: path.group_id
      - text: Rotate group {group_id} service account {serviceaccount_id}'s client secret.
        slots:
          group_id: path.group_id
          serviceaccount_id: path.serviceaccount_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{org_id}/service_accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's service accounts
      effect: read
      questions:
      - Which service accounts have been created in my organization?
      - Can I paginate through an org's service accounts?
      instructions:
      - text: List the service accounts in organization {org_id}.
        slots:
          org_id: path.org_id
      - text: Show the first {limit} service accounts in org {org_id}.
        slots:
          limit: query.limit
          org_id: path.org_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{org_id}/service_accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an organization service account
      effect: write
      questions:
      - Can I create a service account for just one Snyk organization?
      - What do I need to create an org-level service account for API access?
      instructions:
      - text: Create a service account for organization {org_id}.
        slots:
          org_id: path.org_id
      - text: Set up a new org-level API service account in org {org_id} for automation.
        slots:
          org_id: path.org_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{org_id}/service_accounts/{serviceaccount_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization service account by ID
      effect: read
      questions:
      - Can I view one service account in my organization by its ID?
      - What details are returned for a single org-level service account?
      instructions:
      - text: Get service account {serviceaccount_id} in organization {org_id}.
        slots:
          serviceaccount_id: path.serviceaccount_id
          org_id: path.org_id
      - text: Show org {org_id}'s service account {serviceaccount_id}.
        slots:
          org_id: path.org_id
          serviceaccount_id: path.serviceaccount_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{org_id}/service_accounts/{serviceaccount_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an organization service account
      effect: destructive
      questions:
      - Can I remove a service account from my organization when it's no longer used?
      - What happens to API access when an org service account is deleted?
      instructions:
      - text: Delete service account {serviceaccount_id} from organization {org_id}.
        slots:
          serviceaccount_id: path.serviceaccount_id
          org_id: path.org_id
      - text: Remove org {org_id}'s service account {serviceaccount_id}.
        slots:
          org_id: path.org_id
          serviceaccount_id: path.serviceaccount_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{org_id}/service_accounts/{serviceaccount_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename an organization service account
      effect: write
      questions:
      - Can I rename a service account in my organization?
      - Is the name the only thing I can edit on an org service account?
      instructions:
      - text: Rename service account {serviceaccount_id} in organization {org_id}.
        slots:
          serviceaccount_id: path.serviceaccount_id
          org_id: path.org_id
      - text: Give org {org_id}'s service account {serviceaccount_id} a new name.
        slots:
          org_id: path.org_id
          serviceaccount_id: path.serviceaccount_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{org_id}/service_accounts/{serviceaccount_id}/secrets'].post
  update:
    x-apievangelist-phrasing:
      intent: Manage an org service account's client secret
      effect: write
      questions:
      - Can I manage an organization service account's client secret via API?
      - Where do I rotate the client secret on an org-level service account?
      instructions:
      - text: Manage the client secret for service account {serviceaccount_id} in organization {org_id}.
        slots:
          serviceaccount_id: path.serviceaccount_id
          org_id: path.org_id
      - text: Rotate org {org_id} service account {serviceaccount_id}'s client secret.
        slots:
          org_id: path.org_id
          serviceaccount_id: path.serviceaccount_id
      method: generated
      generated: '2026-10-01'