Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[cwiki] Added Enum documentation and fix newline problem for description #8338

Merged
merged 3 commits into from
Jan 7, 2021

Conversation

saschagrebe
Copy link
Contributor

@saschagrebe saschagrebe commented Jan 5, 2021

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.shto 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.

@auto-labeler
Copy link

auto-labeler bot commented Jan 5, 2021

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

@wing328 wing328 merged commit 367ba3a into OpenAPITools:master Jan 7, 2021
@wing328 wing328 added this to the 5.0.1 milestone Jan 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants