Azure / Azure/azure-rest-api-specs
Microsoft.Capacity Revervations, clarify the API "/providers/Microsoft.Capacity/reservationOrders" and its model
- Dominant language
- TypeSpec
- Stars
- 3.1k
- Forks
- 5.9k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 444
Description
See https://github.com/Azure/azure-sdk-for-java/issues/37813
Customer find that some property of `ReservationOrderResponse` model is not populated in response of "ReservationOrder_List". Please document them accordingly.
https://github.com/Azure/azure-rest-api-specs/blob/2d2d12d271c13bd1b56c1ed5e41c5f418ae46067/specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/reservations.json#L235-L271
Also there is an "expand" query parameter on "ReservationOrder_Get". Please also document what is the valid value for the "expand", and which property is affected by this.
https://github.com/Azure/azure-rest-api-specs/blob/2d2d12d271c13bd1b56c1ed5e41c5f418ae46067/specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/reservations.json#L332-L376
Contributor guide
Research direction
Start with specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/reservations.json, especially lines 235-271 and 332-376, and review the linked Azure SDK issue 37813. Document which ReservationOrderResponse properties are not populated by ReservationOrder_List, and specify valid expand values for ReservationOrder_Get and the property each affects.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100