Snyk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snyk Tenants API

7 actions 7 updates phrasing extends openapi/snyk-tenants-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Snyk's API. It is a proposal applied on top of the contract, not a document Snyk publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/tenants'].get
$.paths['/tenants/{tenant_id}'].get
$.paths['/tenants/{tenant_id}'].patch
$.paths['/tenants/{tenant_id}/memberships'].get
$.paths['/tenants/{tenant_id}/memberships/{membership_id}'].delete
$.paths['/tenants/{tenant_id}/memberships/{membership_id}'].patch

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Snyk Tenants API
  version: 1.0.0
extends: openapi/snyk-tenants-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['/tenants'].get
  update:
    x-apievangelist-phrasing:
      intent: List tenants I belong to
      effect: read
      questions:
      - Which Snyk tenants am I a member of?
      - Can I find one of my tenants by name?
      instructions:
      - text: List the tenants I'm a member of.
      - text: Find my tenants named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a tenant's details
      effect: read
      questions:
      - What are the full details of my tenant?
      - Can I look up a tenant by its ID?
      instructions:
      - text: Get the details of tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      - text: Show tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a tenant's details
      effect: write
      questions:
      - Can I rename my tenant?
      - What tenant details can be edited through the API?
      instructions:
      - text: Update the details of tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      - text: Rename tenant {tenant_id} to our company's new name.
        slots:
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}/memberships'].get
  update:
    x-apievangelist-phrasing:
      intent: List memberships in a tenant
      effect: read
      questions:
      - Who are the members of my tenant?
      - Can I filter tenant members by SSO connection type or role?
      - How do I find a tenant member by email?
      instructions:
      - text: List all memberships of tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      - text: Find tenant {tenant_id} members with email {email}.
        slots:
          tenant_id: path.tenant_id
          email: query.email
      - text: List tenant {tenant_id} members with role {role_name}.
        slots:
          tenant_id: path.tenant_id
          role_name: query.role_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}/memberships/{membership_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user's tenant membership
      effect: destructive
      questions:
      - Can I remove a single user from my tenant?
      - What permissions are needed to delete a tenant membership?
      instructions:
      - text: Delete membership {membership_id} from tenant {tenant_id}.
        slots:
          membership_id: path.membership_id
          tenant_id: path.tenant_id
      - text: Remove tenant {tenant_id} member {membership_id}.
        slots:
          tenant_id: path.tenant_id
          membership_id: path.membership_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}/memberships/{membership_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a user's role in a tenant
      effect: write
      questions:
      - Can I give a tenant member a new role?
      - Where do I change someone's tenant-level role?
      instructions:
      - text: Update the role on membership {membership_id} in tenant {tenant_id}.
        slots:
          membership_id: path.membership_id
          tenant_id: path.tenant_id
      - text: Make tenant {tenant_id} member {membership_id} a tenant admin.
        slots:
          tenant_id: path.tenant_id
          membership_id: path.membership_id
      method: generated
      generated: '2026-09-26'