Azure / Azure/typespec-azure

Show examples of cancellation in LRO docs

Open
#135 1 comment 0 reactions 0 assignees View on GitHub
docs needs-area
Dominant language
TypeScript
Stars
27
Forks
90
Avg merge
1d 22h
Merged PRs (30d)
156

Description

In or related to https://azure.github.io/typespec-azure/docs/getstarted/azure-core/step06, could you show an example of how services can cancel an LRO? The REST API Stewardship Board has guidelines - or at least recommendations - on this: https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#controlling-a-long-running-operation

Contributor guide

Open the contributing guide

Research direction

Start with the Step 06 LRO documentation page linked in the issue, then read the REST API Stewardship Board's “Controlling a long-running operation” guidance. Add a service-side cancellation example that follows those recommendations and verify that the page clearly explains the expected behavior.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.