-
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.App to add version preview/2022-08-01 #20228
base: main
Are you sure you want to change the base?
Conversation
Hi, @JinzhaoTian 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. vscswagger@microsoft.com |
Swagger Validation Report
|
compared swaggers (via Oad v0.9.6)] | new version | base version |
---|---|---|
AuthConfigs.json | 2022-08-01(9bc257f) | 2022-03-01(main) |
AuthConfigs.json | 2022-08-01(9bc257f) | 2022-01-01-preview(main) |
CommonDefinitions.json | 2022-08-01(9bc257f) | 2022-03-01(main) |
CommonDefinitions.json | 2022-08-01(9bc257f) | 2022-01-01-preview(main) |
ContainerApps.json | 2022-08-01(9bc257f) | 2022-03-01(main) |
ContainerApps.json | 2022-08-01(9bc257f) | 2022-01-01-preview(main) |
ContainerAppsRevisions.json | 2022-08-01(9bc257f) | 2022-03-01(main) |
ContainerAppsRevisions.json | 2022-08-01(9bc257f) | 2022-01-01-preview(main) |
DaprComponents.json | 2022-08-01(9bc257f) | 2022-03-01(main) |
DaprComponents.json | 2022-08-01(9bc257f) | 2022-01-01-preview(main) |
Global.json | 2022-08-01(9bc257f) | 2022-03-01(main) |
Global.json | 2022-08-01(9bc257f) | 2022-01-01-preview(main) |
ManagedEnvironments.json | 2022-08-01(9bc257f) | 2022-03-01(main) |
ManagedEnvironments.json | 2022-08-01(9bc257f) | 2022-01-01-preview(main) |
ManagedEnvironmentsStorages.json | 2022-08-01(9bc257f) | 2022-03-01(main) |
ManagedEnvironmentsStorages.json | 2022-08-01(9bc257f) | 2022-01-01-preview(main) |
SourceControls.json | 2022-08-01(9bc257f) | 2022-03-01(main) |
SourceControls.json | 2022-08-01(9bc257f) | 2022-01-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌
LintDiff: 1 Errors, 14 Warnings failed [Detail]
compared tags (via openapi-validator v1.13.0) | new version | base version |
---|---|---|
package-preview-2022-08 | package-preview-2022-08(9bc257f) | default(main) |
The following errors/warnings are introduced by current PR:
Rule | Message |
---|---|
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'disableWWWAuthenticate', for definition: 'AzureActiveDirectoryLogin' must follow camelCase style. Example: 'disableWwwAuthenticate'. Location: Microsoft.App/preview/2022-08-01/AuthConfigs.json#L547 |
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.App/preview/2022-08-01/AuthConfigs.json#L298 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: requireHttps Location: Microsoft.App/preview/2022-08-01/AuthConfigs.json#L343 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: preserveUrlFragmentsForLogins Location: Microsoft.App/preview/2022-08-01/AuthConfigs.json#L402 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: validateNonce Location: Microsoft.App/preview/2022-08-01/AuthConfigs.json#L459 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.App/preview/2022-08-01/AuthConfigs.json#L514 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isAutoProvisioned Location: Microsoft.App/preview/2022-08-01/AuthConfigs.json#L530 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: disableWWWAuthenticate Location: Microsoft.App/preview/2022-08-01/AuthConfigs.json#L547 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.App/preview/2022-08-01/AuthConfigs.json#L665 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.App/preview/2022-08-01/AuthConfigs.json#L714 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.App/preview/2022-08-01/AuthConfigs.json#L746 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.App/preview/2022-08-01/AuthConfigs.json#L781 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.App/preview/2022-08-01/AuthConfigs.json#L809 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.App/preview/2022-08-01/AuthConfigs.json#L841 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.App/preview/2022-08-01/AuthConfigs.json#L865 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2022-08-01/ManagedEnvironments.json#L854 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.App/preview/2022-08-01/ManagedEnvironmentsStorages.json#L290 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.App/preview/2022-08-01/CommonDefinitions.json#L1 |
|
The summary and description values should not be same. Location: Microsoft.App/preview/2022-08-01/AuthConfigs.json#L119 |
|
The summary and description values should not be same. Location: Microsoft.App/preview/2022-08-01/AuthConfigs.json#L180 |
|
The summary and description values should not be same. Location: Microsoft.App/preview/2022-08-01/ContainerApps.json#L148 |
|
The summary and description values should not be same. Location: Microsoft.App/preview/2022-08-01/ContainerApps.json#L209 |
|
The summary and description values should not be same. Location: Microsoft.App/preview/2022-08-01/ManagedEnvironmentsStorages.json#L19 |
|
The summary and description values should not be same. Location: Microsoft.App/preview/2022-08-01/ManagedEnvironmentsStorages.json#L66 |
|
The summary and description values should not be same. Location: Microsoft.App/preview/2022-08-01/ManagedEnvironmentsStorages.json#L118 |
|
The summary and description values should not be same. Location: Microsoft.App/preview/2022-08-01/ManagedEnvironmentsStorages.json#L179 |
|
The summary and description values should not be same. Location: Microsoft.App/preview/2022-08-01/SourceControls.json#L137 |
|
The summary and description values should not be same. Location: Microsoft.App/preview/2022-08-01/SourceControls.json#L205 |
|
Based on the response model schema, operation 'ContainerAppsRevisionReplicas_ListReplicas' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.App/preview/2022-08-01/ContainerAppsRevisions.json#L289 |
|
Based on the response model schema, operation 'ManagedEnvironmentsStorages_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.App/preview/2022-08-01/ManagedEnvironmentsStorages.json#L19 |
|
The child tracked resource, 'authConfigs' with immediate parent 'ContainerApp', must have a list by immediate parent operation. Location: Microsoft.App/preview/2022-08-01/AuthConfigs.json#L256 |
|
The child tracked resource, 'revisions' with immediate parent 'ContainerApp', must have a list by immediate parent operation. Location: Microsoft.App/preview/2022-08-01/ContainerAppsRevisions.json#L393 |
|
The child tracked resource, 'replicas' with immediate parent 'Revision', must have a list by immediate parent operation. Location: Microsoft.App/preview/2022-08-01/ContainerAppsRevisions.json#L500 |
|
The child tracked resource, 'daprComponents' with immediate parent 'ManagedEnvironment', must have a list by immediate parent operation. Location: Microsoft.App/preview/2022-08-01/DaprComponents.json#L311 |
|
The child tracked resource, 'certificates' with immediate parent 'ManagedEnvironment', must have a list by immediate parent operation. Location: Microsoft.App/preview/2022-08-01/ManagedEnvironments.json#L845 |
|
The child tracked resource, 'storages' with immediate parent 'ManagedEnvironment', must have a list by immediate parent operation. Location: Microsoft.App/preview/2022-08-01/ManagedEnvironmentsStorages.json#L281 |
|
The child tracked resource, 'sourcecontrols' with immediate parent 'ContainerApp', must have a list by immediate parent operation. Location: Microsoft.App/preview/2022-08-01/SourceControls.json#L264 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.App/preview/2022-08-01/ContainerApps.json#L561 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: external Location: Microsoft.App/preview/2022-08-01/ContainerApps.json#L597 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: allowInsecure Location: Microsoft.App/preview/2022-08-01/ContainerApps.json#L640 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: latestRevision Location: Microsoft.App/preview/2022-08-01/ContainerApps.json#L717 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isHostnameAlreadyVerified Location: Microsoft.App/preview/2022-08-01/ContainerApps.json#L767 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: hasConflictOnManagedEnvironment Location: Microsoft.App/preview/2022-08-01/ContainerApps.json#L837 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: ready Location: Microsoft.App/preview/2022-08-01/ContainerAppsRevisions.json#L562 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: started Location: Microsoft.App/preview/2022-08-01/ContainerAppsRevisions.json#L566 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌
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.App' for api version '2022-08-01'. The supported api-versions are '2022-01-01-preview, 2022-03-01, 2022-06-01-preview'." |
️❌
~[Staging] ServiceAPIReadinessTest: 2 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
RUNTIME_ERROR |
"errorCode: AssertionError, errorMessage: ResourceType 'containerApps' should be deployed in 'West Central US' on apiVersion '2022-08-01'.: expected [ Array(13) ] to satisfy [Function]" |
RUNTIME_ERROR |
"errorCode: AssertionError, errorMessage: ResourceType 'containerApps' should be deployed in 'West Central US' on apiVersion '2022-08-01'.: expected [ Array(13) ] to satisfy [Function]" |
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️⚠️
SDK Track2 Validation: 1 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/9bc257fa794d26b3fb829bdcdff84102bcb7ea5d/specification/app/resource-manager/readme.md#tag-package-preview-2022-08">app/resource-manager/readme.md#package-preview-2022-08
Rule | Message |
---|---|
"readme":"app/resource-manager/readme.md", "tag":"package-preview-2022-08", "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
|
Generated ApiView
|
Hi @JinzhaoTian, Your PR has some issues. Please fix the CI sequentially by following the order of
|
/azp run unifiedPipeline |
No pipelines are associated with this pull request. |
Next Steps to MergeNext steps that must be taken to merge this PR:
|
@JinzhaoTian please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
|
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM API Information (Control Plane)
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
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 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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.