Add guidance for implementing an external standard on graph #503
+3,957
−2,845
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
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 <[email protected]>
Co-authored-by: Jeffrey Richter <[email protected]>
Co-authored-by: Darrel <[email protected]>
…rties New default properties pattern
updated inner error message
…es, and completedDateTime common property name (#507)
fixed graph owners to include nested folders and files
commented azure owners as the group list has errors
Update product name guidance to include the caveat about the /admin s…
fixed example in markdown
Fix formatting of json example.
… Service Design This PR adds a reference in the guidelines for String Offsets & Lengths to the corresponding section in Considerations for Service Design, which has more details and an example JSON response value.
…es of derived types. Also make examples more consistent and complete.
Co-authored-by: Michael Pizzo <[email protected]>
Update dictionary guidance to have the correct workload CSDL to implement a dictionary type
Co-authored-by: Dan Kershaw [MSFT] <[email protected]>
Update navigation property guidance to add to the list of reason why navigation properties are compelling
* Added LRO guidelines * Restore all prior named guidelines with some edits where needed * Address PR review feedback Co-authored-by: Mike Kistler <[email protected]> Co-authored-by: Weidong Xu <[email protected]>
Clarify: cast is not required in order to see properties of derived types.
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.