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

[html2] Fix blank responses in html document #18356

Merged
merged 2 commits into from
Apr 12, 2024

Conversation

Aniokrait
Copy link
Contributor

@Aniokrait Aniokrait commented Apr 11, 2024

fix #14642
fix #3788
fix #11204
fix #1373
Removed {{#schema}} section tag, so that {{{jsonSchema}}} and the other mustache variables can be retrieved via apiInfo.apis.operation.responses

I tested by using the html generated by modules/openapi-generator/src/test/resources/3_1/petstore.yaml.
Before my fixing, responses were empty if $ref was used in yaml. It happened because {{{jsonSchema}}} was null in apiInfo.apis.operation.responses.schema, but exitsts in apiInfo.apis.operation.responses. So the generated script was incomplete as var schemaWrapper = ;

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.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    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*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.1.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@wing328
Copy link
Member

wing328 commented Apr 12, 2024

thanks for the PR. can you please also perform a test with modules/openapi-generator/src/test/resources/3_0/petstore.yaml (3.0 spec) ?

@wing328 wing328 changed the title [html2]Fix blank responses in html document [html2] Fix blank responses in html document Apr 12, 2024
@Aniokrait Aniokrait closed this Apr 12, 2024
@Aniokrait Aniokrait reopened this Apr 12, 2024
@Aniokrait
Copy link
Contributor Author

@wing328
I checked modules/openapi-generator/src/test/resources/3_0/petstore.yaml and the html document was generated as expected.

@wing328
Copy link
Member

wing328 commented Apr 12, 2024

nice. let's give it a try

@wing328 wing328 merged commit 8618658 into OpenAPITools:master Apr 12, 2024
24 checks passed
@wing328
Copy link
Member

wing328 commented Apr 12, 2024

PR merged. have a nice weekend

@wing328
Copy link
Member

wing328 commented Apr 12, 2024

FYI. Samples updated via 359ff9e

@wing328 wing328 added Doc: HTML Generation of HTML documentation Issue: Bug labels Apr 12, 2024
@wing328 wing328 added this to the 7.5.0 milestone Apr 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Doc: HTML Generation of HTML documentation Issue: Bug
Projects
None yet
2 participants