Add guidance for implementing an external standard on graph #503
Conversation
This file contains 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
Adding missing newline
corranrogue9
commented
Nov 6, 2023
graph/GuidelinesGraph.md
Outdated
| @@ -328,6 +329,19 @@ For a complete mapping of error codes to HTTP statuses, see | |||
|
|
|||
| <a name="api-contract-and-non-backward-compatible-changes"></a> | |||
|
|
|||
| ## External standards | |||
|
|
|||
| For ease of client use and interoperatibility, some APIs should implement a standard that is defined external to Microsoft Graph and OData. | |||
There was a problem hiding this comment.
From Mike, I should be clear what APIs "conflict with odata stnadrad/graph guidelines"
corranrogue9
commented
Nov 6, 2023
graph/GuidelinesGraph.md
Outdated
| Workloads must define these standards in their CSDL model if they do not conflict with the OData standard. | ||
| Standards that *do* conflict with the OData standard may be defined in the CSDL in one of two ways: | ||
| 1. Using `Edm.Untyped` only and support for the external standard will come directly from the service implementation; OR | ||
| 2. Adding CSDL elements to model the external standard using `Edm.String` for `EnumType`s that conflict with the OData standard and `Edm.Untyped` wherever any other conflict with the OData standard occurs |
There was a problem hiding this comment.
From Mike: The structuring of the conjunction makes this sentence seem like it's only about enums
There was a problem hiding this comment.
The allowed values annotaiton should be used for strings
OlgaPodo
added
Graph Guidelines
Signed-off-by: Troy Connor <troy0820@users.noreply.github.com>
Co-authored-by: Jeffrey Richter <jeffrichter@live.com>
Co-authored-by: Darrel <darrmi@microsoft.com>
…rties New default properties pattern
Co-authored-by: Garrett DeBruin <16618938+corranrogue9@users.noreply.github.com>
Co-authored-by: Garrett DeBruin <16618938+corranrogue9@users.noreply.github.com>
Co-authored-by: Garrett DeBruin <16618938+corranrogue9@users.noreply.github.com>
Co-authored-by: Garrett DeBruin <16618938+corranrogue9@users.noreply.github.com>
* Added LRO guidelines * Restore all prior named guidelines with some edits where needed * Address PR review feedback Co-authored-by: Mike Kistler <mikekistler@microsoft.com> Co-authored-by: Weidong Xu <weidxu@microsoft.com>
Clarify: cast is not required in order to see properties of derived types.
Fix grammar
Use proper noun name for graph product
Rename `bankAccountInformation` to `bankAccountDetail`
Fix grammar
Add link to nav prop article
Update to `existing core types`
Update description of core types in overview to addd "intrinsic"
Add guidance for types which should not have new structural properties
-require alias, as per [ADR-030](https://microsoft.sharepoint.com/teams/APICouncil/_layouts/OneNote.aspx?id=%2Fteams%2FAPICouncil%2FSiteAssets%2FAPI%20Council%20Notebook&wd=target%28ADRs.one%7CCC35B798-B670-4554-9FCF-1682729EFA23%2FADR-030%20Namespace%20Aliases%7C363534F8-EFBD-4201-9F11-DB02AD5B7FAA%2F%29) -support multiple levels below microsoft.graph (as per [ADR-030]) -clarify uniqueness across namespaces -clarify that any change to a custom namespace name is breaking -add alias to the examples as per above
fix namespace guidance
Co-authored-by: Dan Kershaw [MSFT] <dkershaw10@users.noreply.github.com>
Clarify the naming of EnumTypes and give guidance for the use of flags enums and non-flags enums simultaneously
Add guidance for naming flags vs non-flags enums and cases where they should be defined side-by-side
Update Guidelines.md
Fixed wording from `modeling behavior` to `behavior modeling`
Fixed minor wording
…-rule Updated naming rule for Booleans
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.