Property validity using enums by corranrogue9 · Pull Request #519 · microsoft/api-guidelines

Skip to content

Navigation Menu

Sign in

Appearance settings

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up

Appearance settings

Conversation

@corranrogue9

Copy link

Contributor

Porting this PR from the old repo.

@OlgaPodo OlgaPodo added Graph Guidelines

This should be reviewed by Microsoft Grap team.

Microsoft Graph

This should be reviewed by Microsoft Grap team.

labels

Feb 1, 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@OlgaPodo OlgaPodo OlgaPodo left review comments

Assignees

No one assigned

Labels

Graph Guidelines

This should be reviewed by Microsoft Grap team.

Microsoft Graph

This should be reviewed by Microsoft Grap team.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@corranrogue9 @OlgaPodo