You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Jul 23, 2021. It is now read-only.
For pathParams, required field doesn't seem to work.
My example:
- http:
path: filesmethod: getcors: trueauthorizer: aws_iamdocumentation:
summary: File searchdescription: > Provides the ability to search files with custom filters.pathParams:
-
name: querydescription: The query string (use empty string for no filter)required: true
-
name: rowsPerPagedescription: Number of rows to be returned (default 20)required: false
-
I explicitly set required: false, however after I deployed the APIs, I did an export and these fields are marked as requiredtrue in the exported API documentation. Like below
parameters:
- name: "page"in: "path"description: "Current pagination index (default 0)"required: trueschema:
type: "string"
- name: "query"in: "path"description: "The query string (use empty string for no filter)"required: trueschema:
type: "string"
- name: "sortAsc"in: "path"description: "Sort in ascending order (default false)"required: trueschema:
type: "string"
Also, AWS doesn't seem to give me any information on whether a parameter is required or not.
The text was updated successfully, but these errors were encountered:
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.
For
pathParams
,required
field doesn't seem to work.My example:
I explicitly set
required: false
, however after I deployed the APIs, I did an export and these fields are marked asrequired
true
in the exported API documentation. Like belowAlso, AWS doesn't seem to give me any information on whether a parameter is required or not.
The text was updated successfully, but these errors were encountered: