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.

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

Migrate GitHub.Network API spec to public repo. #30837

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

Conversation

mlacouture
Copy link
Member

@mlacouture mlacouture commented Oct 2, 2024

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:
    • Making GitHub.Network RP API spec public so customers can build SDK-like libraries. The RP was released to GA back in April 2024.

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.

Copy link

openapi-pipeline-app bot commented Oct 2, 2024

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

@mlacouture mlacouture changed the title baseline commit - migrated from RPSaaSMaster (private repo) Migrate GitHub.Network API spec to public repo. Oct 2, 2024
@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview new-api-version new-rp-namespace resource-manager RPaaS TypeSpec Authored with TypeSpec WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Oct 2, 2024
@mlacouture mlacouture added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label Oct 2, 2024
@mlacouture mlacouture force-pushed the dev/miguell/main/github.network-api branch from fc6f4b4 to f1a2c7f Compare October 2, 2024 21:23
@mlacouture

This comment was marked as resolved.

@rkmanda

This comment was marked as resolved.

@rkmanda

This comment was marked as resolved.

@rkmanda rkmanda added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Oct 4, 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 Oct 4, 2024
@mlacouture mlacouture force-pushed the dev/miguell/main/github.network-api branch 7 times, most recently from b676686 to af2bff2 Compare October 15, 2024 18:56
@AzureRestAPISpecReview AzureRestAPISpecReview added the ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test label Oct 15, 2024
@mlacouture mlacouture force-pushed the dev/miguell/main/github.network-api branch from 19d9cd5 to f0c59b3 Compare October 15, 2024 19:21
@mlacouture mlacouture removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Oct 15, 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 Oct 15, 2024
@mentat9
Copy link
Member

mentat9 commented Oct 17, 2024

@mlacouture - Since your APIs are GA and you aren't creating a new API version, I presume your private specs were already reviewed by ARM. Can you provide a link to the PR that was reviewed and signed off by ARM?

@mentat9 mentat9 added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Oct 17, 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 Oct 17, 2024
@mlacouture
Copy link
Member Author

mlacouture commented Oct 17, 2024

@mlacouture - Since your APIs are GA and you aren't creating a new API version, I presume your private specs were already reviewed by ARM. Can you provide a link to the PR that was reviewed and signed off by ARM?

@mentat9 that's right, this is the PR for the GA specs:

@mlacouture mlacouture removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Oct 17, 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 Oct 17, 2024
@mentat9 mentat9 added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Oct 18, 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 Oct 18, 2024
@mlacouture mlacouture enabled auto-merge (squash) October 18, 2024 21:45
@mlacouture
Copy link
Member Author

@mentat9 do you mind approving again? had to rebase the branch - thank you!

@mlacouture mlacouture removed the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Oct 23, 2024
@mlacouture
Copy link
Member Author

Removed ARMSignedOff label as this requires re-approval after rebasing the branch and no response from approver.

@AzureRestAPISpecReview AzureRestAPISpecReview added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 23, 2024
@ramoka178 ramoka178 added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Oct 23, 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 Oct 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review new-api-version new-rp-namespace PublishToCustomers Acknowledgement the changes will be published to Azure customers. ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager RPaaS TypeSpec Authored with TypeSpec
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants