-
Notifications
You must be signed in to change notification settings - Fork 5.5k
ARM ID annotations for Batch #19589
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
ARM ID annotations for Batch #19589
Conversation
Hi, @matthchr 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] |
Swagger Validation Report
|
compared swaggers (via Oad v0.9.6)] | new version | base version |
---|---|---|
BatchManagement.json | 2021-01-01(a22c575) | 2021-01-01(main) |
BatchManagement.json | 2021-06-01(a22c575) | 2021-06-01(main) |
BatchManagement.json | 2022-01-01(a22c575) | 2022-01-01(main) |
BatchManagement.json | 2022-06-01(a22c575) | 2022-06-01(main) |
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v1.13.0) | new version | base version |
---|---|---|
package-2022-06 | package-2022-06(a22c575) | package-2022-06(main) |
package-2022-01 | package-2022-01(a22c575) | package-2022-01(main) |
package-2021-06 | package-2021-06(a22c575) | package-2021-06(main) |
package-2021-01 | package-2021-01(a22c575) | package-2021-01(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
R2026 - AvoidAnonymousTypes |
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Microsoft.Batch/stable/2021-01-01/BatchManagement.json#L2432 |
R2026 - AvoidAnonymousTypes |
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Microsoft.Batch/stable/2021-01-01/BatchManagement.json#L3642 |
R4018 - OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.Batch/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.Batch/stable/2021-01-01/BatchManagement.json#L1041 |
R4037 - MissingTypeObject |
The schema 'AutoStorageBaseProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Batch/stable/2021-01-01/BatchManagement.json#L2240 |
R4037 - MissingTypeObject |
The schema 'BatchAccountUpdateProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Batch/stable/2021-01-01/BatchManagement.json#L2260 |
R4037 - MissingTypeObject |
The schema 'BatchAccountCreateProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Batch/stable/2021-01-01/BatchManagement.json#L2274 |
R4037 - MissingTypeObject |
The schema 'BatchAccountCreateParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Batch/stable/2021-01-01/BatchManagement.json#L2302 |
R4037 - MissingTypeObject |
The schema 'KeyVaultReference' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Batch/stable/2021-01-01/BatchManagement.json#L2330 |
R4037 - MissingTypeObject |
The schema 'AutoStorageProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Batch/stable/2021-01-01/BatchManagement.json#L2355 |
R4037 - MissingTypeObject |
The schema 'VirtualMachineFamilyCoreQuota' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Batch/stable/2021-01-01/BatchManagement.json#L2373 |
R4037 - MissingTypeObject |
The schema 'BatchAccountIdentity' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Batch/stable/2021-01-01/BatchManagement.json#L2391 |
R4037 - MissingTypeObject |
The schema 'BatchAccountProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Batch/stable/2021-01-01/BatchManagement.json#L2455 |
R4037 - MissingTypeObject |
The schema 'BatchAccount' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Batch/stable/2021-01-01/BatchManagement.json#L2593 |
R4037 - MissingTypeObject |
The schema 'BatchAccountUpdateParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Batch/stable/2021-01-01/BatchManagement.json#L2612 |
R4037 - MissingTypeObject |
The schema 'BatchAccountListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Batch/stable/2021-01-01/BatchManagement.json#L2633 |
R4037 - MissingTypeObject |
The schema 'EncryptionProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Batch/stable/2021-01-01/BatchManagement.json#L2649 |
R4037 - MissingTypeObject |
The schema 'KeyVaultProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Batch/stable/2021-01-01/BatchManagement.json#L2680 |
R4037 - MissingTypeObject |
The schema 'BatchAccountRegenerateKeyParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Batch/stable/2021-01-01/BatchManagement.json#L2689 |
R4037 - MissingTypeObject |
The schema 'BatchAccountKeys' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Batch/stable/2021-01-01/BatchManagement.json#L2719 |
R4037 - MissingTypeObject |
The schema 'ActivateApplicationPackageParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Batch/stable/2021-01-01/BatchManagement.json#L2739 |
R4037 - MissingTypeObject |
The schema 'Application' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Batch/stable/2021-01-01/BatchManagement.json#L2751 |
R4037 - MissingTypeObject |
The schema 'ApplicationProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Batch/stable/2021-01-01/BatchManagement.json#L2766 |
R4037 - MissingTypeObject |
The schema 'ApplicationPackage' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Batch/stable/2021-01-01/BatchManagement.json#L2783 |
R4037 - MissingTypeObject |
The schema 'ApplicationPackageProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Batch/stable/2021-01-01/BatchManagement.json#L2798 |
R4037 - MissingTypeObject |
The schema 'ListApplicationsResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Batch/stable/2021-01-01/BatchManagement.json#L2848 |
R4037 - MissingTypeObject |
The schema 'ListApplicationPackagesResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Batch/stable/2021-01-01/BatchManagement.json#L2864 |
R4037 - MissingTypeObject |
The schema 'BatchLocationQuota' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Batch/stable/2021-01-01/BatchManagement.json#L2880 |
R4037 - MissingTypeObject |
The schema 'Resource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Batch/stable/2021-01-01/BatchManagement.json#L2891 |
R4037 - MissingTypeObject |
The schema 'ProxyResource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Batch/stable/2021-01-01/BatchManagement.json#L2925 |
R4037 - MissingTypeObject |
The schema 'CertificateBaseProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Batch/stable/2021-01-01/BatchManagement.json#L2996 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️❌
ModelValidation: 2 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
XMS_EXAMPLE_NOTFOUND_ERROR |
x-ms-example not found in Operations_List. Url: Microsoft.Batch/stable/2021-01-01/BatchManagement.json#L1042:14 |
XMS_EXAMPLE_NOTFOUND_ERROR |
x-ms-example not found in Operations_List. Url: Microsoft.Batch/stable/2021-06-01/BatchManagement.json#L1163:14 |
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️⚠️
SDK Track2 Validation: 0 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/a22c5754ab0bbb26473710a3586c130fa7d97cba/specification/batch/resource-manager/readme.md#tag-package-2022-06">batch/resource-manager/readme.md#package-2022-06
- "https://github.com/Azure/azure-rest-api-specs/blob/a22c5754ab0bbb26473710a3586c130fa7d97cba/specification/batch/resource-manager/readme.md#tag-package-2022-01">batch/resource-manager/readme.md#package-2022-01
- "https://github.com/Azure/azure-rest-api-specs/blob/a22c5754ab0bbb26473710a3586c130fa7d97cba/specification/batch/resource-manager/readme.md#tag-package-2021-06">batch/resource-manager/readme.md#package-2021-06
- "https://github.com/Azure/azure-rest-api-specs/blob/a22c5754ab0bbb26473710a3586c130fa7d97cba/specification/batch/resource-manager/readme.md#tag-package-2021-01">batch/resource-manager/readme.md#package-2021-01
Rule | Message |
---|---|
"readme":"batch/resource-manager/readme.md", "tag":"package-2022-06", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
|
"readme":"batch/resource-manager/readme.md", "tag":"package-2022-01", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
|
"readme":"batch/resource-manager/readme.md", "tag":"package-2021-06", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
|
"readme":"batch/resource-manager/readme.md", "tag":"package-2021-01", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
️️✔️
PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️
CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
Swagger Generation Artifacts
|
Hi @matthchr, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Hi @matthchr, 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. |
e0b72d4
to
41d9db5
Compare
@dpwatrous is there elsewhere that this change needs to be made (batch repo?) for it to persist into new verisons? |
Thanks for the PR, @matthchr. We do need to merge this into the internal service repo, but this change should come along for the ride as I believe we have other changes to merge. @paterasMSFT @wiboris FYI |
.NET SDK has no x-ms-format, so this is a superset, which is OK because this package is not GA yet in .NET |
41d9db5
to
a22c575
Compare
Uses the new arm-id format to describe fields which are references to other ARM resources.
This was split off from #18318
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 appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
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.