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

Workbooks api-version 2023 06 01 #25269

Merged
merged 19 commits into from
Aug 30, 2023
Merged

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] public repo review queue, private repo review queue
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

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, per this wiki doc.)
  • 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:
    • 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:

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.

Getting help

@vutran01 vutran01 requested a review from grlima August 10, 2023 17:35
@openapi-workflow-bot
Copy link

Hi, @vutran01! Thank you for your pull request. To help get your PR merged:

  • Ensure you reviewed the checklists in the PR description.
  • Know that PR assignee is the person auto-assigned and responsible for your current PR review and approval.
  • 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.
  • @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 10, 2023

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️Breaking Change(Cross-Version): 18 Warnings warning [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    workbooks_API.json 2023-06-01(f860321) 2022-04-01(main)
    workbooks_API.json 2023-06-01(f860321) 2018-06-17-preview(main)

    The following breaking changes are detected by comparison with the latest preview version:

    Rule Message
    ⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/workbooks' removed or restructured?
    Old: Microsoft.Insights/preview/2018-06-17-preview/workbooks_API.json#L37:5
    ⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/workbooks/{resourceName}' removed or restructured?
    Old: Microsoft.Insights/preview/2018-06-17-preview/workbooks_API.json#L88:5
    ⚠️ 1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'WorkbookResourceNameParameter' removed or renamed?
    New: Microsoft.Insights/stable/2023-06-01/workbooks_API.json#L679:3
    Old: Microsoft.Insights/preview/2018-06-17-preview/workbooks_API.json#L486:3
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) 'user' from the old version.
    New: Microsoft.Insights/stable/2023-06-01/workbooks_API.json#L444:9
    Old: Microsoft.Insights/preview/2018-06-17-preview/workbooks_API.json#L287:9
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) 'user' from the old version.
    New: Microsoft.Insights/stable/2023-06-01/workbooks_API.json#L568:9
    Old: Microsoft.Insights/preview/2018-06-17-preview/workbooks_API.json#L397:9
    ⚠️ 1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: Microsoft.Insights/stable/2023-06-01/workbooks_API.json#L520:9
    Old: Microsoft.Insights/preview/2018-06-17-preview/workbooks_API.json#L364:9
    ⚠️ 1025 - RequiredStatusChange The 'required' status changed from the old version('True') to the new version('False').
    New: Microsoft.Insights/stable/2023-06-01/workbooks_API.json#L706:5
    Old: Microsoft.Insights/preview/2018-06-17-preview/workbooks_API.json#L513:5
    ⚠️ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: Microsoft.Insights/stable/2023-06-01/workbooks_API.json#L464:9
    Old: Microsoft.Insights/preview/2018-06-17-preview/workbooks_API.json#L323:9
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.Insights/stable/2023-06-01/workbooks_API.json#L467:11
    Old: Microsoft.Insights/preview/2018-06-17-preview/workbooks_API.json#L325:11
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.Insights/stable/2023-06-01/workbooks_API.json#L478:5
    Old: Microsoft.Insights/preview/2018-06-17-preview/workbooks_API.json#L333:5
    ⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'kind' renamed or removed?
    New: common-types/resource-management/v1/types.json#L13:7
    Old: Microsoft.Insights/preview/2018-06-17-preview/workbooks_API.json#L271:7
    ⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'location' renamed or removed?
    New: common-types/resource-management/v1/types.json#L13:7
    Old: Microsoft.Insights/preview/2018-06-17-preview/workbooks_API.json#L271:7
    ⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'tags' renamed or removed?
    New: common-types/resource-management/v1/types.json#L13:7
    Old: Microsoft.Insights/preview/2018-06-17-preview/workbooks_API.json#L271:7
    ⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'code' renamed or removed?
    New: Microsoft.Insights/stable/2023-06-01/workbooks_API.json#L636:7
    Old: Microsoft.Insights/preview/2018-06-17-preview/workbooks_API.json#L466:7
    ⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'message' renamed or removed?
    New: Microsoft.Insights/stable/2023-06-01/workbooks_API.json#L636:7
    Old: Microsoft.Insights/preview/2018-06-17-preview/workbooks_API.json#L466:7
    ⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'details' renamed or removed?
    New: Microsoft.Insights/stable/2023-06-01/workbooks_API.json#L636:7
    Old: Microsoft.Insights/preview/2018-06-17-preview/workbooks_API.json#L466:7
    ⚠️ 1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: Microsoft.Insights/stable/2023-06-01/workbooks_API.json#L444:9
    Old: Microsoft.Insights/preview/2018-06-17-preview/workbooks_API.json#L287:9
    ⚠️ 1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
    New: Microsoft.Insights/stable/2023-06-01/workbooks_API.json#L568:9
    Old: Microsoft.Insights/preview/2018-06-17-preview/workbooks_API.json#L397:9
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️LintDiff succeeded [Detail]
    compared tags (via openapi-validator v2.1.4) new version base version
    package-2023-06-01-only package-2023-06-01-only(f860321) default(main)

    The following errors/warnings exist before current PR submission:

    Rule Message
    ArmResourcePropertiesBag Top level property names should not be repeated inside the properties bag for ARM resource 'Workbook'. Properties [properties.tags] conflict with ARM top level properties. Please rename these.
    Location: Microsoft.Insights/stable/2023-06-01/workbooks_API.json#L478
    ️⚠️Avocado: 1 Warnings warning [Detail]
    Rule Message
    ⚠️ 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-06-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 Aug 10, 2023

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️❌SDK Breaking Change Tracking failed [Detail]

    Breaking Changes Tracking

    azure-sdk-for-go - sdk/resourcemanager/applicationinsights/armapplicationinsights - Approved - 2.0.0-beta.3
    +	Field `InnerError` of struct `WorkbookErrorDefinition` has been removed

    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 5fb045b. 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: 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] notice
      cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.6.7 -> 9.8.1
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.8.1>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` 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 5fb045b. 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] - 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 1 breaking change(s), 17 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 5fb045b. 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 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 5fb045b. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      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
    • ️✔️applicationinsights [View full logs]  [Release Schema Changes]
    ️❌ azure-powershell failed [Detail]
    • Pipeline Framework Failed [Logs]Release - Generate from 5fb045b. 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 Aug 10, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/applicationinsights/armapplicationinsights https://apiview.dev/Assemblies/Review/ba1a6880ab534802858894ee7142bae0
    Java azure-resourcemanager-applicationinsights https://apiview.dev/Assemblies/Review/2325ef72d969440b9791280186fc792e
    .Net Azure.ResourceManager.ApplicationInsights There is no API change compared with the previous version
    JavaScript @azure/arm-appinsights https://apiview.dev/Assemblies/Review/ad72cdcf61194de6bab2ef2f7d3ed103

    @AzureRestAPISpecReview AzureRestAPISpecReview added ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review ARMReview BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required CI-FixRequiredOnFailure CI-MissingBaseCommit labels Aug 10, 2023
    @AzureRestAPISpecReview AzureRestAPISpecReview added ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test and removed CI-FixRequiredOnFailure BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required labels Aug 10, 2023
    @rkmanda rkmanda removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Aug 17, 2023
    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Aug 17, 2023
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 17, 2023

    Next Steps to Merge

    ⚠️ This is an experimental comment. It may not always be up-to-date. ⚠️

    ✔️ 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).

    @ms-henglu
    Copy link
    Member

    Hi @vutran01 ,

    I compared the "workbooks_API.json" file with previous api-version "2022-04-01", I didn't find any new API/properties are introduced, is it intentional?

    @ms-henglu ms-henglu added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Aug 21, 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 Aug 21, 2023
    @vutran01
    Copy link
    Contributor Author

    correct, the changes are to workbook name which states clearly that it should be an uuid and the bump the api version

    @ms-henglu ms-henglu added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Aug 22, 2023
    @openapi-workflow-bot openapi-workflow-bot bot removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Aug 22, 2023
    @Alancere
    Copy link
    Contributor

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 2 pipeline(s).

    @Alancere Alancere added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label Aug 24, 2023
    @vutran01
    Copy link
    Contributor Author

    Azure Pipelines successfully started running 2 pipeline(s).

    /pr RequestMerge

    Copy link

    @sjanamma sjanamma left a comment

    Choose a reason for hiding this comment

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

    approving for merge

    @sjanamma sjanamma merged commit 5fb045b into Azure:main Aug 30, 2023
    @openapi-pipeline-app
    Copy link

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

    jnlycklama pushed a commit that referenced this pull request Nov 8, 2023
    * set default tag to package-2021-03-only
    
    * new default tag and add only workbooks to release
    
    * update package tag with same RP as last package
    
    * update tag name
    
    * Update readme.python.md
    
    * change definition name
    
    * remove operations
    
    * fix missingtypeobject in workbooks
    
    * fix up model validation errors
    
    * initial api-version 2023-06-01
    
    * update workbooks to api-version 2023-06-01
    
    * update description
    
    * revert changes to 2021-03-08
    
    ---------
    
    Co-authored-by: msyyc <[email protected]>
    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 CI-MissingBaseCommit new-api-version ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    7 participants