[Mirror] DMS Swagger Json Review 2021-05-01 #2594
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Swagger pipeline can not start as the pull request has merge conflicts. |
|
Hi, @tianxchen-ms Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com |
|
Swagger pipeline can not start as the pull request has merge conflicts. |
|
Swagger pipeline started successfully. If there is ApiView generated, it will be updated in this comment. |
|
/azp run |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| sqlAvailabilityGroups.json | 2023-03-15-preview(fda03ac) | 2023-03-15-preview(main) |
| clusters.json | 2023-03-01(fda03ac) | 2023-03-01(main) |
| botservice.json | 2021-05-01-preview(fda03ac) | 2021-05-01-preview(main) |
| botservice.json | 2022-06-15-preview(fda03ac) | 2022-06-15-preview(main) |
| botservice.json | 2022-09-15(fda03ac) | 2022-09-15(main) |
| afdx.json | 2020-09-01(fda03ac) | 2020-09-01(main) |
| cdn.json | 2020-09-01(fda03ac) | 2020-09-01(main) |
| afdx.json | 2021-06-01(fda03ac) | 2021-06-01(main) |
| cdn.json | 2021-06-01(fda03ac) | 2021-06-01(main) |
| openapi.json | v1.1(fda03ac) | v1.1(main) |
| communicationservicesrooms.json | 2023-03-31-preview(fda03ac) | 2023-03-31-preview(main) |
| consumption.json | 2023-03-01(fda03ac) | 2023-03-01(main) |
| containerInstance.json | 2022-10-01-preview(fda03ac) | 2022-10-01-preview(main) |
| containerInstance.json | 2023-02-01-preview(fda03ac) | 2023-02-01-preview(main) |
| common-types.json | 2022-10-01(fda03ac) | 2022-10-01(main) |
| costmanagement.generatedetailedcostreport.json | 2022-10-01(fda03ac) | 2022-10-01(main) |
| Pipeline.json | 2018-06-01(fda03ac) | 2018-06-01(main) |
| elastic.json | 2023-02-01-preview(fda03ac) | 2023-02-01-preview(main) |
| Storage.json | 2018-01-01(fda03ac) | 2018-01-01(main) |
| disasterRecoveryConfigs.json | 2022-01-01-preview(fda03ac) | 2022-01-01-preview(main) |
| SchemaRegistry.json | 2022-10-01-preview(fda03ac) | 2022-10-01-preview(main) |
| disasterRecoveryConfigs.json | 2022-10-01-preview(fda03ac) | 2022-10-01-preview(main) |
| namespaces-preview.json | 2022-10-01-preview(fda03ac) | 2022-10-01-preview(main) |
| managedHsm.json | 2020-04-01-preview(fda03ac) | 2020-04-01-preview(main) |
| managedHsm.json | 2021-04-01-preview(fda03ac) | 2021-04-01-preview(main) |
| managedHsm.json | 2021-06-01-preview(fda03ac) | 2021-06-01-preview(main) |
| managedHsm.json | 2021-11-01-preview(fda03ac) | 2021-11-01-preview(main) |
| managedHsm.json | 2022-02-01-preview(fda03ac) | 2022-02-01-preview(main) |
| managedHsm.json | 2021-10-01(fda03ac) | 2021-10-01(main) |
| managedHsm.json | 2022-07-01(fda03ac) | 2022-07-01(main) |
| managedHsm.json | 2022-11-01(fda03ac) | 2022-11-01(main) |
| managedHsm.json | 2023-02-01(fda03ac) | 2023-02-01(main) |
| mfe.json | 2023-02-01-preview(fda03ac) | 2023-02-01-preview(main) |
| management.json | 2020-05-01(fda03ac) | 2020-05-01(main) |
| management.json | 2020-10-01(fda03ac) | 2020-10-01(main) |
| management.json | 2021-04-01(fda03ac) | 2021-04-01(main) |
| route.json | 2023-08-01-preview(fda03ac) | 2023-08-01-preview(main) |
| marketplacecatalog.json | 2022-07-31(fda03ac) | 2022-07-31(main) |
| AzureADAdministrator.json | 2021-12-01-preview(fda03ac) | 2021-12-01-preview(main) |
| Backups.json | 2021-12-01-preview(fda03ac) | 2021-12-01-preview(main) |
| Configurations.json | 2021-12-01-preview(fda03ac) | 2021-12-01-preview(main) |
| Databases.json | 2021-12-01-preview(fda03ac) | 2021-12-01-preview(main) |
| FirewallRules.json | 2021-12-01-preview(fda03ac) | 2021-12-01-preview(main) |
| FlexibleServers.json | 2021-12-01-preview(fda03ac) | 2021-12-01-preview(main) |
| LogFiles.json | 2021-12-01-preview(fda03ac) | 2021-12-01-preview(main) |
| ServiceOperations.json | 2021-12-01-preview(fda03ac) | 2021-12-01-preview(main) |
| netapp.json | 2022-09-01(fda03ac) | 2022-09-01(main) |
| NewRelic.json | 2022-07-01-preview(fda03ac) | 2022-07-01-preview(main) |
| NewRelic.json | 2022-07-01(fda03ac) | 2022-07-01(main) |
| orbital.json | 2022-11-01(fda03ac) | 2022-11-01(main) |
| PaloAltoNetworks.Cloudngfw.json | 2022-08-29-preview(fda03ac) | 2022-08-29-preview(main) |
| FlexibleServers.json | 2022-12-01(fda03ac) | 2022-12-01(main) |
| bms.json | 2023-01-01(fda03ac) | 2023-01-01(main) |
| bms.json | 2023-02-01(fda03ac) | 2023-02-01(main) |
| redisenterprise.json | 2022-11-01-preview(fda03ac) | 2022-11-01-preview(main) |
| redisenterprise.json | 2023-03-01-preview(fda03ac) | 2023-03-01-preview(main) |
| redisenterprise.json | 2022-01-01(fda03ac) | 2022-01-01(main) |
| servicebus.json | 2021-05(fda03ac) | 2021-05(main) |
| DisasterRecoveryConfig.json | 2022-01-01-preview(fda03ac) | 2022-01-01-preview(main) |
| migrationconfigs.json | 2022-01-01-preview(fda03ac) | 2022-01-01-preview(main) |
| DisasterRecoveryConfig.json | 2022-10-01-preview(fda03ac) | 2022-10-01-preview(main) |
| migrationconfigs.json | 2022-10-01-preview(fda03ac) | 2022-10-01-preview(main) |
| Pipeline.json | 2020-12-01(fda03ac) | 2020-12-01(main) |
Only 9 items are listed, please refer to log for more details.
️🔄Breaking Change(Cross-Version) inProgress [Detail]
️🔄LintDiff inProgress [Detail]
️️✔️~[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
Validation passes for ServiceAPIReadinessTest.
️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️❌CadlAPIView: 0 Errors, 1 Warnings failed [Detail]
| Rule | Message |
|---|---|
| "How to fix":"Check the detailed log and update cadl version to latest." |
️❌TypeSpecAPIView: 0 Errors, 2 Warnings failed [Detail]
| Rule | Message |
|---|---|
| "How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR." | |
| "How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR." |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️❌Avocado: 35 Errors, 16 Warnings failed [Detail]
Only 9 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Network/virtualNetworks/{}/subnets/{}/providers/Microsoft.ContainerInstance/serviceAssociationLinks/default is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/containerinstance/resource-manager/readme.md json: Microsoft.ContainerInstance/stable/2021-09-01/containerInstance.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourcegroups/{}/providers/Microsoft.ContainerInstance/containerGroups/{}/containers/{}/attach is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/containerinstance/resource-manager/readme.md json: Microsoft.ContainerInstance/stable/2021-03-01/containerInstance.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/databaseAccounts/{}/apis/sql/databases is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/cosmos-db/resource-manager/readme.md json: Microsoft.DocumentDB/stable/2016-03-31/cosmos-db.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/databaseAccounts/{}/apis/sql/databases/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/cosmos-db/resource-manager/readme.md json: Microsoft.DocumentDB/stable/2016-03-31/cosmos-db.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/databaseAccounts/{}/apis/sql/databases/{}/settings/throughput is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/cosmos-db/resource-manager/readme.md json: Microsoft.DocumentDB/stable/2016-03-31/cosmos-db.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/databaseAccounts/{}/apis/sql/databases/{}/containers is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/cosmos-db/resource-manager/readme.md json: Microsoft.DocumentDB/stable/2016-03-31/cosmos-db.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/databaseAccounts/{}/apis/sql/databases/{}/containers/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/cosmos-db/resource-manager/readme.md json: Microsoft.DocumentDB/stable/2016-03-31/cosmos-db.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/databaseAccounts/{}/apis/sql/databases/{}/containers/{}/settings/throughput is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/cosmos-db/resource-manager/readme.md json: Microsoft.DocumentDB/stable/2016-03-31/cosmos-db.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DocumentDB/databaseAccounts/{}/apis/mongodb/databases is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/cosmos-db/resource-manager/readme.md json: Microsoft.DocumentDB/stable/2016-03-31/cosmos-db.json |
️❌ModelValidation: 119 Errors, 0 Warnings failed [Detail]
Only 9 items are listed, please refer to log for more details.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️~[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️~[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️❌PR Summary: 0 Errors, 0 Warnings failed [Detail]
️❌CadlValidation: 1 Errors, 25 Warnings failed [Detail]
Only 9 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
"details":"The generated swagger file 2022-07-01-preview/openapi.json from cadl specification/newrelic/NewRelic.Management is not the same as the '/mnt/vss/_work/1/azure-rest-api-specs/specification/newrelic/resource-manager/NewRelic.Observability/preview/2022-07-01-preview/NewRelic.json' in PR, please make sure the swagger is consistent with the generated swagger. You can find the difference in the pipeline log." |
| Missing identifying properties of objects in the array item, please add @extension("x-ms-identifiers", []) to specify it. If there are no appropriate identifying properties, please add @extension("x-ms-identifiers",[]). Location: @azure-tools/cadl-azure-core/lib/models.cadl#L13 |
|
| Missing identifying properties of objects in the array item, please add @extension("x-ms-identifiers", []) to specify it. If there are no appropriate identifying properties, please add @extension("x-ms-identifiers",[]). Location: @azure-tools/cadl-azure-core/lib/models.cadl#L13 |
|
| Missing identifying properties of objects in the array item, please add @extension("x-ms-identifiers", []) to specify it. If there are no appropriate identifying properties, please add @extension("x-ms-identifiers",[]). Location: specification/newrelic/NewRelic.Management/main.cadl#L386 |
|
| The documentation should not be the same as the node name. Location: specification/newrelic/NewRelic.Management/main.cadl#L670 |
|
| Missing identifying properties of objects in the array item, please add @extension("x-ms-identifiers", []) to specify it. If there are no appropriate identifying properties, please add @extension("x-ms-identifiers",[]). Location: specification/newrelic/NewRelic.Management/main.cadl#L377 |
|
| The names of Model types must use PascalCase Location: specification/newrelic/NewRelic.Management/main.cadl#L469 |
|
| The names of Model types must use PascalCase Location: specification/newrelic/NewRelic.Management/main.cadl#L599 |
|
| The names of Model types must use PascalCase Location: specification/newrelic/NewRelic.Management/main.cadl#L596 |
️❌TypeSpec Validation: 19 Errors, 5 Warnings failed [Detail]
Only 9 items are listed, please refer to log for more details.
Swagger Generation Artifacts
|
Generated ApiView
|
|
No pipelines are associated with this pull request. |
|
Hi @tianxchen-ms, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
This was referenced Aug 8, 2022
|
/azp run |
|
No pipelines are associated with this pull request. |
|
/azp run |
|
No pipelines are associated with this pull request. |
|
/azp run |
|
No pipelines are associated with this pull request. |
|
/azp run |
|
No pipelines are associated with this pull request. |
|
/azp run |
|
No pipelines are associated with this pull request. |
|
/azp run |
|
No pipelines are associated with this pull request. |
|
/azp run |
This was referenced Apr 24, 2023
|
Hi, @tianxchen-ms, our workflow has detected that there is no management SDK ever released for your RP, to further process SDK onboard for your RP, you should have the SDK client library name of your RP reviewed and approved. Impact: SDK release owner will take the approved management client library name to release SDK. No client library name approval will leads to SDK release delayed. |
|
Hi @tianxchen-ms, one or multiple validation error/warning suppression(s) is detected in your PR. Please follow the Swagger-Suppression-Process to get approval. |
This was referenced Apr 28, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Mirror from
https://github.com/Azure/azure-rest-api-specs/pull/20126