Hello,
I am stuck and cant figure out how to achieve the below logic. I have a resource called /display which users post to all the time. I want to allow them to also use specific querryParameters on the /display resource enum: [routing,refresh,stop] . This appears to work fine, but i want to enhance the documentation by providing examples and description for the new querryParams i am defining. How does one do that?
/display:
description: displaying all kinds of actions
post:
body:
type: Entry
example: !include examples/display-entry-example.raml
queryParameters:
action?:
enum: [routing,refresh,stop]
**> routing:
**> Description: this routes
**> body:
**> type: Entry
**> example: !include examples/routes-entry-example.raml
**> refresh:
**> Description: this refreshes
**> body:
**> type: Entry
**> example: !include examples/refresh-entry-example.raml
**> stop:
**> Description: this is used for stopping
responses:
202:
body:
type: Response
example: !include examples/display-entry-response-example.raml