Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix issues in mgmt group swaggers which result in problematic SDKs #12488

Merged
merged 5 commits into from
Feb 2, 2021
Merged

Fix issues in mgmt group swaggers which result in problematic SDKs #12488

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
94d6e1c
fix issue in 2020-02-01
ArcturusZhang Jan 19, 2021
56b37bf
fix issue in 2020-05-01
ArcturusZhang Jan 19, 2021
1891036
fix model validation
ArcturusZhang Jan 19, 2021
aec1a39
fix prettier
ArcturusZhang Jan 30, 2021
4e39234
revert some removal of x-ms-parameter-location
ArcturusZhang Jan 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...esource-manager/Microsoft.Management/stable/2020-02-01/examples/PatchManagementGroup.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"groupId": "ChildGroup",
"patchGroupRequest": {
"displayName": "AlternateDisplayName",
"parentGroupId": "/providers/Microsoft.Management/managementGroups/AlternateRootGroup"
"parentId": "/providers/Microsoft.Management/managementGroups/AlternateRootGroup"
},
"Cache-Control": "no-cache"
},
Expand Down
6 changes: 4 additions & 2 deletions .../resource-manager/Microsoft.Management/stable/2020-02-01/examples/PutManagementGroup.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@
"createManagementGroupRequest": {
"properties": {
"displayName": "ChildGroup",
"parent": {
"id": "/providers/Microsoft.Management/managementGroups/RootGroup"
"details": {
"parent": {
"id": "/providers/Microsoft.Management/managementGroups/RootGroup"
}
}
}
},
Expand Down
30 changes: 9 additions & 21 deletions .../managementgroups/resource-manager/Microsoft.Management/stable/2020-02-01/management.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1787,14 +1787,14 @@
"type": {
"type": "string",
"enum": [
"Microsoft.Management/managementGroup"
"Microsoft.Management/managementGroups"
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have to change this, because by design, the type of a resource should be in plural form. This must be a mistake.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we ask service team to double confirm it is really typo?

],
"x-ms-enum": {
"name": "Type",
"modelAsString": false,
"values": [
{
"value": "Microsoft.Management/managementGroup"
"value": "Microsoft.Management/managementGroups"
}
]
},
Expand Down Expand Up @@ -1855,7 +1855,7 @@
"schema": {
"$ref": "#/definitions/CreateManagementGroupRequest"
},
"x-ms-parameter-location": "client"
"x-ms-parameter-location": "method"
},
"PatchGroupRequestParameter": {
"name": "patchGroupRequest",
Expand All @@ -1865,7 +1865,7 @@
"schema": {
"$ref": "#/definitions/PatchManagementGroupRequest"
},
"x-ms-parameter-location": "client"
"x-ms-parameter-location": "method"
},
"FilterParameter": {
"name": "$filter",
Expand Down Expand Up @@ -1922,19 +1922,7 @@
"schema": {
"$ref": "#/definitions/CreateOrUpdateSettingsRequest"
},
"x-ms-parameter-location": "client"
},
"OperationResultIdParameter": {
"name": "operationResultId",
"in": "path",
"required": true,
"type": "string",
"enum": [
"create",
"delete"
],
"description": "The id of the operation result.",
"x-ms-parameter-location": "client"
"x-ms-parameter-location": "method"
},
"CheckNameAvailabilityParameter": {
"name": "checkNameAvailabilityRequest",
Expand All @@ -1944,31 +1932,31 @@
"schema": {
"$ref": "#/definitions/CheckNameAvailabilityRequest"
},
"x-ms-parameter-location": "client"
"x-ms-parameter-location": "method"
},
"SkipParameter": {
"name": "$skip",
"in": "query",
"required": false,
"type": "integer",
"description": "Number of entities to skip over when retrieving results. Passing this in will override $skipToken.",
"x-ms-parameter-location": "client"
"x-ms-parameter-location": "method"
},
"TopParameter": {
"name": "$top",
"in": "query",
"required": false,
"type": "integer",
"description": "Number of elements to return when retrieving results. Passing this in will override $skipToken.",
"x-ms-parameter-location": "client"
"x-ms-parameter-location": "method"
},
"SkipTokenParameter": {
"name": "$skiptoken",
"in": "query",
"required": false,
"type": "string",
"description": "Page continuation token is only used if a previous operation returned a partial result. \nIf a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.\n",
"x-ms-parameter-location": "client"
"x-ms-parameter-location": "method"
},
"CacheControlHeader": {
"name": "Cache-Control",
Expand Down
26 changes: 7 additions & 19 deletions .../managementgroups/resource-manager/Microsoft.Management/stable/2020-05-01/management.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1971,7 +1971,7 @@
"schema": {
"$ref": "#/definitions/CreateManagementGroupRequest"
},
"x-ms-parameter-location": "client"
"x-ms-parameter-location": "method"
},
"PatchGroupRequestParameter": {
"name": "patchGroupRequest",
Expand All @@ -1981,7 +1981,7 @@
"schema": {
"$ref": "#/definitions/PatchManagementGroupRequest"
},
"x-ms-parameter-location": "client"
"x-ms-parameter-location": "method"
},
"FilterParameter": {
"name": "$filter",
Expand Down Expand Up @@ -2038,19 +2038,7 @@
"schema": {
"$ref": "#/definitions/CreateOrUpdateSettingsRequest"
},
"x-ms-parameter-location": "client"
},
"OperationResultIdParameter": {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This parameter is removed because there is no reference of this within the scope of this RP.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This causes lint errors. Can you double check?

"name": "operationResultId",
"in": "path",
"required": true,
"type": "string",
"enum": [
"create",
"delete"
],
"description": "The id of the operation result.",
"x-ms-parameter-location": "client"
"x-ms-parameter-location": "method"
},
"CheckNameAvailabilityParameter": {
"name": "checkNameAvailabilityRequest",
Expand All @@ -2060,31 +2048,31 @@
"schema": {
"$ref": "#/definitions/CheckNameAvailabilityRequest"
},
"x-ms-parameter-location": "client"
"x-ms-parameter-location": "method"
},
"SkipParameter": {
"name": "$skip",
"in": "query",
"required": false,
"type": "integer",
"description": "Number of entities to skip over when retrieving results. Passing this in will override $skipToken.",
"x-ms-parameter-location": "client"
"x-ms-parameter-location": "method"
},
"TopParameter": {
"name": "$top",
"in": "query",
"required": false,
"type": "integer",
"description": "Number of elements to return when retrieving results. Passing this in will override $skipToken.",
"x-ms-parameter-location": "client"
"x-ms-parameter-location": "method"
},
"SkipTokenParameter": {
"name": "$skiptoken",
"in": "query",
"required": false,
"type": "string",
"description": "Page continuation token is only used if a previous operation returned a partial result. \nIf a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.\n",
"x-ms-parameter-location": "client"
"x-ms-parameter-location": "method"
},
"CacheControlHeader": {
"name": "Cache-Control",
Expand Down