Skip to content

Commit 1564ac5

Browse files
wwendycWendy ChangWendy Chang
authored
ProviderHub: Swagger doc update (#12680)
* RPaaS 2020.11.20 GA specs * update readme * prettier fix and add custom words * spelling * update SDKs * go sdk * update providerhub swagger * resolve circular dependency * validations fix * camel case * resource type registrations operationIds * linter * update readme * fix validation * update property * required request body parameters * update path * update response payload Co-authored-by: Wendy Chang <wendychang@microsoft.com> Co-authored-by: Wendy Chang <wendychang@gmail.com>
1 parent 6ff4150 commit 1564ac5

19 files changed

+299
-210
lines changed

‎specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/CheckinManifest.json‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,10 @@
33
"subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77",
44
"providerNamespace": "Microsoft.Contoso",
55
"api-version": "2020-11-20",
6-
"BaselineArmManifestLocation": "EastUS2EUAP",
7-
"Environment": "Prod"
6+
"checkinManifestParams": {
7+
"baselineArmManifestLocation": "EastUS2EUAP",
8+
"environment": "Prod"
9+
}
810
},
911
"responses": {
1012
"200": {

‎specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/CustomRollouts_CreateOrUpdate.json‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,12 @@
44
"providerNamespace": "Microsoft.Contoso",
55
"rolloutName": "brazilUsShoeBoxTesting",
66
"api-version": "2020-11-20",
7-
"customRolloutSpecification": {
8-
"properties": {
9-
"specification": {
10-
"Canary": {
11-
"regions": [
12-
"brazilus"
13-
]
14-
}
7+
"properties": {
8+
"specification": {
9+
"canary": {
10+
"regions": [
11+
"brazilus"
12+
]
1513
}
1614
}
1715
}

‎specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/NotificationRegistrations_CreateOrUpdate.json‎

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,30 @@
44
"providerNamespace": "Microsoft.Contoso",
55
"api-version": "2020-11-20",
66
"notificationRegistrationName": "fooNotificationRegistration",
7-
"NotificationRegistrationProperties": {
8-
"notificationMode": "EventHub",
9-
"messageScope": "RegisteredSubscriptions",
10-
"includedEvents": [
11-
"*/write",
12-
"Microsoft.Contoso/employees/delete"
13-
],
14-
"notificationEndpoints": [
15-
{
16-
"locations": [
17-
"",
18-
"East US"
19-
],
20-
"notificationDestination": "/subscriptions/ac6bcfb5-3dc1-491f-95a6-646b89bf3e88/resourceGroups/mgmtexp-eastus/providers/Microsoft.EventHub/namespaces/unitedstates-mgmtexpint/eventhubs/armlinkednotifications"
21-
},
22-
{
23-
"locations": [
24-
"North Europe"
25-
],
26-
"notificationDestination": "/subscriptions/ac6bcfb5-3dc1-491f-95a6-646b89bf3e88/resourceGroups/mgmtexp-northeurope/providers/Microsoft.EventHub/namespaces/europe-mgmtexpint/eventhubs/armlinkednotifications"
27-
}
28-
]
7+
"properties": {
8+
"properties": {
9+
"notificationMode": "EventHub",
10+
"messageScope": "RegisteredSubscriptions",
11+
"includedEvents": [
12+
"*/write",
13+
"Microsoft.Contoso/employees/delete"
14+
],
15+
"notificationEndpoints": [
16+
{
17+
"locations": [
18+
"",
19+
"East US"
20+
],
21+
"notificationDestination": "/subscriptions/ac6bcfb5-3dc1-491f-95a6-646b89bf3e88/resourceGroups/mgmtexp-eastus/providers/Microsoft.EventHub/namespaces/unitedstates-mgmtexpint/eventhubs/armlinkednotifications"
22+
},
23+
{
24+
"locations": [
25+
"North Europe"
26+
],
27+
"notificationDestination": "/subscriptions/ac6bcfb5-3dc1-491f-95a6-646b89bf3e88/resourceGroups/mgmtexp-northeurope/providers/Microsoft.EventHub/namespaces/europe-mgmtexpint/eventhubs/armlinkednotifications"
28+
}
29+
]
30+
}
2931
}
3032
},
3133
"responses": {

‎specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/Operations_CreateOrUpdate.json‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
"subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77",
44
"providerNamespace": "Microsoft.Contoso",
55
"api-version": "2020-11-20",
6-
"OperationsContent": {
7-
"Contents": [
6+
"OperationsPutContent": {
7+
"contents": [
88
{
9-
"Name": "Microsoft.Contoso/Employees/Read",
10-
"Display": {
11-
"Provider": "Microsoft.Contoso",
12-
"Resource": "Employees",
13-
"Operation": "Gets/List employee resources",
14-
"Description": "Read employees"
9+
"name": "Microsoft.Contoso/Employees/Read",
10+
"display": {
11+
"provider": "Microsoft.Contoso",
12+
"resource": "Employees",
13+
"operation": "Gets/List employee resources",
14+
"description": "Read employees"
1515
}
1616
}
1717
]

‎specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/ProviderRegistrations_CreateOrUpdate.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"subscriptionId": "ab7a8701-f7ef-471a-a2f4-d0ebbf494f77",
44
"providerNamespace": "Microsoft.Contoso",
55
"api-version": "2020-11-20",
6-
"ProviderRegistration": {
6+
"properties": {
77
"properties": {
88
"providerType": "Internal",
99
"providerVersion": "2.0",

‎specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/ProviderRegistrations_ListByResourceGroup.json‎

Lines changed: 0 additions & 19 deletions
This file was deleted.

specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/ResourceTypeRegistration_CreateOrUpdate.json renamed to specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/ResourceTypeRegistrations_CreateOrUpdate.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
"providerNamespace": "Microsoft.Contoso",
55
"resourceType": "employees",
66
"api-version": "2020-11-20",
7-
"ResourceTypeRegistration": {
7+
"properties": {
88
"properties": {
99
"routingType": "Default",
10-
"regionality": "regional",
10+
"regionality": "Regional",
1111
"endpoints": [
1212
{
1313
"apiVersions": [
@@ -18,7 +18,7 @@
1818
"East US",
1919
"North Europe"
2020
],
21-
"requiredfeatures": [
21+
"requiredFeatures": [
2222
"<feature flag>"
2323
]
2424
}

specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/ResourceTypeRegistration_Delete.json renamed to specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/ResourceTypeRegistrations_Delete.json

File renamed without changes.

‎specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/Skus_CreateOrUpdate.json‎

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,26 +5,24 @@
55
"api-version": "2020-11-20",
66
"resourceType": "testResourceType",
77
"sku": "testSku",
8-
"SkuResource": {
9-
"properties": {
10-
"skuSettings": [
11-
{
12-
"name": "freeSku",
13-
"tier": "Tier1",
14-
"kind": "Standard"
15-
},
16-
{
17-
"name": "premiumSku",
18-
"tier": "Tier2",
19-
"kind": "Premium",
20-
"costs": [
21-
{
22-
"meterId": "xxx"
23-
}
24-
]
25-
}
26-
]
27-
}
8+
"properties": {
9+
"skuSettings": [
10+
{
11+
"name": "freeSku",
12+
"tier": "Tier1",
13+
"kind": "Standard"
14+
},
15+
{
16+
"name": "premiumSku",
17+
"tier": "Tier2",
18+
"kind": "Premium",
19+
"costs": [
20+
{
21+
"meterId": "xxx"
22+
}
23+
]
24+
}
25+
]
2826
}
2927
},
3028
"responses": {

‎specification/providerhub/resource-manager/Microsoft.ProviderHub/stable/2020-11-20/examples/Skus_CreateOrUpdateNestedResourceTypeFirst.json‎

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,24 @@
66
"resourceType": "testResourceType",
77
"sku": "testSku",
88
"nestedResourceTypeFirst": "nestedResourceTypeFirst",
9-
"SkuResource": {
10-
"properties": {
11-
"skuSettings": [
12-
{
13-
"name": "freeSku",
14-
"tier": "Tier1",
15-
"kind": "Standard"
16-
},
17-
{
18-
"name": "premiumSku",
19-
"tier": "Tier2",
20-
"kind": "Premium",
21-
"costs": [
22-
{
23-
"meterId": "xxx"
24-
}
25-
]
26-
}
27-
]
28-
}
9+
"properties": {
10+
"skuSettings": [
11+
{
12+
"name": "freeSku",
13+
"tier": "Tier1",
14+
"kind": "Standard"
15+
},
16+
{
17+
"name": "premiumSku",
18+
"tier": "Tier2",
19+
"kind": "Premium",
20+
"costs": [
21+
{
22+
"meterId": "xxx"
23+
}
24+
]
25+
}
26+
]
2927
}
3028
},
3129
"responses": {

0 commit comments

Comments
 (0)