Conversation
dosubot
bot
added
size:XS
mnencia
force-pushed
the
dev/722
branch
2 times, most recently
from
78a43d0 to
fee70c3
Compare
Member
Author
|
Closing in favor of PR #724 which addresses the root cause by pinning crd-ref-docs to v0.2.0 instead of working around the issue with template filters. |
mnencia
force-pushed
the
dev/722
branch
3 times, most recently
from
fa5a7ae to
3947d43
Compare
mnencia
changed the title
Member
Author
|
Reopened as the final v0.3.0 requires the change. |
gbartolini
approved these changes
Feb 4, 2026
The crd-ref-docs tool v0.3.0 introduced a change that started
rendering `+optional` Go code markers as `Optional: {}` in the
validation column of API documentation. This appeared as an empty JSON
object and was redundant since the Required column already displayed
this information. This updates the documentation template to filter
out these Optional markers while preserving meaningful validation
rules like patterns and enums. It also removes redundant customMarkers
configuration.
Closes #722
Signed-off-by: Marco Nenciarini <marco.nenciarini@enterprisedb.com>
fcanovai
approved these changes
Feb 4, 2026
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
3 participants
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 crd-ref-docs tool v0.3.0 started rendering
+optionalGo markers asOptional: {}in API documentation's validation column. This appeared as redundant empty JSON objects since the Required column already conveyed this information. The PR updates the documentation template to filter these markers while keeping meaningful validation rules like patterns and enums, and removes unnecessary customMarkers configuration.Closes #722