Skip to content

[Hub Generated] Review request for Microsoft.ProfessionalService to add version preview/2020-11-01-preview #22750

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

Draft
wants to merge 23 commits into
base: main
Choose a base branch
from

Conversation

ariehf
Copy link
Contributor

@ariehf ariehf commented Feb 22, 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.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Feb 22, 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.
compared tags (via openapi-validator v2.0.0) new version base version
package-2020-05-01 package-2020-05-01(c2faae3) default(main)
️❌Avocado: 10 Errors, 0 Warnings failed [Detail]
Rule Message
NO_JSON_FILE_FOUND The JSON file is not found but it is referenced from the readme file.
readme: specification/professionalservice/resource-manager/readme.md
json: Microsoft.ProfessionalService/stable/2020-05-01/professionalservice.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/professionalservice/resource-manager/readme.md
json: 2020-11-01-preview/examples/OperationResults/Get.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/professionalservice/resource-manager/readme.md
json: 2020-11-01-preview/examples/OperationsRp/GetRpOperations.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/professionalservice/resource-manager/readme.md
json: 2020-11-01-preview/examples/ProfessionalService/ProfessionalServiceDelete.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/professionalservice/resource-manager/readme.md
json: 2020-11-01-preview/examples/ProfessionalService/ProfessionalServiceEnrollmentDelete.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/professionalservice/resource-manager/readme.md
json: 2020-11-01-preview/examples/ProfessionalService/ProfessionalServiceEnrollmentGet.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/professionalservice/resource-manager/readme.md
json: 2020-11-01-preview/examples/ProfessionalService/ProfessionalServiceEnrollmentPut.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/professionalservice/resource-manager/readme.md
json: 2020-11-01-preview/examples/ProfessionalService/ProfessionalServiceGet.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/professionalservice/resource-manager/readme.md
json: 2020-11-01-preview/examples/ProfessionalService/ProfessionalServicePut.json
UNREFERENCED_JSON_FILE The swagger JSON file is not referenced from the readme file.
readme: specification/professionalservice/resource-manager/readme.md
json: Microsoft.ProfessionalService/preview/2020-11-01-preview/professionalservice.json
️❌ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
Rule Message
API Readiness check failed. Please make sure your service is deployed. "code: AuthorizationFailed,
message: The client '7904a8be-825f-480e-a728-80a70579dba4' with object id '7904a8be-825f-480e-a728-80a70579dba4' does not have authorization to perform action 'Microsoft.ProfessionalService/operations/read' over scope '/providers/Microsoft.ProfessionalService' or the scope is invalid. If access was recently granted,
please refresh your credentials."
️⚠️~[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]
️️✔️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: 8 Errors, 0 Warnings failed [Detail]
Rule Message
HowToFix Code style issues found
path: 2020-11-01-preview/examples/OperationResults/Get.json
HowToFix Code style issues found
path: 2020-11-01-preview/examples/ProfessionalService/ProfessionalServiceDelete.json
HowToFix Code style issues found
path: 2020-11-01-preview/examples/ProfessionalService/ProfessionalServiceEnrollmentDelete.json
HowToFix Code style issues found
path: 2020-11-01-preview/examples/ProfessionalService/ProfessionalServiceEnrollmentGet.json
HowToFix Code style issues found
path: 2020-11-01-preview/examples/ProfessionalService/ProfessionalServiceEnrollmentPut.json
HowToFix Code style issues found
path: 2020-11-01-preview/examples/ProfessionalService/ProfessionalServiceGet.json
HowToFix Code style issues found
path: 2020-11-01-preview/examples/ProfessionalService/ProfessionalServicePut.json
HowToFix Code style issues found
path: Microsoft.ProfessionalService/preview/2020-11-01-preview/professionalservice.json
️❌SpellCheck: 1 Errors, 0 Warnings failed [Detail]
Rule Message
HowToFix Unknown word (biling), please fix the error or add words to ./custom-words.txt
path: Microsoft.ProfessionalService/preview/2020-11-01-preview/professionalservice.json#L731:33
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️❌PR Summary: 0 Errors, 0 Warnings failed [Detail]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Feb 22, 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 failed [Detail]
  • Code Generator Failed [Logs] Generate from 4d3a0ecb170a45a4c8ed65a9cf17873d7d680131. 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 major version of npm available! 8.19.3 -> 9.5.1
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.5.1>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
    cmderr	[automation_generate.sh] npm notice
    cmdout	[automation_generate.sh] [Autorest] info    |    Installing AutoRest extension '@autorest/modelerfour' (4.24.3 -> 4.24.3)
    cmdout	[automation_generate.sh] [Autorest] info    |    Installed AutoRest extension '@autorest/modelerfour' (4.24.3->4.24.3)
    cmdout	[automation_generate.sh] [Autorest] info    |    Installing AutoRest extension '@autorest/python' (6.4.0 -> 6.4.0)
    cmdout	[automation_generate.sh] [Autorest] info    |    Installed AutoRest extension '@autorest/python' (6.4.0->6.4.0)
    cmdout	[automation_generate.sh] [Autorest] fatal   | Process() cancelled due to failure
    cmdout	[automation_generate.sh] [Autorest] error   |   Error: Could not read 'file:///mnt/vss/_work/1/s/azure-rest-api-specs/specification/professionalservice/resource-manager/Microsoft.ProfessionalService/stable/2020-05-01/professionalservice.json'.
    cmdout	[automation_generate.sh] [Autorest] error   | Autorest completed with an error. If you think the error message is unclear, or is a bug, please declare an issues at https://github.com/Azure/autorest/issues with the error message you are seeing.
    cmdout	[automation_generate.sh] [Autorest]
    cmdout	[automation_generate.sh] [Autorest] info    |    Loading AutoRest core      '/home/cloudtest/.autorest/@[email protected]/nodemodules/@autorest/core/dist' (3.9.2)
    cmdout	[automation_generate.sh] [Autorest] info    |    Loading AutoRest extension '@autorest/modelerfour' (4.24.3->4.24.3)
    cmdout	[automation_generate.sh] [Autorest] info    |    Loading AutoRest extension '@autorest/python' (6.4.0->6.4.0)
    cmdout	[automation_generate.sh] [Autorest] fatal   | Process() cancelled due to failure
    cmdout	[automation_generate.sh] [Autorest] error   |   Error: Could not read 'file:///mnt/vss/_work/1/s/azure-rest-api-specs/specification/professionalservice/resource-manager/Microsoft.ProfessionalService/stable/2020-05-01/professionalservice.json'.
    cmdout	[automation_generate.sh] [Autorest] error   | Autorest completed with an error. If you think the error message is unclear, or is a bug, please declare an issues at https://github.com/Azure/autorest/issues with the error message you are seeing.
    cmdout	[automation_generate.sh] [Autorest]/mnt/vss/_work/1/s/azure-sdk-for-python_tmp/venv-sdk/auto_temp.json does not exist!!!Error happened during codegen
    error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-python]: sh scripts/automation_generate.sh
    warn	Skip package processing as generation is failed
