# 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 Models API
  version: 1.0.0
extends: openapi/aws-api-gateway-models-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['/restapis/{restapi_id}/models'].get
  update:
    x-apievangelist-phrasing:
      intent: List a REST API's models
      effect: read
      questions:
      - What data models are defined on my REST API?
      - How do I see all the JSON schemas attached to a REST API?
      instructions:
      - text: List the models on REST API {restapi_id}.
        slots:
          restapi_id: path.restapi_id
      - text: Show up to {limit} models for REST API {restapi_id}.
        slots:
          limit: query.limit
          restapi_id: path.restapi_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/restapis/{restapi_id}/models'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a data model to a REST API
      effect: write
      questions:
      - How do I define a JSON schema model for request or response bodies?
      - What content type does a new model need?
      instructions:
      - text: Add a model named {name} with content type {contentType} to REST API {restapi_id}.
        slots:
          name: requestBody.name
          contentType: requestBody.contentType
          restapi_id: path.restapi_id
      - text: Create model {name} on REST API {restapi_id} using schema {schema} as {contentType}.
        slots:
          name: requestBody.name
          restapi_id: path.restapi_id
          schema: requestBody.schema
          contentType: requestBody.contentType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/restapis/{restapi_id}/models/{model_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one model's schema
      effect: read
      questions:
      - How do I read the schema of a specific model?
      - Can I get a model with all its referenced models flattened in?
      instructions:
      - text: Show model {model_name} on REST API {restapi_id}.
        slots:
          model_name: path.model_name
          restapi_id: path.restapi_id
      - text: Get model {model_name} from REST API {restapi_id} with references flattened.
        slots:
          model_name: path.model_name
          restapi_id: path.restapi_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/restapis/{restapi_id}/models/{model_name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a model
      effect: destructive
      questions:
      - How do I remove a model I no longer use from my REST API?
      - Can I delete a schema model from a REST API?
      instructions:
      - text: Delete model {model_name} from REST API {restapi_id}.
        slots:
          model_name: path.model_name
          restapi_id: path.restapi_id
      - text: Remove the unused {model_name} model on REST API {restapi_id}.
        slots:
          model_name: path.model_name
          restapi_id: path.restapi_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/restapis/{restapi_id}/models/{model_name}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change an existing model
      effect: write
      questions:
      - How do I change the schema of a model that already exists?
      - Can I edit a model's description after creating it?
      instructions:
      - text: Update model {model_name} on REST API {restapi_id} with {patchOperations}.
        slots:
          model_name: path.model_name
          restapi_id: path.restapi_id
          patchOperations: requestBody.patchOperations
      - text: Patch the schema of existing model {model_name} in REST API {restapi_id}.
        slots:
          model_name: path.model_name
          restapi_id: path.restapi_id
      method: generated
      generated: '2026-10-01'