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

remove myworkbook resource type #26247

Merged
merged 1 commit into from
Nov 2, 2023
Merged

remove myworkbook resource type #26247

merged 1 commit into from
Nov 2, 2023

Conversation

vutran01
Copy link
Contributor

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

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

diagram

[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label ARMChangesRequested
is removed from your PR. This should cause the label WaitForARMFeedback to be added.
[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])

If you need further help with anything, see Getting help section below.

Purpose of this PR

What's the purpose of this PR? Check all that apply. This is mandatory!

  • New API version. (Such PR should have been generated with OpenAPI Hub).
  • 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 swagger quality issues in S360.
  • Other, please clarify:
    • deprecate and remove myworkbook resource type

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:

Breaking changes review (Step 1)

  • If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
    you must follow the breaking changes process.
    IMPORTANT This applies even if:
    • The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
    • You believe there is no need for you to request breaking change approval, for any reason.
      Such claims must be reviewed, and the process is the same.

ARM API changes review (Step 2)

  • If this PR is in purview of ARM review then automation will add the ARMReview label.
  • If you want to force ARM review, add the label yourself.
  • Proceed according to the diagram at the top of this comment.

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
Swagger-Suppression-Process
to get approval.

Getting help

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Oct 16, 2023

Next Steps to Merge

✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Oct 16, 2023

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.
compared tags (via openapi-validator v2.1.6) new version base version
package-2023-10-01-only package-2023-10-01-only(89cb373) default(main)
️❌Avocado: 3 Errors, 1 Warnings failed [Detail]
Rule Message
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Insights/myWorkbooks is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/applicationinsights/resource-manager/readme.md
json: Microsoft.Insights/stable/2021-03-08/myworkbooks_API.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.Insights/myWorkbooks is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/applicationinsights/resource-manager/readme.md
json: Microsoft.Insights/stable/2021-03-08/myworkbooks_API.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Insights/myWorkbooks/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/applicationinsights/resource-manager/readme.md
json: Microsoft.Insights/stable/2021-03-08/myworkbooks_API.json
⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
readme: specification/applicationinsights/resource-manager/readme.md
tag: specification/applicationinsights/resource-manager/readme.md#tag-package-2023-10-01-only
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Oct 16, 2023

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
️❌SDK Breaking Change Tracking failed [Detail]

Breaking Changes Tracking

azure-sdk-for-go - sdk/resourcemanager/applicationinsights/armapplicationinsights - Approved - 2.0.0-beta.3
+	Enum `Kind` has been removed
+	Enum `MyWorkbookManagedIdentityType` has been removed
+	Field `InnerError` of struct `WorkbookErrorDefinition` has been removed
+	Function `*ClientFactory.NewMyWorkbooksClient` has been removed
+	Function `*MyWorkbooksClient.CreateOrUpdate` has been removed
+	Function `*MyWorkbooksClient.Delete` has been removed
+	Function `*MyWorkbooksClient.Get` has been removed
+	Function `*MyWorkbooksClient.NewListByResourceGroupPager` has been removed
+	Function `*MyWorkbooksClient.NewListBySubscriptionPager` has been removed
+	Function `*MyWorkbooksClient.Update` has been removed
+	Function `NewMyWorkbooksClient` has been removed
+	Struct `ErrorDefinition` has been removed
+	Struct `InnerErrorTrace` has been removed
+	Struct `MyWorkbookError` has been removed
+	Struct `MyWorkbookManagedIdentity` has been removed
+	Struct `MyWorkbookProperties` has been removed
+	Struct `MyWorkbookResource` has been removed
+	Struct `MyWorkbookUserAssignedIdentities` has been removed
+	Struct `MyWorkbook` has been removed
+	Struct `MyWorkbooksListResult` has been removed

