microsoft/api-guidelines

View on GitHub

Microsoft REST API Guidelines

Stars: 23.3k
Forks: 2.7k
Open beginner issues: 0
Indexed issues: 129

Dominant language: No language data
License: No license data
Last GitHub push: Aug 5, 2026
Latest indexed: Sep 19, 2026
Contributing guide: Contributing guide
Code of conduct: Code of conduct
Beginner labels: No beginner labels indexed
PR merge metrics: No merged PRs in 30d

Beginner friendly Everything

Open All

129 open issues indexed

Add guidance for handling static path segments, e.g. `@me` Open

Azure Guidelines

microsoft/api-guidelines#410 · 2 assignees · Opened Oct 26, 2022
Add "status" to naming guidelines Open

Azure Guidelines

microsoft/api-guidelines#407 · 2 assignees · Opened Oct 12, 2022
Stronger recommendation for BYOS Open

Azure Guidelines

microsoft/api-guidelines#406 · 1 assignee · Opened Oct 12, 2022
Two letter acronym guidance Open

Difficulty 2/5 1-3 hours Newbie friendliness 35/100

microsoft/api-guidelines#404 · 1 comment · Opened Oct 11, 2022
Run cspell in ci pipeline Open

Azure Guidelines

microsoft/api-guidelines#402 · 1 assignee · Opened Sep 30, 2022
Update guidelines to include unique identifiers... Open

Azure Guidelines enhancement

microsoft/api-guidelines#396 · 1 comment · 1 assignee · Opened Aug 31, 2022
Prescribed error messages for versioning errors? Open

Difficulty 5/5 Over a week Newbie friendliness 25/100

microsoft/api-guidelines#395 · 20 comments · Opened Aug 30, 2022
We should discuss a pattern for very long-running operations (VLROs) Open

Azure Guidelines

Difficulty 5/5 Over a week Newbie friendliness 25/100

microsoft/api-guidelines#394 · Opened Aug 30, 2022
Clarify guidance for returning resources across api-versions Open

Difficulty 5/5 Over a week Newbie friendliness 25/100

microsoft/api-guidelines#393 · 1 comment · Opened Aug 30, 2022
unknownFutureValue in Evolvable enums Open

microsoft/api-guidelines#380 · 2 comments · 1 assignee · Opened Jul 14, 2022
Add guidance on the value of `WWW-Authenticate` header in 401 response Open

Azure Guidelines

Difficulty 4/5 3-5 days Newbie friendliness 25/100

microsoft/api-guidelines#379 · Opened Jul 13, 2022
Document when to use an LRO vs. a VLRO in REST APIs Open

Azure Guidelines

microsoft/api-guidelines#373 · 2 comments · 1 assignee · Opened Jun 20, 2022
Update how client's handle `nextlink` Open

Azure Guidelines

microsoft/api-guidelines#372 · 3 comments · 2 assignees · Opened Jun 20, 2022
Provide guidance on how GUIDs are used throughout the spec... Open

Azure Guidelines enhancement

microsoft/api-guidelines#367 · 1 comment · 1 assignee · Opened Jun 7, 2022
Determine guidance on file upload size Open

Azure Guidelines

Difficulty 4/5 3-5 days Newbie friendliness 35/100

microsoft/api-guidelines#364 · Opened May 31, 2022
Create guidance for additional properties Open

Azure Guidelines enhancement

microsoft/api-guidelines#359 · 2 assignees · Opened May 21, 2022
Create guidance for deprecating versions & version discovery... Open

Azure Guidelines enhancement

Difficulty 4/5 3-5 days Newbie friendliness 35/100

microsoft/api-guidelines#356 · Opened May 20, 2022
Add guidance about how to handle unrecognized query params, well-known but unsupported headers, & unrecognized fields in a request body Open

microsoft/api-guidelines#348 · 1 comment · 1 assignee · Opened Apr 30, 2022
How does one "Engage the Azure REST API Stewardship Board"? Open

microsoft/api-guidelines#345 · 2 comments · 1 assignee · Opened Apr 20, 2022
Add guidance on case folding on enum values Open

Azure Guidelines

Difficulty 2/5 1-3 hours Newbie friendliness 35/100

microsoft/api-guidelines#342 · 8 comments · Opened Mar 31, 2022
Add guidance on the format for time duration values Open

Azure Guidelines

Difficulty 3/5 1-2 days Newbie friendliness 35/100

microsoft/api-guidelines#335 · 1 comment · Opened Mar 8, 2022
Add guidelines about durations using a time unit (seconds, minutes, etc.) with a number value and NOT using ISO8601 Open

Azure Guidelines

Difficulty 2/5 1-3 hours Newbie friendliness 35/100

microsoft/api-guidelines#334 · 1 comment · Opened Mar 8, 2022
Discuss & determine recommendation for soft delete Open

Azure Guidelines

microsoft/api-guidelines#333 · 2 assignees · Opened Mar 8, 2022
Privacy policy api💬 Open

Difficulty 5/5 Over a week Newbie friendliness 15/100

microsoft/api-guidelines#330 · 1 reaction · Opened Feb 11, 2022
Different spelling used for "cancelled" (rest guidelines) and (canceled) Azure guidelines Open

Azure Guidelines

