kunal-pmj
commented
5 years ago One such example would be following REST API.
"/com/vmware/cis/tagging/tag/id:{category_id}?~action=list-tags-for-category": { "post": {
To make it Swagger 2.0 complaint. The query parameter should be removed from request mapping path and moved to the the parameter section.
{ "name": "~action", "in": "query", "description": "~action=list-tags-for-category", "required": true, "type": "string", "enum": [ "list-tags-for-category" ] }
This way the the parameter can be made required with only one possible value
karaatanassov
The swagger specifications generated from this tool are not Swagger 2.0 compliant. There are few APIs whose Query Parameters are appended to the Request Mapping URL. As per Swagger 2.0 and 3.0 specifications Parameters can be of following types and they should be defined in the Parameters section of operations for every path or at the path.
path parameters, such as /users/{id} query parameters, such as /users?role=admin header parameters, such as X-MyHeader: Value cookie parameters, which are passed in the Cookie header, such as Cookie: debug=0; csrftoken=BUSe35dohU3O1MZvDCU