docs: fix LRO requirement sentence typos#585
Open
Rohan5commit wants to merge 1 commit intomicrosoft:vNextfrom
Open
docs: fix LRO requirement sentence typos#585Rohan5commit wants to merge 1 commit intomicrosoft:vNextfrom
Rohan5commit wants to merge 1 commit intomicrosoft:vNextfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Fixes a typo in the Microsoft Graph long-running operations (LRO) design pattern documentation to improve clarity and correctness.
Changes:
- Corrected spelling in the “requirement” sentence describing what “safe” means for LRO creation.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
56
to
+59
| - For most implementations of the LRO pattern (like the example above), there will be 3 permissions necessary to comply with the principle of least privilege: `ArchiveOperation.ReadWrite.All` to create the `archiveOperation` entity, `ArchiveOperation.Read.All` to track the `archiveOperation` entity to completion, and `Archives.Read.All` to retrieve the `archive` that was created as a result of the operation. | ||
| For APIs that would have been modeled as a simple `GET` on the resource URL, but that are modeled as long-running operations due to MSGraph performance requirements, only the `Archive.Read.All` permission is necessary as long as creating the `archiveOperation` entity is "safe". | ||
| Here, "safe" means that there are no side effects of creating the `archiveOperation` entity that would change the functionality of any entities outside of the `archive` being retrieved. | ||
| This requirment does not mean that the API must be idempotent, but an idempotent API is suffucient to meet this requirement. | ||
| This requirement does not mean that the API must be idempotent, but an idempotent API is sufficient to meet this requirement. |
There was a problem hiding this comment.
The permission name in this paragraph is inconsistent: the previous bullet uses Archives.Read.All, but this sentence says Archive.Read.All. Please verify the correct permission name and make it consistent, since readers may copy/paste these scopes.
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
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.
Summary
Related issue
Guideline alignment
CONTRIBUTING.mddocumentation guidance and targets thevNextbranchValidation
git -c core.whitespace=cr-at-eol diff --check