Azure
New stable api 2023-04-01 Microsoft.RedHatOpenShift
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:
-
What's the purpose of the update?
- [ ] new service onboarding
- [x] new API version
- [ ] update existing version for new feature
- [ ] update existing version to fix swagger quality issue in s360
- [ ] Other, please clarify
-
When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month. ASAP
-
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month. As soon as we get arm approval we can run the RP manifest rollout
-
By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.
Contribution checklist (MS Employees Only):
- [x] I commit to follow the Breaking Change Policy of "no breaking changes"
- [x] I have reviewed the documentation for the workflow.
- [ ] Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Applicability: :warning:
If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.
- Change to data plane APIs
- Adding new properties
- All removals
Otherwise your PR may be subject to ARM review requirements. Complete the following:
-
[x] 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.
- Adding a new service
- Adding new API(s)
- Adding a new API version -[x] 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.
-
[x] 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.
-
[x] 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.
Hi, @carlowisse Thanks for your PR. I am workflow bot for review process. Here are some small tips.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hi, @carlowisse your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).
Swagger Validation Report
️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️Breaking Change(Cross-Version): 5 Warnings warning [Detail]
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| redhatopenshift.json | 2023-04-01(362f0fb) | 2022-09-04(main) |
| redhatopenshift.json | 2023-04-01(362f0fb) | 2021-09-01-preview(main) |
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.1.3) | new version | base version |
|---|---|---|
| package-2023-04-01 | package-2023-04-01(362f0fb) | 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: 25 Errors, 0 Warnings failed [Detail]
Tag package-2023-04-01; Prod region: Deployed
Test run on region: westcentralus; Operation coverage: total: 30, untested: 0, failed: 25, passed: 5
Service API Readiness Test failed. Check pipeline artifact for detail report.
| Rule | Message |
|---|---|
|
statusCode: 400, errorCode: InvalidParameter, errorMessage: The provided domain 'cluster.location.aroapp.io' is invalid. Source: runtime OperationId: OpenShiftClusters_CreateOrUpdate |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.RedHatOpenShift/OpenShiftClusters/resourcejvboer' under resource group 'apiTest-PpAICx-23772' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: OpenShiftClusters_Get |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.RedHatOpenShift/OpenShiftClusters/resourcejvboer' under resource group 'apiTest-PpAICx-23772' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: OpenShiftClusters_Update |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.RedHatOpenShift/OpenShiftClusters/resourcejvboer' under resource group 'apiTest-PpAICx-23772' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: OpenShiftClusters_ListCredentials |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.RedHatOpenShift/OpenShiftClusters/resourcejvboer' under resource group 'apiTest-PpAICx-23772' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: OpenShiftClusters_ListAdminCredentials |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.RedHatOpenShift/OpenShiftClusters/resourcejvboer' under resource group 'apiTest-PpAICx-23772' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Secrets_CreateOrUpdate |
|
statusCode: 404, errorCode: InvalidResourceType, errorMessage: The resource type could not be found in the namespace 'Microsoft.RedHatOpenShift' for api version '2023-04-01'. Source: runtime OperationId: Secrets_List |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.RedHatOpenShift/OpenShiftClusters/resourcejvboer' under resource group 'apiTest-PpAICx-23772' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Secrets_Get |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.RedHatOpenShift/OpenShiftClusters/resourcejvboer' under resource group 'apiTest-PpAICx-23772' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Secrets_Update |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.RedHatOpenShift/OpenShiftClusters/resourcejvboer' under resource group 'apiTest-PpAICx-23772' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: MachinePools_CreateOrUpdate |
|
statusCode: 404, errorCode: InvalidResourceType, errorMessage: The resource type could not be found in the namespace 'Microsoft.RedHatOpenShift' for api version '2023-04-01'. Source: runtime OperationId: MachinePools_List |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.RedHatOpenShift/OpenShiftClusters/resourcejvboer' under resource group 'apiTest-PpAICx-23772' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: MachinePools_Get |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.RedHatOpenShift/OpenShiftClusters/resourcejvboer' under resource group 'apiTest-PpAICx-23772' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: MachinePools_Update |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.RedHatOpenShift/OpenShiftClusters/resourcejvboer' under resource group 'apiTest-PpAICx-23772' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: SyncSets_CreateOrUpdate |
|
statusCode: 404, errorCode: InvalidResourceType, errorMessage: The resource type could not be found in the namespace 'Microsoft.RedHatOpenShift' for api version '2023-04-01'. Source: runtime OperationId: SyncSets_List |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.RedHatOpenShift/OpenShiftClusters/resourcejvboer' under resource group 'apiTest-PpAICx-23772' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: SyncSets_Get |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.RedHatOpenShift/OpenShiftClusters/resourcejvboer' under resource group 'apiTest-PpAICx-23772' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: SyncSets_Update |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.RedHatOpenShift/OpenShiftClusters/resourcejvboer' under resource group 'apiTest-PpAICx-23772' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: SyncIdentityProviders_CreateOrUpdate |
|
statusCode: 404, errorCode: InvalidResourceType, errorMessage: The resource type could not be found in the namespace 'Microsoft.RedHatOpenShift' for api version '2023-04-01'. Source: runtime OperationId: SyncIdentityProviders_List |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.RedHatOpenShift/OpenShiftClusters/resourcejvboer' under resource group 'apiTest-PpAICx-23772' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: SyncIdentityProviders_Get |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.RedHatOpenShift/OpenShiftClusters/resourcejvboer' under resource group 'apiTest-PpAICx-23772' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: SyncIdentityProviders_Update |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.RedHatOpenShift/OpenShiftClusters/resourcejvboer' under resource group 'apiTest-PpAICx-23772' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: SyncIdentityProviders_Delete |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.RedHatOpenShift/OpenShiftClusters/resourcejvboer' under resource group 'apiTest-PpAICx-23772' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: SyncSets_Delete |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.RedHatOpenShift/OpenShiftClusters/resourcejvboer' under resource group 'apiTest-PpAICx-23772' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: MachinePools_Delete |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The Resource 'Microsoft.RedHatOpenShift/OpenShiftClusters/resourcejvboer' under resource group 'apiTest-PpAICx-23772' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix Source: runtime OperationId: Secrets_Delete |
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView 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.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️⚠️ azure-sdk-for-python-track2 warning [Detail]
⚠️Warning [Logs]Release - Generate from db80d2c04a9e7ecd7d1fee6da42fe5b825fabf4b. SDK Automation 14.0.0command sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json cmderr [automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed. command sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json cmderr [automation_generate.sh] cmderr [automation_generate.sh] npm notice New minor version of npm available! 9.5.1 -> 9.8.1 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.8.1> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice
️✔️track2_azure-mgmt-redhatopenshift [View full logs] [Release SDK Changes]info [Changelog]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from db80d2c04a9e7ecd7d1fee6da42fe5b825fabf4b. SDK Automation 14.0.0command sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json command generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
️✔️sdk/resourcemanager/redhatopenshift/armredhatopenshift [View full logs] [Release SDK Changes]info [Changelog] ### Features Added info [Changelog] info [Changelog] - New enum type `OutboundType` with values `OutboundTypeLoadbalancer`, `OutboundTypeUserDefinedRouting` info [Changelog] - New field `OutboundType` in struct `NetworkProfile` info [Changelog] info [Changelog] Total 0 breaking change(s), 4 additive change(s).
️⚠️ azure-resource-manager-schemas warning [Detail]
⚠️Warning [Logs]Release - Generate from db80d2c04a9e7ecd7d1fee6da42fe5b825fabf4b. Schema Automation 14.0.0command .sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json cmderr [initScript.sh] cmderr [initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm, cmderr [initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry. cmderr [initScript.sh] npm WARN old lockfile cmderr [initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient... cmderr [initScript.sh] npm WARN old lockfile warn File azure-resource-manager-schemas_tmp/initOutput.json not found to read command .sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
️✔️redhatopenshift [View full logs] [Release Schema Changes]
️❌ azure-powershell failed [Detail]
❌Pipeline Framework Failed [Logs]Release - Generate from db80d2c04a9e7ecd7d1fee6da42fe5b825fabf4b. SDK Automation 14.0.0command sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json command pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json SSL error: syscall failure: Broken pipe Error: SSL error: syscall failure: Broken pipe
️✔️Az.redhatopenshift.DefaultTag [View full logs]error Fatal error: SSL error: syscall failure: Broken pipe error The following packages are still pending: error Az.redhatopenshift.DefaultTag
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/redhatopenshift/armredhatopenshift | https://apiview.dev/Assemblies/Review/fad2773d40ee424e9e5a78192639bbf8 |
Hi @carlowisse, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.
| Task | How to fix | Priority |
|---|---|---|
| Avocado | Fix-Avocado | High |
| Semantic validation | Fix-SemanticValidation-Error | High |
| Model validation | Fix-ModelValidation-Error | High |
| LintDiff | Fix-LintDiff | high |
Hi, @carlowisse, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline
@carlowisse - PR is not generated properly for a new API version
The first commit needs to be the previous api version and the new changes should only be added in the subsequent commits. This is explained in detail here (If using Open API which is recommended) https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/208/OpenAPI-Hub-Adding-new-API-version or here(For manual process) : https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/83/Manual-Process-Adding-new-API-version . Please remove the "ARMChangesRequested" label once you have fixed this issue.
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested
@sjanamma Hi, I have updated the PR with two commits, one being the old api and then the second bringing in the changes. I can't see how or where to remove the label though to request review once more. May I please ask for some assistance?
The changes look good to me overall but there are Linter errors you must address.
❌ XmsEnumValidation | The enum types should have x-ms-enum type extension set with appropriate options.Location: Microsoft.RedHatOpenShift/stable/2023-04-01/redhatopenshift.json#L2215 | ⚠️ SchemaDescriptionOrTitle | Schema should have a description or title.Location: Microsoft.RedHatOpenShift/stable/2023-04-01/redhatopenshift.json#L2215
![azure-pipelines[bot] avatar](https://avatars.githubusercontent.com/in/9426?v=4 "Published by a pub.dev verified publisher"){kind=small}
