Azure / Azure/azure-rest-api-specs
The common-types ErrorResponse does not correspond to the ARM schema
- Dominant language
- TypeSpec
- Stars
- 3.1k
- Forks
- 5.9k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 444
Description
When I tried to use the ErrorResponse type that is defined in the common-types swagger specs, I got an error that the type defined in common-types does not match the schema
```
"the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.",
"id": "R4007",
"validationCategory": "ARMViolation",
```
The errorResponse Type is defined as seen here:
https://github.com/Azure/azure-rest-api-specs/blob/4c0054d815c3ead4b4ef12350ee6379197d4be1a/specification/common-types/resource-management/v1/types.json#L272
Since it doesn't have the "error" property, it doesn't work to be used in other projects
Contributor guide
Research direction
Start with specification/common-types/resource-management/v1/types.json at the ErrorResponse definition, then compare it with the ARM error-response-content schema linked in the issue. Confirm the mismatch and update the common-types definition so it corresponds to the documented schema; validate the affected specification if the repository provides a relevant check.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100