Skip to content

feat(json-schema): Add custom definition ID #1467

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
PainOchoco wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

feat(json-schema): Add custom definition ID #1467

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e6cca9d
feat(json-schema): Add custom def ID
PainOchoco Jun 9, 2025
8018e5c
fix: formatting
PainOchoco Jun 9, 2025
d70f618
fix: Add defId to NodeMeta interface
PainOchoco Jun 9, 2025
599763d
fix: formatting again
PainOchoco Jun 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ark/docs/components/dts/schema.ts
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion ark/docs/components/dts/util.ts
View file
Open in desktop

Large diffs are not rendered by default.

6 changes: 4 additions & 2 deletions ark/schema/roots/root.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,8 +156,10 @@ export abstract class BaseRoot<
}

toJsonSchemaRecurse(ctx: ToJsonSchema.Context): JsonSchema {
if (ctx.useRefs && !this.alwaysExpandJsonSchema)
return { $ref: `#/$defs/${this.id}` }
if (ctx.useRefs && !this.alwaysExpandJsonSchema) {
const defId = this.meta.defId ?? this.id
return { $ref: `#/$defs/${defId}` }
}

return this.toResolvedJsonSchema(ctx)
}
Expand Down
1 change: 1 addition & 0 deletions ark/schema/shared/declare.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ export interface NodeMeta
extends JsonSchema.UniversalMeta,
UnknownErrorConfigs {
alias?: string
defId?: string
onFail?: ArkErrors.Handler
}

Expand Down
Loading