Skip to content

DO NOT MERGE: Add reference doc for crJSON#397

Draft
crandmck wants to merge 1 commit into
mainfrom
crjson-doc
Draft

DO NOT MERGE: Add reference doc for crJSON#397
crandmck wants to merge 1 commit into
mainfrom
crjson-doc

Conversation

@crandmck

@crandmck crandmck commented Jul 23, 2026

Copy link
Copy Markdown
Collaborator

HOW THIS WILL BE DOCUMENTED IS UNDER DISCUSSION. DO NOT MERGE.

Add CrJSON schema reference documentation

Adds a reference doc for the CrJSON schema (crJSON-schema.json) using the existing SchemaReference component, following the same pattern as the Builder/Reader/ManifestDefinition/Settings references.

Changes:

  • Fix SchemaReference.js to correctly resolve $refs using the older definitions keyword (#/definitions/...), not just #/$defs/... Needed because CrJSON's schema predates the schemars-generated schemas and wasn't written with $defs.
  • Add docs/manifest/json-ref/crjson-ref.mdx and wire it into the sidebar and SDK object reference index.
  • Add crJSON-schema.json to static/schemas/ and register it in remote-docs.json so it's fetched automatically from contentauth/c2pa-rs@main on every install/build (same mechanism already used for sb-alg-list.json), keeping it in sync without a dedicated GitHub Actions workflow.

Note: Unlike the schemars-derived schemas (synced only on tagged c2pa-rs releases via update-schemas.yml), this schema tracks c2pa-rs@main continuously since it's a hand-authored fixture with no release binding.

@netlify

netlify Bot commented Jul 23, 2026

Copy link
Copy Markdown

Deploy Preview for cai-open-source ready!

Name Link
🔨 Latest commit babbdee
🔍 Latest deploy log https://app.netlify.com/projects/cai-open-source/deploys/6a615a73082af70008098e1b
😎 Deploy Preview https://deploy-preview-397--cai-open-source.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions

Copy link
Copy Markdown
Contributor

@github-actions
github-actions Bot temporarily deployed to pull request July 23, 2026 00:06 Inactive

@lrosenthol lrosenthol left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You CANNOT copy the crJSON schema from the C2PA site. Please reference it, not copy it!

@crandmck
crandmck marked this pull request as draft July 23, 2026 16:28
@crandmck crandmck changed the title Add reference doc for crJSON DO NOT MERGE: Add reference doc for crJSON Jul 23, 2026
@crandmck

Copy link
Copy Markdown
Collaborator Author

You CANNOT copy the crJSON schema from the C2PA site. Please reference it, not copy it!

As discussed separately, this NOT a copy from the C2PA site, but is an ephemeral copy from https://github.com/contentauth/c2pa-rs/blob/main/sdk/tests/fixtures/schemas/crJSON-schema.json updated via workflow.

It sounds like this file should not exist, but then we need a canonical version that the SDK uses/supports, since that might not always be the same as what's in the C2PA spec.

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