Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add Azure Red Hat OpenShift 2024-08-12-preview API version #30004

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Add Azure Red Hat OpenShift 2024-08-12-preview API version #30004

wants to merge 7 commits into from

Conversation

cadenmarchese
Copy link

@cadenmarchese cadenmarchese commented Jul 29, 2024 •
edited
Loading

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

spec_pr_review_workflow_diagram

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • New resource provider.
  • New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix OpenAPI spec quality issues in S360.
  • Convert existing OpenAPI spec to TypeSpec spec (do not combine this with implementing changes for a new API version).
  • Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • I have reviewed following Resource Provider guidelines, including
    ARM resource provider contract and
    REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
    This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

@openapi-pipeline-app openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jul 29, 2024 •
edited
Loading

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ This is the public specs repo main branch which is not intended for iterative development.
    You must acknowledge that you understand that after this PR is merged, you won't be able to stop your changes from being published to Azure customers.
    If this is what you intend, add PublishToCustomers label to your PR.
    Otherwise, retarget this PR onto a feature branch, i.e. with prefix release- (see aka.ms/azsdk/api-versions#release--branches).
  • ❌ This PR is in purview of the ARM review (label: ARMReview). This PR must get ARMSignedOff label from an ARM reviewer.
    This PR is not ready for ARM review (label: NotReadyForARMReview). This PR will not be reviewed by ARM until relevant problems are fixed. Consult the rest of this Next Steps to Merge comment for details.
    Once the blocking problems are addressed, add to the PR a comment with contents /azp run. Automation will re-evaluate this PR and if everything looks good, it will add WaitForARMFeedback label which will put this PR on the ARM review queue.
    For details of the ARM review, see aka.ms/azsdk/pr-arm-review
  • ❌ This PR is NotReadyForARMReview because it has the BreakingChangeReviewRequired label.
  • ❌ This PR has at least one breaking change (label: BreakingChangeReviewRequired).
    To unblock this PR, follow the process at aka.ms/brch.
  • ❌ The required check named Swagger ModelValidation has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it and consult the aka.ms/ci-fix guide

@openapi-pipeline-app openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jul 29, 2024 •
edited
Loading

Generated ApiView

Language Package Name ApiView Link
Swagger Microsoft.RedHatOpenShift https://apiview.dev/Assemblies/Review/7d06db40cb194091a8715c77add9b186?revisionId=352b6660ae3f4c059d34accaed5df616

This was referenced Jul 29, 2024
Draft
Draft
@cadenmarchese cadenmarchese mentioned this pull request Jul 29, 2024
Closed
7 tasks
@cadenmarchese cadenmarchese marked this pull request as ready for review July 29, 2024 14:46
@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview new-api-version ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required NotReadyForARMReview and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jul 29, 2024
@AzureRestAPISpecReview AzureRestAPISpecReview added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed NotReadyForARMReview BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required labels Jul 30, 2024
@ms-bogdan-rotaru ms-bogdan-rotaru added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Jul 31, 2024
@openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jul 31, 2024
@cadenmarchese cadenmarchese added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review labels Aug 13, 2024
@gary-x-li gary-x-li added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Aug 13, 2024
@openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Aug 13, 2024
@cadenmarchese cadenmarchese mentioned this pull request Aug 14, 2024
Open
@razvanbadea-msft
Copy link
Contributor

the required Swagger SpellCheck fails, please fix it first

@razvanbadea-msft razvanbadea-msft added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Sep 19, 2024
@openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 19, 2024
@AzureRestAPISpecReview AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required NotReadyForARMReview and removed ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test labels Sep 19, 2024
@openapi-pipeline-app openapi-pipeline-app bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 19, 2024
@AzureRestAPISpecReview AzureRestAPISpecReview added ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Sep 19, 2024
@AzureRestAPISpecReview AzureRestAPISpecReview removed the ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test label Oct 1, 2024
@mikekistler mikekistler added the BreakingChange-Approved-Benign Changes are not breaking at the REST API level and have at most minor impact to generated SDKs. label Oct 2, 2024
@AzureRestAPISpecReview AzureRestAPISpecReview added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required NotReadyForARMReview and removed NotReadyForARMReview BreakingChange-Approved-Benign Changes are not breaking at the REST API level and have at most minor impact to generated SDKs. BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Oct 8, 2024
@openapi-pipeline-app openapi-pipeline-app
Copy link

PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.

@cadenmarchese
commit latest API version first
11e422b 
* ensures reviewers can see changes from new API
@cadenmarchese
commit 2024-08-12-preview changes
1110c04 
commit changes to readme

* this file appears required for comparison with Azure types

commit v2024-08-12-preview examples

add descriptions to all new api fields

adjust one of the code comments according to feedback on the Red Hat side

add platformworkloadidentityroleset + examples

fix relative path to common-types
use common-types files directly rather than copying them into
the redhatopenshift directory

use common-types/v6, use ManagedServiceIdentity type definition

fix Swagger SpellCheck

remove "format":"uuid" from clientIds, principalIds, tenantIds
attempt to fix Swagger LintDiff check

convert platformWorkloadIdentities to map
@cadenmarchese
identity -> managedServiceIdentity
543affa
@cadenmarchese
rename managedServiceIdentity back to identity, use common-types
533a2de 
directly
@cadenmarchese
fix UNRESOLVABLE_REFERENCE
c078be9
@cadenmarchese
fix relative path to common types
8c0c30d
@cadenmarchese
attempt to fix UNRESOLVABLE_REFERENCE
ca2d871
@cadenmarchese cadenmarchese force-pushed the add-20240812preview-2 branch 2 times, most recently from 104998f to ca2d871 Compare October 11, 2024 20:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@razvanbadea-msft razvanbadea-msft razvanbadea-msft left review comments

@ms-bogdan-rotaru ms-bogdan-rotaru ms-bogdan-rotaru left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
ARMReview BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required new-api-version NotReadyForARMReview resource-manager
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@cadenmarchese @gary-x-li @razvanbadea-msft @ms-bogdan-rotaru @AzureRestAPISpecReview @mikekistler