️❌ azure-sdk-for-java failed [Detail]
  • Pipeline Framework Failed [Logs] Generate from 4d3a0ecb170a45a4c8ed65a9cf17873d7d680131. 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
    command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
    ENOENT: no such file or directory, stat 'azure-sdk-for-java/sdk/professionalservice/azure-resourcemanager-professionalservice/pom.xml'
    Error: ENOENT: no such file or directory, stat 'azure-sdk-for-java/sdk/professionalservice/azure-resourcemanager-professionalservice/pom.xml'
  • azure-resourcemanager-professionalservice [View full logs
    error	Fatal error: ENOENT: no such file or directory, stat 'azure-sdk-for-java/sdk/professionalservice/azure-resourcemanager-professionalservice/pom.xml'
    error	The following packages are still pending:
    error		azure-resourcemanager-professionalservice
️❌ azure-sdk-for-go failed [Detail]
  • Code Generator Failed [Logs] Generate from 4d3a0ecb170a45a4c8ed65a9cf17873d7d680131. 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
    cmderr	[generator automation-v2] [ERROR] total 1 error(s):
    cmderr	[generator automation-v2] [ERROR] failed to execute `go generate` '�[33;1mWARNING: Unable to find version for /mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/professionalservice/armprofessionalservice�[0m
    cmderr	[generator automation-v2] [ERROR] Cannot find go module under resourcemanager/professionalservice/armprofessionalservice, try to build in /mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/professionalservice/armprofessionalservice
    cmderr	[generator automation-v2] [ERROR] ##[command]Cleaning auto-generated files in /mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/professionalservice/armprofessionalservice
    cmderr	[generator automation-v2] [ERROR] ##[command]Executing autorest.go in  /mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/professionalservice/armprofessionalservice
    cmderr	[generator automation-v2] [ERROR] autorest --version=3.8.2 --use=@autorest/[email protected] --go --track2 --output-folder=/mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/professionalservice/armprofessionalservice --clear-output-folder=false --go.clear-output-folder=false --honor-body-placement=false --remove-unreferenced-types=true ./autorest.md
    cmderr	[generator automation-v2] [ERROR] AutoRest code generation utility [cli version: 3.6.1; node: v16.19.1]
    cmderr	[generator automation-v2] [ERROR] (C) 2018 Microsoft Corporation.
    cmderr	[generator automation-v2] [ERROR] https://aka.ms/autorest
    cmderr	[generator automation-v2] [ERROR] info    | AutoRest core version selected from configuration: 3.8.2.
    cmderr	[generator automation-v2] [ERROR] There is a new version of AutoRest available (3.6.3).
    cmderr	[generator automation-v2] [ERROR] > You can install the newer version with with npm install -g autorest@latest
    cmderr	[generator automation-v2] [ERROR] info    |    Loading AutoRest core      '/home/cloudtest/.autorest/@[email protected]/nodemodules/@autorest/core/dist' (3.8.2)
    cmderr	[generator automation-v2] [ERROR] info    |    Installing AutoRest extension '@autorest/go' (4.0.0-preview.45 -> 4.0.0-preview.45)
    cmderr	[generator automation-v2] [ERROR] info    |    Installed AutoRest extension '@autorest/go' (4.0.0-preview.45->4.0.0-preview.45)
    cmderr	[generator automation-v2] [ERROR] info    |    Installing AutoRest extension '@autorest/modelerfour' (4.23.1 -> 4.23.1)
    cmderr	[generator automation-v2] [ERROR] info    |    Installed AutoRest extension '@autorest/modelerfour' (4.23.1->4.23.1)
    cmderr	[generator automation-v2] [ERROR] fatal   | Process() cancelled due to failure
    cmderr	[generator automation-v2] [ERROR] error   |   Error: Could not read 'file:///mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/professionalservice/armprofessionalservice/Microsoft.ProfessionalService/stable/2020-05-01/professionalservice.json'.
    cmderr	[generator automation-v2] [ERROR] error   | Autorest completed with an error. If you think the error message is unclear, or is a bug, please declare an issues at https://github.com/Azure/autorest/issues with the error message you are seeing.
    cmderr	[generator automation-v2] [ERROR] ##[error]Error running autorest.go
    cmderr	[generator automation-v2] [ERROR] build.go:5: running "pwsh": exit status 1
    cmderr	[generator automation-v2] [ERROR] ': exit status 1
    error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go]: generator automation-v2
    warn	Skip package processing as generation is failed
