Help Center/ API Gateway/ User Guide/ Managing APIs/ API Design File Extension Definitions/ x-apigateway-sample
Updated on 2025-09-26 GMT+08:00
View PDF
Share

x-apigateway-sample

Meaning: Example values of API request parameters.

Scope of effect: Operation Object (2.0)/Operation Object (3.0)

Example:

paths:
  /:
    get:
      parameters:
        - maximum: 0
          minimum: 0
          maxLength: 0
          minLength: 0
          type: string
          x-apigateway-orchestrations: []
          x-apigateway-pass-through: always
          x-apigateway-sample: 'test-sample'
          name: test
          in: query
          required: true