Skip to content

List records under their schema names, with doc comments - #5

Merged
happyDemon merged 1 commit into
mainfrom
type-names-and-docs
Nov 10, 2026
Merged

happyDemon merged 1 commit into
mainfrom
type-names-and-docs

Conversation

@happyDemon

@happyDemon happyDemon commented Nov 10, 2026 •

Copy link
Copy Markdown
Member

Why

The Studio method list derived every record name, because runtime types had none: SignInResult showed up as VerifySignInCodeResponse, and nested records were named after the field holding them. Doc comments from the schema were not shown at all.

What changes

  • A record is listed under the id its generated type carries (identity/identity.skir:SignInResult), so the same record has one definition wherever it is used.
  • Doc comments on methods, records, fields and variants are included in the list, where the Studio shows them.
  • Types without that metadata keep the derived names from before, so older generated code still works.

Requires php-skir/runtime 0.2.1 (php-skir/runtime#3). CI checks this branch against the runtime branch of the same name.

The Studio method list uses a type's record id and doc comments when
the generated types carry them, and falls back to derived names
otherwise.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
@happyDemon
happyDemon merged commit 323df2a into main Nov 10, 2026
6 checks passed
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