Skip to content

Conversation

@TommyBrosman
Copy link
Contributor

@TommyBrosman TommyBrosman commented Nov 11, 2025

This change introduces a number of APIs for encoding schemas as snapshots and testing them for compatibility.

Description

The following alpha APIs have been added:

  • checkCompatibility
  • importCompatibilitySchemaSnapshot
  • exportCompatibilitySchemaSnapshot

See the changeset for details on how to use them in tests.

Reviewer Guidance

  • I would like feedback on the documentation. The intended audience is application developers authoring schema compatibility tests.
  • I'm looking for suggestions on how to make the API unit tests more concise.

@github-actions github-actions bot added area: dds Issues related to distributed data structures area: dds: tree changeset-present public api change Changes to a public API base: main PRs targeted against main branch labels Nov 11, 2025
TommyBrosman and others added 3 commits November 11, 2025 13:51
- Regenerate API files.
Co-authored-by: Joshua Smithrud <54606601+Josmithr@users.noreply.github.com>
@TommyBrosman TommyBrosman marked this pull request as ready for review November 12, 2025 02:00
@TommyBrosman TommyBrosman requested review from a team as code owners November 12, 2025 02:00
TommyBrosman and others added 2 commits November 12, 2025 11:22
Co-authored-by: Joshua Smithrud <54606601+Josmithr@users.noreply.github.com>
…nted the fact that we only care about the schema.

- Renamed parse/snapshot to import/export.
- privateRemarks on importCompatibilitySchemaSnapshot.
@github-actions github-actions bot added the area: framework Framework is a tag for issues involving the developer framework. Eg Aqueduct label Nov 12, 2025
TommyBrosman and others added 2 commits November 13, 2025 08:38
Co-authored-by: Craig Macomber (Microsoft) <42876482+CraigMacomber@users.noreply.github.com>
@github-actions
Copy link
Contributor

🔗 No broken links found! ✅

Your attention to detail is admirable.

linkcheck output


> fluid-framework-docs-site@0.0.0 ci:check-links /home/runner/work/FluidFramework/FluidFramework/docs
> start-server-and-test "npm run serve -- --no-open" 3000 check-links

1: starting server using command "npm run serve -- --no-open"
and when url "[ 'http://127.0.0.1:3000' ]" is responding with HTTP status code 200
running tests using command "npm run check-links"


> fluid-framework-docs-site@0.0.0 serve
> docusaurus serve --no-open

[SUCCESS] Serving "build" directory at: http://localhost:3000/

> fluid-framework-docs-site@0.0.0 check-links
> linkcheck http://localhost:3000 --skip-file skipped-urls.txt

Crawling...

Stats:
  250224 links
    1778 destination URLs
    2015 URLs ignored
       0 warnings
       0 errors


@TommyBrosman TommyBrosman merged commit e5be416 into microsoft:main Nov 15, 2025
42 checks passed
TommyBrosman added a commit to TommyBrosman/FluidFramework that referenced this pull request Nov 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: dds: tree area: dds Issues related to distributed data structures area: framework Framework is a tag for issues involving the developer framework. Eg Aqueduct base: main PRs targeted against main branch changeset-present public api change Changes to a public API

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants