[Do not merge]Test PR #15969
Closed
[Do not merge]Test PR #15969
Conversation
This file contains hidden or 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
|
Hi, @MehaKaushik 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. [email protected] |
|
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Validation Report
|
| Rule | Message |
|---|---|
| Per the Noun_Verb convention for Operation Ids, the noun 'GraphResources' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DocumentDB/preview/2021-07-01-preview/cosmos-db.json#L1568 |
|
| Since operation 'LocationList' response has model definition 'x-ms-pageable', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DocumentDB/preview/2021-07-01-preview/cosmos-db.json#L5211 |
|
| 'GET' operation 'LocationList' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DocumentDB/preview/2021-07-01-preview/cosmos-db.json#L5211 |
|
| 'GET' operation 'LocationGet' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DocumentDB/preview/2021-07-01-preview/cosmos-db.json#L5247 |
|
| 'PUT' operation 'CassandraResources_UpdateCassandraViewThroughput' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DocumentDB/preview/2021-07-01-preview/cosmos-db.json#L5489 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.DocumentDB/preview/2021-07-01-preview/cosmos-db.json#L9487 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.DocumentDB/preview/2021-07-01-preview/managedCassandra.json#L781 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.DocumentDB/preview/2021-07-01-preview/managedCassandra.json#L997 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.DocumentDB/preview/2021-07-01-preview/managedCassandra.json#L1064 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.DocumentDB/preview/2021-07-01-preview/cosmos-db.json#L5539 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.DocumentDB/preview/2021-07-01-preview/cosmos-db.json#L5588 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.DocumentDB/preview/2021-07-01-preview/managedCassandra.json#L341 |
|
| A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'GraphResources_CreateUpdateGraph' Request Model: 'GraphResourceCreateUpdateParameters' Response Model: 'GraphResourceGetResults' Location: Microsoft.DocumentDB/preview/2021-07-01-preview/cosmos-db.json#L1520 |
|
| A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'CassandraResources_CreateUpdateCassandraView' Request Model: 'CassandraViewCreateUpdateParameters' Response Model: 'CassandraViewGetResults' Location: Microsoft.DocumentDB/preview/2021-07-01-preview/cosmos-db.json#L5358 |
|
| A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'CassandraResources_UpdateCassandraViewThroughput' Request Model: 'ThroughputSettingsUpdateParameters' Response Model: 'ThroughputSettingsGetResults' Location: Microsoft.DocumentDB/preview/2021-07-01-preview/cosmos-db.json#L5488 |
|
| A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Service_Create' Request Model: 'ServiceResourceCreateUpdateParameters' Response Model: 'ServiceResource' Location: Microsoft.DocumentDB/preview/2021-07-01-preview/services.json#L80 |
|
| OperationId should contain the verb: 'migratetoautoscale' in:'CassandraResources_MigrateCassandraViewToAutoscale'. Consider updating the operationId Location: Microsoft.DocumentDB/preview/2021-07-01-preview/cosmos-db.json#L5541 |
|
| OperationId should contain the verb: 'migratetomanualthroughput' in:'CassandraResources_MigrateCassandraViewToManualThroughput'. Consider updating the operationId Location: Microsoft.DocumentDB/preview/2021-07-01-preview/cosmos-db.json#L5590 |
|
| The child tracked resource, 'graphs' with immediate parent 'DatabaseAccountGetResults', must have a list by immediate parent operation. Location: Microsoft.DocumentDB/preview/2021-07-01-preview/cosmos-db.json#L6123 |
|
| The child tracked resource, 'views' with immediate parent 'CassandraKeyspaceGetResults', must have a list by immediate parent operation. Location: Microsoft.DocumentDB/preview/2021-07-01-preview/cosmos-db.json#L6580 |
|
| The child tracked resource, 'backups' with immediate parent 'ClusterResource', must have a list by immediate parent operation. Location: Microsoft.DocumentDB/preview/2021-07-01-preview/managedCassandra.json#L988 |
|
| The child tracked resource, 'dataCenters' with immediate parent 'ClusterResource', must have a list by immediate parent operation. Location: Microsoft.DocumentDB/preview/2021-07-01-preview/managedCassandra.json#L1055 |
|
| The child tracked resource, 'services' with immediate parent 'DatabaseAccountGetResults', must have a list by immediate parent operation. Location: Microsoft.DocumentDB/preview/2021-07-01-preview/services.json#L315 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: supportsAvailabilityZone Location: Microsoft.DocumentDB/preview/2021-07-01-preview/cosmos-db.json#L9508 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isResidencyRestricted Location: Microsoft.DocumentDB/preview/2021-07-01-preview/cosmos-db.json#L9513 |
|
| The value provided for description is not descriptive enough. Accurate and descriptive description is essential for maintaining reference documentation. Location: Microsoft.DocumentDB/preview/2021-07-01-preview/services.json#L288 |
|
| The value provided for description is not descriptive enough. Accurate and descriptive description is essential for maintaining reference documentation. Location: Microsoft.DocumentDB/preview/2021-07-01-preview/services.json#L298 |
|
| 'resource' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DocumentDB/preview/2021-07-01-preview/cosmos-db.json#L6103 |
|
| 'options' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DocumentDB/preview/2021-07-01-preview/cosmos-db.json#L6114 |
|
| 'resource' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.DocumentDB/preview/2021-07-01-preview/cosmos-db.json#L6600 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The JSON file has a circular reference. readme: specification/cosmos-db/resource-manager/readme.md json: Microsoft.DocumentDB/preview/2021-07-01-preview/privateEndpointConnection.json |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️❌[Staging] PrettierCheck: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Code style issues found path: Microsoft.DocumentDB/preview/2021-07-01-preview/services.json |
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Swagger Generation Artifacts
|
| Rule | Message |
|---|---|
|
"logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=252264&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b", "detail":"Run.ps1 failed with exit code 128 " |
️❌[Staging] SDK Breaking Change Tracking failed [Detail]
Breaking Changes Tracking
❌azure-sdk-for-python-track2 - track2_azure-mgmt-cosmosdb - 6.4.0+ Parameter create_mode of model DatabaseAccountCreateUpdateParameters is now required
️✔️azure-sdk-for-go - cosmos-db/mgmt/2021-06-15/documentdb - v57.1.0️✔️azure-sdk-for-go - cosmos-db/mgmt/2021-05-15/documentdb - v57.1.0️✔️azure-sdk-for-go - cosmos-db/mgmt/2021-04-15/documentdb - v57.1.0️✔️azure-sdk-for-go - cosmos-db/mgmt/2021-03-15/documentdb - v57.1.0️✔️azure-sdk-for-go - cosmos-db/mgmt/2021-01-15/documentdb - v57.1.0️✔️azure-sdk-for-go - cosmos-db/mgmt/2019-08-01/documentdb - v57.1.0️✔️azure-sdk-for-go - cosmos-db/mgmt/2015-04-08/documentdb - v57.1.0️✔️azure-sdk-for-go - preview/cosmos-db/mgmt/2021-07-01-preview/documentdb - v57.1.0️✔️azure-sdk-for-go - preview/cosmos-db/mgmt/2021-04-01-preview/documentdb - v57.1.0️✔️azure-sdk-for-go - preview/cosmos-db/mgmt/2021-03-01-preview/documentdb - v57.1.0️✔️azure-sdk-for-go - preview/cosmos-db/mgmt/2020-09-01-preview/documentdb - v57.1.0❌azure-sdk-for-go - preview/cosmos-db/mgmt/2020-06-01-preview/documentdb - v57.1.0+ Field `Identity` of struct `RestorableDatabaseAccountGetResult` has been removed + Field `Identity` of struct `RestorableMongodbCollectionGetResult` has been removed + Field `Identity` of struct `RestorableMongodbDatabaseGetResult` has been removed + Field `Identity` of struct `RestorableSQLContainerGetResult` has been removed + Field `Identity` of struct `RestorableSQLDatabaseGetResult` has been removed + Field `Location` of struct `RestorableMongodbCollectionGetResult` has been removed + Field `Location` of struct `RestorableMongodbDatabaseGetResult` has been removed + Field `Location` of struct `RestorableSQLContainerGetResult` has been removed + Field `Location` of struct `RestorableSQLDatabaseGetResult` has been removed + Field `Tags` of struct `RestorableDatabaseAccountGetResult` has been removed + Field `Tags` of struct `RestorableMongodbCollectionGetResult` has been removed + Field `Tags` of struct `RestorableMongodbDatabaseGetResult` has been removed + Field `Tags` of struct `RestorableSQLContainerGetResult` has been removed + Field `Tags` of struct `RestorableSQLDatabaseGetResult` has been removed + Struct `DefaultErrorResponse` has been removed
️✔️azure-sdk-for-go - preview/cosmos-db/mgmt/2020-04-01-preview/documentdb - v57.1.0️✔️azure-sdk-for-go - preview/cosmos-db/mgmt/2020-03-01-preview/documentdb - v57.1.0️✔️azure-sdk-for-go - preview/cosmos-db/mgmt/2019-12-12-preview/documentdb - v57.1.0️✔️azure-sdk-for-go - preview/cosmos-db/mgmt/2019-08-01-preview/documentdb - v57.1.0
lirenhe
added
the
DoNotMerge
Contributor
|
@MehaKaushik the default branch is main, and it seems there is another PR from your fork master branch to main branch, #15971 |
|
Hi @MehaKaushik, 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. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.