# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Amazon API Gateway REST API Keys Documentation API
  version: 1.0.0
extends: openapi/aws-api-gateway-documentation-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['/restapis/{restapi_id}/documentation/parts'].get
  update:
    x-apievangelist-phrasing:
      intent: List a REST API's documentation parts
      effect: read
      questions:
      - What documentation has been written for my REST API's methods and resources?
      - Can I filter documentation parts by type or path?
      instructions:
      - text: List documentation parts for REST API {restapi_id}.
        slots:
          restapi_id: path.restapi_id
      - text: Show {type} documentation parts on REST API {restapi_id} under path {path}.
        slots:
          type: query.type
          restapi_id: path.restapi_id
          path: query.path
      - text: Find documentation parts named {nameQuery} in REST API {restapi_id}.
        slots:
          nameQuery: query.nameQuery
          restapi_id: path.restapi_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/restapis/{restapi_id}/documentation/parts'].post
  update:
    x-apievangelist-phrasing:
      intent: Add documentation to part of a REST API
      effect: write
      questions:
      - How do I add a description to a specific method or resource of my REST API?
      - Where does a documentation part attach in my API?
      instructions:
      - text: Add documentation {properties} at location {location} on REST API {restapi_id}.
        slots:
          properties: requestBody.properties
          location: requestBody.location
          restapi_id: path.restapi_id
      - text: Document location {location} of REST API {restapi_id} with {properties}.
        slots:
          location: requestBody.location
          restapi_id: path.restapi_id
          properties: requestBody.properties
      method: generated
      generated: '2026-10-01'
- target: $.paths['/restapis/{restapi_id}/documentation/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List documentation snapshots
      effect: read
      questions:
      - Which documentation versions have I published for a REST API?
      - How do I see past snapshots of my API docs?
      instructions:
      - text: List documentation versions of REST API {restapi_id}.
        slots:
          restapi_id: path.restapi_id
      - text: Show the saved documentation snapshots for REST API {restapi_id}.
        slots:
          restapi_id: path.restapi_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/restapis/{restapi_id}/documentation/versions'].post
  update:
    x-apievangelist-phrasing:
      intent: Snapshot a REST API's documentation
      effect: write
      questions:
      - How do I freeze the current docs of my REST API as a version?
      - Can I tie a documentation snapshot to a stage?
      instructions:
      - text: Snapshot the docs of REST API {restapi_id} as version {documentationVersion}.
        slots:
          restapi_id: path.restapi_id
          documentationVersion: requestBody.documentationVersion
      - text: Publish documentation version {documentationVersion} of REST API {restapi_id} to stage {stageName}.
        slots:
          documentationVersion: requestBody.documentationVersion
          restapi_id: path.restapi_id
          stageName: requestBody.stageName
      method: generated
      generated: '2026-10-01'