-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
[ML] Update deployment API status code from 202 to 201 #28495
Conversation
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see https://aka.ms/azsdk/specreview/merge. |
Swagger Validation Report
|
Compared specs (v0.10.7) | new version | base version |
---|---|---|
workspaceRP.json | 2024-04-01-preview(aab622b) | 2024-01-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
Rule | Message |
---|---|
The new version is missing a client parameter that was found in the old version. Was 'AOAIModelsToDeployParameter' removed or renamed? New: Microsoft.MachineLearningServices/preview/2024-04-01-preview/workspaceRP.json#L6063:3 Old: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L5120:3 |
|
The optional parameter 'aoaiModelsToDeploy' was removed in the new version. Old: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L519:9 |
|
The optional parameter 'aoaiModelsToDeploy' was removed in the new version. Old: Microsoft.MachineLearningServices/preview/2024-01-01-preview/workspaceRP.json#L684:9 |
️⚠️
LintDiff: 0 Warnings warning [Detail]
Compared specs (v2.2.0) | new version | base version |
---|---|---|
package-preview-2024-04 | package-preview-2024-04(aab622b) | package-preview-2024-04(release-machinelearningservices-Microsoft.MachineLearningServices-2024-04-01-preview) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
SecurityDefinitionsStructure |
Every OpenAPI(swagger) spec/configuration must have a security definitions section and it must adhere to the following structure: https://github.com/Azure/azure-openapi-validator/blob/main/docs/security-definitions-structure-validation.md Location: Microsoft.MachineLearningServices/preview/2024-04-01-preview/workspaceRP.json#L1 |
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/preview/2024-04-01-preview/workspaceRP.json#L162 |
ProvisioningStateMustBeReadOnly |
provisioningState property must be set to readOnly. Location: Microsoft.MachineLearningServices/preview/2024-04-01-preview/workspaceRP.json#L252 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:type. Location: Microsoft.MachineLearningServices/preview/2024-04-01-preview/workspaceRP.json#L299 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:keyVaultProperties. Location: Microsoft.MachineLearningServices/preview/2024-04-01-preview/workspaceRP.json#L299 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:keyIdentifier. Location: Microsoft.MachineLearningServices/preview/2024-04-01-preview/workspaceRP.json#L299 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:name. Location: Microsoft.MachineLearningServices/preview/2024-04-01-preview/workspaceRP.json#L299 |
ProvisioningStateMustBeReadOnly |
provisioningState property must be set to readOnly. Location: Microsoft.MachineLearningServices/preview/2024-04-01-preview/workspaceRP.json#L307 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.MachineLearningServices/preview/2024-04-01-preview/workspaceRP.json#L311 |
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/preview/2024-04-01-preview/workspaceRP.json#L328 |
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/preview/2024-04-01-preview/workspaceRP.json#L328 |
ProvisioningStateMustBeReadOnly |
provisioningState property must be set to readOnly. Location: Microsoft.MachineLearningServices/preview/2024-04-01-preview/workspaceRP.json#L366 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:authType. Location: Microsoft.MachineLearningServices/preview/2024-04-01-preview/workspaceRP.json#L588 |
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/preview/2024-04-01-preview/workspaceRP.json#L613 |
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/preview/2024-04-01-preview/workspaceRP.json#L1556 |
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/preview/2024-04-01-preview/workspaceRP.json#L1556 |
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/preview/2024-04-01-preview/workspaceRP.json#L1798 |
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/preview/2024-04-01-preview/workspaceRP.json#L1798 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.MachineLearningServices/preview/2024-04-01-preview/workspaceRP.json#L2453 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.MachineLearningServices/preview/2024-04-01-preview/workspaceRP.json#L2479 |
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/preview/2024-04-01-preview/workspaceRP.json#L2546 |
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/preview/2024-04-01-preview/workspaceRP.json#L2656 |
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/preview/2024-04-01-preview/workspaceRP.json#L2656 |
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/preview/2024-04-01-preview/workspaceRP.json#L2656 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.MachineLearningServices/preview/2024-04-01-preview/workspaceRP.json#L2823 |
ProvisioningStateMustBeReadOnly |
provisioningState property must be set to readOnly. Location: Microsoft.MachineLearningServices/preview/2024-04-01-preview/workspaceRP.json#L2920 |
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/preview/2024-04-01-preview/workspaceRP.json#L2937 |
ProvisioningStateMustBeReadOnly |
provisioningState property must be set to readOnly. Location: Microsoft.MachineLearningServices/preview/2024-04-01-preview/workspaceRP.json#L2978 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.MachineLearningServices/preview/2024-04-01-preview/workspaceRP.json#L3023 |
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/preview/2024-04-01-preview/workspaceRP.json#L3119 |
️️✔️
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.
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️
Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
@ms-henglu it will be great if you can review this PR as this is a fix requested by the staging branch we are trying to merge, you can see the request is from this comment: |
88effb4
into
Azure:release-machinelearningservices-Microsoft.MachineLearningServices-2024-04-01-preview
…024 04 01 preview (#27840) * Adds base for updating Microsoft.MachineLearningServices from version preview/2024-01-01-preview to version 2024-04-01-preview * Updates readme * Updates API version in new specs and examples * Update mfe.json (#28205) * Os Patching Result for ComputeInstance property (#28242) * move ospatching result message to a more appropriate place (#28306) * [ML]WRP 2024-04-01-preview swagger changes (#28311) * changes for 04-01-preview and examples * Fix and run prettier Fix and run prettier * Fix operation Id issue * Fix lint error * small fix on rai policy schema * Fix example * Add missing fix * Fix issue and add suppression * Update example * Fix * Fix example issue * prettier fix * Add description (#28460) * [ML] Update deployment API status code from 202 to 201 (#28495) * Update status code * remove suppression * [ML] Add missing connection APIs in 04-01-preview version (#28662) * Add connection missing APIs * Update example and connection ids * Add missing parameter * Update suppression * Update api --------- Co-authored-by: Brian Hungerman <brianhungerman@gmail.com> Co-authored-by: libc16 <88697960+libc16@users.noreply.github.com> Co-authored-by: ZhidaLiu <zhili@microsoft.com>
…024 04 01 preview (#27840) * Adds base for updating Microsoft.MachineLearningServices from version preview/2024-01-01-preview to version 2024-04-01-preview * Updates readme * Updates API version in new specs and examples * Update mfe.json (#28205) * Os Patching Result for ComputeInstance property (#28242) * move ospatching result message to a more appropriate place (#28306) * [ML]WRP 2024-04-01-preview swagger changes (#28311) * changes for 04-01-preview and examples * Fix and run prettier Fix and run prettier * Fix operation Id issue * Fix lint error * small fix on rai policy schema * Fix example * Add missing fix * Fix issue and add suppression * Update example * Fix * Fix example issue * prettier fix * Add description (#28460) * [ML] Update deployment API status code from 202 to 201 (#28495) * Update status code * remove suppression * [ML] Add missing connection APIs in 04-01-preview version (#28662) * Add connection missing APIs * Update example and connection ids * Add missing parameter * Update suppression * Update api --------- Co-authored-by: Brian Hungerman <brianhungerman@gmail.com> Co-authored-by: libc16 <88697960+libc16@users.noreply.github.com> Co-authored-by: ZhidaLiu <zhili@microsoft.com>
ARM (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting help
section at the bottom of this PR description.Note
As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Click here to see the details of Step 1, Breaking Changes review
If you are in purview of Step 1 of the diagram, follow the Breaking Changes review process.
IMPORTANT! This applies even if you believe your PR was mislabeled, for any reason, including tool failure.
Click here to see the details of Step 2, ARM review
See https://aka.ms/azsdk/pr-arm-review.
Click here to see the diagram footnotes
Diagram footnotes
[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.
Purpose of this PR
What's the purpose of this PR? Check the specific option that applies. This is mandatory!
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:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.
Additional information
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
suppressions guide to get approval.
Getting help
Purpose of this PR
andDue diligence checklist
.Next Steps to Merge
comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queued
state, please add a comment with contents/azp run
.This should result in a new comment denoting a
PR validation pipeline
has started and the checks should be updated after few minutes.