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

[Hub Generated] Review request for Microsoft.Help to add version preview/2023-01-01-preview #23407

Merged
merged 1 commit into from
Apr 12, 2023
Merged

[Hub Generated] Review request for Microsoft.Help to add version preview/2023-01-01-preview #23407

merged 1 commit into from
Apr 12, 2023

Conversation

BharathaAravind
Copy link
Member

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

ARM API Information (Control Plane)

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. 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, @BharathaAravind 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 Apr 3, 2023 •
    edited
    Loading

    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.0.0) new version base version
    default default(09b8153) default(main)
    ️️✔️Avocado succeeded [Detail] [Expand] 
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand] 
    Validation passes for ServiceAPIReadinessTest.
    ️️✔️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 Apr 3, 2023 •
    edited
    Loading

    Swagger Generation Artifacts

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

    Breaking Changes Tracking



    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 8c1d363. 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] npm notice
cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.5.0 -> 9.6.4
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.4>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.6.4` to update!
cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-selfhelp [View full logs]  [Release SDK Changes] 
      info	[Changelog]   - Initial Release
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 8c1d363. 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/selfhelp/armselfhelp [View full logs]  [Release SDK Changes] 
      info	[Changelog] This is a new package
info	[Changelog]
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 8c1d363. 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-selfhelp [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 failed [Detail]
    • ❌Failed [Logs]Release - Generate from 8c1d363. 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
    • ❌help/resource-manager [View full logs] 
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 8c1d363. 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
    • ️✔️Az.help.DefaultTag [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Apr 3, 2023 •
    edited
    Loading

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/selfhelp/armselfhelp https://apiview.dev/Assemblies/Review/2bb2e3e554d2450d9cbc09b7b986591e
    Java azure-resourcemanager-help https://apiview.dev/Assemblies/Review/8a46e3b8e3434ccdb0322a002f095f2e
    JavaScript @azure/arm-selfhelp https://apiview.dev/Assemblies/Review/37713178434a4b2b8b662cb42409e87d

    @azure-sdk azure-sdk mentioned this pull request Apr 3, 2023
    Closed
    This was referenced Apr 3, 2023
    Closed
    Closed
    Closed
    Closed
    @BharathaAravind BharathaAravind marked this pull request as ready for review April 4, 2023 19:23
    @BharathaAravind
    Copy link
    Member Author

    BharathaAravind commented Apr 4, 2023 •
    edited
    Loading

    @ArcturusZhang - Do you know why the Powershell SDK pr still uses the old namespace. It seems to be based on .Net sdk which has HelpRp namespace. Any pointers on how to update this SDK. Also, any pointers on how to generate Az cli commands based on this swagger?

    Our namespace review: Azure/azure-sdk#5817

    @BharathaAravind
    Copy link
    Member Author

    @ArcturusZhang - Can you please let me know what is the next step in the process. Our SDK namespace review is done. I created this pr updating the namespace for the tier 1 SDK's

    @ArcturusZhang ArcturusZhang merged commit 8c1d363 into main Apr 12, 2023
    @ArcturusZhang ArcturusZhang deleted the BharathaAravind-help-Microsoft.Help-2023-01-01-preview branch April 12, 2023 07:24
    This was referenced Apr 12, 2023
    Closed
    Closed
    Closed
    Closed
    Closed
    @msyyc msyyc mentioned this pull request Apr 13, 2023
    Merged
    @BharathaAravind BharathaAravind restored the BharathaAravind-help-Microsoft.Help-2023-01-01-preview branch April 21, 2023 02:50
    JoshLove-msft pushed a commit to JoshLove-msft/azure-rest-api-specs that referenced this pull request Apr 25, 2023
    @BharathaAravind @JoshLove-msft
    update sdk namespaces for all languages except c# (Azure#23407)
    1c65956
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @ArcturusZhang ArcturusZhang ArcturusZhang approved these changes

    @msyyc msyyc Awaiting requested review from msyyc msyyc is a code owner

    @Wzb123456789 Wzb123456789 Awaiting requested review from Wzb123456789

    @qiaozha qiaozha Awaiting requested review from qiaozha qiaozha is a code owner

    Assignees

    @ArcturusZhang ArcturusZhang

    Labels
    resource-manager
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    3 participants
    @BharathaAravind @ArcturusZhang @AzureRestAPISpecReview