-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
Cognitive Services 2024-04-01-preview #28509
Cognitive Services 2024-04-01-preview #28509
Conversation
…ew/2023-10-01-preview to version 2024-04-01-preview
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge. |
Swagger Validation Report
|
Compared specs (v0.10.8) | new version | base version |
---|---|---|
cognitiveservices.json | 2024-04-01-preview(7e7de19) | 2023-05-01(main) |
cognitiveservices.json | 2024-04-01-preview(7e7de19) | 2023-10-01-preview(main) |
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌
LintDiff: 3 Errors, 55 Warnings failed [Detail]
Compared specs (v2.2.2) | new version | base version |
---|---|---|
package-preview-2024-04 | package-preview-2024-04(7e7de19) | 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.
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
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.CognitiveServices/preview/2024-04-01-preview/cognitiveservices.json#L31 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.CognitiveServices/preview/2024-04-01-preview/cognitiveservices.json#L81 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not have default value, property:keySource. Location: Microsoft.CognitiveServices/preview/2024-04-01-preview/cognitiveservices.json#L118 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:name. Location: Microsoft.CognitiveServices/preview/2024-04-01-preview/cognitiveservices.json#L118 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.CognitiveServices/preview/2024-04-01-preview/cognitiveservices.json#L137 |
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.CognitiveServices/preview/2024-04-01-preview/cognitiveservices.json#L152 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.CognitiveServices/preview/2024-04-01-preview/cognitiveservices.json#L181 |
PathForTrackedResourceTypes |
The path must be under a subscription and resource group for tracked resource types. Location: Microsoft.CognitiveServices/preview/2024-04-01-preview/cognitiveservices.json#L237 |
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.CognitiveServices/preview/2024-04-01-preview/cognitiveservices.json#L281 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.CognitiveServices/preview/2024-04-01-preview/cognitiveservices.json#L313 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.CognitiveServices/preview/2024-04-01-preview/cognitiveservices.json#L584 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.CognitiveServices/preview/2024-04-01-preview/cognitiveservices.json#L612 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.CognitiveServices/preview/2024-04-01-preview/cognitiveservices.json#L671 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.CognitiveServices/preview/2024-04-01-preview/cognitiveservices.json#L1076 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.CognitiveServices/preview/2024-04-01-preview/cognitiveservices.json#L1104 |
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.CognitiveServices/preview/2024-04-01-preview/cognitiveservices.json#L1161 |
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.CognitiveServices/preview/2024-04-01-preview/cognitiveservices.json#L1161 |
RequestSchemaForTrackedResourcesMustHaveTags |
A tracked resource MUST always have tags as a top level optional property. Tracked resource does not have tags in the request schema. Location: Microsoft.CognitiveServices/preview/2024-04-01-preview/cognitiveservices.json#L1161 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.CognitiveServices/preview/2024-04-01-preview/cognitiveservices.json#L1205 |
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.CognitiveServices/preview/2024-04-01-preview/cognitiveservices.json#L1220 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.CognitiveServices/preview/2024-04-01-preview/cognitiveservices.json#L1252 |
XmsPageableForListCalls |
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.CognitiveServices/preview/2024-04-01-preview/cognitiveservices.json#L1269 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.CognitiveServices/preview/2024-04-01-preview/cognitiveservices.json#L1297 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:name. Location: Microsoft.CognitiveServices/preview/2024-04-01-preview/cognitiveservices.json#L1492 |
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.CognitiveServices/preview/2024-04-01-preview/cognitiveservices.json#L1525 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.CognitiveServices/preview/2024-04-01-preview/cognitiveservices.json#L1557 |
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.CognitiveServices/preview/2024-04-01-preview/cognitiveservices.json#L1768 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.CognitiveServices/preview/2024-04-01-preview/cognitiveservices.json#L1800 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:name. Location: Microsoft.CognitiveServices/preview/2024-04-01-preview/cognitiveservices.json#L2854 |
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.CognitiveServices/preview/2024-04-01-preview/cognitiveservices.json#L2893 |
️️✔️
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.
️️✔️
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]
Swagger Generation Artifacts
|
Generated ApiView
|
6264cf9
to
4eac467
Compare
4eac467
to
4a8588e
Compare
b5c9112
to
c7e1fa3
Compare
bcced44
to
9899fad
Compare
db68f19
to
a02a89f
Compare
azure-sdk-for-go is blocking merge, please address then request merge again |
It's fixed, thank you so much for your help. @TimLovellSmith |
/pr RequestMerge |
@tianxin-ms I'm working on adding NetworkSecurityPerimeters to common-types, as it seems clearly needed! Please could you help me review the PR? Thanks. #28958 |
} | ||
} | ||
}, | ||
"/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/modelCapacities/{model-format}/{model-name}/{model-version}": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[ARMBlockingComment] Unfortunately I just noticed this and I don't think it follows ARM guidelines - ARM (and RBAC) needs the type/{instance}/type/{instance}/type/{instance} pattern to be followed in resource URLs #Resolved
@tianxin-ms There are some ModelValidation errors to fix now |
This is basically okay. Now that I think of it further, it might be even better just to have one complex filter parameter in line with the well-known 'list resources' API, which allows OData style filtering by e.g. type+region. But I don't think that is actually required, and it could even be added in a future version, if all the filter parameters are optional #Resolved Refers to: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-04-01-preview/cognitiveservices.json:6771 in a2e20e1. [](commit_id = a2e20e1, deletion_comment = False) |
Just wondering - non-blocking -- do you really wish to make it required? Maybe it would be useful to not need to specify all the parameters, and be able to query different subsets? Refers to: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2024-04-01-preview/cognitiveservices.json:6766 in 0a714ec. [](commit_id = 0a714ec, deletion_comment = False) |
Thanks, I just fixed it, a typo |
It's designed to be required, those 3 are all needed to query a "model". We will return bad request, if every of them is missing. |
@TimLovellSmith , the ModelValidation error is fixed now, could you please help us signoff and approve the manifest PR? |
+1 We are waiting for this manifest for over a month now and this is blocking our product release |
* Adds base for updating Microsoft.CognitiveServices from version preview/2023-10-01-preview to version 2024-04-01-preview * Updates readme * Updates API version in new specs and examples * Cognitive Services 2024-04-01-preview * Add NSP APIs * address some error * address lintdiff error * Add list for defender * fix nsp ModelValidation * Add Mode Capacities Apis * fix example * Added properties for models api * Update models APIs * fix a name * Removed getModel * Change an example name * Fix example name * Update NSP APIs * update PutRaiPolicy example * using proxy resource type * Fix example * Remove models API from 04-01-preview * Remove sibling values alongside $ref * Address ModelValidation check * Address comments * fix breaking change * address NSP comments * fix nsp example * fix NSP * fix an example * fix sdk-go * Fix modelCapacities APIs * removed $ --------- Co-authored-by: madhura <[email protected]>
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.