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

[Hub Generated] Review request for Microsoft.Advisor to add version stable/2023-01-01 #24029

Merged
merged 5 commits into from
May 25, 2023

Conversation

brandonh1994
Copy link
Contributor

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

ARM API Information (Control Plane)

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. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

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 apply 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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Note that this doesn't apply if you are trying to merge a PR that was previously in the private repository.
  • 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

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

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

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

@openapi-pipeline-app
Copy link

Swagger pipeline can not start as the pull request has merge conflicts.

@openapi-workflow-bot
Copy link

Hi, @brandonh1994 Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

    @openapi-pipeline-app
    Copy link

    Swagger pipeline can not start as the pull request has merge conflicts.

    @openapi-pipeline-app
    Copy link

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

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 17, 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.
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

    API Test is not triggered due to precheck failure. Check pipeline log for details.

    ️️✔️SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️CadlAPIView 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).
    ️️✔️CadlValidation succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    ️️✔️TypeSpec Validation succeeded [Detail] [Expand]
    Validation passes for TypeSpec Validation.
    ️️✔️PR Summary succeeded [Detail] [Expand]
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 17, 2023

    Swagger Generation Artifacts

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

    Breaking Changes Tracking



    azure-sdk-for-js - @azure/arm-advisor - Approved - 4.0.0
    +	Interface RecommendationsListNextOptionalParams no longer has parameter filter
    +	Interface RecommendationsListNextOptionalParams no longer has parameter skipToken
    +	Interface RecommendationsListNextOptionalParams no longer has parameter top
    +	Interface SuppressionsListNextOptionalParams no longer has parameter skipToken
    +	Interface SuppressionsListNextOptionalParams no longer has parameter top
    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 277cfe5. 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
    • ️✔️Azure.ResourceManager.Advisor [View full logs]  [Release SDK Changes]
      info	[Changelog]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 277cfe5. 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]  New minor version of npm available! 9.5.1 -> 9.6.7
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.7>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-advisor [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Added operation group AdvisorManagementClientOperationsMixin
      info	[Changelog]   - Added operation group AdvisorScoresOperations
      info	[Changelog]   - Model ConfigData has a new parameter duration
      info	[Changelog]   - Model ConfigData has a new parameter system_data
      info	[Changelog]   - Model Resource has a new parameter system_data
      info	[Changelog]   - Model ResourceMetadata has a new parameter action
      info	[Changelog]   - Model ResourceMetadata has a new parameter plural
      info	[Changelog]   - Model ResourceMetadata has a new parameter singular
      info	[Changelog]   - Model ResourceRecommendationBase has a new parameter actions
      info	[Changelog]   - Model ResourceRecommendationBase has a new parameter description
      info	[Changelog]   - Model ResourceRecommendationBase has a new parameter exposed_metadata_properties
      info	[Changelog]   - Model ResourceRecommendationBase has a new parameter label
      info	[Changelog]   - Model ResourceRecommendationBase has a new parameter learn_more_link
      info	[Changelog]   - Model ResourceRecommendationBase has a new parameter potential_benefits
      info	[Changelog]   - Model ResourceRecommendationBase has a new parameter remediation
      info	[Changelog]   - Model ResourceRecommendationBase has a new parameter system_data
      info	[Changelog]   - Model SuppressionContract has a new parameter system_data
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 277cfe5. 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.1.2
      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.1.2
      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-advisor [View full logs]  [Release SDK Changes]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 277cfe5. 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/advisor/armadvisor [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New enum type `Aggregated` with values `AggregatedDay`, `AggregatedMonth`, `AggregatedWeek`
      info	[Changelog] - New enum type `CreatedByType` with values `CreatedByTypeApplication`, `CreatedByTypeKey`, `CreatedByTypeManagedIdentity`, `CreatedByTypeUser`
      info	[Changelog] - New enum type `Duration` with values `DurationFourteen`, `DurationNinety`, `DurationSeven`, `DurationSixty`, `DurationThirty`, `DurationTwentyOne`
      info	[Changelog] - New enum type `PredictionType` with values `PredictionTypePredictiveRightsizing`
      info	[Changelog] - New function `*ClientFactory.NewManagementClient() *ManagementClient`
      info	[Changelog] - New function `*ClientFactory.NewScoresClient() *ScoresClient`
      info	[Changelog] - New function `NewManagementClient(string, azcore.TokenCredential, *arm.ClientOptions) (*ManagementClient, error)`
      info	[Changelog] - New function `*ManagementClient.Predict(context.Context, PredictionRequest, *ManagementClientPredictOptions) (ManagementClientPredictResponse, error)`
      info	[Changelog] - New function `NewScoresClient(string, azcore.TokenCredential, *arm.ClientOptions) (*ScoresClient, error)`
      info	[Changelog] - New function `*ScoresClient.Get(context.Context, string, *ScoresClientGetOptions) (ScoresClientGetResponse, error)`
      info	[Changelog] - New function `*ScoresClient.List(context.Context, *ScoresClientListOptions) (ScoresClientListResponse, error)`
      info	[Changelog] - New struct `PredictionRequest`
      info	[Changelog] - New struct `PredictionRequestProperties`
      info	[Changelog] - New struct `PredictionResponse`
      info	[Changelog] - New struct `PredictionResponseProperties`
      info	[Changelog] - New struct `ProxyResource`
      info	[Changelog] - New struct `ScoreEntity`
      info	[Changelog] - New struct `ScoreEntityForAdvisor`
      info	[Changelog] - New struct `ScoreEntityForAdvisorProperties`
      info	[Changelog] - New struct `ScoreResponse`
      info	[Changelog] - New struct `SystemData`
      info	[Changelog] - New struct `TimeSeriesEntityItem`
      info	[Changelog] - New field `SystemData` in struct `ConfigData`
      info	[Changelog] - New field `Duration` in struct `ConfigDataProperties`
      info	[Changelog] - New field `SystemData` in struct `Resource`
      info	[Changelog] - New field `SystemData` in struct `ResourceRecommendationBase`
      info	[Changelog] - New field `SystemData` in struct `SuppressionContract`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 52 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 277cfe5. 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-advisor [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added operation group AdvisorScores
      info	[Changelog]   - Added Interface AdvisorScoreEntity
      info	[Changelog]   - Added Interface AdvisorScoreEntityProperties
      info	[Changelog]   - Added Interface AdvisorScoreResponse
      info	[Changelog]   - Added Interface AdvisorScoresGetOptionalParams
      info	[Changelog]   - Added Interface AdvisorScoresListOptionalParams
      info	[Changelog]   - Added Interface PredictionRequest
      info	[Changelog]   - Added Interface PredictionResponse
      info	[Changelog]   - Added Interface PredictOptionalParams
      info	[Changelog]   - Added Interface ProxyResource
      info	[Changelog]   - Added Interface ScoreEntity
      info	[Changelog]   - Added Interface SystemData
      info	[Changelog]   - Added Interface TimeSeriesEntityItem
      info	[Changelog]   - Added Type Alias AdvisorScoresGetResponse
      info	[Changelog]   - Added Type Alias AdvisorScoresListResponse
      info	[Changelog]   - Added Type Alias Aggregated
      info	[Changelog]   - Added Type Alias CreatedByType
      info	[Changelog]   - Added Type Alias Duration
      info	[Changelog]   - Added Type Alias PredictionType
      info	[Changelog]   - Added Type Alias PredictResponse
      info	[Changelog]   - Interface ConfigData has a new optional parameter duration
      info	[Changelog]   - Interface Resource has a new optional parameter systemData
      info	[Changelog]   - Added Enum KnownAggregated
      info	[Changelog]   - Added Enum KnownCreatedByType
      info	[Changelog]   - Added Enum KnownDuration
      info	[Changelog]   - Added Enum KnownPredictionType
      info	[Changelog]
      info	[Changelog] **Breaking Changes**
      info	[Changelog]
      info	[Changelog]   - Interface RecommendationsListNextOptionalParams no longer has parameter filter
      info	[Changelog]   - Interface RecommendationsListNextOptionalParams no longer has parameter skipToken
      info	[Changelog]   - Interface RecommendationsListNextOptionalParams no longer has parameter top
      info	[Changelog]   - Interface SuppressionsListNextOptionalParams no longer has parameter skipToken
      info	[Changelog]   - Interface SuppressionsListNextOptionalParams no longer has parameter top
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 277cfe5. 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] WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
      cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
      cmderr	[initScript.sh] npm WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
      cmderr	[initScript.sh] npm WARN old lockfile
      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
    • ️✔️advisor [View full logs
    ️❌ azure-powershell failed [Detail]
    • Pipeline Framework Failed [Logs]Release - Generate from 277cfe5. 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.advisor.DefaultTag [View full logs
      error	Fatal error: SSL error: syscall failure: Broken pipe
      error	The following packages are still pending:
      error		Az.advisor.DefaultTag
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 17, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/advisor/armadvisor https://apiview.dev/Assemblies/Review/9aad035140b34a91b289b86645587e68
    .Net Azure.ResourceManager.Advisor https://apiview.dev/Assemblies/Review/5fe05d38ef65439a86a8a91791d07b65
    Java azure-resourcemanager-advisor https://apiview.dev/Assemblies/Review/aded8530e0274548bd438703c4e9b0e2
    JavaScript @azure/arm-advisor https://apiview.dev/Assemblies/Review/dd421244b2924ba5b5cdf443e9b3a4fd

    @v-xuto
    Copy link
    Member

    v-xuto commented May 18, 2023

    @qiaozha Please help review JS breaking change.

    1 similar comment
    @v-xuto
    Copy link
    Member

    v-xuto commented May 22, 2023

    @qiaozha Please help review JS breaking change.

    @v-xuto v-xuto added the Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates label May 25, 2023
    @qiaozha qiaozha merged commit 277cfe5 into main May 25, 2023
    @qiaozha qiaozha deleted the brandonh1994-advisor-Microsoft.Advisor-2023-01-01 branch May 25, 2023 06:23
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates Approved-SdkBreakingChange-JavaScript CI-BreakingChange-JavaScript resource-manager
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants