Azure / Azure/azure-rest-api-specs
[Documentation] armresources.DeploymentProperties.Template comment allows JSON string
- Dominant language
- TypeSpec
- Stars
- 3.1k
- Forks
- 5.9k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 444
Description
DeploymentProperties.Template comment says that it allows a JSON string to be passed, but only a JSON object is supported in calls to PUT /deployments.
https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources#DeploymentProperties
https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/services/resources/mgmt/2020-10-01/resources?utm_source=gopls#DeploymentProperties.Template
Contributor guide
Research direction
The linked pkg.go.dev pages identify DeploymentProperties.Template and its generated comment; start by locating that property's source definition in the REST API specification. Update the description so it states that PUT /deployments accepts a JSON object, then verify the generated documentation no longer says a JSON string is allowed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100