Snyk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snyk Container Registry Import Policy API

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

$.info
$.paths['/orgs/{org_id}/container_import/{integration_id}/policy'].get
$.paths['/orgs/{org_id}/container_import/{integration_id}/policy'].post
$.paths['/orgs/{org_id}/container_import/{integration_id}/policy'].delete
$.paths['/orgs/{org_id}/container_import/{integration_id}/policy'].patch
$.paths['/orgs/{org_id}/container_import/{integration_id}/policy/dry_run'].post
$.paths['/orgs/{org_id}/container_import/{integration_id}/policy/dry_run/{job_id}'].get

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 Container Registry Import Policy API
  version: 1.0.0
extends: openapi/snyk-containerregistryimportpolicy-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: 6
- target: $.paths['/orgs/{org_id}/container_import/{integration_id}/policy'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a container registry import policy
      effect: read
      questions:
      - What import policy is set on my container registry integration?
      - Can I see which images a registry integration will auto-import?
      instructions:
      - text: Get the import policy for registry integration {integration_id} in org {org_id}.
        slots:
          integration_id: path.integration_id
          org_id: path.org_id
      - text: Show organization {org_id}'s container import policy on integration {integration_id}.
        slots:
          org_id: path.org_id
          integration_id: path.integration_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/container_import/{integration_id}/policy'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a container registry import policy
      effect: write
      questions:
      - How do I set up an import policy for a container registry integration?
      - Can I define which registry images Snyk should import automatically?
      instructions:
      - text: Create an import policy for registry integration {integration_id} in org {org_id}.
        slots:
          integration_id: path.integration_id
          org_id: path.org_id
      - text: Add a new container import policy to integration {integration_id} for organization {org_id}.
        slots:
          integration_id: path.integration_id
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/container_import/{integration_id}/policy'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a container registry import policy
      effect: destructive
      questions:
      - How do I remove the import policy from a registry integration?
      - Can I stop automatic image imports by deleting the policy?
      instructions:
      - text: Delete the import policy on registry integration {integration_id} in org {org_id}.
        slots:
          integration_id: path.integration_id
          org_id: path.org_id
      - text: Remove organization {org_id}'s container import policy from integration {integration_id}.
        slots:
          org_id: path.org_id
          integration_id: path.integration_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/container_import/{integration_id}/policy'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a container registry import policy
      effect: write
      questions:
      - How do I change the rules in an existing registry import policy?
      - Can I edit an import policy without deleting and recreating it?
      instructions:
      - text: Update the import policy on registry integration {integration_id} in org {org_id}.
        slots:
          integration_id: path.integration_id
          org_id: path.org_id
      - text: Edit the existing container import policy of integration {integration_id} for organization {org_id}.
        slots:
          integration_id: path.integration_id
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/container_import/{integration_id}/policy/dry_run'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a dry run of a registry import policy
      effect: write
      questions:
      - Can I test what an import policy would import before applying it?
      - How do I start a dry run job for a container registry policy?
      instructions:
      - text: Start an import policy dry run for registry integration {integration_id} in org {org_id}.
        slots:
          integration_id: path.integration_id
          org_id: path.org_id
      - text: Test this policy against integration {integration_id} in organization {org_id} without importing anything.
        slots:
          integration_id: path.integration_id
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/container_import/{integration_id}/policy/dry_run/{job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the status and results of a policy dry run
      effect: read
      questions:
      - Has my import policy dry run finished, and what did it find?
      - Where can I read the results of a dry run job?
      instructions:
      - text: Get dry run job {job_id} for registry integration {integration_id} in org {org_id}.
        slots:
          job_id: path.job_id
          integration_id: path.integration_id
          org_id: path.org_id
      - text: Check the results of policy dry run {job_id} on integration {integration_id}, org {org_id}.
        slots:
          job_id: path.job_id
          integration_id: path.integration_id
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'