Fix warnings during generation due to missing summary and description #178
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Currently, if you run `make generate | grep WARN` there are thousands of warnings due to endpoints missing summaries or descriptions. The overwhelming number of warnings makes it harder to spot genuine errors in the templates - e.g. #177. This change wraps each unconditional reference to summary or description in an `{{#if}}` to cure the warnings.
averche
approved these changes
May 29, 2023
dhuckins
pushed a commit
to hashicorp/vault-client-dotnet
that referenced
this pull request
Jun 9, 2023
This is the vault-client-dotnet counterpart to hashicorp/vault-client-go#178. Currently, if you run `make generate | grep 'Unregistered helper name'` there are 16260 warnings due to endpoints missing various fields in their data models: ``` 192 [main] WARN o.o.c.t.HandlebarsEngineAdapter - Unregistered helper name 'collectionFormat', processing template: 54 [main] WARN o.o.c.t.HandlebarsEngineAdapter - Unregistered helper name 'complexType', processing template: 3369 [main] WARN o.o.c.t.HandlebarsEngineAdapter - Unregistered helper name 'description', processing template: 942 [main] WARN o.o.c.t.HandlebarsEngineAdapter - Unregistered helper name 'mediaType', processing template: 1600 [main] WARN o.o.c.t.HandlebarsEngineAdapter - Unregistered helper name 'notes', processing template: 7271 [main] WARN o.o.c.t.HandlebarsEngineAdapter - Unregistered helper name 'returnType', processing template: 2832 [main] WARN o.o.c.t.HandlebarsEngineAdapter - Unregistered helper name 'summary', processing template: ``` The overwhelming number of warnings makes it harder to spot genuine issues occurring. This change wraps each unconditional reference to these fields in an `{{#if}}` or `{{#with}}` to cure the warnings.
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Currently, if you run
make generate | grep WARNthere are thousands of warnings due to endpoints missing summaries or descriptions.The overwhelming number of warnings makes it harder to spot genuine errors in the templates - e.g. #177.
This change wraps each unconditional reference to summary or description in an
{{#if}}to cure the warnings.How has this been tested?
There are no changes to the generated files as a result of these changes - just the warnings are cured.