Created by: saschagrebe
I recognized that enums are not documented well in confluence wiki markup. Therefore I created this PR which renders the enum values as a table in the model section. Additionaly I removed the escaping of values to make sure the text is displayed correctly in wiki (i. e. " instead of " or with multiline comments).
Input:
FooType:
description: >
A simple enum with:
* Multiline description
* Enum value
* Enum description
type: string
enum:
- "F-Code"
x-enum-varnames:
- FOO
x-enum-descriptions:
- The amazing foo enum
Output:
h3. FooType
A simple enum with:
* Multiline description
* Enum value
* Enum description
||Name||Value||Description||
|FOO |"F-Code" |The amazing foo enum |
PR checklist
-
Read the contribution guidelines. -
Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community. -
If contributing template-only or documentation-only changes which will change sample output, build the project beforehand. -
Run the shell script ./bin/generate-samples.sh
to update all Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master. These must match the expectations made by your contribution. You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example./bin/generate-samples.sh bin/configs/java*
. For Windows users, please run the script in Git BASH. -
File the PR against the correct branch: master
,5.1.x
,6.0.x
-
Copy the technical committee to review the pull request if your PR is targeting a particular programming language.