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

Update servicelinker.json #3677

Open
wants to merge 1 commit into
base: JackTn-test-sdkbreakingchange-3
Choose a base branch
from
Open

Update servicelinker.json #3677

wants to merge 1 commit into from

Conversation

JackTn
Copy link

@JackTn JackTn commented Oct 30, 2023

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:

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. 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.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No refresh required for updates in this PR

Contribution checklist:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

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:

  • Check this box if any of the following appy 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
      -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

@openapi-dev-app-jacktn
Copy link

openapi-dev-app-jacktn bot commented Oct 30, 2023 •
edited by openapi-pipeline-app-test bot
Loading

Automatic PR validation restarted. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛.

@openapi-dev-app-jacktn
Copy link

openapi-dev-app-jacktn bot commented Oct 30, 2023 •
edited by openapi-pipeline-app-test bot
Loading

Swagger Validation Report

️🔄BreakingChange inProgress [Detail]
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand] 
There are no breaking changes.
️🔄LintDiff inProgress [Detail]
️️✔️PR Summary succeeded [Detail] [Expand]
️🔄Avocado inProgress [Detail]
️️✔️ModelValidation succeeded [Detail] [Expand] 
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand] 
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand] 
Validation passed for PoliCheck.
️️✔️[NotRequired_Staging] PrettierCheck succeeded [Detail] [Expand] 
Validation passes for PrettierCheck.
️️✔️[NotRequired_Staging] SpellCheck succeeded [Detail] [Expand] 
Validation passes for SpellCheck.
️🔄[NotRequired_Staging] SDK Track2 Validation inProgress [Detail]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-dev-app-jacktn
Copy link

openapi-dev-app-jacktn bot commented Oct 30, 2023 •
edited by openapi-pipeline-app-test bot
Loading

Swagger Generation Artifacts

️🔄[NotRequired_Staging] ApiDocPreview inProgress [Detail]
️⚠️[NotRequired_Staging] SDK Breaking Change Tracking warning [Detail]

Breaking Changes Tracking

⚠️azure-sdk-for-go - sdk/resourcemanager/servicelinker/armservicelinker - 2.0.0
+	Function `*ClientFactory.NewLinkerClient` has been removed
+	Function `*ClientFactory.NewOperationsClient` has been removed
+	Function `*LinkerClient.BeginCreateOrUpdate` has been removed
+	Function `*LinkerClient.BeginDelete` has been removed
+	Function `*LinkerClient.BeginUpdate` has been removed
+	Function `*LinkerClient.BeginValidate` has been removed
+	Function `*LinkerClient.Get` has been removed
+	Function `*LinkerClient.NewListPager` has been removed
+	Function `NewClientFactory` has been removed
+	Struct `ClientFactory` has been removed
+	Struct `LinkerClientCreateOrUpdateResponse` has been removed
+	Struct `LinkerClientDeleteResponse` has been removed
+	Struct `LinkerClientListResponse` has been removed
+	Struct `LinkerClientUpdateResponse` has been removed
+	Struct `LinkerClientValidateResponse` has been removed
+	Type of `ErrorAdditionalInfo.Info` has been changed from `any` to `interface{}`
⚠️azure-sdk-for-python-track2 - track2_azure-mgmt-servicelinker - 1.1.0
+	Removed operation LinkerOperations.begin_create_or_update
+	Removed operation LinkerOperations.begin_delete
+	Removed operation LinkerOperations.begin_update
+	Removed operation LinkerOperations.begin_validate
+	Removed operation LinkerOperations.get
+	Removed operation LinkerOperations.list
⚠️azure-sdk-for-js - @azure/arm-servicelinker - 3.0.0
+	Removed operation Linker.beginCreateOrUpdate
+	Removed operation Linker.beginCreateOrUpdateAndWait
+	Removed operation Linker.beginDelete
+	Removed operation Linker.beginDeleteAndWait
+	Removed operation Linker.beginUpdate
+	Removed operation Linker.beginUpdateAndWait
+	Removed operation Linker.beginValidate
+	Removed operation Linker.beginValidateAndWait
+	Removed operation Linker.get
+	Removed operation Linker.list
️🔄 azure-sdk-for-net-track2 inProgress [Detail]
️🔄 azure-sdk-for-python-track2 inProgress [Detail]
️🔄 azure-sdk-for-java inProgress [Detail]
️🔄 azure-sdk-for-go inProgress [Detail]
️🔄 azure-sdk-for-js inProgress [Detail]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-dev-app-jacktn
Copy link

openapi-dev-app-jacktn bot commented Oct 30, 2023 •
edited by openapi-pipeline-app-test bot
Loading

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/servicelinker/armservicelinker https://apiviewstaging.azurewebsites.net/Assemblies/Review/e5159c89dbb5486ba263bd848c42c13e
.Net Azure.ResourceManager.ServiceLinker https://apiviewstaging.azurewebsites.net/Assemblies/Review/e312154009e74d9599a9bf19733d33be
Java azure-resourcemanager-servicelinker https://apiviewstaging.azurewebsites.net/Assemblies/Review/076a19ba6df64727bea49a1dc51648d1
JavaScript @azure/arm-servicelinker https://apiviewstaging.azurewebsites.net/Assemblies/Review/9778e4fb977447e4a10c561a209e7498

@azure-sdk azure-sdk mentioned this pull request Oct 30, 2023
Draft
@azure-sdk azure-sdk mentioned this pull request Oct 30, 2023
Closed
@azure-sdk azure-sdk mentioned this pull request Oct 30, 2023
Closed
This was referenced Oct 30, 2023
Closed
Closed
@JackTn
Copy link
Author

JackTn commented Nov 1, 2023

/azp run

@azure-pipelines Azure Pipelines
Copy link

No pipelines are associated with this pull request.

@JackTn JackTn added APIStewardshipBoard-SignedOff The Azure API Stewardship team has reviewed and approved the changes. and removed APIStewardshipBoard-SignedOff The Azure API Stewardship team has reviewed and approved the changes. labels Nov 1, 2023
@JackTn
Copy link
Author

JackTn commented Nov 1, 2023

/azp run

@azure-pipelines Azure Pipelines
Copy link

No pipelines are associated with this pull request.

@JackTn
Copy link
Author

JackTn commented Nov 1, 2023

/azp run

@azure-pipelines Azure Pipelines
Copy link

No pipelines are associated with this pull request.

@openapi-dev-app-jacktn OpenApi Dev app JackTn
Copy link

Automatic PR validation started. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛.

@openapi-dev-app-jacktn OpenApi Dev app JackTn
Copy link

Swagger pipeline started successfully, please wait for status update in this comment.

1 similar comment
@openapi-dev-app-jacktn OpenApi Dev app JackTn
Copy link

Swagger pipeline started successfully, please wait for status update in this comment.

@openapi-dev-app-jacktn OpenApi Dev app JackTn
Copy link

Swagger pipeline started successfully. If there is ApiView generated, it will be updated in this comment.

@JackTn
Copy link
Author

JackTn commented Nov 6, 2023

/azp run

@azure-pipelines Azure Pipelines
Copy link

No pipelines are associated with this pull request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
BreakingChangeReviewRequired CI-BreakingChange-Go CI-BreakingChange-JavaScript CI-BreakingChange-Python-Track2 resource-manager RPaaS
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@JackTn @AzureRestAPISpecReview