Progress Software · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Chef Automate API Documentation Comp Assets API

5 actions 5 updates phrasing extends openapi/progress-software-comp-assets-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Progress Software's API. It is a proposal applied on top of the contract, not a document Progress Software publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/api/v0/compliance/reporting/assets/config'].put
$.paths['/api/v0/compliance/reporting/assets/config/search'].get
$.paths['/api/v0/compliance/reporting/assets/count'].post
$.paths['/api/v0/compliance/reporting/assets/search'].post

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 Chef Automate API Documentation Comp Assets API
  version: 1.0.0
extends: openapi/progress-software-comp-assets-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['/api/v0/compliance/reporting/assets/config'].put
  update:
    x-apievangelist-phrasing:
      intent: Set how many days before an asset counts as unreachable
      effect: write
      questions:
      - How do I change the number of days after which a compliance asset is treated as unreachable?
      - Can I tighten the unreachable-asset window to a shorter number of days?
      instructions:
      - text: Mark compliance assets unreachable after {value} days.
        slots:
          value: requestBody.value
      - text: Set the unreachable assets threshold to {value} days.
        slots:
          value: requestBody.value
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/compliance/reporting/assets/config/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the unreachable assets setting
      effect: read
      questions:
      - After how many days does Chef Automate consider a compliance asset unreachable?
      - What policy name and day count are set for unreachable assets?
      instructions:
      - text: Show the current unreachable assets configuration.
      - text: Get the day threshold used for unreachable compliance assets.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/compliance/reporting/assets/count'].post
  update:
    x-apievangelist-phrasing:
      intent: Count reported and unreported compliance assets
      effect: read
      questions:
      - How many of my compliance assets have reported versus not reported?
      - Can I count assets that match certain filters?
      instructions:
      - text: Count compliance assets.
      - text: Count reported and unreported assets matching {filters}.
        slots:
          filters: requestBody.filters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/compliance/reporting/assets/search'].post
  update:
    x-apievangelist-phrasing:
      intent: List compliance assets by collection status
      effect: read
      questions:
      - Which compliance assets have stopped reporting?
      - Can I list only the uncollected assets, a page at a time?
      instructions:
      - text: List compliance assets of type {assets_type}.
        slots:
          assets_type: requestBody.assets_type
      - text: List {size} assets matching {filters} starting at {from}.
        slots:
          size: requestBody.size
          filters: requestBody.filters
          from: requestBody.from
      method: generated
      generated: '2026-10-01'