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] Support alias types #18579

Merged
merged 4 commits into from May 11, 2024
Merged

Conversation

Aniokrait
Copy link
Contributor

@Aniokrait Aniokrait commented May 6, 2024

fix #13312
Alias to primitvies were not interpreted as a model and not included models list.
However, the scripts in the generated html docs still needs them to dereference $ref.

How to validate the work

Use minimal reproducable spec of #13312 (here)

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.

@Aniokrait Aniokrait changed the title Fix alias types Support alias types May 6, 2024
@Aniokrait Aniokrait changed the title Support alias types [html2] Support alias types May 10, 2024
// apis
List<OperationsMap> allOperations = new ArrayList<>();
generateApis(files, allOperations, allModels);
// webhooks
List<WebhooksMap> allWebhooks = new ArrayList<>();
generateWebhooks(files, allWebhooks, allModels);
// supporting files
Map<String, Object> bundle = buildSupportFileBundle(allOperations, allModels, allWebhooks);
Map<String, Object> bundle = buildSupportFileBundle(allOperations, allModels, aliasModels, allWebhooks);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fyi @OpenAPITools/generator-core-team

@wing328 wing328 added the Doc: HTML Generation of HTML documentation label May 11, 2024
@wing328 wing328 added this to the 7.6.0 milestone May 11, 2024
@wing328 wing328 merged commit 3d96a40 into OpenAPITools:master May 11, 2024
14 checks passed
renatomameli pushed a commit to renatomameli/openapi-generator that referenced this pull request May 17, 2024
* [html2] Support alias models to render html docs.

* [html2] Fix compile error

* [html2] Update sample
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 Enhancement: General
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] [HTML2] No models for alias types generated, html docs broken
2 participants