Generate JSON schema for app-server protocol #5063
Merged
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
|
All contributors have signed the CLA ✍️ ✅ |
|
I have read the CLA Document and I hereby sign the CLA |
|
recheck |
kmk142789
approved these changes
Oct 13, 2025
pakrym-oai
reviewed
Oct 14, 2025
|
|
||
| /// Optional Prettier executable path to format generated TypeScript files | ||
| #[arg(short = 'p', long = "prettier", value_name = "PRETTIER_BIN")] | ||
| prettier: Option<PathBuf>, |
There was a problem hiding this comment.
Do we need a switch for cases that don't care about OpenAPI?
There was a problem hiding this comment.
@codex add a switch to control this, turn it on by default
There was a problem hiding this comment.
Summary
- Added a
--json-schemaflag to the export CLI so JSON Schema generation can be toggled while defaulting to the previous behavior. codex-rs/app-server-protocol/src/bin/export.rsL9-L30
Testing
- ✅
just fmt
pakrym-oai
approved these changes
Oct 14, 2025
rasmusrygaard
force-pushed
the
dev/rasmus/generate_json_schema2
branch
from
2cc4861 to
591304d
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Add annotations and an export script that let us generate app-server protocol types as typescript and JSONSchema.
The script itself is a bit hacky because we need to manually label some of the types. Unfortunately it seems that enum variants don't get good names by default and end up with something like
EventMsg1,EventMsg2, etc. I'm not an expert in this by any means, but since this is only run manually and we already need to enumerate the types required to describe the protocol, it didn't seem that much worse. An ideal solution here would be to have some kind of root that we could generate schemas for in one go, but I'm not sure if that's compatible with how we generate the protocol today.