cancel
Showing results for 
Search instead for 
Did you mean: 

Using OAS with Swagger-Inline to Document API

Highlighted
Occasional Visitor

Using OAS with Swagger-Inline to Document API

How do I describe an object using swagger-inline formats for use with the oas npm tool? In the below, the selector portion of the request body is a nested object that looks something like this:
{
      property: {condition: String value},
      property: {condition: Integer value}
}

 

/*
* @oas [post] /db/{db}/query/document
* description: "Returns information about a specific document."
* parameters:
* - (path) db=test* {String} The name of the database to query.
* - (body) selector* {object} An object containing selectors used for querying
* - (body) fields* {String} An array containing the fields returned by the query
* - (body) limit {Integer:int32} How many documents to return
*/
Tags (2)
New Here?
Join us and watch the welcome video:
Announcements
Top Kudoed Authors
Top Kudoed Posts