# 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 Gateway Responses API
  version: 1.0.0
extends: openapi/aws-api-gateway-gateway-responses-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['/restapis/{restapi_id}/gatewayresponses'].get
  update:
    x-apievangelist-phrasing:
      intent: List a REST API's gateway responses
      effect: read
      questions:
      - What error responses does API Gateway return for my REST API?
      - How do I see all customized gateway responses on an API?
      instructions:
      - text: List gateway responses for REST API {restapi_id}.
        slots:
          restapi_id: path.restapi_id
      - text: Show all the error response settings on REST API {restapi_id}.
        slots:
          restapi_id: path.restapi_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/restapis/{restapi_id}/gatewayresponses/{response_type}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one gateway response type
      effect: read
      questions:
      - How is a particular gateway error, like an expired token, currently configured?
      - What status code does one gateway response type return?
      instructions:
      - text: Show the {response_type} gateway response on REST API {restapi_id}.
        slots:
          response_type: path.response_type
          restapi_id: path.restapi_id
      - text: Get how REST API {restapi_id} responds for {response_type}.
        slots:
          restapi_id: path.restapi_id
          response_type: path.response_type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/restapis/{restapi_id}/gatewayresponses/{response_type}'].put
  update:
    x-apievangelist-phrasing:
      intent: Customize a gateway response
      effect: write
      questions:
      - Can I change the body API Gateway returns when a request is unauthorized?
      - How do I add CORS headers to gateway error responses?
      instructions:
      - text: Set the {response_type} gateway response on REST API {restapi_id} to status {statusCode}.
        slots:
          response_type: path.response_type
          restapi_id: path.restapi_id
          statusCode: requestBody.statusCode
      - text: Customize {response_type} on REST API {restapi_id} with templates {responseTemplates}.
        slots:
          response_type: path.response_type
          restapi_id: path.restapi_id
          responseTemplates: requestBody.responseTemplates
      - text: Add headers {responseParameters} to the {response_type} response of REST API {restapi_id}.
        slots:
          responseParameters: requestBody.responseParameters
          response_type: path.response_type
          restapi_id: path.restapi_id
      method: generated
      generated: '2026-10-01'