Snyk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snyk Collection API

9 actions 9 updates phrasing extends openapi/snyk-collection-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 9

$.info
$.paths['/orgs/{org_id}/collections'].get
$.paths['/orgs/{org_id}/collections'].post
$.paths['/orgs/{org_id}/collections/{collection_id}'].get
$.paths['/orgs/{org_id}/collections/{collection_id}'].delete
$.paths['/orgs/{org_id}/collections/{collection_id}'].patch
$.paths['/orgs/{org_id}/collections/{collection_id}/relationships/projects'].get
$.paths['/orgs/{org_id}/collections/{collection_id}/relationships/projects'].post
$.paths['/orgs/{org_id}/collections/{collection_id}/relationships/projects'].delete

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 Collection API
  version: 1.0.0
extends: openapi/snyk-collection-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['/orgs/{org_id}/collections'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's project collections
      effect: read
      questions:
      - What collections does my org have, with their issue and project counts?
      - Can I find a collection by name or hide auto-generated ones?
      instructions:
      - text: List the collections in org {org_id}.
        slots:
          org_id: path.org_id
      - text: Find collections named {name} in org {org_id}.
        slots:
          name: query.name
          org_id: path.org_id
      - text: List org {org_id} collections sorted by {sort} {direction}.
        slots:
          org_id: path.org_id
          sort: query.sort
          direction: query.direction
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/collections'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a project collection
      effect: write
      questions:
      - How do I group Snyk projects into a new collection?
      - Can I create a named collection for my team's projects?
      instructions:
      - text: Create a new collection in org {org_id}.
        slots:
          org_id: path.org_id
      - text: Start a collection for our payments projects in organization {org_id}.
        slots:
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/collections/{collection_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single collection
      effect: read
      questions:
      - Where can I see the details of one collection?
      - Can I fetch a collection by its ID?
      instructions:
      - text: Get collection {collection_id} in org {org_id}.
        slots:
          collection_id: path.collection_id
          org_id: path.org_id
      - text: Show the details of collection {collection_id} for organization {org_id}.
        slots:
          collection_id: path.collection_id
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/collections/{collection_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a collection
      effect: destructive
      questions:
      - How do I delete a collection I no longer need?
      - Can I remove a whole collection by ID?
      instructions:
      - text: Delete collection {collection_id} from org {org_id}.
        slots:
          collection_id: path.collection_id
          org_id: path.org_id
      - text: Remove the collection {collection_id} in organization {org_id} entirely.
        slots:
          collection_id: path.collection_id
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/collections/{collection_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or edit a collection
      effect: write
      questions:
      - How do I rename an existing collection?
      - Can I edit a collection's attributes after creating it?
      instructions:
      - text: Edit collection {collection_id} in org {org_id}.
        slots:
          collection_id: path.collection_id
          org_id: path.org_id
      - text: Rename collection {collection_id} for organization {org_id}.
        slots:
          collection_id: path.collection_id
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/collections/{collection_id}/relationships/projects'].get
  update:
    x-apievangelist-phrasing:
      intent: List the projects in a collection
      effect: read
      questions:
      - Which projects are inside a given collection?
      - Can I filter a collection's projects by target or integration?
      instructions:
      - text: List projects in collection {collection_id} of org {org_id}.
        slots:
          collection_id: path.collection_id
          org_id: path.org_id
      - text: Show projects in collection {collection_id} for target {target_id} in org {org_id}.
        slots:
          collection_id: path.collection_id
          target_id: query.target_id
          org_id: path.org_id
      - text: List collection {collection_id} projects from integration {integration} in org {org_id}.
        slots:
          collection_id: path.collection_id
          integration: query.integration
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/collections/{collection_id}/relationships/projects'].post
  update:
    x-apievangelist-phrasing:
      intent: Add projects to a collection
      effect: write
      questions:
      - How do I add projects to an existing collection?
      - Can I put several projects into a collection in one call?
      instructions:
      - text: Add these projects to collection {collection_id} in org {org_id}.
        slots:
          collection_id: path.collection_id
          org_id: path.org_id
      - text: Put the listed project IDs into collection {collection_id} for organization {org_id}.
        slots:
          collection_id: path.collection_id
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/collections/{collection_id}/relationships/projects'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove projects from a collection
      effect: destructive
      questions:
      - How do I take projects out of a collection without deleting them?
      - Can I remove several projects from a collection at once?
      instructions:
      - text: Remove these projects from collection {collection_id} in org {org_id}.
        slots:
          collection_id: path.collection_id
          org_id: path.org_id
      - text: Take the listed project IDs out of collection {collection_id} for organization {org_id}.
        slots:
          collection_id: path.collection_id
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'