Multiple Examples with Different Parameters
scalabl3 opened this issue · comments
Jasdeep Jaitla commented
I am trying to figure out how to do list multiple examples with different parameter combinations and formatting for a single resource/request type that have consistent responses.
## MyAPICall [/resource/{param1}/{param2}{?jsonp,userID}]
### Example 1 [GET]
+ Parameters
+ param1 (string, `demo`) - Blog Subsection
+ param2 (string, `posts`) - Resources requested, comma separated (%2C encoded comma)
+ jsonp (string, `0`) - jsonp callback identifier, use `0` if not using jsonp
+ userID (string, `1234`) - userID of the caller
### Example 2 [GET]
+ Parameters
+ param1 (string, `demo`) - Blog Subsection
+ param2 (string, `posts%2Ccomments`) - Resources requested, comma separated (%2C encoded comma), i.e. posts,comments is posts%2Ccomments
+ jsonp (string, `0`) - jsonp callback identifier, use `0` if not using jsonp
+ userID (string, `1234`) - userID of the caller
+ Response 200
...
+ Response 404
...
It's also ok if I supply parameter types above the examples, and then just put in examples more simply:
## MyAPICall [/resource/{param1}/{param2}{?jsonp,userID}]
+ Parameters
+ param1 (string) - Blog Subsection
+ param2 (string) - Resources requested, comma separated (%2C encoded comma)
+ jsonp (string) - jsonp callback identifier, use `0` if not using jsonp
+ userID (string) - userID of the caller
### Example 1 [GET]
+ Parameters
+ param1: `demo`
+ param2: `posts`
+ jsonp: `0`
+ userID: `1234`
### Example 2 [GET]
+ Parameters
+ param1: `demo`
+ param2: `posts%2Ccomments`
+ jsonp: `0`
+ userID: `1234`
+ Response 200
...
+ Response 404
...
Jasdeep Jaitla commented
Sorry, added this to wrong repo, meant to do on api-blueprint...