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

[TSP Migration][HybridConnectivity] TypeSpec migrated from swagger #31699

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

Conversation

pshao25
Copy link
Member

@pshao25 pshao25 commented Nov 29, 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:
    • 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.

Copy link

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

Copy link

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

Copy link

openapi-pipeline-app bot commented Nov 29, 2024

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ Your PR has breaking changes in the generated SDK for JavaScript (label: BreakingChange-JavaScript-Sdk). Refer to step 3 in the PR workflow diagram.
  • ❌ The required check named SDK azure-sdk-for-go 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. In addition, refer to step 3 in the PR workflow diagram

@azure-sdk
Copy link
Collaborator

azure-sdk commented Nov 29, 2024

API change check

APIView has identified API level changes in this PR and created following API reviews.

Microsoft.HybridConnectivity

@pshao25 pshao25 changed the title Migration/hybridconnectivity Migrate hybridconnectivity to TypeSpec Nov 29, 2024
@pshao25 pshao25 changed the title Migrate hybridconnectivity to TypeSpec [TSP Migration][HybridConnectivity] TypeSpec migrated from swagger Nov 29, 2024
@JeffreyRichter JeffreyRichter added the BreakingChange-Approved-Benign Changes are not breaking at the REST API level and have at most minor impact to generated SDKs. label Jan 20, 2025
@pshao25
Copy link
Member Author

pshao25 commented Jan 21, 2025

/azp run

Copy link

Azure Pipelines successfully started running 3 pipeline(s).

@AzureRestAPISpecReview AzureRestAPISpecReview added WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed NotReadyForARMReview labels Jan 21, 2025
Comment on lines +26 to +36
@armResourceOperations
interface EndpointResources {
/**
* Gets the endpoint to the resource.
*/
#suppress "@azure-tools/typespec-azure-core/no-openapi" "non-standard operations"
@operationId("Endpoints_Get")
get is ArmResourceRead<
EndpointResource,
Azure.ResourceManager.Foundations.ExtensionBaseParameters
>;

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pshao25

Do you know why the Endponts -> EndpointResources happens in convertion?

It appears Java SDK's break is caused by this pattern (same as the ServiceConfigurations)
#32243 (comment)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SDK can use @clientName to override this, so not a blocking issue for SDK.
https://github.com/Azure/azure-rest-api-specs/pull/32243/files

@alexmahonic alexmahonic added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Jan 23, 2025
@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 Jan 23, 2025
@pshao25 pshao25 added BreakingChange-LintDiff suppressions for LintDiff errors Approved-LintDiff PublishToCustomers Acknowledgement the changes will be published to Azure customers. and removed BreakingChange-LintDiff suppressions for LintDiff errors labels Jan 24, 2025
@tadelesh
Copy link
Member

/azp run

Copy link

You have several pipelines (over 10) configured to build pull requests in this repository. Specify which pipelines you would like to run by using /azp run [pipelines] command. You can specify multiple pipelines using a comma separated list.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved-LintDiff ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChange-Approved-Benign Changes are not breaking at the REST API level and have at most minor impact to generated SDKs. BreakingChange-JavaScript-Sdk BreakingChange-Python-Sdk BreakingChange-Python-Sdk-Approved BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required PipelineBotTrigger PublishToCustomers Acknowledgement the changes will be published to Azure customers. resource-manager RPaaS TypeSpec Authored with TypeSpec
Projects
None yet
Development

Successfully merging this pull request may close these issues.