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

Removal of the "service in preview" description for SapVirtualInstances and Monitors resource types for 2023-04-01 api-version #23868

Merged
merged 1 commit into from
May 10, 2023
Merged

Removal of the "service in preview" description for SapVirtualInstances and Monitors resource types for 2023-04-01 api-version #23868

merged 1 commit into from
May 10, 2023

Conversation

sushantyadav-msft
Copy link
Contributor

@sushantyadav-msft sushantyadav-msft commented May 9, 2023 •
edited
Loading

ARM API Information [Documentation change]

Removing the "service in preview" description from the swagger api-version as the service is announcing GA soon. Changes are to revert the commit - 324219b

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.
    No service change required.
  3. When do you expect to publish the swagger? Please provide date or, the date is not yet available, the month.
    Around 15/05/23 the API version documentation will be published.
  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.

  • 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-workflow-bot
Copy link

Hi, @sushantyadav-msft 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. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 9, 2023 •
    edited
    Loading

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand] 
    There are no breaking changes.
    compared swaggers (via Oad v0.10.4)] new version base version
    SAPVirtualInstance.json 2023-04-01(3749f4e) 2023-04-01(main)
    monitors.json 2023-04-01(3749f4e) 2023-04-01(main)
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand] 
    There is no credential detected.
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    compared tags (via openapi-validator v2.0.1) new version base version
    package-2023-04 package-2023-04(3749f4e) package-2023-04(main)

    The following errors/warnings exist before current PR submission:

    Rule Message
    ⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'SapLandscapeMonitorModel'. Consider using the plural form of 'SapLandscapeMonitor' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.Workloads/stable/2023-04-01/monitors.json#L579
    ⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'SapLandscapeMonitorModel'. Consider using the plural form of 'SapLandscapeMonitor' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.Workloads/stable/2023-04-01/monitors.json#L623
    ⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'SapLandscapeMonitorModel'. Consider using the plural form of 'SapLandscapeMonitor' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.Workloads/stable/2023-04-01/monitors.json#L673
    ⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'SapLandscapeMonitorModel'. Consider using the plural form of 'SapLandscapeMonitor' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.Workloads/stable/2023-04-01/monitors.json#L714
    ⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'SapLandscapeMonitorModel'. Consider using the plural form of 'SapLandscapeMonitor' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.Workloads/stable/2023-04-01/monitors.json#L760
    ⚠️ 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.Workloads/stable/2023-04-01/monitors.json#L855
    ⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.Workloads/stable/2023-04-01/SAPVirtualInstance.json#L2199
    ⚠️ 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.Workloads/stable/2023-04-01/SAPVirtualInstance.json#L2328
    ⚠️ 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.Workloads/stable/2023-04-01/SAPVirtualInstance.json#L2550
    ⚠️ 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.Workloads/stable/2023-04-01/SAPVirtualInstance.json#L2554
    ⚠️ 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.Workloads/stable/2023-04-01/SAPVirtualInstance.json#L4222
    ️️✔️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 9, 2023 •
    edited
    Loading

    Swagger Generation Artifacts

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

    Breaking Changes Tracking



    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 756495d. 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]
cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.5.1 -> 9.6.6
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.6>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.6.6` to update!
cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-workloads [View full logs]  [Release SDK Changes] 
      info	[Changelog]
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 756495d. 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-workloads [View full logs]  [Release SDK Changes]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 756495d. 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/workloads/armworkloads [View full logs]  [Release SDK Changes] 
      info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 756495d. 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
cmderr	[automation_generate.sh] [ERROR] Cannot generate changelog because the codes of local and npm may be the same.
    • ️✔️@azure/arm-workloads [View full logs]  [Release SDK Changes] 
      info	[Changelog]
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 756495d. 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
    • ️✔️workloads [View full logs] 
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 9, 2023 •
    edited
    Loading

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/workloads/armworkloads There is no API change compared with the previous version
    Java azure-resourcemanager-workloads There is no API change compared with the previous version
    .Net Azure.ResourceManager.Workloads There is no API change compared with the previous version
    JavaScript @azure/arm-workloads https://apiview.dev/Assemblies/Review/e92aa22752e34503b264c5855c346cdd

    @sushantyadav-msft sushantyadav-msft added the DoNotMerge <valid label in PR review process> use to hold merge after approval label May 9, 2023
    @azure-sdk azure-sdk mentioned this pull request May 9, 2023
    Closed
    This was referenced May 9, 2023
    Closed
    Closed
    Closed
    Closed
    @sushantyadav-msft sushantyadav-msft changed the title Reverted the description that the services are in preview. Reverting the "service in preview" description for SapVirtualInstances and Monitors resource types for 2023-04-01 api-version May 9, 2023
    @sushantyadav-msft sushantyadav-msft changed the title Reverting the "service in preview" description for SapVirtualInstances and Monitors resource types for 2023-04-01 api-version Removal of the "service in preview" description for SapVirtualInstances and Monitors resource types for 2023-04-01 api-version May 9, 2023
    gargankit-microsoft
    gargankit-microsoft approved these changes May 9, 2023
    View reviewed changes
    Copy link
    Member

    @gargankit-microsoft gargankit-microsoft left a comment

    Choose a reason for hiding this comment

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

    Please make sure same swagger is present in Private repo RPSaaSMaster for GA folder too.

    @zedy-wj zedy-wj self-requested a review May 10, 2023 02:05
    @zedy-wj zedy-wj added the Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates label May 10, 2023
    @sushantyadav-msft sushantyadav-msft removed the DoNotMerge <valid label in PR review process> use to hold merge after approval label May 10, 2023
    @live1206 live1206 merged commit 756495d into main May 10, 2023
    @live1206 live1206 deleted the sushantyadav-msft-workloads-Microsoft.Workloads-2023-04-01-revertPreview branch May 10, 2023 06:59
    This was referenced May 10, 2023
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @gargankit-microsoft gargankit-microsoft gargankit-microsoft approved these changes

    @zedy-wj zedy-wj zedy-wj approved these changes

    Assignees

    @zedy-wj zedy-wj

    Labels
    Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates resource-manager RPaaS
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    5 participants
    @sushantyadav-msft @zedy-wj @gargankit-microsoft @live1206 @AzureRestAPISpecReview