Skip to content

Comments

Improve explain output for variants and deprecated schemas#97

Merged
macalinao merged 2 commits intomasterfrom
lintel-fix-docs
Feb 25, 2026
Merged

Improve explain output for variants and deprecated schemas#97
macalinao merged 2 commits intomasterfrom
lintel-fix-docs

Conversation

@macalinao
Copy link
Contributor

Summary

  • Expand inline anyOf/oneOf variant properties for non-$ref schemas, while keeping $ref variants as compact one-line references pointing to DEFINITIONS
  • Add [DEPRECATED] tag to properties, composition variants, and definition entries
  • Sort deprecated items (properties and definitions) to the end of their lists
  • Truncate multi-line descriptions to first sentence in one-line variant summaries
  • Prioritize title → $ref name → first-sentence description for variant labels

Test plan

  • All 48 existing jsonschema-explain tests pass
  • Verified output with real schema containing anyOf with $ref variants, deprecated fields, and multi-line descriptions

- Expand inline anyOf/oneOf variant properties for non-$ref schemas
- Show $ref variants as one-line references (details in DEFINITIONS)
- Add [DEPRECATED] tag to properties, variants, and definitions
- Sort deprecated properties and definitions to the end of their lists
- Truncate variant descriptions to first sentence for clean one-liners
- Prioritize title over $ref name over description in variant summaries
@macalinao macalinao merged commit cf2cda4 into master Feb 25, 2026
3 checks passed
@macalinao macalinao deleted the lintel-fix-docs branch February 25, 2026 00:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant