# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Snyk Projects API
  version: 1.0.0
extends: openapi/snyk-projects-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: 4
- target: $.paths['/orgs/{org_id}/projects'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's Snyk projects
      effect: read
      questions:
      - What projects does my Snyk organization monitor?
      - Can I filter projects by tag, business criticality or environment?
      - Which projects were last monitored from the CLI before a certain date?
      instructions:
      - text: List projects in org {org_id}.
        slots:
          org_id: path.org_id
      - text: Show projects in org {org_id} for target {target_id}.
        slots:
          org_id: path.org_id
          target_id: query.target_id
      - text: List org {org_id} projects with business criticality {business_criticality} in environment {environment}.
        slots:
          org_id: path.org_id
          business_criticality: query.business_criticality
          environment: query.environment
      - text: Find projects whose names start with {names_start_with} in org {org_id}.
        slots:
          names_start_with: query.names_start_with
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/projects/{project_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a project by ID
      effect: read
      questions:
      - Where can I see one project's details and latest issue counts?
      - Can I fetch a single Snyk project with its dependency total?
      instructions:
      - text: Get project {project_id} in org {org_id}.
        slots:
          project_id: path.project_id
          org_id: path.org_id
      - text: Show project {project_id} in organization {org_id} with its latest issue counts.
        slots:
          project_id: path.project_id
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/projects/{project_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a project
      effect: destructive
      questions:
      - How do I delete a Snyk project I no longer want monitored?
      - Can I remove a project from an organization by ID?
      instructions:
      - text: Delete project {project_id} from org {org_id}.
        slots:
          project_id: path.project_id
          org_id: path.org_id
      - text: Remove project {project_id} in organization {org_id} permanently.
        slots:
          project_id: path.project_id
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/projects/{project_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a project's settings or attributes
      effect: write
      questions:
      - How do I change a project's tags or business criticality?
      - Can I update an existing project's attributes in place?
      instructions:
      - text: Update project {project_id} in org {org_id}.
        slots:
          project_id: path.project_id
          org_id: path.org_id
      - text: Change the attributes of project {project_id} for organization {org_id}.
        slots:
          project_id: path.project_id
          org_id: path.org_id
      method: generated
      generated: '2026-09-26'