Generate a docs for properties that are a simple reference #5129
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.
Open API 3.0 doesn't allow attaching docs and additional properties to a
$ref
type definition. Because of this (and this was a forgottenTODO
) many property descriptions were dropped in the OpenAPI output.This PR fixes this by using a common/recommended workaround consisting in using a single
allOf
inline schema around the reference.Fixes #5082.
@szabosteve can you verify that the doc generation pipeline correctly picks up this change?
Example (taken from the diff):
Becomes: