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

fix(doc): problematic polling operation for lro delete #1442

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/getstarted/azure-core/step06.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@ alias ServiceTraits = SupportsRepeatableRequests &
alias Operations = Azure.Core.ResourceOperations<ServiceTraits>;

interface Widgets {
@doc("Gets status of a Widget operation.")
getWidgetOperationStatus is Operations.GetResourceOperationStatus<Widget>;
@doc("Get status of a Widget operation. This operation return status in status code. No response body is returned.")
getWidgetOperationStatus is Operations.GetResourceOperationStatus<Widget, never>;

@doc("Fetch a Widget by name.")
getWidget is Operations.ResourceRead<Widget>;

@doc("Creates or updates a Widget asynchronously.")
@doc("Create or replace a Widget asynchronously.")
@pollingOperation(Widgets.getWidgetOperationStatus)
createOrUpdateWidget is Operations.LongRunningResourceCreateOrUpdate<Widget>;
createOrUpdateWidget is Operations.LongRunningResourceCreateOrReplace<Widget>;

@doc("Delete a Widget asynchronously.")
@pollingOperation(Widgets.getWidgetOperationStatus)
Expand All @@ -36,7 +36,7 @@ interface Widgets {
}
```

1. We change `createOrUpdateWidget` to use `LongRunningResourceCreateOrUpdate<Widget>` and `deleteWidget` to use `LongRunningResourceDelete`.
1. We change `createOrUpdateWidget` to use `LongRunningResourceCreateOrReplace<Widget>` and `deleteWidget` to use `LongRunningResourceDelete`.
2. We define the `getWidgetOperationStatus` operation based on the `GetResourceOperationStatus` signature. This defines the operation status monitor as a child resource of the `Widget` type so that it shows up under that resource in the route hierarchy.
3. We **must** add the `pollingOperation` decorator to both of the long-running operations and reference the `Widgets.getWidgetOperationStatus` operation. This connects the long-running operations to their associated status monitor operation to make it easier for service clients to be generated.

Expand Down
Loading