# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Palo Alto Networks Compliance Frameworks API
  version: 1.0.0
extends: openapi/palo-alto-networks-compliance-frameworks-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: 16
- target: $.paths['/definitions'].get
  update:
    x-apievangelist-phrasing:
      intent: List compliance frameworks (unversioned path)
      effect: read
      questions:
      - Which compliance frameworks exist in my tenant service group, via the unversioned definitions endpoint?
      - Can the short /definitions listing filter frameworks by category or status?
      instructions:
      - text: Using the unversioned definitions endpoint, list all compliance frameworks.
      - text: Via the short-path definitions API, list frameworks in category {category} with status {status}.
        slots:
          category: query.category
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/definitions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a compliance framework (unversioned path)
      effect: write
      questions:
      - How do I define a new compliance framework through the unversioned definitions endpoint?
      - Does the server assign the id when I post a framework to the short /definitions path?
      instructions:
      - text: Through the unversioned definitions endpoint, create compliance framework {name}.
        slots:
          name: requestBody.name
      - text: Post a framework named {name} sourced from {source_url} to the short-path definitions API.
        slots:
          name: requestBody.name
          source_url: requestBody.source_url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/definitions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a framework revision (unversioned path)
      effect: read
      questions:
      - Can I fetch the in-progress draft of a framework from the unversioned definitions endpoint?
      - What does the op parameter choose when reading a framework on the short /definitions path?
      instructions:
      - text: From the unversioned definitions endpoint, get framework {id} with op {op}.
        slots:
          id: path.id
          op: query.op
      - text: Via the short-path API, show the released revision of framework {id} using op {op}.
        slots:
          id: path.id
          op: query.op
      method: generated
      generated: '2026-09-26'
