# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for JFrog Catalog REST Packages API
  version: 1.0.0
extends: openapi/jfrog-packages-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/packages/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search the package catalog
      effect: read
      questions:
      - Which packages in the catalog have known vulnerabilities?
      - Can I search packages by name and filter by a minimum severity?
      - How do I find packages of one type that carry a certain label?
      instructions:
      - text: Search the catalog for packages named {query}.
        slots:
          query: requestBody.query
      - text: Find {package_type} packages with vulnerabilities of at least {min_severity} severity.
        slots:
          package_type: requestBody.package_type
          min_severity: requestBody.min_severity
      method: generated
      generated: '2026-10-01'
- target: $.paths['/packages/{packageType}/{packageName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get package details
      effect: read
      questions:
      - What licenses and vulnerabilities does a specific package have?
      - Can I see the custom labels attached to a package?
      instructions:
      - text: Get details for {packageType} package {packageName}.
        slots:
          packageType: path.packageType
          packageName: path.packageName
      - text: Show me licenses and labels for the {packageName} {packageType} package.
        slots:
          packageName: path.packageName
          packageType: path.packageType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/packages/{packageType}/{packageName}/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a package's versions
      effect: read
      questions:
      - Which versions of a package are known, with vulnerability counts?
      - Can I page through every version of a package?
      instructions:
      - text: List versions of {packageType} package {packageName}.
        slots:
          packageType: path.packageType
          packageName: path.packageName
      - text: Show {limit} versions of {packageName} ({packageType}) starting at {offset}.
        slots:
          limit: query.limit
          packageName: path.packageName
          packageType: path.packageType
          offset: query.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/packages/{packageType}/{packageName}/versions/{version}/vulnerabilities'].get
  update:
    x-apievangelist-phrasing:
      intent: List CVEs affecting a package version
      effect: read
      questions:
      - Which CVEs affect a specific version of a package, including transitive ones?
      - Can I filter a package version's vulnerabilities to a single severity?
      instructions:
      - text: List vulnerabilities in {packageName} {version} ({packageType}).
        slots:
          packageName: path.packageName
          version: path.version
          packageType: path.packageType
      - text: Show {severity} CVEs for {packageType} package {packageName} version {version}.
        slots:
          severity: query.severity
          packageType: path.packageType
          packageName: path.packageName
          version: path.version
      method: generated
      generated: '2026-10-01'