Skip to content

Commit 03f5675

Browse files
chchen3chchen3
committed
Add descriptions for objects and fix typo
1 parent 79da892 commit 03f5675

File tree

1 file changed

+46
-17
lines changed
  • specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01

1 file changed

+46
-17
lines changed

‎specification/reservations/resource-manager/Microsoft.Capacity/stable/2022-11-01/reservations.json‎

Lines changed: 46 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1340,7 +1340,7 @@
13401340
},
13411341
"RefundRequestProperties": {
13421342
"type": "object",
1343-
"description": "Properties needed for refund request including the session id from calculte refund, the scope, the reservation to be returned and the return reason.",
1343+
"description": "Properties needed for refund request including the session id from calculate refund, the scope, the reservation to be returned and the return reason.",
13441344
"properties": {
13451345
"sessionId": {
13461346
"type": "string",
@@ -1532,17 +1532,17 @@
15321532
"properties": {
15331533
"resourceType": {
15341534
"type": "string",
1535-
"description": "The type of resource the SKU applies to.",
1535+
"description": "The type of resource the sku applies to.",
15361536
"readOnly": true
15371537
},
15381538
"name": {
15391539
"type": "string",
1540-
"description": "The name of SKU",
1540+
"description": "The name of sku",
15411541
"readOnly": true
15421542
},
15431543
"billingPlans": {
15441544
"type": "object",
1545-
"description": "The billing plan options available for this SKU.",
1545+
"description": "The billing plan options available for this sku.",
15461546
"additionalProperties": {
15471547
"type": "array",
15481548
"items": {
@@ -1563,7 +1563,7 @@
15631563
"readOnly": true,
15641564
"items": {
15651565
"type": "string",
1566-
"description": "The set of locations that the SKU is available. If not specified, the SKU is available in all locations."
1566+
"description": "The set of locations that the sku is available. If not specified, the sku is available in all locations."
15671567
}
15681568
},
15691569
"skuProperties": {
@@ -1579,7 +1579,7 @@
15791579
"msrp": {
15801580
"type": "object",
15811581
"readOnly": true,
1582-
"description": "Pricing information about the SKU",
1582+
"description": "Pricing information about the sku",
15831583
"properties": {
15841584
"p1Y": {
15851585
"type": "object",
@@ -1598,12 +1598,12 @@
15981598
},
15991599
"tier": {
16001600
"type": "string",
1601-
"description": "The tier of this SKU",
1601+
"description": "The tier of this sku",
16021602
"readOnly": true
16031603
},
16041604
"size": {
16051605
"type": "string",
1606-
"description": "The size of this SKU",
1606+
"description": "The size of this sku",
16071607
"readOnly": true
16081608
},
16091609
"capabilities": {
@@ -1659,7 +1659,7 @@
16591659
"items": {
16601660
"type": "string"
16611661
},
1662-
"description": "The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted."
1662+
"description": "The value of restrictions. If the restriction type is set to location. This would be different locations where the sku is restricted."
16631663
},
16641664
"reasonCode": {
16651665
"type": "string",
@@ -1812,7 +1812,7 @@
18121812
"originalQuantity": {
18131813
"type": "integer",
18141814
"format": "int32",
1815-
"description": "Total Quantity of the SKUs purchased in the reservation."
1815+
"description": "Total Quantity of the skus purchased in the reservation."
18161816
},
18171817
"term": {
18181818
"$ref": "#/definitions/ReservationTerm"
@@ -1972,7 +1972,7 @@
19721972
"ReservationQuantity": {
19731973
"type": "integer",
19741974
"format": "int32",
1975-
"description": "Quantity of the SKUs that are part of the reservation. Must be greater than zero."
1975+
"description": "Quantity of the skus that are part of the reservation. Must be greater than zero."
19761976
},
19771977
"AvailableScopeProperties": {
19781978
"type": "object",
@@ -2070,6 +2070,7 @@
20702070
},
20712071
"RenewPropertiesResponse": {
20722072
"type": "object",
2073+
"description": "The renew properties for a reservation.",
20732074
"properties": {
20742075
"purchaseProperties": {
20752076
"$ref": "#/definitions/PurchaseRequest"
@@ -2104,6 +2105,7 @@
21042105
},
21052106
"SkuName": {
21062107
"type": "object",
2108+
"description": "The name of sku",
21072109
"properties": {
21082110
"name": {
21092111
"type": "string"
@@ -2112,6 +2114,7 @@
21122114
},
21132115
"CalculateRefundResponse": {
21142116
"type": "object",
2117+
"description": "The response of calculate refund containing refund information of reservation",
21152118
"properties": {
21162119
"id": {
21172120
"type": "string",
@@ -2124,6 +2127,7 @@
21242127
},
21252128
"RefundResponse": {
21262129
"type": "object",
2130+
"description": "The response of refund request containing refund information of reservation",
21272131
"properties": {
21282132
"id": {
21292133
"type": "string",
@@ -2136,6 +2140,7 @@
21362140
},
21372141
"RefundResponseProperties": {
21382142
"type": "object",
2143+
"description": "The refund properties of reservation",
21392144
"properties": {
21402145
"sessionId": {
21412146
"type": "string",
@@ -2557,7 +2562,7 @@
25572562
"type": "string"
25582563
},
25592564
"quantity": {
2560-
"description": "Quantity of the SKUs that are part of the reservation.",
2565+
"description": "Quantity of the skus that are part of the reservation.",
25612566
"$ref": "#/definitions/ReservationQuantity"
25622567
},
25632568
"provisioningState": {
@@ -2597,14 +2602,14 @@
25972602
},
25982603
"skuDescription": {
25992604
"type": "string",
2600-
"description": "Description of the SKU in english."
2605+
"description": "Description of the sku in english."
26012606
},
26022607
"extendedStatusInfo": {
26032608
"description": "The message giving detailed information about the status code.",
26042609
"$ref": "#/definitions/ExtendedStatusInfo"
26052610
},
26062611
"billingPlan": {
2607-
"description": "The billing plan options available for this SKU.",
2612+
"description": "The billing plan options available for this sku.",
26082613
"$ref": "#/definitions/ReservationBillingPlan"
26092614
},
26102615
"displayProvisioningState": {
@@ -2695,6 +2700,7 @@
26952700
},
26962701
"ReservationSplitProperties": {
26972702
"type": "object",
2703+
"description": "Properties of reservation split",
26982704
"properties": {
26992705
"splitDestinations": {
27002706
"type": "array",
@@ -2711,6 +2717,7 @@
27112717
},
27122718
"ReservationMergeProperties": {
27132719
"type": "object",
2720+
"description": "Properties of reservation merge",
27142721
"properties": {
27152722
"mergeDestination": {
27162723
"type": "string",
@@ -2727,6 +2734,7 @@
27272734
},
27282735
"ReservationSwapProperties": {
27292736
"type": "object",
2737+
"description": "Properties of reservation swap",
27302738
"properties": {
27312739
"swapSource": {
27322740
"type": "string",
@@ -2740,6 +2748,7 @@
27402748
},
27412749
"PurchaseRequestProperties": {
27422750
"type": "object",
2751+
"description": "Properties of reservation purchase request",
27432752
"properties": {
27442753
"reservedResourceType": {
27452754
"$ref": "#/definitions/ReservedResourceType"
@@ -2754,7 +2763,7 @@
27542763
"$ref": "#/definitions/ReservationBillingPlan"
27552764
},
27562765
"quantity": {
2757-
"description": "Quantity of the SKUs that are part of the reservation.",
2766+
"description": "Quantity of the skus that are part of the reservation.",
27582767
"$ref": "#/definitions/ReservationQuantity"
27592768
},
27602769
"displayName": {
@@ -2896,6 +2905,7 @@
28962905
},
28972906
"PatchProperties": {
28982907
"type": "object",
2908+
"description": "Properties for reservation patch",
28992909
"properties": {
29002910
"appliedScopeType": {
29012911
"$ref": "#/definitions/AppliedScopeType"
@@ -2933,6 +2943,7 @@
29332943
},
29342944
"SplitProperties": {
29352945
"type": "object",
2946+
"description": "Properties for reservation split",
29362947
"properties": {
29372948
"quantities": {
29382949
"type": "array",
@@ -2952,6 +2963,7 @@
29522963
},
29532964
"MergeProperties": {
29542965
"type": "object",
2966+
"description": "Properties for reservation merge",
29552967
"properties": {
29562968
"sources": {
29572969
"type": "array",
@@ -2964,6 +2976,7 @@
29642976
},
29652977
"MergeRequest": {
29662978
"type": "object",
2979+
"description": "The request for reservation merge",
29672980
"properties": {
29682981
"properties": {
29692982
"x-ms-client-flatten": true,
@@ -2973,6 +2986,7 @@
29732986
},
29742987
"PurchaseRequest": {
29752988
"type": "object",
2989+
"description": "The request for reservation purchase",
29762990
"properties": {
29772991
"sku": {
29782992
"$ref": "#/definitions/SkuName"
@@ -3006,6 +3020,7 @@
30063020
},
30073021
"Patch": {
30083022
"type": "object",
3023+
"description": "The request for reservation patch",
30093024
"properties": {
30103025
"properties": {
30113026
"x-ms-client-flatten": true,
@@ -3015,6 +3030,7 @@
30153030
},
30163031
"SplitRequest": {
30173032
"type": "object",
3033+
"description": "The request for reservation split",
30183034
"properties": {
30193035
"properties": {
30203036
"x-ms-client-flatten": true,
@@ -3034,6 +3050,7 @@
30343050
},
30353051
"Error": {
30363052
"type": "object",
3053+
"description": "Error inofrmation",
30373054
"properties": {
30383055
"error": {
30393056
"$ref": "#/definitions/ExtendedErrorInfo"
@@ -3042,6 +3059,7 @@
30423059
},
30433060
"ExtendedErrorInfo": {
30443061
"type": "object",
3062+
"description": "Extended error information including error code and error message",
30453063
"properties": {
30463064
"code": {
30473065
"$ref": "#/definitions/ErrorResponseCode"
@@ -3074,6 +3092,7 @@
30743092
},
30753093
"AppliedReservations": {
30763094
"type": "object",
3095+
"description": "The response for applied reservations api",
30773096
"properties": {
30783097
"id": {
30793098
"type": "string",
@@ -3098,6 +3117,7 @@
30983117
},
30993118
"AppliedReservationsProperties": {
31003119
"type": "object",
3120+
"description": "Properties for applied reservations returned",
31013121
"properties": {
31023122
"reservationOrderIds": {
31033123
"$ref": "#/definitions/AppliedReservationList"
@@ -3106,6 +3126,7 @@
31063126
},
31073127
"AppliedReservationList": {
31083128
"type": "object",
3129+
"description": "Paginated list of applied reservations",
31093130
"properties": {
31103131
"value": {
31113132
"type": "array",
@@ -3123,6 +3144,7 @@
31233144
},
31243145
"OperationList": {
31253146
"type": "object",
3147+
"description": "Paginated list of operations",
31263148
"properties": {
31273149
"value": {
31283150
"type": "array",
@@ -3141,6 +3163,7 @@
31413163
},
31423164
"OperationResponse": {
31433165
"type": "object",
3166+
"description": "The response containing operation information",
31443167
"properties": {
31453168
"name": {
31463169
"description": "Name of the operation",
@@ -3166,6 +3189,7 @@
31663189
},
31673190
"OperationDisplay": {
31683191
"type": "object",
3192+
"description": "Information about an operation",
31693193
"properties": {
31703194
"provider": {
31713195
"type": "string"
@@ -3188,6 +3212,7 @@
31883212
},
31893213
"ReservationList": {
31903214
"type": "object",
3215+
"description": "List of `Reservation`s",
31913216
"properties": {
31923217
"value": {
31933218
"type": "array",
@@ -3203,6 +3228,7 @@
32033228
},
32043229
"ReservationOrderList": {
32053230
"type": "object",
3231+
"description": "List of `ReservationOrder`s",
32063232
"properties": {
32073233
"value": {
32083234
"type": "array",
@@ -3305,6 +3331,7 @@
33053331
},
33063332
"Price": {
33073333
"type": "object",
3334+
"description": "Pricing information containing the amount and the currency code",
33083335
"properties": {
33093336
"currencyCode": {
33103337
"type": "string",
@@ -3332,6 +3359,7 @@
33323359
},
33333360
"CalculatePriceResponse": {
33343361
"type": "object",
3362+
"description": "The response of calculate price for reservation.",
33353363
"properties": {
33363364
"properties": {
33373365
"$ref": "#/definitions/CalculatePriceResponseProperties"
@@ -3340,6 +3368,7 @@
33403368
},
33413369
"CalculatePriceResponseProperties": {
33423370
"type": "object",
3371+
"description": "Properties for calculate price response",
33433372
"properties": {
33443373
"billingCurrencyTotal": {
33453374
"type": "object",
@@ -3384,11 +3413,11 @@
33843413
"type": "string"
33853414
},
33863415
"skuTitle": {
3387-
"description": "Title of SKU that is being purchased.",
3416+
"description": "Title of sku that is being purchased.",
33883417
"type": "string"
33893418
},
33903419
"skuDescription": {
3391-
"description": "Description of SKU that is being purchased.",
3420+
"description": "Description of sku that is being purchased.",
33923421
"type": "string"
33933422
},
33943423
"pricingCurrencyTotal": {

0 commit comments

Comments
 (0)