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] Publish private branch 'voiceservices/api-release' #23928

Merged

Conversation

sebastianrex
Copy link
Contributor

@sebastianrex sebastianrex commented May 11, 2023

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.

@sebastianrex
Copy link
Contributor Author

The PR is created based on the updates in the private branch. The updates in the PR has already been reviewed and approved with this PR Azure/azure-rest-api-specs-pr/11967

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented May 11, 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.
compared swaggers (via Oad v0.10.4)] new version base version
voiceservices.json 2023-04-03(9bb7d68) 2023-01-31(main)
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 1 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.2) new version base version
package-2023-04-03 package-2023-04-03(9bb7d68) default(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule Message Related RPC [For API reviewers]
⚠️ 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.VoiceServices/stable/2023-04-03/voiceservices.json#L989


The following errors/warnings exist before current PR submission:

Rule Message
⚠️ 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.VoiceServices/stable/2023-04-03/voiceservices.json#L812
⚠️ 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.VoiceServices/stable/2023-04-03/voiceservices.json#L979
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌~[Staging] ServiceAPIReadinessTest: 0 Errors, 0 Warnings failed [Detail]

Tag package-2023-04-03; Prod region: Not deployed; Canary region: Not deployed

️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️❌CadlAPIView: 0 Errors, 1 Warnings failed [Detail]
Rule Message
⚠️ Failed to generate cadl APIView. Please check the detail log and make sure cadl compiler version is the latest. "How to fix":"Check the detailed log and update cadl version to latest."
️️✔️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-workflow-bot
Copy link

Hi, @sebastianrex 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

    openapi-pipeline-app bot commented May 11, 2023

    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 1dc3b69. 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.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-voiceservices [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Model CommunicationsGateway has a new parameter identity
      info	[Changelog]   - Model CommunicationsGateway has a new parameter integrated_mcp_enabled
      info	[Changelog]   - Model CommunicationsGatewayUpdate has a new parameter identity
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 1dc3b69. 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-voiceservices [View full logs]  [Release SDK Changes]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 1dc3b69. 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/voiceservices/armvoiceservices [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New enum type `ManagedServiceIdentityType` with values `ManagedServiceIdentityTypeNone`, `ManagedServiceIdentityTypeSystemAssigned`, `ManagedServiceIdentityTypeSystemAssignedUserAssigned`, `ManagedServiceIdentityTypeUserAssigned`
      info	[Changelog] - New struct `ManagedServiceIdentity`
      info	[Changelog] - New struct `UserAssignedIdentity`
      info	[Changelog] - New field `Identity` in struct `CommunicationsGateway`
      info	[Changelog] - New field `IntegratedMcpEnabled` in struct `CommunicationsGatewayProperties`
      info	[Changelog] - New field `Identity` in struct `CommunicationsGatewayUpdate`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 12 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 1dc3b69. 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-voiceservices [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added Interface ManagedServiceIdentity
      info	[Changelog]   - Added Interface UserAssignedIdentity
      info	[Changelog]   - Added Type Alias ManagedServiceIdentityType
      info	[Changelog]   - Interface CommunicationsGateway has a new optional parameter identity
      info	[Changelog]   - Interface CommunicationsGateway has a new optional parameter integratedMcpEnabled
      info	[Changelog]   - Interface CommunicationsGatewayUpdate has a new optional parameter identity
      info	[Changelog]   - Added Enum KnownManagedServiceIdentityType
    ️❌ azure-sdk-for-net-track2 failed [Detail]
    • Failed [Logs]Release - Generate from 1dc3b69. 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
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:712
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 712 | �[0m         �[36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to build sdk. exit code: False
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
    • Azure.ResourceManager.VoiceServices [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] Breaking Changes:
    ️❌ azure-resource-manager-schemas failed [Detail]
    • Failed [Logs]Release - Generate from 1dc3b69. 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]
      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
    • voiceservices/resource-manager [View full logs
    ️❌ azure-powershell failed [Detail]
    • Pipeline Framework Failed [Logs]Release - Generate from 1dc3b69. 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.voiceservices.DefaultTag [View full logs
      error	Fatal error: SSL error: syscall failure: Broken pipe
      error	The following packages are still pending:
      error		Az.voiceservices.DefaultTag
      error		Az.VoiceServices
    • Az.VoiceServices
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 11, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/voiceservices/armvoiceservices https://apiview.dev/Assemblies/Review/d427a5fe297f450a92057ecbb3c58561
    .Net Azure.ResourceManager.VoiceServices https://apiview.dev/Assemblies/Review/d88d0a921a134307ab483c8949564fde
    Java azure-resourcemanager-voiceservices https://apiview.dev/Assemblies/Review/0851d4ce5a294aaa8dd61137b73155f2
    JavaScript @azure/arm-voiceservices https://apiview.dev/Assemblies/Review/a6caf0d0199c48bf9a0518749ff3a46b

    @openapi-workflow-bot openapi-workflow-bot bot added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels May 11, 2023
    @openapi-workflow-bot
    Copy link

    Hi, @sebastianrex your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).

    @sebastianrex
    Copy link
    Contributor Author

    This PR was already approved and merged into the private repo, this is just publishing that PR

    @openapi-workflow-bot
    Copy link

    Hi @sebastianrex, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    @sebastianrex
    Copy link
    Contributor Author

    sebastianrex commented May 11, 2023

    Urgh, the readme changes are because the PR that I'm pulling over from the private repo didn't have the readme changes applied yet.

    I've fixed up the python version manually.

    The .NET SDK actually had the wrong name in this repo before, so I think I should leave it as-is. Since the .NET SDKs aren't autogenerated anyway, I think this is fine.

    And I don't think this requires ARM review since the linked PR was already signed off

    @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 labels May 11, 2023
    @raosuhas
    Copy link

    This PR was already approved and merged into the private repo, this is just publishing that PR

    Is there any diff at all between this PR and the one checked in the private repo ?

    @raosuhas raosuhas added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label May 15, 2023
    @openapi-workflow-bot
    Copy link

    Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested

    @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 May 15, 2023
    @sebastianrex
    Copy link
    Contributor Author

    This PR was already approved and merged into the private repo, this is just publishing that PR

    Is there any diff at all between this PR and the one checked in the private repo ?

    No, not in the API. The only diff is this commit: bcfb1f7 which just fixes up some of the SDK README files

    @sebastianrex sebastianrex removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label May 16, 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 May 16, 2023
    @raosuhas raosuhas added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label May 17, 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 May 17, 2023
    @sebastianrex
    Copy link
    Contributor Author

    Hi @Wzb123456789 , this PR just publishes a previously-merged PR from RPSaaSMaster. Can we get this merged please?

    @sebastianrex
    Copy link
    Contributor Author

    Hi @Wzb123456789 have you had a chance to look at this yet? It's just a merge from RPSaaSMaster into public, so should be uncontroversial

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-SdkBreakingChange-Python ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review Cadl Authored with Cadl new-api-version ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager RPaaS
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    6 participants