Support.json Get Support Ticket serviceId + ProbClassId filter changes by devinlstoen · Pull Request #19117 · Azure/azure-rest-api-specs

devinlstoen · 2022-05-18T02:20:51Z

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Add a changelog entry for this PR by answering the following questions:

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
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.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No refresh required for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

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 appy 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 are using OpenAPIHub to initialize the PR for adding a new version. 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

Removing API(s) in a stable version
Removing properties in a stable version
Removing API version(s) in a stable version
Updating API in a stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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

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

openapi-workflow-bot · 2022-05-18T02:20:55Z

Hi, @devinlstoen 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 · 2022-05-18T02:20:55Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

Compared Swaggers (Based on Oad v0.9.5)
- current:stable/2020-04-01/support.json compared with base:stable/2020-04-01/support.json

️⚠️LintDiff: 0 Warnings warning [Detail]

Linted configuring files (Based on source branch, openapi-validator v1.13.0 , classic-openapi-validator v1.2.4 )
- support/resource-manager/readme.md tag:package-2020-04
Linted configuring files (Based on target branch, openapi-validator v1.13.0 , classic-openapi-validator v1.2.4 )
- support/resource-manager/readme.md tag:package-2020-04

The following errors/warnings exist before current PR submission:

Rule	Message
`❌` R4018 - OperationsApiResponseSchema	The response schema of operations API '/providers/Microsoft.Support/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.Support/stable/2020-04-01/support.json#L37
`❌` R4037 - MissingTypeObject	The schema 'OperationsListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Support/stable/2020-04-01/support.json#L789
`❌` R4037 - MissingTypeObject	The schema 'display' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Support/stable/2020-04-01/support.json#L813
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: nameAvailable Location: Microsoft.Support/stable/2020-04-01/support.json#L975
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: require24X7Response Location: Microsoft.Support/stable/2020-04-01/support.json#L1182

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ApiReadinessCheck succeeded [Detail] [Expand]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️❌PoliCheck: 0 Errors, 0 Warnings failed [Detail]

️️✔️SDK Track2 Validation succeeded [Detail] [Expand]

Validation passes for SDKTrack2Validation

The following tags are being changed in this PR

support/resource-manager/readme.md#package-2020-04

️️✔️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).

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2022-05-18T02:20:56Z

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-go-track2 - armsupport - 1.0.1
️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-support - 6.0.0
️✔️azure-sdk-for-go - support/mgmt/2020-04-01/support - v65.0.0
️✔️azure-sdk-for-go - preview/support/mgmt/2019-05-01-preview/support - v65.0.0

️⚠️ azure-sdk-for-python-track2 warning [Detail]

⚠️Warning [Logs]Release - Generate from 8dac2fe. 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]  config global `--global`, `--local` are deprecated. Use `--location=global` instead.

️✔️track2_azure-mgmt-support [View full logs] [Release SDK Changes]
- azure_mgmt_support-1.0.0b1-py3-none-any.whl
- azure-mgmt-support-1.0.0b1.zip
```
info	[Changelog]
```

️⚠️ azure-sdk-for-java warning [Detail]

⚠️Warning [Logs]Release - Generate from 8dac2fe. 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
cmderr	[generate.py] SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
cmderr	[generate.py] SLF4J: Defaulting to no-operation (NOP) logger implementation
cmderr	[generate.py] SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.

️✔️azure-resourcemanager-support [View full logs] [Release SDK Changes]

️⚠️ azure-sdk-for-js warning [Detail]

⚠️Warning [Logs]Release - Generate from 8dac2fe. 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
cmderr	[automation_init.sh]  deprecated read-package-tree@5.1.6: The functionality that this package provided is now in @npmcli/arborist
cmderr	[automation_init.sh] deprecated uuid@3.4.0: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
cmderr	[automation_init.sh] npm WARN deprecated @opentelemetry/types@0.2.0: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
cmderr	[automation_init.sh] WARN deprecated @azure/storage-blob@10.5.0: This version has been deprecated, please upgrade to the version tagged as latest
cmderr	[automation_init.sh] npm WARN @octokit/plugin-request-log@1.0.4 requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
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-support [View full logs] [Release SDK Changes]

azure-arm-support-2.0.3.tgz

info	[Changelog]
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 8dac2fe. SDK Automation 14.0.0

command	sh ./eng/initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️support/mgmt/2020-04-01/support [View full logs] [Release SDK Changes]

info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).

️✔️preview/support/mgmt/2019-05-01-preview/support [View full logs]

info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).

️️✔️ azure-sdk-for-go-track2 succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 8dac2fe. 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

