Snyk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snyk Deployment Credentials API

6 actions 6 updates phrasing extends openapi/snyk-deploymentcredentials-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/installs/{install_id}/deployments/{deployment_id}/credentials'].get
$.paths['/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/credentials'].post
$.paths['/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/credentials/{credential_id}'].get
$.paths['/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/credentials/{credential_id}'].delete
$.paths['/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/credentials/{credential_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 Deployment Credentials API
  version: 1.0.0
extends: openapi/snyk-deploymentcredentials-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/installs/{install_id}/deployments/{deployment_id}/credentials'].get
  update:
    x-apievangelist-phrasing:
      intent: List credentials for a Broker deployment
      effect: read
      questions:
      - Which credentials are stored on a Broker deployment?
      - Can I page through a Broker deployment's credentials?
      instructions:
      - text: List credentials for deployment {deployment_id} in install {install_id} of tenant {tenant_id}.
        slots:
          deployment_id: path.deployment_id
          install_id: path.install_id
          tenant_id: path.tenant_id
      - text: Show the first {limit} credentials on Broker deployment {deployment_id}, install {install_id}, tenant {tenant_id}.
        slots:
          limit: query.limit
          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}/credentials'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a credential to a Broker deployment
      effect: write
      questions:
      - How do I add a new credential to a Broker deployment?
      - Can I register an extra credential for an existing Broker deployment?
      instructions:
      - text: Create a credential on deployment {deployment_id} in install {install_id} of tenant {tenant_id}.
        slots:
          deployment_id: path.deployment_id
          install_id: path.install_id
          tenant_id: path.tenant_id
      - text: Add a new credential to Broker deployment {deployment_id}, 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}/credentials/{credential_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Broker deployment credential
      effect: read
      questions:
      - Can I look up a single credential on a Broker deployment?
      - What data is kept for one deployment credential?
      instructions:
      - text: Get credential {credential_id} on deployment {deployment_id}, install {install_id}, tenant {tenant_id}.
        slots:
          credential_id: path.credential_id
          deployment_id: path.deployment_id
          install_id: path.install_id
          tenant_id: path.tenant_id
      - text: Show Broker credential {credential_id} for deployment {deployment_id} in install {install_id} of tenant {tenant_id}.
        slots:
          credential_id: path.credential_id
          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}/credentials/{credential_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Broker deployment credential
      effect: destructive
      questions:
      - Can I remove a credential from a Broker deployment?
      - What deletes an outdated deployment credential?
      instructions:
      - text: Delete credential {credential_id} from deployment {deployment_id}, install {install_id}, tenant {tenant_id}.
        slots:
          credential_id: path.credential_id
          deployment_id: path.deployment_id
          install_id: path.install_id
          tenant_id: path.tenant_id
      - text: Remove Broker credential {credential_id} on deployment {deployment_id} of install {install_id} in tenant {tenant_id}.
        slots:
          credential_id: path.credential_id
          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}/credentials/{credential_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a Broker deployment credential
      effect: write
      questions:
      - Can I update an existing Broker deployment credential in place?
      - Is there a way to change a stored deployment credential without recreating it?
      instructions:
      - text: Update credential {credential_id} on deployment {deployment_id}, install {install_id}, tenant {tenant_id}.
        slots:
          credential_id: path.credential_id
          deployment_id: path.deployment_id
          install_id: path.install_id
          tenant_id: path.tenant_id
      - text: Change Broker credential {credential_id} for deployment {deployment_id} in install {install_id} of tenant {tenant_id}.
        slots:
          credential_id: path.credential_id
          deployment_id: path.deployment_id
          install_id: path.install_id
          tenant_id: path.tenant_id
      method: generated
      generated: '2026-09-26'