The current version can’t do it, we’re trying to make sure the next version 
supports it.

 

 

 

From: <[email protected]> on behalf of Gary 
<[email protected]>
Reply-To: "[email protected]" 
<[email protected]>
Date: Friday, 23 September 2016 at 13:55
To: Swagger <[email protected]>
Subject: documenting an API for a resource whose representation is determined 
by a query parameter

 

Is there support or workarounds for APIs which return different representations 
of a resource based on a query parameter? 

 

In our work scenario, we expose, for example:

 

/terms

 

which takes an optional view query parameter with a default value of ID and 
available values of ID, VALUE and ENTITY.  All successful requests will return 
a 200 and an array of term id, value or entity objects based on the view query 
parameter value.

 

Can swagger be used to document this api and, if not, is it due a flaw or 
weakness in our API?

 

Thanks!

 

Gary

-- 
You received this message because you are subscribed to the Google Groups 
"Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
For more options, visit https://groups.google.com/d/optout.


-- 
You received this message because you are subscribed to the Google Groups 
"Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
For more options, visit https://groups.google.com/d/optout.

Reply via email to