jsonapi-doc
How to make apidoc.json parameters required?
Super simple but I can't find the docs on how to mark a parameter as required when I markup my document to generate an api-doc (using the package @: http://apidocjs.com)
// My APIDOC markup in my PHP doc
* @apiParam {String} [type] comma delimited list of any or all of: contests, deals, coupons
... which generates the following html:
I want the optional as shown to become required. What is the markup for that?
Solution
Found it. Turns out you just remove the [] brackets around the variable
* @apiParam {String} required_variable comma delimited list of any or all of: contests, deals, coupons
- How do I display the data returned from my API?
- How to parse a partially stringified JSON received from an external API in Node.js?
- Object of type 'Decimal' is not JSON serializable : AWS Lambda - DynamoDB
- Transform a tree-like json so that single "item" in a list is moved up (from leaf), empty items deleted - using jq
- Decode JSON in Swift "The given data was not valid JSON."
- Create Javascript objects from a template
- Send string in body as a POST REST call to ASP.NET using JavaScript
- AWS Step Function - Adding dynamic value to Pass state type
- Facing issues in plotting stacked bar chart with binning applied in vega lite
- How to retrieve a fixed length string from json array
- How can I declare a dynamic property name starting with an @
- Classic ASP and json2.js: how to access keys with special characters?
- How to make API call in Kotlin Using Retrofit (Android) with nested JSON APIs
- How to de/serialize an immutable object without default constructor using ObjectMapper?
- R and writing to JSON
- Deserialize to a Map<String, Object> with correct type for each value
- Serialization and deserialization in Typescript for classes with nested maps
- TypeError: Object of type CartItem is not JSON serializable
- Decode json files and add it in array
- spacy doc.char_span raises error whenever there is any number in string
- How to filter only the object name using jq/jmespath?
- QML | Persistent Memory in ListModel (storing ListModel for later use)
- Why I can't load images from json file with webpack-5?
- Remove duplicate from nested json array using jolt spec
- jq: error: tostring/1 is not defined at <top-level>, line 1:
- How to read JSON array of arrays with mixed values in Retrofit 2?
- Remove key from a Json inside a JsonObject
- Set Content-Length header in Response Entity (Spring Boot) using Java
- Trouble fetching data from API using JavaScript and JSON
- cannot resolve symbol jsonobject in intellij