Snyk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snyk Broker Deployments API

6 actions 6 updates phrasing extends openapi/snyk-brokerdeployments-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 6

$.info

$.paths['/tenants/{tenant_id}/brokers/deployments'].get

$.paths['/tenants/{tenant_id}/brokers/installs/{install_id}/deployments'].get

$.paths['/tenants/{tenant_id}/brokers/installs/{install_id}/deployments'].post

$.paths['/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}'].delete

$.paths['/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}'].patch

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 Broker Deployments API
  version: 1.0.0
extends: openapi/snyk-brokerdeployments-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: 5
- target: $.paths['/tenants/{tenant_id}/brokers/deployments'].get
  update:
    x-apievangelist-phrasing:
      intent: List all Broker deployments in a tenant
      effect: read
      questions:
      - Which Broker deployments exist across my whole tenant?
      - Can I see every Broker deployment regardless of install?
      instructions:
      - text: List all Broker deployments in tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      - text: Show every deployment across installs for tenant {tenant_id}.
        slots:
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}/brokers/installs/{install_id}/deployments'].get
  update:
    x-apievangelist-phrasing:
      intent: List Broker deployments for one install
      effect: read
      questions:
      - What deployments belong to a specific Broker install?
      - Can I list deployments under one install ID?
      instructions:
      - text: List Broker deployments for install {install_id} in tenant {tenant_id}.
        slots:
          install_id: path.install_id
          tenant_id: path.tenant_id
      - text: Show deployments created under install {install_id} of tenant {tenant_id}.
        slots:
          install_id: path.install_id
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}/brokers/installs/{install_id}/deployments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Broker deployment for an install
      effect: write
      questions:
      - How do I create a new Universal Broker deployment?
      - Can I add a deployment to an existing Broker install?
      instructions:
      - text: Create a Broker deployment for install {install_id} in tenant {tenant_id}.
        slots:
          install_id: path.install_id
          tenant_id: path.tenant_id
      - text: Add a new deployment to Broker install {install_id} under tenant {tenant_id}.
        slots:
          install_id: path.install_id
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Broker deployment
      effect: destructive
      questions:
      - How do I tear down a Broker deployment?
      - Can I delete one deployment from an install?
      instructions:
      - text: Delete Broker deployment {deployment_id} from install {install_id} in tenant {tenant_id}.
        slots:
          deployment_id: path.deployment_id
          install_id: path.install_id
          tenant_id: path.tenant_id
      - text: Remove deployment {deployment_id} under install {install_id}, tenant {tenant_id}.
        slots:
          deployment_id: path.deployment_id
          install_id: path.install_id
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a Broker deployment
      effect: write
      questions:
      - How do I change the settings of an existing Broker deployment?
      - Can I edit a deployment in place?
      instructions:
      - text: Update Broker deployment {deployment_id} for install {install_id} in tenant {tenant_id}.
        slots:
          deployment_id: path.deployment_id
          install_id: path.install_id
          tenant_id: path.tenant_id
      - text: Edit deployment {deployment_id} under install {install_id} of tenant {tenant_id}.
        slots:
          deployment_id: path.deployment_id
          install_id: path.install_id
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'