Add AppPlatform new API schema for new pricing tier #17003
Closed
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
yuwzho
requested review from
ArcturusZhang,
BigCat20196,
RAY-316 and
msyyc
as code owners
|
Hi, @yuwzho 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 Validation Report
|
| 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-01-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-01-01-preview/appplatform.json#L1242 |
|
| '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-01-01-preview/appplatform.json#L2362 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AppPlatform/preview/2022-01-01-preview/appplatform.json#L6676 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AppPlatform/preview/2022-01-01-preview/appplatform.json#L6785 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AppPlatform/preview/2022-01-01-preview/appplatform.json#L6827 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AppPlatform/preview/2022-01-01-preview/appplatform.json#L6873 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AppPlatform/preview/2022-01-01-preview/appplatform.json#L6943 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AppPlatform/preview/2022-01-01-preview/appplatform.json#L7184 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AppPlatform/preview/2022-01-01-preview/appplatform.json#L9424 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AppPlatform/preview/2022-01-01-preview/appplatform.json#L9476 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AppPlatform/preview/2022-01-01-preview/appplatform.json#L9519 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AppPlatform/preview/2022-01-01-preview/appplatform.json#L9767 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AppPlatform/preview/2022-01-01-preview/appplatform.json#L9888 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AppPlatform/preview/2022-01-01-preview/appplatform.json#L9948 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AppPlatform/preview/2022-01-01-preview/appplatform.json#L10064 |
|
| 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-01-01-preview/appplatform.json#L2357 |
|
| Based on the response model schema, operation 'BuildService_ListSupportedBuildpacks' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.AppPlatform/preview/2022-01-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-01-01-preview/appplatform.json#L2170 |
|
| 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-01-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-01-01-preview/appplatform.json#L1242 |
The following errors/warnings exist before current PR submission:
Only 21 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
| 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-01-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-01-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-01-01-preview/appplatform.json#L557 |
|
| '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-01-01-preview/appplatform.json#L2469 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AppPlatform/preview/2022-01-01-preview/appplatform.json#L8924 |
|
| The enum types should have x-ms-enum type extension set with appropriate options. Property name: storageType Location: Microsoft.AppPlatform/preview/2022-01-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-01-01-preview/appplatform.json#L8299 |
|
| Based on the response model schema, operation 'RuntimeVersions_ListRuntimeVersions' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.AppPlatform/preview/2022-01-01-preview/appplatform.json#L4932 |
|
| The child tracked resource, 'apps' with immediate parent 'ServiceResource', must have a list by immediate parent operation. Location: Microsoft.AppPlatform/preview/2022-01-01-preview/appplatform.json#L7744 |
|
| The child tracked resource, 'bindings' with immediate parent 'AppResource', must have a list by immediate parent operation. Location: Microsoft.AppPlatform/preview/2022-01-01-preview/appplatform.json#L7964 |
|
| The child tracked resource, 'storages' with immediate parent 'ServiceResource', must have a list by immediate parent operation. Location: Microsoft.AppPlatform/preview/2022-01-01-preview/appplatform.json#L8192 |
|
| The child tracked resource, 'certificates' with immediate parent 'ServiceResource', must have a list by immediate parent operation. Location: Microsoft.AppPlatform/preview/2022-01-01-preview/appplatform.json#L8044 |
|
| The child tracked resource, 'domains' with immediate parent 'AppResource', must have a list by immediate parent operation. Location: Microsoft.AppPlatform/preview/2022-01-01-preview/appplatform.json#L8390 |
|
| The child tracked resource, 'deployments' with immediate parent 'AppResource', must have a list by immediate parent operation. Location: Microsoft.AppPlatform/preview/2022-01-01-preview/appplatform.json#L8470 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isValid Location: Microsoft.AppPlatform/preview/2022-01-01-preview/appplatform.json#L7288 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: traceEnabled Location: Microsoft.AppPlatform/preview/2022-01-01-preview/appplatform.json#L7407 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: strictHostKeyChecking Location: Microsoft.AppPlatform/preview/2022-01-01-preview/appplatform.json#L7629 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: strictHostKeyChecking Location: Microsoft.AppPlatform/preview/2022-01-01-preview/appplatform.json#L7691 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.AppPlatform/preview/2022-01-01-preview/appplatform.json#L7717 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: public Location: Microsoft.AppPlatform/preview/2022-01-01-preview/appplatform.json#L7782 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: httpsOnly Location: Microsoft.AppPlatform/preview/2022-01-01-preview/appplatform.json#L7822 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌~[Staging] ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.AppPlatform' for api version '2022-01-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'." |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌Cross-Version Breaking Changes: 28 Errors, 194 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.9.1)
- current:preview/2022-01-01-preview/appplatform.json compared with base:stable/2020-07-01/appplatform.json
- current:preview/2022-01-01-preview/appplatform.json compared with base:preview/2021-09-01-preview/appplatform.json
Only 21 items are listed, please refer to log for more details.
The following breaking changes are detected by comparison with latest preview version:
Only 21 items are listed, please refer to log for more details.
️️✔️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).
|
[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 Generation Artifacts
|
This was referenced Dec 8, 2021
This was referenced Dec 8, 2021
|
Azure Pipelines successfully started running 1 pipeline(s). |
Member
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Member
|
Hi @yuwzho, are these breaking changes expected: |
Contributor
Author
|
@msyyc Yes, they are. We already got the breaking change approval and ARM signed off in the private repo. You can check the linked PR in description. |
Member
|
@yuwzho , please ping me when you get chance coz I have some questions on the associated PR of private repo. |
Member
|
Closed this as it's replaced by new PR. |
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.
Reviewed swaggger change: https://github.com/Azure/azure-rest-api-specs-pr/pull/4120
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.