Difficulty 1/5 Under an hour Newbie friendliness 35/100

microsoft/api-guidelines#323 · Opened Jan 27, 2022
Add guidance on API design that is amenable to RBAC authorization Open

Azure Guidelines

Difficulty 5/5 Over a week Newbie friendliness 20/100

microsoft/api-guidelines#322 · Opened Jan 25, 2022
Casing of compound product names Open

Graph Guidelines

Difficulty 1/5 Under an hour Newbie friendliness 45/100

microsoft/api-guidelines#321 · Opened Jan 20, 2022
Clarify guidelines on Bring-Your-Own-Storage Open

Azure Guidelines

Difficulty 2/5 1-3 hours Newbie friendliness 35/100

microsoft/api-guidelines#320 · 2 comments · Opened Jan 19, 2022
Document how to implement "RELO" type LRO for action operations Open

Azure Guidelines

Difficulty 5/5 Over a week Newbie friendliness 35/100

microsoft/api-guidelines#318 · Opened Jan 19, 2022
Error response should clearly distinguish usage errors from runtime errors Open

Azure Guidelines

microsoft/api-guidelines#315 · 1 assignee · Opened Jan 6, 2022
[Azure REST API Guidelines] Provide a default table of generic error codes for usage errors Open

Azure Guidelines enhancement

Difficulty 3/5 1-2 days Newbie friendliness 35/100

microsoft/api-guidelines#312 · 6 comments · Opened Dec 10, 2021
[Azure REST API guidelines] Conflicting guidance on `status` values for resource-based LROs Open

Difficulty 5/5 Over a week Newbie friendliness 30/100

microsoft/api-guidelines#310 · 2 comments · Opened Dec 9, 2021
[Azure REST Guidelines] Information on LRO Result Open

microsoft/api-guidelines#308 · 1 reaction · 1 assignee · Opened Dec 3, 2021
[Azure REST API Guidelines]: Add correlation header guidance Open

Azure Guidelines

Difficulty 1/5 Under an hour Newbie friendliness 45/100

microsoft/api-guidelines#307 · Opened Nov 30, 2021
Add guidance for support of HTTP/2 Open

Azure Guidelines

Difficulty 5/5 Over a week Newbie friendliness 25/100

microsoft/api-guidelines#306 · Opened Nov 19, 2021
orderBy: Clarify meaning of "A special case of such an expression is a property path terminating on a primitive property" Open

Difficulty 2/5 1-3 hours Newbie friendliness 35/100

microsoft/api-guidelines#304 · Opened Nov 17, 2021
Add guidance for handling multiple authentication methods Open

Azure Guidelines

Difficulty 3/5 1-2 days Newbie friendliness 38/100

microsoft/api-guidelines#292 · Opened Sep 16, 2021
Determine guidance for top level error code mapping to HTTP status codes Open

Azure Guidelines

microsoft/api-guidelines#286 · 1 comment · 1 assignee · Opened Sep 8, 2021
Q. must a PATCH upsert that creates a new resource return 201 Created and Location header? Open

microsoft/api-guidelines#284 · 9 comments · 1 assignee · Opened Sep 2, 2021
[Azure] Add guidance for batch operations Open

Azure Guidelines

microsoft/api-guidelines#283 · 3 comments · 1 reaction · 1 assignee · Opened Aug 31, 2021
Add guidelines for RBAC Open

Difficulty 5/5 Over a week Newbie friendliness 25/100

microsoft/api-guidelines#281 · Opened Aug 12, 2021
Add guidance for "wrapping" industry API Open

Azure Guidelines

Difficulty 3/5 1-2 days Newbie friendliness 35/100

microsoft/api-guidelines#275 · 1 comment · Opened Aug 3, 2021
Add further guidance on idempotency Open

Azure Guidelines

microsoft/api-guidelines#274 · 2 assignees · Opened Jul 30, 2021
Cross-check Azure guidelines with ARM guidelines to ensure consistency Open

Azure Guidelines

microsoft/api-guidelines#273 · 4 comments · 1 assignee · Opened Jul 28, 2021
Create guidelines for websockets. Open

Azure Guidelines

Difficulty 5/5 Over a week Newbie friendliness 20/100

microsoft/api-guidelines#272 · 1 reaction · Opened Jul 27, 2021
Add section on operation granularity Open

Azure Guidelines

Difficulty 2/5 1-3 hours Newbie friendliness 45/100

microsoft/api-guidelines#269 · Opened Jul 20, 2021
Provide example hypothesis documents for service teams. Open

Azure Guidelines

Difficulty 3/5 1-2 days Newbie friendliness 25/100

microsoft/api-guidelines#268 · Opened Jul 20, 2021
Provide examples of hero scenarios for so service teams. Open

Azure Guidelines

microsoft/api-guidelines#267 · 1 assignee · Opened Jul 20, 2021
Evolvable Graph API design Open

Difficulty 5/5 Over a week Newbie friendliness 25/100

microsoft/api-guidelines#255 · 1 comment · Opened Jun 28, 2021
Updated Azure Guidelines: Projections Open

Azure Guidelines

Difficulty 5/5 Over a week Newbie friendliness 25/100

microsoft/api-guidelines#248 · Opened Jun 18, 2021

microsoft/api-guidelines

Get new issues in your inbox