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

[Test] Delete a path which is not used #3691

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

Conversation

ankhyk
Copy link

@ankhyk ankhyk commented Nov 14, 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.

Copy link

openapi-pipeline-app-test bot commented Nov 14, 2023

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

Copy link

openapi-pipeline-app-test bot commented Nov 14, 2023

Swagger Validation Report

️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]
compared swaggers (via Oad v0.10.4)] new version base version
servicelinker.json 2022-05-01(9d299d7) 2022-05-01(main)
Rule Message
1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}/validateLinker' removed or restructured?
Old: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L269:5
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.6) new version base version
package-2022-05-01 package-2022-05-01(9d299d7) package-2022-05-01(main)

The following errors/warnings exist before current PR submission:

Rule Message
ResourceNameRestriction The resource name parameter 'linkerName' should be defined with a 'pattern' restriction.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L74
DeleteResponseCodes Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L168
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L201
PatchResponseCodes Long-running PATCH operations must have responses with 200, 202 and default return codes. They also must not have other response codes.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L212
LroPatch202 The async patch operation should return 202.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L247
ResourceNameRestriction The resource name parameter 'linkerName' should be defined with a 'pattern' restriction.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L269
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L52
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L65
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L88
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L104
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L132
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L163
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L188
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L207
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L232
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L263
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L286
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L302
⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: GetConfiguration
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L315
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L322
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L329
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L335
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L429
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L696
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L712
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L864
️️✔️PR Summary succeeded [Detail] [Expand]
️️✔️[NotRequired_Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌ModelValidation: 3 Errors, 0 Warnings failed [Detail]
Rule Message
MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
Url: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L691:23
ExampleUrl: stable/2022-05-01/examples/PutLink.json#L25:15
MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
Url: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L691:23
ExampleUrl: stable/2022-05-01/examples/PutLink.json#L41:15
LRO_RESPONSE_HEADER Long running operation should return location or azure-AsyncOperation in header but not provided
Url: Microsoft.ServiceLinker/stable/2022-05-01/servicelinker.json#L194:22
ExampleUrl: stable/2022-05-01/examples/DeleteLink.json
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️~[NotRequired_Staging] SwaggerAPIView succeeded [Detail] [Expand]
️️✔️~[NotRequired_Staging] TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️[NotRequired_Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️[NotRequired_Staging] SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation

  • The following tags are being changed in this PR
    • "https://github.com/openapi-env-test/azure-rest-api-specs/blob/9d299d7cf949f82280a26d453dca855affb9f351/specification/servicelinker/resource-manager/readme.md#tag-package-2022-05-01">servicelinker/resource-manager/readme.md#package-2022-05-01
The following errors/warnings are introduced by current PR:
The following errors/warnings exist before current PR submission:
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app-test bot commented Nov 14, 2023

Swagger Generation Artifacts

️🔄[NotRequired_Staging] ApiDocPreview inProgress [Detail]
️❌[NotRequired_Staging] SDK Breaking Change Tracking failed [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.BeginValidate` has been removed
+	Function `NewClientFactory` has been removed
+	Struct `ClientFactory` 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_validate
azure-sdk-for-js - @azure/arm-servicelinker - 3.0.0
+	Removed operation Linker.beginValidate
+	Removed operation Linker.beginValidateAndWait
️❌ azure-sdk-for-net-track2 failed [Detail]
  • Failed [Logs] Generate from 5673035. SDK Automation 14.0.0
    command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
    command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:712
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 712 | �[0m         �[36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to build sdk. exit code: False
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
  • Azure.ResourceManager.ServiceLinker [View full logs]  [Preview SDK Changes] Breaking Change Detected
    info	[Changelog] Breaking Changes: /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : TypesMustExist : Type 'Azure.ResourceManager.ServiceLinker.Models.LinkerAuthType' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/servicelinker/Azure.ResourceManager.ServiceLinker/src/Azure.ResourceManager.ServiceLinker.csproj::TargetFramework=netstandard2.0],
    info	[Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : TypesMustExist : Type 'Azure.ResourceManager.ServiceLinker.Models.LinkerValidateOperationResult' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/servicelinker/Azure.ResourceManager.ServiceLinker/src/Azure.ResourceManager.ServiceLinker.csproj::TargetFramework=netstandard2.0],
    info	[Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : TypesMustExist : Type 'Azure.ResourceManager.ServiceLinker.Models.LinkerValidationResultItemInfo' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/servicelinker/Azure.ResourceManager.ServiceLinker/src/Azure.ResourceManager.ServiceLinker.csproj::TargetFramework=netstandard2.0],
    info	[Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(82,5): error : TypesMustExist : Type 'Azure.ResourceManager.ServiceLinker.Models.LinkerValidationResultStatus' does not exist in the implementation but it does exist in the contract. [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/servicelinker/Azure.ResourceManager.ServiceLinker/src/Azure.ResourceManager.ServiceLinker.csproj::TargetFramework=netstandard2.0],
    info	[Changelog] /home/cloudtest/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(96,5): error : ApiCompat failed for '/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/bin/Azure.ResourceManager.ServiceLinker/Debug/netstandard2.0/Azure.ResourceManager.ServiceLinker.dll' [/mnt/vss/_work/1/s/azure-sdk-for-net/sdk/servicelinker/Azure.ResourceManager.ServiceLinker/src/Azure.ResourceManager.ServiceLinker.csproj::TargetFramework=netstandard2.0]
️⚠️ azure-sdk-for-python-track2 warning [Detail]
  • ⚠️Warning [Logs] Generate from 5673035. SDK Automation 14.0.0
    command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
    cmderr	[automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
    cmderr	[automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
    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] npm notice
    cmderr	[automation_generate.sh] npm notice New major version of npm available! 9.8.1 -> 10.2.4
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.4>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
    cmderr	[automation_generate.sh] npm notice
  • ️✔️track2_azure-mgmt-servicelinker [View full logs]  [Preview SDK Changes] Breaking Change Detected
    info	[Changelog] ### Breaking Changes
    info	[Changelog]
    info	[Changelog]   - Removed operation LinkerOperations.begin_validate
️⚠️ azure-sdk-for-java warning [Detail]
  • ⚠️Warning [Logs] Generate from 5673035. SDK Automation 14.0.0
    command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
    cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.3.1
    cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
    cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.3.1
    cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
    command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
  • ️✔️azure-resourcemanager-servicelinker [View full logs]  [Preview SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from 5673035. SDK Automation 14.0.0
    command	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/servicelinker/armservicelinker [View full logs]  [Preview SDK Changes] Breaking Change Detected
    info	[Changelog] ### Breaking Changes
    info	[Changelog]
    info	[Changelog] - Type of `ErrorAdditionalInfo.Info` has been changed from `any` to `interface{}`
    info	[Changelog] - Function `NewClientFactory` has been removed
    info	[Changelog] - Function `*ClientFactory.NewLinkerClient` has been removed
    info	[Changelog] - Function `*ClientFactory.NewOperationsClient` has been removed
    info	[Changelog] - Function `*LinkerClient.BeginValidate` has been removed
    info	[Changelog] - Struct `ClientFactory` has been removed
    info	[Changelog] - Struct `LinkerClientValidateResponse` has been removed
    info	[Changelog]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog] - New value `ClientTypeKafkaSpringBoot` added to type alias `ClientType`
    info	[Changelog]
    info	[Changelog] Total 9 breaking change(s), 1 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from 5673035. SDK Automation 14.0.0
    command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
    warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
    command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
  • ️✔️@azure/arm-servicelinker [View full logs]  [Preview SDK Changes] Breaking Change Detected
    info	[Changelog] **Features**
    info	[Changelog]
    info	[Changelog]   - Enum KnownClientType has a new value KafkaSpringBoot
    info	[Changelog]
    info	[Changelog] **Breaking Changes**
    info	[Changelog]
    info	[Changelog]   - Removed operation Linker.beginValidate
    info	[Changelog]   - Removed operation Linker.beginValidateAndWait
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app-test bot commented Nov 14, 2023

@ankhyk ankhyk changed the title [Test] New API version for Microsoft.ServiceLinker stable/2023-05-01 [Test] Delete a path which is not used Nov 16, 2023
@raych1
Copy link

raych1 commented Nov 22, 2023

/azp run

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants