Azure / Azure/azure-sdk-tools

[LintDiff][~[Staging] Swagger LintDiff failed] Conflicting validation rules for Async operations

Open
#6,198 2 comments 1 reaction 2 assignees Claimed by @bdefoy View on GitHub
ARM bug Central-EngSys Spec PR Tools
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 1h
Merged PRs (30d)
143

Description

**Describe the bug**
Following two rules seems conflicting:

1.
- https://github.com/Azure/azure-openapi-validator/blob/main/docs/delete-operation-async-response-validation.md
- https://github.com/Azure/azure-openapi-validator/blob/main/docs/create-operation-async-response-validation.md

2.
- https://github.com/Azure/autorest/tree/main/docs/extensions#x-ms-long-running-operation-options

Azure/azure-openapi-validator#1 says, you must add **x-ms-long-running-operation-options**
while Azure/azure-openapi-validator#2 says, you don't need to add this if you are following ARM guidelines at server end.

**Example where the rule flagged**: https://github.com/Azure/azure-rest-api-specs-pr/pull/12351/checks?check_run_id=13277783713
Search **DeleteOperationAsyncResponseValidation** and **XmsLongRunningOperationOptions**

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.