️🔄 azure-sdk-for-js inProgress [Detail]
️❌ azure-resource-manager-schemas failed [Detail]
  • Failed [Logs] Generate from 4d3a0ecb170a45a4c8ed65a9cf17873d7d680131. 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
  • professionalservice/resource-manager [View full logs
️❌ azure-powershell failed [Detail]
  • Failed [Logs] Generate from 4d3a0ecb170a45a4c8ed65a9cf17873d7d680131. 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.professionalservice [View full logs]  [Preview SDK Changes]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

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

@openapi-workflow-bot
Copy link

Hi, @ariehf 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-workflow-bot
    Copy link

    Hi @ariehf This PR was flagged for introducing a new RP namespace that is not being onboarded with RPaaS. Merging this PR to the main branch will be blocked as RPaaS is required for new RPs. To resolve this and allow the PR to be merged into the main branch, please use RPaaS to onboard the new RP.

    @openapi-workflow-bot
    Copy link

    Hi, @{PRAuthor}, our workflow has detected that there is no management SDK ever released for your RP, to further process SDK onboard for your RP, you should have the SDK client library name of your RP reviewed and approved.
    Action Required:

  • Follow this guidance Naming for new initial management or client libraries (new SDKs) - Overview (azure.com) to create an issue for management client library name arch board review.
  • Paste the issue link that you created in step 1 in this PR

  • Impact: SDK release owner will take the approved management client library name to release SDK. No client library name approval will leads to SDK release delayed.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants