# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Chef Automate API Documentation Profiles Service API
  version: 1.0.0
extends: openapi/progress-software-profilesservice-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: 7
- target: $.paths['/api/v0/compliance/market/read/{name}/version/{version}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show an available market compliance profile
      effect: read
      questions:
      - What controls are in a compliance profile I haven't installed yet?
      - Can I preview a market profile by name and version before installing it?
      instructions:
      - text: Show available market profile {name} version {version}.
        slots:
          name: path.name
          version: path.version
      - text: Preview un-installed profile {name} at version {version}.
        slots:
          name: path.name
          version: path.version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/compliance/profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload or install a compliance profile
      effect: write
      questions:
      - How do I upload my own InSpec profile tarball to Chef Automate?
      - Can I install a market profile into a user's namespace?
      instructions:
      - text: Upload a compliance profile for owner {owner}.
        slots:
          owner: requestBody.owner
      - text: Install a profile with metadata {meta} for {owner}.
        slots:
          meta: requestBody.meta
          owner: requestBody.owner
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/compliance/profiles/metasearch'].post
  update:
    x-apievangelist-phrasing:
      intent: Check which profiles lack stored metadata
      effect: read
      questions:
      - Which of these profile checksums are missing metadata in the backend?
      - Can I check several profiles by sha256 to see if they need uploading?
      instructions:
      - text: Check which profile sha256 IDs {sha256} have no stored metadata.
        slots:
          sha256: requestBody.sha256
      - text: Find missing profile metadata for checksums {sha256}.
        slots:
          sha256: requestBody.sha256
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/compliance/profiles/read/{owner}/{name}/version/{version}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show an installed compliance profile
      effect: read
      questions:
      - What does a profile I've already installed contain?
      - Can I view an installed profile for a specific owner and version?
      instructions:
      - text: Show installed profile {name} version {version} owned by {owner}.
        slots:
          name: path.name
          version: path.version
          owner: path.owner
      - text: Get the details of {owner}'s installed profile {name} at {version}.
        slots:
          owner: path.owner
          name: path.name
          version: path.version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/compliance/profiles/search'].post
  update:
    x-apievangelist-phrasing:
      intent: List compliance profiles
      effect: read
      questions:
      - Which compliance profiles are available in the market?
      - Can I list just the profiles a given user has installed?
      instructions:
      - text: List all market compliance profiles.
      - text: List profiles installed by owner {owner}.
        slots:
          owner: requestBody.owner
      - text: Search profiles named {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/compliance/profiles/tar'].post
  update:
    x-apievangelist-phrasing:
      intent: Download a compliance profile as a tarball
      effect: read
      questions:
      - How do I download a profile to my workstation as a tarball?
      - Can I export an installed profile so I can edit it locally?
      instructions:
      - text: Download profile {name} version {version} owned by {owner} as a tarball.
        slots:
          name: requestBody.name
          version: requestBody.version
          owner: requestBody.owner
      - text: Export the tarball for profile {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/compliance/profiles/{owner}/{name}/version/{version}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Uninstall a compliance profile
      effect: destructive
      questions:
      - How do I uninstall a profile from a user's namespace?
      - Does deleting an installed profile remove it from the market list too?
      instructions:
      - text: Uninstall profile {name} version {version} from owner {owner}.
        slots:
          name: path.name
          version: path.version
          owner: path.owner
      - text: Delete {owner}'s installed profile {name} at {version}.
        slots:
          owner: path.owner
          name: path.name
          version: path.version
      method: generated
      generated: '2026-10-01'