Snyk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Snyk Targets API

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

$.info
$.paths['/orgs/{org_id}/targets'].get
$.paths['/orgs/{org_id}/targets/{target_id}'].get
$.paths['/orgs/{org_id}/targets/{target_id}'].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 Targets API
  version: 1.0.0
extends: openapi/snyk-targets-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: 3
- target: $.paths['/orgs/{org_id}/targets'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's targets
      effect: read
      questions:
      - Which repositories and other targets are imported into my organization?
      - Can I list only private targets, or hide targets with no projects?
      - What targets were created after a certain date?
      instructions:
      - text: List the targets in organization {org_id}.
        slots:
          org_id: path.org_id
      - text: Find org {org_id} targets with display name {display_name}.
        slots:
          org_id: path.org_id
          display_name: query.display_name
      - text: List org {org_id} targets of source type {source_types} created on or after {created_gte}.
        slots:
          org_id: path.org_id
          source_types: query.source_types
          created_gte: query.created_gte
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/targets/{target_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one target by ID
      effect: read
      questions:
      - Can I look up the details of one target by its ID?
      - What information is stored for a single imported target?
      instructions:
      - text: Get target {target_id} in organization {org_id}.
        slots:
          target_id: path.target_id
          org_id: path.org_id
      - text: Show org {org_id}'s target {target_id}.
        slots:
          org_id: path.org_id
          target_id: path.target_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/targets/{target_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a target
      effect: destructive
      questions:
      - Can I delete a target I no longer want monitored?
      - What permission do I need to remove a target from an org?
      instructions:
      - text: Delete target {target_id} from organization {org_id}.
        slots:
          target_id: path.target_id
          org_id: path.org_id
      - text: Remove org {org_id}'s target {target_id}.
        slots:
          org_id: path.org_id
          target_id: path.target_id
      method: generated
      generated: '2026-09-26'