Azure / Azure/azure-rest-api-specs
Incorrect definition for Microsoft.Web/sites/functions/keys resource body
- Dominant language
- TypeSpec
- Stars
- 3.1k
- Forks
- 6k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 444
Description
The PUT schema references "KeyInfo" directly as the PUT body:
https://github.com/Azure/azure-rest-api-specs/blob/cde7f150e8d3bf3af2418cc347cae0fb2baed6a7/specification/web/resource-manager/Microsoft.Web/stable/2020-12-01/WebApps.json#L3801
KeyInfo is defined here:
https://github.com/Azure/azure-rest-api-specs/blob/cde7f150e8d3bf3af2418cc347cae0fb2baed6a7/specification/web/resource-manager/Microsoft.Web/stable/2020-12-01/WebApps.json#L23121-L23134
Instead, the expectation is that the body should be an ARM resource schema, with "properties" of type "KeyInfo".
This is resulting in incorrect Bicep types & incorrect ARM template schema documentation being generated.
These two comments appear to confirm the service behavior:
https://github.com/Azure/azure-quickstart-templates/issues/6757#issuecomment-582008031
https://github.com/Azure/bicep/issues/784#issuecomment-906402741
Contributor guide
Research direction
Open specification/web/resource-manager/Microsoft.Web/stable/2020-12-01/WebApps.json at the PUT schema around line 3801 and compare it with the KeyInfo definition around lines 23121-23134. Confirm the body follows the ARM resource shape with properties typed as KeyInfo, then verify that the resulting Bicep types and ARM template schema documentation describe that shape correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- json
- Domain
- api, cloud
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 30/100