Progress Software · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Chef Automate API Documentation License API

4 actions 4 updates phrasing extends openapi/progress-software-license-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 4

$.info
$.paths['/api/v0/license/apply'].post
$.paths['/api/v0/license/request'].post
$.paths['/api/v0/license/status'].get

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 License API
  version: 1.0.0
extends: openapi/progress-software-license-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: 3
- target: $.paths['/api/v0/license/apply'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply a license
      effect: write
      questions:
      - How do I install a license key in Chef Automate?
      - Can I replace the current license with a new one?
      instructions:
      - text: Apply license {license}.
        slots:
          license: requestBody.license
      - text: Install the license key {license}.
        slots:
          license: requestBody.license
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/license/request'].post
  update:
    x-apievangelist-phrasing:
      intent: Request a trial license
      effect: write
      questions:
      - How do I request a trial license with my name and email?
      - Is GDPR consent required when requesting a license?
      instructions:
      - text: Request a license for {first_name} {last_name} at {email}.
        slots:
          first_name: requestBody.first_name
          last_name: requestBody.last_name
          email: requestBody.email
      - text: Request a trial license for {email} with GDPR consent.
        slots:
          email: requestBody.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/license/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Get license status
      effect: read
      questions:
      - What's the status of my current license?
      - When does my license expire?
      instructions:
      - text: Get the current license status.
      - text: Show license details and expiry.
      method: generated
      generated: '2026-10-01'