-
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
[Hub Generated] Review request for Microsoft.AppPlatform to add version preview/2022-02-01-preview #17184
[Hub Generated] Review request for Microsoft.AppPlatform to add version preview/2022-02-01-preview #17184
Conversation
…2-01-01-preview to version 2022-02-01-preview
Swagger Validation Report
|
Rule | Message |
---|---|
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: 'BuildServiceAgentPool_UpdatePut' Request Model: 'BuildServiceAgentPoolSizeProperties' Response Model: 'BuildServiceAgentPoolResource' Location: Microsoft.AppPlatform/preview/2022-02-01-preview/appplatform.json#L2357 |
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 'BuildService' 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.AppPlatform/preview/2022-02-01-preview/appplatform.json#L1197 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'BuildService' 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.AppPlatform/preview/2022-02-01-preview/appplatform.json#L1242 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'RuntimeVersions' 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.AppPlatform/preview/2022-02-01-preview/appplatform.json#L4937 |
|
Since operation 'ConfigServers_Validate' response has model definition 'array', 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.AppPlatform/preview/2022-02-01-preview/appplatform.json#L677 |
|
'PUT' operation 'ConfigServers_UpdatePut' 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.AppPlatform/preview/2022-02-01-preview/appplatform.json#L557 |
|
'PUT' operation 'BuildServiceAgentPool_UpdatePut' 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.AppPlatform/preview/2022-02-01-preview/appplatform.json#L2362 |
|
'PUT' operation 'MonitoringSettings_UpdatePut' 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.AppPlatform/preview/2022-02-01-preview/appplatform.json#L2469 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AppPlatform/preview/2022-02-01-preview/appplatform.json#L6676 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AppPlatform/preview/2022-02-01-preview/appplatform.json#L6785 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AppPlatform/preview/2022-02-01-preview/appplatform.json#L6827 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AppPlatform/preview/2022-02-01-preview/appplatform.json#L6873 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AppPlatform/preview/2022-02-01-preview/appplatform.json#L6943 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AppPlatform/preview/2022-02-01-preview/appplatform.json#L7184 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AppPlatform/preview/2022-02-01-preview/appplatform.json#L8920 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AppPlatform/preview/2022-02-01-preview/appplatform.json#L9420 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AppPlatform/preview/2022-02-01-preview/appplatform.json#L9472 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AppPlatform/preview/2022-02-01-preview/appplatform.json#L9515 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AppPlatform/preview/2022-02-01-preview/appplatform.json#L9763 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AppPlatform/preview/2022-02-01-preview/appplatform.json#L9884 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AppPlatform/preview/2022-02-01-preview/appplatform.json#L9944 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AppPlatform/preview/2022-02-01-preview/appplatform.json#L10060 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Property name: storageType Location: Microsoft.AppPlatform/preview/2022-02-01-preview/appplatform.json#L8215 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Property name: type Location: Microsoft.AppPlatform/preview/2022-02-01-preview/appplatform.json#L8299 |
|
Based on the response model schema, operation 'BuildService_ListSupportedBuildpacks' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.AppPlatform/preview/2022-02-01-preview/appplatform.json#L2077 |
|
Based on the response model schema, operation 'BuildService_ListSupportedStacks' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.AppPlatform/preview/2022-02-01-preview/appplatform.json#L2170 |
|
Based on the response model schema, operation 'RuntimeVersions_ListRuntimeVersions' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.AppPlatform/preview/2022-02-01-preview/appplatform.json#L4932 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'BuildServiceModel'. Consider using the plural form of 'BuildService' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AppPlatform/preview/2022-02-01-preview/appplatform.json#L1197 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'BuildServiceModel'. Consider using the plural form of 'BuildService' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AppPlatform/preview/2022-02-01-preview/appplatform.json#L1242 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'BuildServiceModel'. Consider using the plural form of 'BuildService' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AppPlatform/preview/2022-02-01-preview/appplatform.json#L1287 |
|
OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'BuildServiceModel'. Consider using the plural form of 'BuildService' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AppPlatform/preview/2022-02-01-preview/appplatform.json#L1335 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌
~[Staging] ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
API Readiness check failed. Please make sure your service is deployed. |
"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.AppPlatform' for api version '2022-02-01-preview'. The supported api-versions are '2019-05-01-preview, 2020-07-01, 2020-11-01-preview, 2021-06-01-preview, 2021-09-01-preview, 2022-01-01-preview'." |
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌
Cross-Version Breaking Changes: 29 Errors, 111 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.9.1)
- current:preview/2022-02-01-preview/appplatform.json compared with base:stable/2020-07-01/appplatform.json
- current:preview/2022-02-01-preview/appplatform.json compared with base:preview/2022-01-01-preview/appplatform.json
Only 30 items are listed, please refer to log for more details.
The following breaking changes are detected by comparison with latest preview version:
Rule | Message |
---|---|
The required parameter 'agentPoolResource' was removed in the new version. Old: Microsoft.AppPlatform/preview/2022-01-01-preview/appplatform.json#L2382:11 |
|
The required parameter 'poolSize' was added in the new version. New: Microsoft.AppPlatform/preview/2022-02-01-preview/appplatform.json#L2382:11 |
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️
SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️
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).
Swagger Generation Artifacts
|
Hi @LGDoor, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Hi, @LGDoor your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
This new api version is forked and updated from '2022-01-01-preview' which is already approved in #17141 |
4afa14a
to
7b3d881
Compare
@LGDoor , the changes looks good to me. Did you talk to menghua to make this swagger changes in ADO repo? |
After discussion, this change will be merged into another version |
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
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.
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.