Property validity using enums by corranrogue9 · Pull Request #519 · microsoft/api-guidelines
Navigation Menu
{{ message }}
microsoft / api-guidelines Public
- Notifications You must be signed in to change notification settings
- Fork 2.7k
Open
Property validity using enums#519
corranrogue9 wants to merge 3 commits intovNextfrom
Property validity using enums#519
corranrogue9 wants to merge 3 commits intovNextfrom
Conversation
corranrogue9 added 3 commits
January 22, 2024 16:41
OlgaPodo
added
Graph Guidelines
labels
Feb 1, 2024OlgaPodo reviewed Feb 8, 2024
| Microsoft Graph API Design Pattern | ||
|
|
||
| *There are often cases where a type has a property which denotes a kind of role that the type can fulfill. This property can evolve over time to a point where the way the type that fulfills that role needs to be configured in some way. This pattern allows configuring such properties in a forward compatible way.* | ||
|
|
Copy link
Collaborator
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When we talk about aPI design pattern we think in terms of API resources and representation for a new customer. It is not clear what application or business problem that patter is trying to address. Can we be more specific? Good examples are https://github.com/microsoft/api-guidelines/blob/vNext/graph/patterns/navigation-property.md, https://github.com/microsoft/api-guidelines/blob/vNext/graph/patterns/viewpoint.md
Copy link
Collaborator
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems that this pattern is beyond a role use case and is about properties dependencies where one property is an enumeration.
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