-
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
Service Fabric Managed Clusters - api version 2022-10-01-preview #21033
Conversation
Hi, @a-santamaria 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 |
---|---|---|
managedapplication.json | 2022-10-01-preview(116ca3e) | 2022-01-01(main) |
managedapplication.json | 2022-10-01-preview(116ca3e) | 2022-08-01-preview(main) |
managedcluster.json | 2022-10-01-preview(116ca3e) | 2022-01-01(main) |
managedcluster.json | 2022-10-01-preview(116ca3e) | 2022-08-01-preview(main) |
nodetype.json | 2022-10-01-preview(116ca3e) | 2022-01-01(main) |
nodetype.json | 2022-10-01-preview(116ca3e) | 2022-08-01-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:
Rule | Message |
---|---|
The 'required' status changed from the old version('True') to the new version('False'). New: Microsoft.ServiceFabric/preview/2022-10-01-preview/nodetype.json#L712:7 Old: Microsoft.ServiceFabric/preview/2022-08-01-preview/nodetype.json#L712:7 |
️️✔️
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-2022-10-preview | package-2022-10-preview(116ca3e) | default(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️❌
~[Staging] ServiceAPIReadinessTest: 49 Errors, 0 Warnings failed [Detail]
Tag package-2022-10-preview; Prod region: Deployed
Test run on region: westcentralus; Operation coverage: total: 45, untested: 0, failed: 39, passed: 6
Service API Readiness Test failed. Check pipeline artifact for detail report.
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
CLIENT_ERROR |
statusCode: 400, errorCode: InvalidParameter, errorMessage: Value cannot be null. Parameter name: Sku Source: runtime OperationId: ManagedClusters_CreateOrUpdate |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.ServiceFabric/managedclusters/clusterno9nhuc' under resource group 'apiTest-tBOVNS-21033' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: ManagedClusters_Get |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.ServiceFabric/managedclusters/clusterno9nhuc' under resource group 'apiTest-tBOVNS-21033' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: ManagedClusters_Update |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterno9nhuc' not found. Source: runtime OperationId: Applications_CreateOrUpdate |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterno9nhuc' not found. Source: runtime OperationId: Applications_List |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterno9nhuc' not found. Source: runtime OperationId: Applications_Get |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterno9nhuc' not found. Source: runtime OperationId: Applications_Update |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterno9nhuc' not found. Source: runtime OperationId: ApplicationTypes_CreateOrUpdate |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterno9nhuc' not found. Source: runtime OperationId: ApplicationTypes_List |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterno9nhuc' not found. Source: runtime OperationId: ApplicationTypes_Get |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterno9nhuc' not found. Source: runtime OperationId: ApplicationTypes_Update |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterno9nhuc' not found. Source: runtime OperationId: NodeTypes_CreateOrUpdate |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterno9nhuc' not found. Source: runtime OperationId: NodeTypes_Get |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterno9nhuc' not found. Source: runtime OperationId: NodeTypes_ListByManagedClusters |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterno9nhuc' not found. Source: runtime OperationId: NodeTypes_Update |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterno9nhuc' not found. Source: runtime OperationId: NodeTypes_Reimage |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterno9nhuc' not found. Source: runtime OperationId: NodeTypes_DeleteNode |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterno9nhuc' not found. Source: runtime OperationId: NodeTypes_Restart |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterno9nhuc/applicatu0e4fu' not found. Source: runtime OperationId: ApplicationTypeVersions_CreateOrUpdate |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterno9nhuc/applicatu0e4fu' not found. Source: runtime OperationId: ApplicationTypeVersions_ListByApplicationTypes |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterno9nhuc/applicatu0e4fu' not found. Source: runtime OperationId: ApplicationTypeVersions_Get |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterno9nhuc/applicatu0e4fu' not found. Source: runtime OperationId: ApplicationTypeVersions_Update |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterno9nhuc/applicats1yvwf' not found. Source: runtime OperationId: Services_CreateOrUpdate |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterno9nhuc/applicats1yvwf' not found. Source: runtime OperationId: Services_ListByApplications |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterno9nhuc/applicats1yvwf' not found. Source: runtime OperationId: Services_Get |
CLIENT_ERROR |
statusCode: 404, errorCode: ParentResourceNotFound, errorMessage: Can not perform requested operation on nested resource. Parent resource 'clusterno9nhuc/applicats1yvwf' not found. Source: runtime OperationId: Services_Update |
CLIENT_ERROR |
statusCode: 400, errorCode: InvalidRequestFormat, errorMessage: Cannot parse the request. Source: runtime OperationId: ManagedClusterVersion_ListByEnvironment |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: details Source: response OperationId: ManagedClusterVersion_ListByEnvironment |
CLIENT_ERROR |
statusCode: 400, errorCode: InvalidRequestFormat, errorMessage: Cannot parse the request. Source: runtime OperationId: ManagedClusterVersion_GetByEnvironment |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: details Source: response OperationId: ManagedClusterVersion_GetByEnvironment |
️️✔️
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
|
Hi @a-santamaria, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Hi, @a-santamaria your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
"fasterZonalUpdates": { | ||
"type": "boolean", | ||
"description": "Indicates whether to use a maximum of 3 UD per zone instead of 5 for Cross Az Node types for faster deployments." | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
consider modelling this as an enum :
Replace boolean/switch properties with better enum
A Boolean will forever have two valid values (true or false). A string enum type is always preferred. Also, properties should always provide better values just than True and False. For example two switches "isTypeA" and "isTypeB" should be replaced with one enum "type": [A, B, DefaultType]. Even if you still believe [True, False] are the correct values for a property, you should use a string enum with values [True, False] instead of boolean. Enums are always a more flexible and future proof option because they allow additional values to be added in the future in a non-breaking way, e.g. [True, False, Unknown].
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok, thanks fore the suggestion. fixed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@raosuhas please take a look again with the change suggested
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@raosuhas please review again
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
Hi, @a-santamaria. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
Hi, @a-santamaria. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
app deployment will finish by the end of this week and we will start the RP manifest upgrade next week |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
@live1206 can you please merge the pr? the RP manifest is already deployed. |
@a-santamaria There are some errors for staging Service API Readiness Test, it would be great if you can fix them even it does not block the merge. The details can be found via #21033 (comment) |
This reverts commit 76de999.
@live1206 I tried to do it by I reverted the change; it's going to take longer so we'll make those fixes on the next version. We need to generate the documentation for this version |
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
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:
10/29/2022
10/31/2022
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.