docs(container-definitions): Reserve some keys in IFluidCodeDetailsConfig for framework use #25641
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR reserves certain keys in the IFluidCodeDetailsConfig interface for Fluid Framework use by updating documentation to specify that keys starting with "FluidFramework." are reserved. The changes improve the interface documentation to clarify its purpose and establish namespace conventions for future framework features.
Key changes:
- Reserved keys with "FluidFramework." prefix for framework use in
IFluidCodeDetailsConfig - Enhanced documentation for both
IFluidCodeDetailsConfigandIFluidCodeDetailsinterfaces - Added changeset documenting the minor breaking change
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| packages/common/container-definitions/src/fluidPackage.ts | Updated interface documentation to reserve "FluidFramework." prefixed keys and clarify usage |
| .changeset/forty-snakes-swim.md | Added changeset documenting the reserved key namespace change |
github-actions
bot
added
changeset-present
base: main
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Updates the documentation on
IFluidCodeDetailsandIFluidCodeDetailsConfigto make some string keys in the latter reserved for Fluid Framework use.Breaking Changes
While it could theoretically cause breaking changes, I could not find evidence of our partners using keys like the ones this PR now makes reserved; the chances seem pretty low IMO. Furthermore, the scenario for which we intend to use reserved keys does not apply to existing Fluid documents, so even if some partner was using keys like these, their Fluid files would not go through the code that will care about the new reserved keys (at least not the code we already know of today).
Reviewer Guidance
The review process is outlined on this wiki page.