Add TypeSpec examples to flat-bag, facets and subtypes pattern docs (#1061)#588
Open
mary-wan wants to merge 5 commits into
Open
Add TypeSpec examples to flat-bag, facets and subtypes pattern docs (#1061)#588mary-wan wants to merge 5 commits into
mary-wan wants to merge 5 commits into
Conversation
Documents how the facets API design pattern is authored in TypeSpec using the @facet decorator from @microsoft/typespec-msgraph (issue microsoftgraph/typespec-msgraph#1061, Phase 6): - facets.md: new "Facets in TypeSpec" section with a driveItem example (audio/file/folder/image/video as @facet nullable @complex properties), the linter rules, and the compiled CSDL (a standard nullable complex property -- @facet is authoring/lint-only and emits no CSDL annotation). - GuidelinesGraph.md: add a "TypeSpec representation" column to the modeling-variants comparison table and a pointer to the new section.
adrian05-ms
approved these changes
Jun 23, 2026
Merges marynjenga/graph-patterns (PR microsoft#588) into the facets branch and resolves the GuidelinesGraph.md conflict where both branches rewrote the modeling-variants comparison table. Reconciled the shared 'TypeSpec representation' column so all three rows are correct against @microsoft/typespec-msgraph v1.1.0 (verified by compiling canaries): - Type hierarchy -> `@abstract` + `extends` - Facets -> `@facet` on a nullable `@complex` property - Flat bag -> `@flatBag` + `@variant` The prior facets-branch cell ('plain entity properties (no dedicated decorator)') was incorrect -- @flatBag/@variant ship in v1.1.0 -- and Mary's 'Facets = —' cell was incomplete since @facet ships as well. The merged table captures both decorator sets.
Add facets TypeSpec docs + reconcile pattern comparison table
mary-wan
changed the title
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Adds a TypeSpec representation section to
graph/patterns/flat-bag.mdwith a runnable @flatBag("type") + @variant(...) exampleAdds a TypeSpec representation section to
graph/patterns/subtypes.mdwith an @abstract + extends example using the directoryObject → user/group hierarchygraph/patterns/facets.md— new Facets in TypeSpec section: adriveItemexample (audio/file/folder/image/videoas@facetnullable@complexproperties), the linter rules, and the compiled CSDL.graph/GuidelinesGraph.md— reconciles the TypeSpec representation column so all three rows are correct:@abstract+extends@facet@flatBag+@variantCompanion to issue #1061 (@flatBag / @variant decorators shipped in @microsoft/typespec-msgraph Issue#1061). The API guidelines previously documented these patterns in CSDL/JSON only; this PR adds the TypeSpec authoring guidance developers need now that the pattern decorators ship.