serverless-aws-documentation
serverless-aws-documentation copied to clipboard
*default* and *maximum* - do not get passed on to documentation
default and maximum, set in parameters section under events do not get passed on to documentation. I have added default and maximum value for parameters, but downloadDocumentation does not include it in the generated file. I added this parameter as per Swagger 2.0 specs, as can be seen in this link in the default parameter section: https://swagger.io/docs/specification/2-0/describing-parameters/
and can also be seen in this image
Here is my serverless yml file
` ListCustomerOrdersResponse
handler: src/handlers/v1/customer-orders.listCustomerOrders
events:
- http:
path: v1/customer-orders
method: get
private: ${self:custom.private}
documentation:
summary: "List customer orders."
queryParams:
- name: "offset"
required: false
type: string
default: "0"
description: The offset to fetch the page of results. Pass 0 for the first page.
- name: "limit"
required: false
type: string
default: "200"
maximum: "100"
description: The numbers of items to return. Must be a positive integer value.
methodResponses:
- statusCode: "200"
responseBody:
description: "A list of available customer orders."
responseModels:
"application/json": "ListCustomerOrdersResponse"`
Any update on this ?
Any updates for this yet?