Snyk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snyk Broker Contexts API

9 actions 9 updates phrasing extends openapi/snyk-brokercontexts-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['/tenants/{tenant_id}/brokers/installs/{install_id}/connections/{connection_id}/contexts'].get
$.paths['/tenants/{tenant_id}/brokers/installs/{install_id}/contexts/{context_id}'].get
$.paths['/tenants/{tenant_id}/brokers/installs/{install_id}/contexts/{context_id}'].delete
$.paths['/tenants/{tenant_id}/brokers/installs/{install_id}/contexts/{context_id}'].patch
$.paths['/tenants/{tenant_id}/brokers/installs/{install_id}/contexts/{context_id}/integration'].patch
$.paths['/tenants/{tenant_id}/brokers/installs/{install_id}/contexts/{context_id}/integrations/{integration_id}'].delete
$.paths['/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/contexts'].get
$.paths['/tenants/{tenant_id}/brokers/installs/{install_id}/deployments/{deployment_id}/contexts'].post

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 Broker Contexts API
  version: 1.0.0
extends: openapi/snyk-brokercontexts-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['/tenants/{tenant_id}/brokers/installs/{install_id}/connections/{connection_id}/contexts'].get
  update:
    x-apievangelist-phrasing:
      intent: List Broker contexts for a connection
      effect: read
      questions:
      - Which Broker contexts are attached to a given Broker connection?
      - Can I page through the contexts of one Broker connection?
      instructions:
      - text: List Broker contexts for connection {connection_id} in install {install_id} of tenant {tenant_id}.
        slots:
          connection_id: path.connection_id
          install_id: path.install_id
          tenant_id: path.tenant_id
      - text: Show the first {limit} contexts of Broker connection {connection_id}, install {install_id}, tenant {tenant_id}.
        slots:
          limit: query.limit
          connection_id: path.connection_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}/contexts/{context_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Broker context by ID
      effect: read
      questions:
      - Can I look up a single Broker context by its ID?
      - What does one Broker context record contain?
      instructions:
      - text: Get Broker context {context_id} in install {install_id} of tenant {tenant_id}.
        slots:
          context_id: path.context_id
          install_id: path.install_id
          tenant_id: path.tenant_id
      - text: Show the details of context {context_id} for Broker install {install_id} in tenant {tenant_id}.
        slots:
          context_id: path.context_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}/contexts/{context_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Broker context
      effect: destructive
      questions:
      - Can I remove a Broker context I no longer use?
      - What permissions do I need to delete a Broker context?
      instructions:
      - text: Delete Broker context {context_id} from install {install_id} in tenant {tenant_id}.
        slots:
          context_id: path.context_id
          install_id: path.install_id
          tenant_id: path.tenant_id
      - text: Remove context {context_id} from Broker install {install_id}, tenant {tenant_id}.
        slots:
          context_id: path.context_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}/contexts/{context_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a Broker context
      effect: write
      questions:
      - Can I change the settings of an existing Broker context?
      - Is it possible to edit a Broker context after the deployment is running?
      instructions:
      - text: Update Broker context {context_id} in install {install_id} of tenant {tenant_id}.
        slots:
          context_id: path.context_id
          install_id: path.install_id
          tenant_id: path.tenant_id
      - text: Change the values of context {context_id} on Broker install {install_id}, tenant {tenant_id}.
        slots:
          context_id: path.context_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}/contexts/{context_id}/integration'].patch
  update:
    x-apievangelist-phrasing:
      intent: Associate an integration with a Broker context
      effect: write
      questions:
      - How do I link an integration to a Broker context?
      - Can I change which integration a Broker context is used by?
      instructions:
      - text: Associate an integration with Broker context {context_id} in install {install_id}, tenant {tenant_id}.
        slots:
          context_id: path.context_id
          install_id: path.install_id
          tenant_id: path.tenant_id
      - text: Point Broker context {context_id} of install {install_id} in tenant {tenant_id} at a different integration.
        slots:
          context_id: path.context_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}/contexts/{context_id}/integrations/{integration_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Detach an integration from a Broker context
      effect: destructive
      questions:
      - Can I unlink an integration from a Broker context without deleting the context?
      - What removes the association between a Broker context and an integration?
      instructions:
      - text: Detach integration {integration_id} from Broker context {context_id} in install {install_id}, tenant {tenant_id}.
        slots:
          integration_id: path.integration_id
          context_id: path.context_id
          install_id: path.install_id
          tenant_id: path.tenant_id
      - text: Remove the link between context {context_id} and integration {integration_id} on install {install_id} in tenant {tenant_id}.
        slots:
          context_id: path.context_id
          integration_id: path.integration_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}/contexts'].get
  update:
    x-apievangelist-phrasing:
      intent: List Broker contexts for a deployment
      effect: read
      questions:
      - Which contexts belong to a particular Broker deployment?
      - Can I list every context under one Broker deployment?
      instructions:
      - text: List contexts 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} contexts of 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}/contexts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Broker context for a deployment
      effect: write
      questions:
      - How do I create a new Broker context on a deployment?
      - Can I add a context to an existing Broker deployment through the API?
      instructions:
      - text: Create a Broker context 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 context 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'