Progress Software · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Chef Automate API Documentation Cds API

5 actions 5 updates phrasing extends openapi/progress-software-cds-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/beta/content/credentials'].post

$.paths['/api/beta/content/enabled'].get

$.paths['/api/beta/content/install'].post

$.paths['/api/beta/content/items'].get

OpenAPI Overlay

# 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 Cds API
  version: 1.0.0
extends: openapi/progress-software-cds-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/beta/content/credentials'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit cloud credentials to enable content
      effect: write
      questions:
      - How do I enable content downloads by submitting my cloud client ID and secret?
      - What credentials does the content service need, including a tenant-specific URL?
      instructions:
      - text: Submit content credentials with client ID {client_id} and secret {client_secret}.
        slots:
          client_id: requestBody.client_id
          client_secret: requestBody.client_secret
      - text: Enable content using tenant URL {tenant_specific_url} and client ID {client_id}.
        slots:
          tenant_specific_url: requestBody.tenant_specific_url
          client_id: requestBody.client_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/beta/content/enabled'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether content is enabled
      effect: read
      questions:
      - Is content enabled on this Automate instance?
      - Have content credentials already been set up here?
      instructions:
      - text: Check if content is enabled on this instance.
      - text: Tell me whether content credentials are configured.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/beta/content/install'].post
  update:
    x-apievangelist-phrasing:
      intent: Install a content item
      effect: write
      questions:
      - How do I install a content item by its ID?
      - Can I record which user requested a content install?
      instructions:
      - text: Install content item {id}.
        slots:
          id: requestBody.id
      - text: Install content item {id} on behalf of {request_user}.
        slots:
          id: requestBody.id
          request_user: requestBody.request_user
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/beta/content/items'].get
  update:
    x-apievangelist-phrasing:
      intent: List available content items
      effect: read
      questions:
      - What content items are available and which are already installed?
      - Can I see the description and current state of each content item?
      instructions:
      - text: List all content items with their state.
      - text: Show me which content items are available to install.
      method: generated
      generated: '2026-10-01'