# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Aws Api Gateway Deployments API
  version: 1.0.0
extends: openapi/aws-api-gateway-deployments-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}/deployments'].get
  update:
    x-apievangelist-phrasing:
      intent: List a REST API's deployments
      effect: read
      questions:
      - What deployments have been made of my REST API?
      - How do I see the deployment history of a REST API?
      instructions:
      - text: List deployments of REST API {restapi_id}.
        slots:
          restapi_id: path.restapi_id
      - text: Show the deployment history for REST API {restapi_id}.
        slots:
          restapi_id: path.restapi_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/restapis/{restapi_id}/deployments'].post
  update:
    x-apievangelist-phrasing:
      intent: Deploy a REST API to a stage
      effect: write
      questions:
      - How do I deploy my REST API so changes go live?
      - Which stage name does a REST API deployment require?
      instructions:
      - text: Deploy REST API {restapi_id} to stage {stageName}.
        slots:
          restapi_id: path.restapi_id
          stageName: requestBody.stageName
      - text: Deploy REST API {restapi_id} to {stageName} with note {description}.
        slots:
          restapi_id: path.restapi_id
          stageName: requestBody.stageName
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/apis/{api_id}/deployments'].get
  update:
    x-apievangelist-phrasing:
      intent: List an HTTP or WebSocket API's deployments
      effect: read
      questions:
      - What deployments exist for my HTTP or WebSocket API?
      - Can I see past deployments of a v2 API?
      instructions:
      - text: List deployments of HTTP or WebSocket API {api_id}.
        slots:
          api_id: path.api_id
      - text: Show the deployment history of v2 API {api_id}.
        slots:
          api_id: path.api_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/apis/{api_id}/deployments'].post
  update:
    x-apievangelist-phrasing:
      intent: Deploy an HTTP or WebSocket API
      effect: write
      questions:
      - How do I deploy my WebSocket API?
      - Is a stage name optional when deploying an HTTP API?
      instructions:
      - text: Deploy HTTP or WebSocket API {api_id}.
        slots:
          api_id: path.api_id
      - text: Deploy v2 API {api_id} to stage {StageName}.
        slots:
          api_id: path.api_id
          StageName: requestBody.StageName
      method: generated
      generated: '2026-10-01'