Snyk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snyk Invites API

4 actions 4 updates phrasing extends openapi/snyk-invites-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 4

$.info

$.paths['/orgs/{org_id}/invites'].get

$.paths['/orgs/{org_id}/invites'].post

$.paths['/orgs/{org_id}/invites/{invite_id}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Snyk Invites API
  version: 1.0.0
extends: openapi/snyk-invites-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: 3
- target: $.paths['/orgs/{org_id}/invites'].get
  update:
    x-apievangelist-phrasing:
      intent: List pending invitations to an organization
      effect: read
      questions:
      - Who has been invited to my organization but hasn't accepted yet?
      - Can I page through outstanding org invitations?
      instructions:
      - text: List pending invitations for organization {org_id}.
        slots:
          org_id: path.org_id
      - text: Show the first {limit} open invites to org {org_id}.
        slots:
          limit: query.limit
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/invites'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite a user to an organization
      effect: write
      questions:
      - How do I invite a teammate to my Snyk organization by email?
      - Can I set the role someone gets when I invite them to an org?
      instructions:
      - text: Invite this user to organization {org_id} as a collaborator.
        slots:
          org_id: path.org_id
      - text: Send an org {org_id} invitation to a new developer with the admin role.
        slots:
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/invites/{invite_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a pending organization invitation
      effect: destructive
      questions:
      - Can I revoke an invite I sent before it's accepted?
      - What cancels a pending invitation to an organization?
      instructions:
      - text: Cancel invitation {invite_id} to organization {org_id}.
        slots:
          invite_id: path.invite_id
          org_id: path.org_id
      - text: Withdraw pending invite {invite_id} for org {org_id}.
        slots:
          invite_id: path.invite_id
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'