Azure / Azure/azure-openapi-validator

[LroExtension & GetOperation200] Not handle the GET polling API - false positive

Open
#549 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
53
Forks
57
Avg merge
1d 23h
Merged PRs (30d)
2

Description

**Describe the bug**

This is a representation of the location header status polling API and the linter rules haven't accounted for it.

```json
"/providers/Microsoft.Subscription/subscriptionOperations/{operationId}": {
"get": {
"description": "Get the status of the pending Microsoft.Subscription API operations.",
"operationId": "SubscriptionOperation_Get",
"x-ms-examples": {
"getPendingSubscriptionOperations": {
"$ref": "./examples/getSubscriptionOperation.json"
}
},
"responses": {
"200": {
"description": "Successful completion of the asynchronous operation",
"schema": {
"$ref": "#/definitions/SubscriptionCreationResult"
}
},
"202": {
"description": "Accepted. Subscription update is in progress.",
"headers": {
"Location": {
"description": "The URL where the status of the asynchronous operation can be checked.",
"type": "string"
},
"Retry-After": {
"description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.",
"type": "integer",
"format": "int64"
}
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse"
}
}
},
"parameters": [
{
"name": "operationId",
"in": "path",
"description": "The operation ID, which can be found from the Location field in the generate recommendation response header.",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/apiVersionParameter"
}
]
}
},
```
**To Reproduce**
Steps to reproduce the behavior:

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.
image

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Additional context**
https://github.com/Azure/azure-rest-api-specs/pull/24395/files

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.