Use fenced code plugin to document API parameters. firstName String description with markdown support score Integer another description line with markdown support api-parameters ```api-parameters firstName, String, description with *markdown* support score, Integer, another description line with *markdown* support ```

Use syntax to define nested objects like this: Note: when using this approach it is necessary to explicitly define a entry, such as in this example. sessionId Integer session Id person Person person to login with firstName String first name of the person lastName String last name of the person roles List<Role> list of authorized roles id String role id description String role description Note: if a parameter name actually contains a period ("."), you can prevent this nesting behavior by putting the parameter name in single quotes, e.g. "person.firstName" parent.child ```api-parameters sessionId, Integer, session Id person, Person, person to login with person.firstName, String, first name of the person person.lastName, String, last name of the person roles, List<Role>, list of authorized roles roles.id, String, role id roles.description, String, role description ``` root person

Use the parameter to specify a title. firstName String description with markdown support score Integer another description line with markdown support title ```api-parameters {title: "person definition"} firstName, String, description with *markdown* support score, Integer, another description line with *markdown* support ```

Use to make collapsible. city String city name zipCode String zip code Note: requires to be present collapsed: true|false api-parameters ```api-parameters {title: "address definition", anchorPrefix: "title", collapsed: true} city, String, city name zipCode, String, zip code ``` collapsed title

Use to remove top/bottom margins when there are multiple parameter instances in a row. firstName String description with markdown support score Integer another description line with markdown support city String city name zipCode String zip code noGap: true ```api-parameters { title: "person definition", anchorPrefix: "title", collapsed: false, noGap: true } firstName, String, description with *markdown* support score, Integer, another description line with *markdown* support ``` ```api-parameters {title: "address definition", anchorPrefix: "title", collapsed: true} city, String, city name zipCode, String, zip code ```

Use the parameter to render API Parameters using smaller font size and occupying less width firstName String description with markdown support score Integer another description line with markdown support small ```api-parameters {small: true} firstName, String, description with *markdown* support score, Integer, another description line with *markdown* support ```

Use quotes to wrap a multiline description. Here is an example of description including multiple lines and nested code block example. cores String Specify how many cores to allocate for execution execute(cores: 10) gpu Boolean Specify whether to use gpu execute(cores: 10, gpu: true) Note: Use larger number of backticks on outside then inside to distinct between plugin boundaries and nested code blocks " `````api-parameters cores, String, " ``` execute(cores: 10) ``` Specify how many cores to allocate for execution " gpu, Boolean, " ``` execute(cores: 10, gpu: true) ``` Specify whether to use gpu " ````` api-parameters

Instead of hard-coding your parameters inside markdown files, you can specify an external JSON file. JSON could be generated based on the data you have. Some examples: build time annotation processor test time command line parameters generation Given the above file, use to display it as API Parameters sessionId Integer session Id person Person person to login with firstName String first name of the person lastName String last name of the person roles List<Role> list of authorized roles id String role id description String role description Note: field in JSON file is treated as Markdown :include-api-parameters: api-parameters.json {title: "Person Definition"} description

Each API parameter has an anchor associated with it. You need to hover over parameter name for it to appear. Use parameter to avoid conflict of anchor ids when using the same API parameter names within a single page: firstName String description with markdown support score Integer another description line with markdown support In the example above is added to each parameter link. anchorPrefix ```api-parameters {anchorPrefix: "customPrefix"} firstName, String, description with *markdown* support score, Integer, another description line with *markdown* support ``` customPrefix

Znai hard wraps long parameter names to leave more space to description. VERY_LONG_PARAMETER_NAME_WITHOUT_SPACES String description with markdown support VERY_LONG_ANOTHER_PARAMETER_NAME_WITHOUT_SPACES String another description line with markdown support Use to remove hard wrap enforcement VERY_LONG_PARAMETER_NAME_WITHOUT_SPACES String description with markdown support VERY_LONG_ANOTHER_PARAMETER_NAME_WITHOUT_SPACES String another description line with markdown support noWrap: true ```api-parameters {anchorPrefix: "customPrefix", noWrap: true} VERY_LONG_PARAMETER_NAME_WITHOUT_SPACES, String, description with *markdown* support VERY_LONG_ANOTHER_PARAMETER_NAME_WITHOUT_SPACES, String, another description line with *markdown* support ```

Use to use all the available horizontal space VERY_LONG_PARAMETER_NAME_WITHOUT_SPACES String longer line longer line, description with markdown support VERY_LONG_ANOTHER_PARAMETER_NAME_WITHOUT_SPACES String longer line longer line, another description line with markdown support and few moe lines wide: true ```api-parameters {anchorPrefix: "customPrefix", noWrap: true, wide: true} VERY_LONG_PARAMETER_NAME_WITHOUT_SPACES, String, "longer line longer line, description with *markdown* support" VERY_LONG_ANOTHER_PARAMETER_NAME_WITHOUT_SPACES, String, "longer line longer line, another description line with *markdown* support and few moe lines" ```