Skip to content

fix(cli): host hyperframes.json schema so $schema resolves - #403

Closed
sebastianbreguel wants to merge 1 commit into
heygen-com:mainfrom
sebastianbreguel:fix/schema-hosting-304
Closed

fix(cli): host hyperframes.json schema so $schema resolves#403
sebastianbreguel wants to merge 1 commit into
heygen-com:mainfrom
sebastianbreguel:fix/schema-hosting-304

Conversation

@sebastianbreguel

Copy link
Copy Markdown

Summary

  • add a canonical hyperframes.json schema under packages/core/schemas
  • mirror the public schemas into docs/public/schema so Mintlify serves the expected URLs
  • add a drift test to keep the canonical and published schemas in sync

Why

The generated hyperframes.json pointed at https://hyperframes.heygen.com/schema/hyperframes.json, but that URL returned 404 because the schema was not being published from the docs site.

Validation

  • bun test packages/core/src/registry/docs-schema-sync.test.ts

The  URL in every generated hyperframes.json
(https://hyperframes.heygen.com/schema/hyperframes.json) returned 404
because (a) the schema file didn't exist and (b) no copies of the three
schemas were served from docs/public/.

- Add packages/core/schemas/hyperframes.json describing ProjectConfig.
- Mirror all three schemas (hyperframes, registry, registry-item) into
  docs/public/schema/ so Mintlify serves them at the expected URLs.
- Add a drift test that fails if the mirrors ever diverge or if a
  schema's $id stops matching its public URL.
@miguel-heygen

Copy link
Copy Markdown
Collaborator

Hi @sebastianbreguel, the url https://hyperframes.heygen.com/schema/hyperframes.json is working fine, what issues did you have?

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.

2 participants