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.

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 with Swagger for Microsoft.Help RP #23690

Merged
merged 3 commits into from
Apr 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -8,34 +8,49 @@
"body": {
"value": [
{
"solutionId": "SampleSolutionId1",
"solutionType": "Diagnostics",
"description": "This is a diagnostic",
"requiredParameterSets": [
[
"ResourceUri"
"id": "subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read/providers/Microsoft.Help/discoverySolutions/SampleSolutionId1",
"type": "Microsoft.Help/discoverySolutions",
"name": "SampleSolutionId1",
"properties": {
"solutionId": "SampleSolutionId1",
"solutionType": "Diagnostics",
"description": "This is a diagnostic",
"requiredParameterSets": [
[
"ResourceUri"
]
]
]
}
},
{
"solutionId": "SampleSolutionId2",
"solutionType": "Diagnostics",
"description": "This is another diagnostic",
"requiredParameterSets": [
[
"ResourceUri"
"id": "subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read/providers/Microsoft.Help/discoverySolutions/SampleSolutionId2",
"type": "Microsoft.Help/discoverySolutions",
"name": "SampleSolutionId2",
"properties": {
"solutionId": "SampleSolutionId2",
"solutionType": "Diagnostics",
"description": "This is a diagnostic",
"requiredParameterSets": [
[
"ResourceUri"
]
]
]
}
},
{
"solutionId": "SampleSolutionId3",
"solutionType": "Diagnostics",
"description": "This is another testing diagnostic"
},
{
"solutionId": "SampleSolutionId4",
"solutionType": "Diagnostics",
"description": "This is also another testing diagnostic"
"id": "subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read/providers/Microsoft.Help/discoverySolutions/SampleSolutionId3",
"type": "Microsoft.Help/discoverySolutions",
"name": "SampleSolutionId3",
"properties": {
"solutionId": "SampleSolutionId3",
"solutionType": "Diagnostics",
"description": "This is a diagnostic",
"requiredParameterSets": [
[
"ResourceUri"
]
]
}
}
],
"nextLink": "nextLinkUrl"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -523,19 +523,33 @@
"description": "The list of solution metadata.",
"type": "array",
"items": {
"$ref": "#/definitions/SolutionMetadata"
},
"x-ms-identifiers": [
"solutionId"
]
"$ref": "#/definitions/SolutionMetadataResource"
}
},
"nextLink": {
"description": "The link used to get the next page of solution metadata.",
"type": "string"
}
}
},
"SolutionMetadata": {
"SolutionMetadataResource": {
"description": "Solution Metadata resource",
"type": "object",
"x-ms-azure-resource": true,
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/SolutionMetadataProperties",
"description": "Solution metadata Resource properties."
}
},
"allOf": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
}
]
},
"SolutionMetadataProperties": {
"description": "Diagnostic solution metadata.",
"type": "object",
"properties": {
Expand Down Expand Up @@ -573,7 +587,7 @@
"required": true,
"type": "string",
"description": "This is an extension resource provider and only resource level extension is supported at the moment.",
"x-ms-parameter-location": "client",
"x-ms-parameter-location": "method",
"x-ms-skip-url-encoding": true
},
"ApiVersionParameter": {
Expand All @@ -593,22 +607,24 @@
"maxLength": 100,
"pattern": "^[A-Za-z0-9-+@()_]+$",
"description": "Unique resource name for insight resources",
"x-ms-parameter-location": "client"
"x-ms-parameter-location": "method"
},
"FilterParameter": {
"name": "$filter",
"description": "Can be used to filter solutionIds by 'ProblemClassificationId'. The filter supports only 'and' and 'eq' operators. Example: $filter=ProblemClassificationId eq '1ddda5b4-cf6c-4d4f-91ad-bc38ab0e811e' and ProblemClassificationId eq '0a9673c2-7af6-4e19-90d3-4ee2461076d9'.",
"in": "query",
"required": false,
"type": "string",
"x-ms-skip-url-encoding": true
"x-ms-skip-url-encoding": true,
"x-ms-parameter-location": "method"
},
"SkipTokenParameter": {
"name": "$skiptoken",
"description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.",
"in": "query",
"required": false,
"type": "string"
"type": "string",
"x-ms-parameter-location": "method"
}
}
}
2 changes: 1 addition & 1 deletion specification/help/resource-manager/readme.go.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ These settings apply only when `--go` is specified on the command line.
```yaml $(go) && $(track2)
azure-arm: true
license-header: MICROSOFT_MIT_NO_VERSION
module-name: sdk/resourcemanager/help/armhelp
module-name: sdk/resourcemanager/selfhelp/armselfhelp
module: github.com/Azure/azure-sdk-for-go/$(module-name)
output-folder: $(go-sdk-folder)/$(module-name)
```
3 changes: 0 additions & 3 deletions specification/help/resource-manager/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,6 @@ swagger-to-sdk:
- repo: azure-cli-extensions
- repo: azure-powershell
```
## Az

See configuration in [readme.az.md](./readme.az.md)

## Go

Expand Down
6 changes: 3 additions & 3 deletions specification/help/resource-manager/readme.python.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ Please also specify `--python-sdks-folder=<path to the root directory of your az
``` yaml $(python)
azure-arm: true
license-header: MICROSOFT_MIT_NO_VERSION
package-name: azure-mgmt-help
namespace: azure.mgmt.help
package-name: azure-mgmt-selfhelp
namespace: azure.mgmt.selfhelp
package-version: 1.0.0b1
clear-output-folder: true
```

``` yaml $(python)
no-namespace-folders: true
output-folder: $(python-sdks-folder)/help/azure-mgmt-help/azure/mgmt/help
output-folder: $(python-sdks-folder)/selfhelp/azure-mgmt-selfhelp/azure/mgmt/selfhelp
```
4 changes: 2 additions & 2 deletions specification/help/resource-manager/readme.typescript.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Please also specify `--typescript-sdks-folder=<path to root folder of your azure
``` yaml $(typescript)
typescript:
azure-arm: true
package-name: "@azure/arm-help"
qiaozha marked this conversation as resolved.
Show resolved Hide resolved
output-folder: "$(typescript-sdks-folder)/sdk/help/arm-help"
package-name: "@azure/arm-selfhelp"
output-folder: "$(typescript-sdks-folder)/sdk/selfhelp/arm-selfhelp"
payload-flattening-threshold: 1
clear-output-folder: true
generate-metadata: true
Expand Down