Repository navigation
Let types carry their schema name and doc comment - #3
Merged
Merged
Conversation
Structs and enums take an optional record id (`path/to/module.skir:Qualified.Name`) and doc, and fields, variants and methods an optional doc. Serialization ignores them; they exist so a server can describe its methods the way the schema does. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
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
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.
Why
A runtime
Typeonly knows kinds, fields and variants. It has no idea what the schema calls a struct or enum, and no doc comments. The server's RPC Studio therefore has to invent record names (VerifySignInCodeResponseinstead ofSignInResult) and cannot show documentation.What changes
All additions are optional, so existing calls and generated code keep working:
Type::struct()andType::enum()takerecordId(path/to/module.skir:Qualified.Name, the same identity upstream type descriptors use) anddoc.Field::value(),Variant::constant()andVariant::wrapper()takedoc.MethodDescriptortakesdoc.Serialization ignores all of it.
Follow-ups
The generators emit this metadata (
@php-skir/generator-coreand the three PHP generators), andphp-skir/serveruses it for the Studio method list.