️✔️armsupport [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-net failed [Detail]

❌Failed [Logs]Release - Generate from 8dac2fe. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	sudo apt-get install -y dotnet-sdk-6.0
command	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/support/resource-manager/readme.md
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] No usable version of the libssl was found
cmderr	[Autorest] FATAL: csharp/simplifier - FAILED
cmderr	[Autorest] FATAL: Error: [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
cmderr	[Autorest] Process() cancelled due to exception : [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: autorest
warn	Skip package processing as generation is failed

️⚠️ azure-resource-manager-schemas warning [Detail]

⚠️Warning [Logs]Release - Generate from 8dac2fe. 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]  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

️✔️support [View full logs]

️️✔️ azure-powershell succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 8dac2fe. 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.Support [View full logs] [Release SDK Changes]
- Az.Support.0.1.0.nupkg

_{Posted by Swagger Pipeline | How to fix these errors?}

ruowan · 2022-05-19T01:50:52Z

/azp run

azure-pipelines · 2022-05-19T01:51:01Z

Azure Pipelines successfully started running 1 pipeline(s).

raosuhas

tadelesh · 2022-06-08T05:09:31Z

/azp run

azure-pipelines · 2022-06-08T05:09:40Z

Azure Pipelines successfully started running 1 pipeline(s).

openapi-workflow-bot · 2022-06-08T05:11:32Z

Hi @devinlstoen, 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.

Task	How to fix	Priority
Avocado	Fix-Avocado	High
Semantic validation	Fix-SemanticValidation-Error	High
Model validation	Fix-ModelValidation-Error	High
LintDiff	Fix-LintDiff	high

If you need further help, please feedback via swagger feedback.

openapi-workflow-bot · 2022-06-08T05:11:32Z

Hi @devinlstoen, 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.

Task	How to fix	Priority
Avocado	Fix-Avocado	High
Semantic validation	Fix-SemanticValidation-Error	High
Model validation	Fix-ModelValidation-Error	High
LintDiff	Fix-LintDiff	high

If you need further help, please feedback via swagger feedback.

tadelesh · 2022-06-08T05:30:12Z

@devinlstoen Please address the Avocado and PrettierCheck error.

devinlstoen · 2022-06-08T22:00:16Z

/azp run

@devinlstoen Please address the Avocado and PrettierCheck error.

Hello, I addressed the Avocado and PrettierCheck errors.

devinlstoen · 2022-06-08T22:41:33Z

/azp run

@devinlstoen Please address the Avocado and PrettierCheck error.

Hello, I addressed the Avocado and PrettierCheck errors.

I have a question about the filter parameters. Should I include the entire

problem classification id ("/providers/Microsoft.Support/services/service_guid/problemClassifications/compute_vm_problemClassification_guid",)

and service id ("/providers/Microsoft.Support/services/vm_windows_service_guid/problemClassifications/problemClassification_guid")

in the filter request?

Or am I fine just requiring the guid? (i.e "$filter": "ProblemClassificationId eq 'compute_vm_problemClassification_guid'")

tadelesh · 2022-06-09T02:14:53Z

/azp run

@devinlstoen Please address the Avocado and PrettierCheck error.

Hello, I addressed the Avocado and PrettierCheck errors.

I have a question about the filter parameters. Should I include the entire

problem classification id ("/providers/Microsoft.Support/services/service_guid/problemClassifications/compute_vm_problemClassification_guid",)

and service id ("/providers/Microsoft.Support/services/vm_windows_service_guid/problemClassifications/problemClassification_guid")

in the filter request?

Or am I fine just requiring the guid? (i.e "$filter": "ProblemClassificationId eq 'compute_vm_problemClassification_guid'")

for the list operation, filter is ok.

Support.json Get Support Ticket serviceId + ProbClassId filter changes

7f38b70

openapi-assignment-bot bot assigned tadelesh May 18, 2022

Add list tickets service + probClassId examples

193e306

raosuhas approved these changes Jun 8, 2022

View reviewed changes

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label Jun 8, 2022

Reference example files in support.json

875d2b2

openapi-pipeline-app bot removed the CI-FixRequiredOnFailure label Jun 8, 2022

devinlstoen added 2 commits June 8, 2022 11:09

List Support tickets example files formatting

08f8186

Service Id problem class id example prettier format fix

9bc9291

tadelesh merged commit 8dac2fe into Azure:main Jun 9, 2022

azure-sdk mentioned this pull request Jun 9, 2022

[ReleasePR armsupport] Support.json Get Support Ticket serviceId + ProbClassId filter changes Azure/azure-sdk-for-go#18343

Closed

Conversation

devinlstoen commented May 18, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

Uh oh!

openapi-workflow-bot bot commented May 18, 2022

Uh oh!

openapi-pipeline-app bot commented May 18, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Validation Report

Uh oh!

openapi-pipeline-app bot commented May 18, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Generation Artifacts

Breaking Changes Tracking

Uh oh!

ruowan commented May 19, 2022

Uh oh!

azure-pipelines bot commented May 19, 2022

Uh oh!

raosuhas left a comment

Choose a reason for hiding this comment

Uh oh!

tadelesh commented Jun 8, 2022

Uh oh!

azure-pipelines bot commented Jun 8, 2022

Uh oh!

openapi-workflow-bot bot commented Jun 8, 2022

Uh oh!

openapi-workflow-bot bot commented Jun 8, 2022

Uh oh!

tadelesh commented Jun 8, 2022

Uh oh!

devinlstoen commented Jun 8, 2022

Uh oh!

devinlstoen commented Jun 8, 2022

Uh oh!

tadelesh commented Jun 9, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Comments

devinlstoen commented May 18, 2022 •

edited

Loading

openapi-pipeline-app bot commented May 18, 2022 •

edited

Loading

openapi-pipeline-app bot commented May 18, 2022 •

edited

Loading

tadelesh commented Jun 9, 2022 •

edited

Loading