Make schema def rendering more robust #5036
Closed
Conversation
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
|
@captbaritone has imported this pull request. If you are a Meta employee, you can view this in D78595366. |
|
@captbaritone merged this pull request in e2aaaa8. |
facebook-github-bot
pushed a commit
that referenced
this pull request
Aug 2, 2025
Summary: Fixes #5045. In b208fed we upgraded schemars which changed how the json schema for the compiler config is represented. It looks like the previous representation used enums of a single string literal to represent string literals. The new version uses the [const keyword](https://json-schema.org/understanding-json-schema/reference/const) for string literals. ## Before <img width="800" height="354" alt="Screenshot 2025-08-01 at 9 39 51 AM" src="https://github.com/user-attachments/assets/66c6ca23-7707-47cf-ad4f-f4bb554b8bec" /> ## After <img width="789" height="351" alt="Screenshot 2025-08-01 at 9 39 35 AM" src="https://github.com/user-attachments/assets/36ff9995-09bf-42e9-8cdd-30c5c3633172" /> Related: #5036 Pull Request resolved: #5047 Reviewed By: evanyeung Differential Revision: D79452138 Pulled By: captbaritone fbshipit-source-id: 817ab1f27c5a6c415b9bac1f561291318f069409
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 b208fed we upgraded schemars which changed how the json schema for the compiler config is represented. This uncovered gaps in our documentation renderer. Specifically, we had hard coded the assumption that the definitions would live on the
.defintitionsproperty of the schema. The new version of schemars puts them under$defswhich aligns better with json schema spec.This diff makes
$defsthe default assumed location for definitions, but lets the parent pass in definitions from another location. This diff also starts the process of using versioned schemas for our versioned docs. As part of this I pulled in the version of the config schema from the commit that added the v20 docs. So, now as our current config schema changes, the v20 docs will still reflect the config as it was at the v20 release.This allows us to pressure test the docs rendering, ensuring they can render both the old and new representations.