-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
Copy the stable version of 2021-08-01 #15180
Copy the stable version of 2021-08-01 #15180
Conversation
Hi, @sureleo 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 |
---|---|
The enum types should have x-ms-enum type extension set with appropriate options. Property name: name Location: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L963 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: dev Location: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L983 |
|
'family' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L992 |
|
'capacity' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L995 |
|
'spec' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L1848 |
|
'scheduling' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L1860 |
|
'default' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L1877 |
|
'resources' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L1889 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
Per the Noun_Verb convention for Operation Ids, the noun 'DataControllers' 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.AzureArcData/stable/2021-08-01/azurearcdata.json#L725 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'DataControllers' 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.AzureArcData/stable/2021-08-01/azurearcdata.json#L788 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'DataControllers' 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.AzureArcData/stable/2021-08-01/azurearcdata.json#L832 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'DataControllers' 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.AzureArcData/stable/2021-08-01/azurearcdata.json#L876 |
|
'PUT' operation 'DataControllers_PutDataController' 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.AzureArcData/stable/2021-08-01/azurearcdata.json#L725 |
|
'PATCH' operation 'DataControllers_PatchDataController' should use method name 'Update'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L876 |
|
Guid used in model definition 'OnPremiseProperty' for property 'id'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L1425 |
|
Guid used in model definition 'LogAnalyticsWorkspaceConfig' for property 'workspaceId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L1924 |
|
Guid used in model definition 'UploadServicePrincipal' for property 'clientId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L1944 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: dev Location: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L936 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L1106 |
|
The tracked resource, 'DataControllerResource', must have a list by resource group operation.(This rule does not apply for tenant level resources.) Location: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L1237 |
|
The tracked resource, 'DataControllerResource', must have a list by subscriptions operation. Location: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L1237 |
|
'dataControllerName' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L743 |
|
'dataControllerName' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L797 |
|
'dataControllerName' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L841 |
|
'dataControllerName' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L885 |
|
'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.AzureArcData/stable/2021-08-01/azurearcdata.json#L1154 |
|
'PageOfDataControllerResource' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L1222 |
|
'ResourceSku' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L1320 |
|
'systemData' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L1199 |
|
'value' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L1225 |
|
'capacity' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L1323 |
|
'family' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L1327 |
|
'name' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L1330 |
|
'size' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L1333 |
|
'tier' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L1336 |
|
'onPremiseProperty' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L1362 |
|
'uploadWatermark' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L1369 |
|
'basicLoginInformation' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L1377 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌
Cross-Version Breaking Changes: 7 Errors, 2 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.8.11)
- current:stable/2021-08-01/azurearcdata.json compared with base:preview/2021-06-01-preview/azurearcdata.json
Rule | Message |
---|---|
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/postgresInstances' removed or restructured? Old: Microsoft.AzureArcData/preview/2021-06-01-preview/azurearcdata.json#L639:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/postgresInstances' removed or restructured? Old: Microsoft.AzureArcData/preview/2021-06-01-preview/azurearcdata.json#L678:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/postgresInstances/{postgresInstanceName}' removed or restructured? Old: Microsoft.AzureArcData/preview/2021-06-01-preview/azurearcdata.json#L721:5 |
1006 - RemovedDefinition |
The new version is missing a definition that was found in the old version. Was 'PostgresInstanceSku' removed or renamed? New: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L927:3 Old: Microsoft.AzureArcData/preview/2021-06-01-preview/azurearcdata.json#L1219:3 |
1006 - RemovedDefinition |
The new version is missing a definition that was found in the old version. Was 'PostgresInstanceProperties' removed or renamed? New: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L927:3 Old: Microsoft.AzureArcData/preview/2021-06-01-preview/azurearcdata.json#L1219:3 |
1006 - RemovedDefinition |
The new version is missing a definition that was found in the old version. Was 'PostgresInstance' removed or renamed? New: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L927:3 Old: Microsoft.AzureArcData/preview/2021-06-01-preview/azurearcdata.json#L1219:3 |
1006 - RemovedDefinition |
The new version is missing a definition that was found in the old version. Was 'PostgresInstanceUpdate' removed or renamed? New: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L927:3 Old: Microsoft.AzureArcData/preview/2021-06-01-preview/azurearcdata.json#L1219:3 |
The new version has a different 'allOf' property than the previous one. New: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L1522:9 Old: Microsoft.AzureArcData/preview/2021-06-01-preview/azurearcdata.json#L1864:9 |
|
The new version has a different 'allOf' property than the previous one. New: Microsoft.AzureArcData/stable/2021-08-01/azurearcdata.json#L959:5 Old: Microsoft.AzureArcData/preview/2021-06-01-preview/azurearcdata.json#L1251:5 |
️️✔️
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
|:speech_balloon: AutorestCore/Exception|"readme":"azurearcdata/resource-manager/readme.md",
"tag":"package-2021-08-01",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"azurearcdata/resource-manager/readme.md",
"tag":"package-2021-08-01",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"azurearcdata/resource-manager/readme.md",
"tag":"package-2021-08-01",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
️️✔️
[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Swagger Generation Artifacts
|
Hello. This PR is just copying whatever we had in private repo to public repo: https://github.com/Azure/azure-rest-api-specs-pr/pull/4205 The PR in private repo has been signed off by both breaking change and ARM. Hence I don't think it'll need another round of review just for the copying purpose. |
* Copy the stable version of 2021-08-01 * Fix spellcheck and readme.md * Adding alibaba as known word
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Please ensure to add changelog with this PR by answering the following questions.
July 31 2021
July 31 2021
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please 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 there are following updates in the PR, ensure to request an approval from 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.