[Hub Generated] Review request for Microsoft.ConfidentialLedger to add version preview/2023-01-26-preview #22325
Conversation
This file contains 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
…iew/2022-09-08-preview to version 2023-01-26-preview
|
Hi, @musabbir 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.10.4)] | new version | base version |
|---|---|---|
| managedccf.json | 2023-01-26-preview(5c5e625) | 2022-09-08-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-preview-2023-01 | package-preview-2023-01(5c5e625) | default(main) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ConfidentialLedger/preview/2023-01-26-preview/confidentialledger.json#L466 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ConfidentialLedger/preview/2023-01-26-preview/confidentialledger.json#L656 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ManagedCCFModel'. Consider using the plural form of 'ManagedCCF' 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.ConfidentialLedger/preview/2023-01-26-preview/managedccf.json#L44 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ManagedCCFModel'. Consider using the plural form of 'ManagedCCF' 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.ConfidentialLedger/preview/2023-01-26-preview/managedccf.json#L85 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ManagedCCFModel'. Consider using the plural form of 'ManagedCCF' 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.ConfidentialLedger/preview/2023-01-26-preview/managedccf.json#L130 |
|
| 200/201 Responses of long running operations must have a schema definition for return type. OperationId: 'ManagedCCF_Create', Response code: '201' Location: Microsoft.ConfidentialLedger/preview/2023-01-26-preview/managedccf.json#L165 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ManagedCCFModel'. Consider using the plural form of 'ManagedCCF' 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.ConfidentialLedger/preview/2023-01-26-preview/managedccf.json#L187 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ManagedCCFModel'. Consider using the plural form of 'ManagedCCF' 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.ConfidentialLedger/preview/2023-01-26-preview/managedccf.json#L240 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ManagedCCFModel'. Consider using the plural form of 'ManagedCCF' 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.ConfidentialLedger/preview/2023-01-26-preview/managedccf.json#L289 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ConfidentialLedger/preview/2023-01-26-preview/managedccf.json#L459 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.ConfidentialLedger' for api version '2023-01-26-preview'. The supported api-versions are '2020-12-01-preview, 2021-05-13-preview, 2022-05-13, 2022-09-08-preview'." |
️❌~[Staging] ServiceAPIReadinessTest: 12 Errors, 0 Warnings failed [Detail]
Tag package-preview-2023-01; Prod region: Not deployed; Canary region: Deployed
Test run on region: eastus2euap; Operation coverage: total: 14, untested: 0, failed: 12, passed: 2
Service API Readiness Test failed. Check pipeline artifact for detail report.
| Rule | Message |
|---|---|
|
statusCode: 403, errorCode: AuthorizationFailed, errorMessage: The client '7904a8be-825f-480e-a728-80a70579dba4' with object id '7904a8be-825f-480e-a728-80a70579dba4' does not have authorization to perform action 'Microsoft.ConfidentialLedger/checkNameAvailability/action' over scope '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5' or the scope is invalid. If access was recently granted, please refresh your credentials. Source: runtime OperationId: CheckNameAvailability |
|
statusCode: 400, errorCode: NoRegisteredProviderFound, errorMessage: No registered resource provider found for location 'eastus2euap' and API version '2023-01-26-preview' for type 'Ledgers'. The supported api-versions are '2020-12-01-preview, 2021-05-13-preview, 2022-05-13, 2022-09-08-preview'. The supported locations are 'eastus, southcentralus, westeurope, eastus2euap'. Source: runtime OperationId: Ledger_Create |
|
statusCode: 404, errorCode: InvalidResourceType, errorMessage: The resource type 'Ledgers' could not be found in the namespace 'Microsoft.ConfidentialLedger' for api version '2023-01-26-preview'. The supported api-versions are '2020-12-01-preview,2021-05-13-preview,2022-05-13,2022-09-08-preview'. Source: runtime OperationId: Ledger_ListBySubscription |
|
statusCode: 404, errorCode: InvalidResourceType, errorMessage: The resource type 'Ledgers' could not be found in the namespace 'Microsoft.ConfidentialLedger' for api version '2023-01-26-preview'. The supported api-versions are '2020-12-01-preview,2021-05-13-preview,2022-05-13,2022-09-08-preview'. Source: runtime OperationId: Ledger_ListByResourceGroup |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.ConfidentialLedger/Ledgers/ledgernas6soyh' under resource group 'apiTest-oxULhI-22325' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Ledger_Get |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.ConfidentialLedger/Ledgers/ledgernas6soyh' under resource group 'apiTest-oxULhI-22325' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Ledger_Update |
|
statusCode: 400, errorCode: NoRegisteredProviderFound, errorMessage: No registered resource provider found for location 'eastus2euap' and API version '2023-01-26-preview' for type 'ManagedCCFs'. The supported api-versions are '2022-09-08-preview'. The supported locations are 'eastus2euap, westus'. Source: runtime OperationId: ManagedCCF_Create |
|
statusCode: 404, errorCode: InvalidResourceType, errorMessage: The resource type 'ManagedCCFs' could not be found in the namespace 'Microsoft.ConfidentialLedger' for api version '2023-01-26-preview'. The supported api-versions are '2022-09-08-preview'. Source: runtime OperationId: ManagedCCF_ListBySubscription |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.ConfidentialLedger/ManagedCCFs/appnamecu8g28' under resource group 'apiTest-oxULhI-22325' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: ManagedCCF_Get |
|
statusCode: 404, errorCode: InvalidResourceType, errorMessage: The resource type 'ManagedCCFs' could not be found in the namespace 'Microsoft.ConfidentialLedger' for api version '2023-01-26-preview'. The supported api-versions are '2022-09-08-preview'. Source: runtime OperationId: ManagedCCF_ListByResourceGroup |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.ConfidentialLedger/ManagedCCFs/appnamecu8g28' under resource group 'apiTest-oxULhI-22325' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: ManagedCCF_Update |
|
statusCode: 404, errorCode: InvalidResourceType, errorMessage: The resource type 'operations' could not be found in the namespace 'Microsoft.ConfidentialLedger' for api version '2023-01-26-preview'. The supported api-versions are '2020-12-01-preview,2021-05-13-preview,2022-05-13,2022-09-08-preview'. Source: runtime OperationId: Operations_List |
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView 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.
️️✔️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.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
|
Hi @musabbir, 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. |
This was referenced Jan 26, 2023
|
@musabbir - Please see if you can fix all the Linter warnings. There is also a BreakingChangeReviewRequired label on the PR. You have an option to fix your contracts to be backward compatible or reach out to azbreakchangereview@microsoft.com get an excepton |
|
Hi @musabbir, Your PR has some issues. Please fix the CI sequentially by following the order of
|
added 2 commits
February 3, 2023 15:36
AzureRestAPISpecReview
added
ReadyForApiTest
AzureRestAPISpecReview
added
CI-FixRequiredOnFailure
and removed
BreakingChangeReviewRequired
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
This was referenced Feb 10, 2023
AzureRestAPISpecReview
removed
the
BreakingChangeReviewRequired
Thank you for the link. I fixed that issue and I can see majority of the sdks building now. |
MaryGao
reviewed
Feb 17, 2023
...urce-manager/Microsoft.ConfidentialLedger/preview/2023-01-26-preview/confidentialledger.json
Outdated
Show resolved
Hide resolved
MaryGao
reviewed
Feb 17, 2023
...urce-manager/Microsoft.ConfidentialLedger/preview/2023-01-26-preview/confidentialledger.json
Outdated
Show resolved
Hide resolved
|
@leni-msft |
leniatgh
deleted the
musabbir-confidentialledger-Microsoft.ConfidentialLedger-2023-01-26-preview
branch
This was referenced Feb 21, 2023
aviyerMSFT
pushed a commit
to aviyerMSFT/azure-rest-api-specs
that referenced
this pull request
Mar 22, 2023
…d version preview/2023-01-26-preview (Azure#22325) * Adds base for updating Microsoft.ConfidentialLedger from version preview/2022-09-08-preview to version 2023-01-26-preview * Updates readme * Updates API version in new specs and examples * RunningState for ledger under Confidential ledger body * Fix examples * add client flatten false to get rid of Linter warning * add scheme to 201 response to avoid linter warning * add example for 201 * remove flatten * update errorResponse to use v3 json from resource-management * fix Resource schema * acl resource remove * Revert last 2 and try deleting client name * Use tracked resources model * Remove ResourceLocation --------- Co-authored-by: Musabbir Khan <musabbirkhan@microsoft.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
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:
February, 2023
February 2023
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.