SCOM PP Swagger 2022-09-13-preview FROM Private To PUBLIC by RBANSALMS · Pull Request #25148 · Azure/azure-rest-api-specs

RBANSALMS · 2023-08-03T07:12:25Z

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

[1] public repo review queue, private repo review queue
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label ARMChangesRequested
is removed from your PR. This should cause the label WaitForARMFeedback to be added.
[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue

If you need further help with anything, see Getting help section below.

Purpose of this PR

What's the purpose of this PR? Check all that apply. This is mandatory!

New API version. (Such PR should have been generated with OpenAPI Hub, per this wiki doc.)
Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
Update existing version to fix swagger quality issues in S360.
Other, please clarify:
- edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
I have reviewed following Resource Provider guidelines, including
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to Step 2, "ARM Review", for this PR.

Breaking changes review (Step 1)

If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
you must follow the breaking changes process.
IMPORTANT This applies even if:
- The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
- You believe there is no need for you to request breaking change approval, for any reason.
  Such claims must be reviewed, and the process is the same.

ARM API changes review (Step 2)

If this PR is in purview of ARM review then automation will add the ARMReview label.
If you want to force ARM review, add the label yourself.
Proceed according to the diagram at the top of this comment.

Getting help

For general PR approval workflow, see the diagram at the top of this comment.
For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
and https://aka.ms/ci-fix.
If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

openapi-pipeline-app · 2023-08-03T07:12:28Z

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: 33 Errors, 5 Warnings failed [Detail]

compared tags (via openapi-validator v2.1.3)	new version	base version
package-2022-09-13-preview	package-2022-09-13-preview(18c4270)	default(main)

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

Only 30 items are listed, please refer to log for more details.

Rule	Message	Related RPC [For API reviewers]
`❌` OperationsAPIImplementation	Operations API must be implemented for 'Microsoft.Scom'. Location: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L1
`❌` PathResourceProviderMatchNamespace	The last resource provider 'Microsoft.Scom' doesn't match the namespace. Location: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L50	RPC-Uri-V1-03
`❌` OperationsApiResponseSchema	The response schema of operations API '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scom/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L74
`❌` OperationsApiSchemaUsesCommonTypes	Operations API path must follow the schema provided in the common types. Location: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L75	RPC-Operations-V1-01
`❌` PathResourceProviderMatchNamespace	The last resource provider 'Microsoft.Scom' doesn't match the namespace. Location: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L92	RPC-Uri-V1-03
`❌` PathResourceProviderMatchNamespace	The last resource provider 'Microsoft.Scom' doesn't match the namespace. Location: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L134	RPC-Uri-V1-03
`❌` PathResourceProviderMatchNamespace	The last resource provider 'Microsoft.Scom' doesn't match the namespace. Location: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L173	RPC-Uri-V1-03
`❌` ResourceNameRestriction	The resource name parameter 'instanceName' should be defined with a 'pattern' restriction. Location: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L173	RPC-Uri-V1-05
`❌` PutResponseSchemaDescription	Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L247	RPC-Put-V1-11
`❌` PutResponseSchemaDescription	Description of 201 response code of a PUT operation MUST include term 'create'. Location: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L247	RPC-Put-V1-11
`❌` PatchResponseCode	LRO PATCH must have 200 and 202 return codes. Location: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L277
`❌` LroPatch202	The async patch operation should return 202. Location: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L305	RPC-Patch-V1-06, RPC-Async-V1-08
`❌` LroLocationHeader	A 202 response should include an Location response header. Location: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L359	RPC-Async-V1-07
`❌` PathResourceProviderMatchNamespace	The last resource provider 'Microsoft.Scom' doesn't match the namespace. Location: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L383	RPC-Uri-V1-03
`❌` ResourceNameRestriction	The resource name parameter 'instanceName' should be defined with a 'pattern' restriction. Location: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L383	RPC-Uri-V1-05
`❌` LroPostReturn	200 response for a LRO POST operation must have a response schema specified. Location: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L384	RPC-Post-V1-03
`❌` LroLocationHeader	A 202 response should include an Location response header. Location: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L416	RPC-Async-V1-07
`❌` PathResourceProviderMatchNamespace	The last resource provider 'Microsoft.Scom' doesn't match the namespace. Location: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L437	RPC-Uri-V1-03
`❌` ResourceNameRestriction	The resource name parameter 'instanceName' should be defined with a 'pattern' restriction. Location: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L437	RPC-Uri-V1-05
`❌` LroPostReturn	200 response for a LRO POST operation must have a response schema specified. Location: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L438	RPC-Post-V1-03
`❌` LroLocationHeader	A 202 response should include an Location response header. Location: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L462	RPC-Async-V1-07
`❌` MissingTypeObject	The schema 'OperationsList' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L485
`❌` XmsIdentifierValidation	Missing identifier id in array item property Location: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L488
`❌` MissingTypeObject	The schema 'display' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L511
`❌` MissingTypeObject	The schema 'MonitoringInstance' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L553
`❌` MissingTypeObject	The schema 'MonitoringInstanceProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L579
`❌` XmsIdentifierValidation	Missing identifier id in array item property Location: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L591
`❌` MissingTypeObject	The schema 'ManagementServerProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L651
`❌` MissingTypeObject	The schema 'DomainControllerProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L681
`❌` MissingTypeObject	The schema 'DomainUserCredentials' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L699

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

Validation passes for Avocado.

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

️⚠️~[NotRequired_Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

API Test is not triggered due to precheck failure. Check pipeline log for details.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️TypeSpecAPIView succeeded [Detail] [Expand]

️❌ModelValidation: 6 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` LRO_RESPONSE_HEADER	Long running operation should return location or azure-AsyncOperation in header but not provided Url: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L355:22 ExampleUrl: preview/2022-09-13-preview/examples/Instance_Delete.json
`❌` LRO_RESPONSE_HEADER	Long running operation should return location or azure-AsyncOperation in header but not provided Url: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L412:22 ExampleUrl: preview/2022-09-13-preview/examples/Instance_Scale.json
`❌` LRO_RESPONSE_HEADER	Long running operation should return location or azure-AsyncOperation in header but not provided Url: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L458:22 ExampleUrl: preview/2022-09-13-preview/examples/Instances_PatchServers.json
`❌` LRO_RESPONSE_HEADER	Long running operation should return location or azure-AsyncOperation in header but not provided Url: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L355:22 ExampleUrl: preview/2022-09-13-preview/examples/Instance_Delete.json
`❌` LRO_RESPONSE_HEADER	Long running operation should return location or azure-AsyncOperation in header but not provided Url: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L412:22 ExampleUrl: preview/2022-09-13-preview/examples/Instance_Scale.json
`❌` LRO_RESPONSE_HEADER	Long running operation should return location or azure-AsyncOperation in header but not provided Url: Microsoft.SCOM/preview/2022-09-13-preview/scom.json#L458:22 ExampleUrl: preview/2022-09-13-preview/examples/Instances_PatchServers.json

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

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

️️✔️Automated merging requirements met succeeded [Detail] [Expand]

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

openapi-workflow-bot · 2023-08-03T07:12:28Z

Hi, @RBANSALMS! Thank you for your pull request. To help get your PR merged:

Ensure you reviewed the checklists in the PR description.

Know that PR assignee is the person auto-assigned and responsible for your current PR review and approval.

For convenient view of the API changes made by this PR, refer to the URLs provided in the table in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

openapi-pipeline-app · 2023-08-03T07:12:28Z

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 warning [Detail]

⚠️Warning [Logs] Generate from 60105d0adab5307e2b1d3b71c88ca9c9c9a37c75. 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.6.7 -> 9.8.1
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.8.1>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.8.1` to update!
cmderr	[automation_generate.sh] npm notice
warn	No file changes detected after generation
warn	No package detected after generation

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

⚠️Warning [Logs] Generate from 60105d0adab5307e2b1d3b71c88ca9c9c9a37c75. 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.2.1
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.2.1
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-scom [View full logs] [Preview SDK Changes]

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

️✔️Succeeded [Logs] Generate from 60105d0adab5307e2b1d3b71c88ca9c9c9a37c75. 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/scom/armscom [View full logs] [Preview SDK Changes]
```
info	[Changelog] This is a new package
info	[Changelog]
```

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

️✔️Succeeded [Logs] Generate from 60105d0adab5307e2b1d3b71c88ca9c9c9a37c75. 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-scom [View full logs] [Preview SDK Changes]

azure-arm-scom-1.0.0-beta.1.tgz

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

️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]

️✔️Succeeded [Logs] Generate from 60105d0adab5307e2b1d3b71c88ca9c9c9a37c75. Schema Automation 14.0.0

command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
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

️✔️scom [View full logs] [Preview Schema Changes]

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

openapi-pipeline-app · 2023-08-03T07:12:29Z

Generated ApiView

Language	Package Name	ApiView Link
Swagger	Microsoft.SCOM	https://apiview.dev/Assemblies/Review/d6cca75db61d42d88dc1791c79983ef8
Go	sdk/resourcemanager/scom/armscom	https://apiview.dev/Assemblies/Review/f22e31ad2f2d42e9a0c5db35add5fb10
Java	azure-resourcemanager-scom	https://apiview.dev/Assemblies/Review/c77c2759f8cf4d4492efb02a14c3ef4c
JavaScript	@azure/arm-scom	https://apiview.dev/Assemblies/Review/521ce35d32d04478859be07369311c4c

openapi-workflow-bot · 2023-08-03T07:18:34Z

Hi @RBANSALMS! For review efficiency consideration, when creating a new API version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version.
For more details refer to the wiki.

openapi-workflow-bot · 2023-08-03T07:18:35Z

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

RBANSALMS · 2023-08-03T08:51:40Z

GitHub issue for finalizing name of the NameSpace for SDK:
https://github.com/Azure/azure-sdk-pr/issues/1187

SCOMPPSwagger2022-09-13-preview

7a52fb0

azure-sdk mentioned this pull request Aug 3, 2023

[AutoPR sdk/resourcemanager/scom/armscom] SCOM PP Swagger 2022-09-13-preview FROM Private To PUBLIC azure-sdk/azure-sdk-for-go#6682

Closed

AzureRestAPISpecReview added CI-MissingBaseCommit new-api-version new-rp-namespace resource-manager RPaaS labels Aug 3, 2023

This was referenced Aug 3, 2023

[AutoPR @azure/arm-scom] SCOM PP Swagger 2022-09-13-preview FROM Private To PUBLIC azure-sdk/azure-sdk-for-js#6020

Closed

[AutoPR azure-resourcemanager-scom] SCOM PP Swagger 2022-09-13-preview FROM Private To PUBLIC azure-sdk/azure-sdk-for-java#6337

Closed

RBANSALMS mentioned this pull request Aug 3, 2023

SCOMMI RP From Private To Public #24803

Closed

8 tasks

removing refs of other version APIs files

18c4270

azure-sdk mentioned this pull request Aug 3, 2023

[AutoPR scom] SCOM PP Swagger 2022-09-13-preview FROM Private To PUBLIC azure-sdk/azure-resource-manager-schemas#3004

Draft

RBANSALMS closed this Aug 4, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

SCOM PP Swagger 2022-09-13-preview FROM Private To PUBLIC#25148

SCOM PP Swagger 2022-09-13-preview FROM Private To PUBLIC#25148
RBANSALMS wants to merge 2 commits intomainfrom
SCOMRPPP1

RBANSALMS commented Aug 3, 2023 •

edited

Loading

Uh oh!

openapi-pipeline-app bot commented Aug 3, 2023 •

edited

Loading

Uh oh!

openapi-workflow-bot bot commented Aug 3, 2023

Uh oh!

openapi-pipeline-app bot commented Aug 3, 2023 •

edited

Loading

Breaking Changes Tracking

Uh oh!

openapi-pipeline-app bot commented Aug 3, 2023 •

edited

Loading

Uh oh!

openapi-workflow-bot bot commented Aug 3, 2023

Uh oh!

openapi-workflow-bot bot commented Aug 3, 2023

Uh oh!

RBANSALMS commented Aug 3, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Comments

Conversation

RBANSALMS commented Aug 3, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Purpose of this PR

Due diligence checklist

Breaking changes review (Step 1)

ARM API changes review (Step 2)

Getting help

Uh oh!

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

Uh oh!

Swagger Validation Report

Uh oh!

openapi-workflow-bot bot commented Aug 3, 2023

Uh oh!

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

Uh oh!

Swagger Generation Artifacts

Breaking Changes Tracking

Uh oh!

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

Uh oh!

Generated ApiView

Uh oh!

openapi-workflow-bot bot commented Aug 3, 2023

Uh oh!

openapi-workflow-bot bot commented Aug 3, 2023

Uh oh!

RBANSALMS commented Aug 3, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

RBANSALMS commented Aug 3, 2023 •

edited

Loading

openapi-pipeline-app bot commented Aug 3, 2023 •

edited

Loading

openapi-pipeline-app bot commented Aug 3, 2023 •

edited

Loading

openapi-pipeline-app bot commented Aug 3, 2023 •

edited

Loading