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
- Webservice connecting do database with IOS, PHP, REST API, JSON
- Mapping through these JSON elements
- Loading json data from a file into Postgres
- JSON problem solution
- How to save value into JSON configuration file using Microsoft.Extensions.Configuration?
- What are structs should be according to API docs to parse data from response?
- ASP.NET Core appsettings.json update in code
- How do I convert a string to a table in Lua?
- Deserializing JSON with dynamic keys
- How to run query on JSON using jQuery Ajax
- Ignore Unparseable JSON with jq
- undefined name "array" while processing JSON message via AVRO Schema
- get size of JSON object
- How to read the request body using orjson library in FastAPI?
- How to read into JSON with Python? OSError: [Errno 36] File name too long:
- PowerShell ConvertFrom-Json ignores top-level array?
- How do I read a JSON file into (server) memory?
- Is there a way to extract JSON from an http response without having to build structs?
- error org.json.JSONException: No value for PROJECT_NAME This is my json
- FullCalendar error when one eventSource is empty
- Unable to fetch nested values from axios api response
- How do you get a formatted/indented JSON String from a JSON object?
- Putting HTML as part of string in JSON?
- Swift iOS NSJsonSerialization fails silently
- How to allow iOS app to search Rails JSON API?
- How to receive data from html form
- How to get the value of a key which contains unicode code point in a JSON?
- Why does Spring Boot Controller give JSON but empty structure [{},{}]
- What is the Rails way to handle different controller clients (Web, iOS API)?
- how do I read and write from/to a JSON file in the root folder of my project?