- target: $.paths['/definitions/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a compliance framework (unversioned path)
      effect: write
      questions:
      - How does editing a framework on the unversioned endpoint decide between the in-progress draft and a new revision?
      - Can I release a framework revision right away when updating through the short /definitions path?
      instructions:
      - text: On the unversioned definitions endpoint, rename framework {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Via the short-path API, update framework {id} and set release to {release}.
        slots:
          id: path.id
          release: query.release
      method: generated
      generated: '2026-09-26'
- target: $.paths['/definitions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a compliance framework (unversioned path)
      effect: destructive
      questions:
      - Does deleting a framework on the unversioned definitions endpoint remove every revision too?
      - Is framework deletion through the short /definitions path permanent?
      instructions:
      - text: Permanently delete framework {id} via the unversioned definitions endpoint.
        slots:
          id: path.id
      - text: Remove framework {id} and its revisions using the short /definitions path.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/definitions/{id}:clone'].post
  update:
    x-apievangelist-phrasing:
      intent: Clone a compliance framework (unversioned path)
      effect: write
      questions:
      - Can I copy an existing framework into my TSG using the unversioned clone action?
      - What call on the short /definitions path duplicates a framework?
      instructions:
      - text: Clone framework {id} with the unversioned definitions clone action.
        slots:
          id: path.id
      - text: Duplicate framework {id} into my TSG through the short-path API.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/definitions/{id}:benchmark'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark framework as benchmark (unversioned path)
      effect: write
      questions:
      - How do I flag a framework as a benchmark on the unversioned definitions endpoint?
      - Which short-path action sets the benchmark designation on a framework?
      instructions:
      - text: Using the unversioned endpoint, mark framework {id} as a benchmark.
        slots:
          id: path.id
      - text: Flag framework {id} as benchmark via the short /definitions path.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/definitions/{id}:un-benchmark'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove benchmark flag (unversioned path)
      effect: write
      questions:
      - Can I clear the benchmark designation from a framework via the unversioned definitions endpoint?
      - Which short-path action un-benchmarks a framework?
      instructions:
      - text: Via the short-path API, remove the benchmark flag from framework {id}.
        slots:
          id: path.id
      - text: Un-benchmark framework {id} on the unversioned definitions endpoint.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compliance-frameworks/v1/definitions'].get
  update:
    x-apievangelist-phrasing:
      intent: List compliance frameworks (v1 API)
      effect: read
      questions:
      - What compliance frameworks does the v1 compliance-frameworks API return for my TSG?
      - Can I filter the v1 framework list down to one category or a status?
      instructions:
      - text: List all compliance frameworks with the v1 compliance-frameworks API.
      - text: With the v1 API, list frameworks whose category is {category} and status is {status}.
        slots:
          category: query.category
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compliance-frameworks/v1/definitions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a compliance framework (v1 API)
      effect: write
      questions:
      - Can I create a custom compliance framework with a hierarchy using the v1 compliance-frameworks API?
      - Which fields does the v1 API accept when I add a framework, such as source URL and logo?
      instructions:
      - text: Create a v1 compliance framework called {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      - text: With the v1 API, add framework {name} in category {category}.
        slots:
          name: requestBody.name
          category: requestBody.category
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compliance-frameworks/v1/definitions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a framework revision (v1 API)
      effect: read
      questions:
      - How do I read the currently released revision of a framework with the v1 compliance-frameworks API?
      - Can the v1 API return a framework's in-progress revision instead of the released one?
      instructions:
      - text: Get v1 compliance framework {id} using op {op}.
        slots:
          id: path.id
          op: query.op
      - text: Show the in-progress revision of framework {id} from the v1 API with op {op}.
        slots:
          id: path.id
          op: query.op
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compliance-frameworks/v1/definitions/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a compliance framework (v1 API)
      effect: write
      questions:
      - Does updating a framework through the v1 API create a new in-progress revision when none exists?
      - Can I publish my framework edits immediately with the v1 release flag?
      instructions:
      - text: Update v1 compliance framework {id} with description {description}.
        slots:
          id: path.id
          description: requestBody.description
      - text: Edit framework {id} in the v1 API and release it with release {release}.
        slots:
          id: path.id
          release: query.release
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compliance-frameworks/v1/definitions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a compliance framework (v1 API)
      effect: destructive
      questions:
      - Can I permanently remove a framework and all its revisions with the v1 compliance-frameworks API?
      - What gets deleted along with a framework in the v1 API?
      instructions:
      - text: Delete v1 compliance framework {id} and all of its revisions.
        slots:
          id: path.id
      - text: Permanently remove framework {id} through the v1 compliance-frameworks API.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compliance-frameworks/v1/definitions/{id}:clone'].post
  update:
    x-apievangelist-phrasing:
      intent: Clone a compliance framework (v1 API)
      effect: write
      questions:
      - Can I duplicate a compliance framework into my TSG with the v1 API?
      - Which v1 compliance-frameworks action makes a copy of an existing framework?
      instructions:
      - text: Make a v1 copy of compliance framework {id} in my TSG.
        slots:
          id: path.id
      - text: Clone framework {id} using the v1 compliance-frameworks clone action.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compliance-frameworks/v1/definitions/{id}:benchmark'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark framework as benchmark (v1 API)
      effect: write
      questions:
      - Can I designate a framework as a benchmark using the v1 compliance-frameworks API?
      - Which v1 action turns a framework into a benchmark?
      instructions:
      - text: Designate v1 compliance framework {id} as a benchmark.
        slots:
          id: path.id
      - text: Use the v1 API to set the benchmark designation on framework {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compliance-frameworks/v1/definitions/{id}:un-benchmark'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove benchmark flag (v1 API)
      effect: write
      questions:
      - How do I stop a framework from being a benchmark with the v1 compliance-frameworks API?
      - Which v1 action removes the benchmark designation?
      instructions:
      - text: Take the benchmark designation off v1 compliance framework {id}.
        slots:
          id: path.id
      - text: Use the v1 API to un-benchmark framework {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'