️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
️⚠️ azure-sdk-for-python-track2 warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from 5ce6377. 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]
    cmderr	[automation_generate.sh] npm notice New major version of npm available! 9.8.1 -> 10.2.2
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.2>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@10.2.2` to update!
    cmderr	[automation_generate.sh] npm notice
  • ️✔️track2_azure-mgmt-applicationinsights [View full logs]  [Release SDK Changes]
    info	[Changelog]
️⚠️ azure-sdk-for-java warning [Detail]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from 5ce6377. 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/applicationinsights/armapplicationinsights [View full logs]  [Release SDK Changes] Breaking Change Detected
    info	[Changelog] ### Breaking Changes
    info	[Changelog]
    info	[Changelog] - Enum `Kind` has been removed
    info	[Changelog] - Enum `MyWorkbookManagedIdentityType` has been removed
    info	[Changelog] - Function `*ClientFactory.NewMyWorkbooksClient` has been removed
    info	[Changelog] - Function `NewMyWorkbooksClient` has been removed
    info	[Changelog] - Function `*MyWorkbooksClient.CreateOrUpdate` has been removed
    info	[Changelog] - Function `*MyWorkbooksClient.Delete` has been removed
    info	[Changelog] - Function `*MyWorkbooksClient.Get` has been removed
    info	[Changelog] - Function `*MyWorkbooksClient.NewListByResourceGroupPager` has been removed
    info	[Changelog] - Function `*MyWorkbooksClient.NewListBySubscriptionPager` has been removed
    info	[Changelog] - Function `*MyWorkbooksClient.Update` has been removed
    info	[Changelog] - Struct `ErrorDefinition` has been removed
    info	[Changelog] - Struct `InnerErrorTrace` has been removed
    info	[Changelog] - Struct `MyWorkbook` has been removed
    info	[Changelog] - Struct `MyWorkbookError` has been removed
    info	[Changelog] - Struct `MyWorkbookManagedIdentity` has been removed
    info	[Changelog] - Struct `MyWorkbookProperties` has been removed
    info	[Changelog] - Struct `MyWorkbookResource` has been removed
    info	[Changelog] - Struct `MyWorkbookUserAssignedIdentities` has been removed
    info	[Changelog] - Struct `MyWorkbooksListResult` has been removed
    info	[Changelog] - Field `InnerError` of struct `WorkbookErrorDefinition` has been removed
    info	[Changelog]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog] - New value `WebTestKindStandard` added to enum type `WebTestKind`
    info	[Changelog] - New function `*ClientFactory.NewOperationsClient() *OperationsClient`
    info	[Changelog] - New function `NewOperationsClient(azcore.TokenCredential, *arm.ClientOptions) (*OperationsClient, error)`
    info	[Changelog] - New function `*OperationsClient.NewListPager(*OperationsClientListOptions) *runtime.Pager[OperationsClientListResponse]`
    info	[Changelog] - New struct `ErrorFieldContract`
    info	[Changelog] - New struct `HeaderField`
    info	[Changelog] - New struct `WebTestPropertiesRequest`
    info	[Changelog] - New struct `WebTestPropertiesValidationRules`
    info	[Changelog] - New struct `WebTestPropertiesValidationRulesContentValidation`
    info	[Changelog] - New field `Details` in struct `ErrorResponse`
    info	[Changelog] - New field `Request`, `ValidationRules` in struct `WebTestProperties`
    info	[Changelog] - New field `Innererror` in struct `WorkbookErrorDefinition`
    info	[Changelog]
    info	[Changelog] Total 29 breaking change(s), 17 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from 5ce6377. 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-appinsights [View full logs]  [Release SDK Changes]
    info	[Changelog]
    error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
️⚠️ azure-resource-manager-schemas warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from 5ce6377. Schema Automation 14.0.0
    command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
    cmderr	[initScript.sh] npm notice
    cmderr	[initScript.sh] npm notice New major version of npm available! 8.19.4 -> 10.2.2
    cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.2>
    cmderr	[initScript.sh] npm notice Run `npm install -g npm@10.2.2` to update!
    cmderr	[initScript.sh] npm notice
    warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
    command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
    warn	No file changes detected after generation
  • ️✔️applicationinsights [View full logs
️❌ azure-powershell failed [Detail]
  • Pipeline Framework Failed [Logs]Release - Generate from 5ce6377. SDK Automation 14.0.0
    command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
    command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
    SSL error: syscall failure: Broken pipe
    Error: SSL error: syscall failure: Broken pipe
  • ️✔️Az.applicationinsights.DefaultTag [View full logs
    error	Fatal error: SSL error: syscall failure: Broken pipe
    error	The following packages are still pending:
    error		Az.applicationinsights.DefaultTag
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Oct 16, 2023

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/applicationinsights/armapplicationinsights https://apiview.dev/Assemblies/Review/6ff041880f7243fba0be2c58e2a82b03
Java azure-resourcemanager-applicationinsights https://apiview.dev/Assemblies/Review/d683921c0b5b41de9d4a474c9ecc1dc2
.Net Azure.ResourceManager.ApplicationInsights https://apiview.dev/Assemblies/Review/c080b6d7b0f84adb8c26f43a151cd931
JavaScript @azure/arm-appinsights https://apiview.dev/Assemblies/Review/50cbf98b10f44d34960d68b4b121aeee

Copy link
Member

@rkmanda rkmanda left a comment

Choose a reason for hiding this comment

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

:shipit:

@rkmanda rkmanda added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Oct 20, 2023
@openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 20, 2023
@Alancere Alancere added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label Oct 24, 2023
@vutran01
Copy link
Contributor Author

vutran01 commented Nov 1, 2023

/pr RequestMerge

@rkmanda rkmanda merged commit 5ce6377 into main Nov 2, 2023
28 of 31 checks passed
@rkmanda rkmanda deleted the users/vutran/myworkbook branch November 2, 2023 03:12
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go resource-manager
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants