Progress Software · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Chef Automate API Documentation Projects API

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

$.info
$.paths['/apis/iam/v2/projects'].get
$.paths['/apis/iam/v2/projects'].post
$.paths['/apis/iam/v2/projects/{id}'].get
$.paths['/apis/iam/v2/projects/{id}'].put
$.paths['/apis/iam/v2/projects/{id}'].delete

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 Projects API
  version: 1.0.0
extends: openapi/progress-software-projects-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: 5
- target: $.paths['/apis/iam/v2/projects'].get
  update:
    x-apievangelist-phrasing:
      intent: List IAM projects
      effect: read
      questions:
      - Which IAM projects exist for scoping permissions?
      - Can I see every project used in my access policies?
      instructions:
      - text: List all IAM projects.
      - text: Show every project defined for policy scoping.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/apis/iam/v2/projects'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an IAM project
      effect: write
      questions:
      - How do I create a project to scope resources in my IAM policies?
      - Can I create a project without the default editor, viewer and owner policies?
      instructions:
      - text: Create IAM project {id} named {name}.
        slots:
          id: requestBody.id
          name: requestBody.name
      - text: 'Create project {id} called {name} and skip its default policies: {skip_policies}.'
        slots:
          id: requestBody.id
          name: requestBody.name
          skip_policies: requestBody.skip_policies
      method: generated
      generated: '2026-10-01'
- target: $.paths['/apis/iam/v2/projects/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an IAM project
      effect: read
      questions:
      - How do I look up a single IAM project's details?
      - What name does a given project ID have?
      instructions:
      - text: Show IAM project {id}.
        slots:
          id: path.id
      - text: Get the details of project {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/apis/iam/v2/projects/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename an IAM project
      effect: write
      questions:
      - How do I rename an existing IAM project?
      - Can I change a project's ID, or only its name?
      instructions:
      - text: Rename project {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Change the display name of IAM project {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/apis/iam/v2/projects/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an IAM project
      effect: destructive
      questions:
      - What happens to policies and resources when I delete a project?
      - How do I delete an IAM project I no longer need?
      instructions:
      - text: Delete IAM project {id}.
        slots:
          id: path.id
      - text: Remove project {id} from all resources and policy statements.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'