-
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] Publish private branch 'jiyu/appconfig_1101' #19732
[Hub Generated] Publish private branch 'jiyu/appconfig_1101' #19732
Conversation
The PR is created based on the updates in the private branch. The updates in the PR has already been reviewed and approved with this PR Azure/azure-rest-api-specs-pr/5037 |
Hi, @jiayi11 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 |
---|---|---|
appconfiguration.json | 2022-03-01(44b4918) | 2020-06-01(main) |
appconfiguration.json | 2022-03-01(44b4918) | 2021-10-01(main) |
The following breaking changes are detected by comparison with the latest stable version:
Only 30 items are listed, please refer to log for more details.
The following breaking changes are detected by comparison with the latest preview version:
Rule | Message |
---|---|
The new version is missing a property found in the old version. Was 'enablePurgeProtection' renamed or removed? New: Microsoft.AppConfiguration/preview/2022-03-01-preview/appconfiguration.json#L1638:7 Old: Microsoft.AppConfiguration/preview/2021-10-01-preview/appconfiguration.json#L1420:7 |
️️✔️
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-03-01-preview | package-2022-03-01-preview(44b4918) | default(main) |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
R4037 - MissingTypeObject |
The schema 'ErrorDetails' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.AppConfiguration/preview/2022-03-01-preview/appconfiguration.json#L2116 |
R4037 - MissingTypeObject |
The schema 'ErrorAdditionalInfo' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.AppConfiguration/preview/2022-03-01-preview/appconfiguration.json#L2150 |
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.AppConfiguration/preview/2022-03-01-preview/appconfiguration.json#L1902 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enablePurgeProtection Location: Microsoft.AppConfiguration/preview/2022-03-01-preview/appconfiguration.json#L1537 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: fillGapWithZero Location: Microsoft.AppConfiguration/preview/2022-03-01-preview/appconfiguration.json#L2026 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: purgeProtectionEnabled Location: Microsoft.AppConfiguration/preview/2022-03-01-preview/appconfiguration.json#L2419 |
|
The response of operation:'PrivateEndpointConnections_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppConfiguration/preview/2022-03-01-preview/appconfiguration.json#L559 |
|
The response of operation:'PrivateEndpointConnections_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppConfiguration/preview/2022-03-01-preview/appconfiguration.json#L606 |
|
The response of operation:'KeyValues_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppConfiguration/preview/2022-03-01-preview/appconfiguration.json#L868 |
|
The response of operation:'KeyValues_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.AppConfiguration/preview/2022-03-01-preview/appconfiguration.json#L915 |
|
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: ConfigurationStores_CheckNameAvailable Location: Microsoft.AppConfiguration/preview/2022-03-01-preview/appconfiguration.json#L1191 |
|
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: ConfigurationStores_CheckNameNotAvailable Location: Microsoft.AppConfiguration/preview/2022-03-01-preview/appconfiguration.json#L1191 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️
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/44b49188f49c2bd9bc3d974845b97c8b66729bbe/specification/appconfiguration/resource-manager/readme.md#tag-package-2022-03-01-preview">appconfiguration/resource-manager/readme.md#package-2022-03-01-preview
Rule | Message |
---|---|
"readme":"appconfiguration/resource-manager/readme.md", "tag":"package-2022-03-01-preview", "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 @jiayi11, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Hi @jiayi11, 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. |
Hi, @jiayi11 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
37ebfd2
to
075abe3
Compare
The breaking changes are approved as in the private pr: https://github.com/Azure/azure-rest-api-specs-pr/pull/5037 |
APIs moving from private repo. Original PR: https://github.com/Azure/azure-rest-api-specs-pr/pull/5037. |
Hi @honghr, could you please take a look at the pr? |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
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.