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

[aspnetcore] Fix config enum documentation #9404

Merged
merged 1 commit into from
May 6, 2021

Conversation

hauntingEcho
Copy link
Contributor

@hauntingEcho hauntingEcho commented May 4, 2021

To fix #9398

PR checklist

  • [ X ] Read the contribution guidelines.
  • [ X ] 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.
  • [ X ] Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    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.
  • [ X ] File the PR against the correct branch: master, 5.1.x, 6.0.x
  • [ X ] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

technical committee mentions: @mandrean @frankyjuang @shibayan @Blackclaws

@wing328 wing328 changed the title Fixes #9398: fix aspnetcore config enum documentation [ aspnetcore] Fix config enum documentation May 6, 2021
@wing328 wing328 changed the title [ aspnetcore] Fix config enum documentation [aspnetcore] Fix config enum documentation May 6, 2021
@wing328 wing328 added this to the 5.1.1 milestone May 6, 2021
@wing328
Copy link
Member

wing328 commented May 6, 2021

LGTM

@wing328 wing328 merged commit 32b2ea3 into OpenAPITools:master May 6, 2021
@wing328
Copy link
Member

wing328 commented May 17, 2021

Looks like this change is causing an issue in publishing updated documentation to the public website as part of the Travis CI workflow:

[success] [webpackbar] Client: Compiled with some errors in 2.46m


../docs/generators/aspnetcore.md
SyntaxError: unknown: Expected corresponding JSX closing tag for <strong> (34:82)

  32 | <td parentName="tr" {...{"align":null}}>{`classModifier`}</td>
  33 | <td parentName="tr" {...{"align":null}}>{`Class Modifier for controller classes: Empty string or abstract.`}</td>
> 34 | <td parentName="tr" {...{"align":null}}><dl><dt>{`*`}<strong parentName="td">{`*`}</dt><dd>{`Keep class default with no modifier`}</dd><dt></strong>{`abstract**`}</dt><dd>{`Make class abstract`}</dd></dl></td>
     |                                                                                   ^
  35 | <td parentName="tr" {...{"align":null}}></td>
  36 | </tr>
  37 | <tr parentName="tbody">
 @ ./.docusaurus/registry.js 1:25362-25423 1:25236-25318
 @ ./node_modules/@docusaurus/core/lib/client/exports/ComponentCreator.js
 @ ./.docusaurus/routes.js
 @ ./node_modules/@docusaurus/core/lib/client/clientEntry.js
 @ multi ./node_modules/@docusaurus/core/lib/client/clientEntry.js

ref: https://travis-ci.org/github/OpenAPITools/openapi-generator/builds/771409157

@wing328
Copy link
Member

wing328 commented May 17, 2021

I think it's due empty string "" as the enum value: https://github.com/OpenAPITools/openapi-generator/pull/9404/files#diff-c8d3b05be5059a6612785c8de1e952973400d80ea639375e784e3a7f01beca9bR291. I'll file a PR to revert the change and see if the issue goes away

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.

[BUG] Document values for aspnetcore buildTarget
2 participants