[MachineLearningServices]Add missing kind property in the workspace #26362

ZhidaLiu · 2023-10-25T00:20:17Z

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] ARM review queue (for merge queues, see [4])
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 (for ARM review queue, [1])

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

Viewing API changes

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.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.

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-10-25T00:20:21Z

Next Steps to Merge

✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).

openapi-pipeline-app · 2023-10-25T00:20:22Z

Swagger Validation Report

️❌BreakingChange: 2 Errors, 0 Warnings failed [Detail]

compared swaggers (via Oad v0.10.4)]	new version	base version
machineLearningServices.json	2023-10-01(3efc7dc)	2023-10-01(main)

Rule	Message
`❌` 1041 - AddedPropertyInResponse	The new version has a new property 'kind' in response that was not found in the old version. New: Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json#L2366:7 Old: Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json#L2366:7
`❌` 1045 - AddedOptionalProperty	The new version has a new optional property 'kind' that was not found in the old version. New: Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json#L2366:7 Old: Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json#L2366:7

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

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

There is no credential detected.

️⚠️LintDiff: 0 Warnings warning [Detail]

compared tags (via openapi-validator v2.1.6)	new version	base version
package-2023-10	package-2023-10(3efc7dc)	package-2023-10(main)

The following errors/warnings exist before current PR submission:

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

Rule	Message
`❌` ProvisioningStateSpecifiedForLROPut	201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json#L114
`❌` PutResponseCodes	Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json#L114
`❌` DeleteResponseCodes	Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json#L180
`❌` LroLocationHeader	A 202 response should include an Location response header. Location: Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json#L213
`❌` PostResponseCodes	200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. Location: Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json#L458
`❌` GetCollectionOnlyHasValueAndNextLink	Get endpoints for collections of resources must only have the `value` and `nextLink` properties in their model. Location: Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json#L586
`❌` ResourceNameRestriction	The resource name parameter 'computeName' should be defined with a 'pattern' restriction. Location: Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json#L795
`❌` PatchResponseCodes	Long-running PATCH operations must have responses with 200, 202 and default return codes. They also must not have other response codes. Location: Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json#L933
`❌` PatchIdentityProperty	The patch operation body parameter schema should contain property 'identity'. Location: Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json#L962
`❌` ConsistentPatchProperties	The property 'properties.properties' in the request body either not apppear in the resource model or has the wrong level. Location: Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json#L966
`❌` LroPatch202	The async patch operation should return 202. Location: Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json#L972
`❌` DeleteResponseCodes	Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json#L987
`❌` ResourceNameRestriction	The resource name parameter 'computeName' should be defined with a 'pattern' restriction. Location: Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json#L1049
`❌` CollectionObjectPropertiesNaming	Collection object returned by list operation 'Compute_ListNodes' with 'x-ms-pageable' extension, has no property named 'value'. Location: Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json#L1076
`❌` ResourceNameRestriction	The resource name parameter 'computeName' should be defined with a 'pattern' restriction. Location: Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json#L1140
`❌` ResourceNameRestriction	The resource name parameter 'computeName' should be defined with a 'pattern' restriction. Location: Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json#L1186
`❌` LroLocationHeader	A 202 response should include an Location response header. Location: Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json#L1218
`❌` ResourceNameRestriction	The resource name parameter 'computeName' should be defined with a 'pattern' restriction. Location: Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json#L1230
`❌` LroLocationHeader	A 202 response should include an Location response header. Location: Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json#L1262
`❌` ResourceNameRestriction	The resource name parameter 'computeName' should be defined with a 'pattern' restriction. Location: Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json#L1274
`❌` LroLocationHeader	A 202 response should include an Location response header. Location: Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json#L1306
`❌` GetCollectionOnlyHasValueAndNextLink	Get endpoints for collections of resources must only have the `value` and `nextLink` properties in their model. Location: Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json#L1347
`❌` ResourceNameRestriction	The resource name parameter 'privateEndpointConnectionName' should be defined with a 'pattern' restriction. Location: Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json#L1363
`❌` PutResponseCodes	Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json#L1407
`❌` GetCollectionOnlyHasValueAndNextLink	Get endpoints for collections of resources must only have the `value` and `nextLink` properties in their model. Location: Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json#L1532
`❌` PutResponseCodes	Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json#L1692
`❌` GetCollectionOnlyHasValueAndNextLink	Get endpoints for collections of resources must only have the `value` and `nextLink` properties in their model. Location: Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json#L1905
`❌` DeleteResponseCodes	Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json#L1972
`❌` ProvisioningStateSpecifiedForLROPut	200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json#L2074
`❌` ProvisioningStateSpecifiedForLROPut	201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.MachineLearningServices/stable/2023-10-01/machineLearningServices.json#L2074

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

Validation passes for Avocado.

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

️️✔️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-pipeline-app · 2023-10-25T00:20:23Z