Prevent overwriting description of map fields #5158
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.
In #3323,
map
fields where included in the OpenAPI specification, which is good. However, the documentation for the field might be confusing since it contains the following hard coded example that might be irrelevant and misleading for the one reading the documentation:It is also not possible to override this hard coded description using
grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field
, like this:This PR removes the hard coded description and instead let's the creator of the protobuf file decide the appropriate descriptions for the field.
References to other Issues or PRs
Have you read the Contributing Guidelines?
Brief description of what is fixed or changed
Other comments