docs(readme): document -schemaHash option#34
Open
klaidliadon wants to merge 1 commit into
Open
Conversation
The -schemaHash opt-out (default-on) was missing from the options table. In the OpenAPI generator it gates whether the schema hash appears in the generated spec's header comment.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The
-schemaHashopt-out (default-on) was missing from the README options table, so it was undiscoverable unless you read the template. This adds the missing row. (-helpalready lists it — that output is generated from the opts dict — so only the hand-maintained table needed updating.)Docs-only; no template or generated-code change.
-schemaHash=falseomits the schema hash + version consts from the generated output, which removes the per-edit hash churn that causes merge conflicts.Part of a sweep documenting this flag across the generators (gen-golang webrpc/gen-golang#122 already up).