Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Microsoft REST API Guidelines Deprecation #956

Open
scgbear opened this issue Mar 28, 2023 · 2 comments
Open

Microsoft REST API Guidelines Deprecation #956

scgbear opened this issue Mar 28, 2023 · 2 comments
Labels
bug Something isn't working

Comments

@scgbear
Copy link
Member

scgbear commented Mar 28, 2023

Describe the bug
The Azure API Stewardship Board is currently in the process of deprecating the Microsoft REST API Guidelines. The guidelines themselves havn't had an update in 4 years and there is no clear owner of these guidelines.

They have updated the main README.md for Azure Service Teams and GraphQL services to use the their relavent REST Guidelines. with the following content:

NOTICE TO READERS
Guidance for Azure service teams
Azure service teams should use companion documents, Azure REST API Guidelines and Considerations for Service Design, when building or modifying their services. These documents provide a refined set of guidance targeted specifically for Azure services. For more information please refer to the README in the Azure folder.

Guidance for Microsoft Graph service teams
Microsoft Graph service teams should reference the companion document, Graph REST API Guidelines when building or modifying their services.

In the process of building many of Microsoft's highest scale services, the Microsoft Graph team found the Microsoft API guidelines tremendously useful as a baseline. However, there are several areas where we need to provide more clarity on how developers should describe their APIs. The companion document, Graph REST API Guidelines is a set of amendments and clarifications for Microsoft Graph that act as further reading. Recognizing that two documents is a lot for a new API designer to absorb, our plan is to follow the approach Azure have taken and roll out guidelines for Microsoft Graph into a single consolidated document.

This playbook is currently referencing these soon to be deprecated guidelines here: https://github.com/microsoft/code-with-engineering-playbook/tree/main/docs/design/design-patterns/rest-api-design-guidance

@scgbear scgbear added the bug Something isn't working label Mar 28, 2023
@TessFerrandez
Copy link
Member

Thank you for this comment @scgbear, sorry didn't see it until now... but when looking into it, I couldn't find the notice about deprecation... so I am unsure about what has been deprecated.

If you have the bandwidth, could you create a PR to modify/delete the outdated content

@liammoat
Copy link

liammoat commented Feb 7, 2024

Reference (I think): https://github.com/microsoft/api-guidelines/blob/vNext/graph/Guidelines-deprecated.md#deprecation-notice-to-readers

I'm happy to drop a PR on this if required

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants