[Cognitive Services - Azure AI Content Safety] - 2023-10-15-preview Public Preview #25570
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| contentsafety.json | 2023-10-01(ec6e686) | 2023-10-01(main) |
️⚠️Breaking Change(Cross-Version): 24 Warnings warning [Detail]
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| contentsafety.json | 2023-10-15-preview(ec6e686) | 2023-10-01(main) |
| contentsafety.json | 2023-10-15-preview(ec6e686) | 2023-04-30-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 2 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| package-2023-10-01 | package-2023-10-01(ec6e686) | package-2023-10-01(main) |
| package-2023-10-15-preview | package-2023-10-15-preview(ec6e686) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: ContentSafety/preview/2023-10-15-preview/contentsafety.json#L1003 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: ContentSafety/preview/2023-10-15-preview/contentsafety.json#L1060 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
Per the Noun_Verb convention for Operation Ids, the noun 'TextBlocklists' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: ContentSafety/preview/2023-10-15-preview/contentsafety.json#L110 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'TextBlocklists' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: ContentSafety/preview/2023-10-15-preview/contentsafety.json#L150 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'TextBlocklists' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: ContentSafety/preview/2023-10-15-preview/contentsafety.json#L194 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'TextBlocklists' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: ContentSafety/preview/2023-10-15-preview/contentsafety.json#L256 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'TextBlocklists' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: ContentSafety/preview/2023-10-15-preview/contentsafety.json#L406 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'TextBlocklists' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: ContentSafety/preview/2023-10-15-preview/contentsafety.json#L464 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'TextBlocklists' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: ContentSafety/stable/2023-10-01/contentsafety.json#L110 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'TextBlocklists' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: ContentSafety/stable/2023-10-01/contentsafety.json#L150 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'TextBlocklists' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: ContentSafety/stable/2023-10-01/contentsafety.json#L194 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'TextBlocklists' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: ContentSafety/stable/2023-10-01/contentsafety.json#L256 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'TextBlocklists' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: ContentSafety/stable/2023-10-01/contentsafety.json#L406 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'TextBlocklists' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: ContentSafety/stable/2023-10-01/contentsafety.json#L464 |
| Security definition should have a description. Location: ContentSafety/preview/2023-10-15-preview/contentsafety.json#L46 |
|
| Security definition should have a description. Location: ContentSafety/preview/2023-10-15-preview/contentsafety.json#L51 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: ContentSafety/preview/2023-10-15-preview/contentsafety.json#L63 |
|
| 'PATCH' operation 'TextBlocklists_CreateOrUpdateTextBlocklist' should use method name 'Update'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: ContentSafety/preview/2023-10-15-preview/contentsafety.json#L194 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: ContentSafety/preview/2023-10-15-preview/contentsafety.json#L298 |
|
| Path parameter should specify characters allowed (pattern). Location: ContentSafety/preview/2023-10-15-preview/contentsafety.json#L480 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: ContentSafety/preview/2023-10-15-preview/contentsafety.json#L517 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: ContentSafety/preview/2023-10-15-preview/contentsafety.json#L800 |
|
| Schema name should be Pascal case. Location: ContentSafety/preview/2023-10-15-preview/contentsafety.json#L890 |
|
| Schema name should be Pascal case. Location: ContentSafety/preview/2023-10-15-preview/contentsafety.json#L924 |
|
| Schema name should be Pascal case. Location: ContentSafety/preview/2023-10-15-preview/contentsafety.json#L937 |
|
| Security definition should have a description. Location: ContentSafety/stable/2023-10-01/contentsafety.json#L46 |
|
| Security definition should have a description. Location: ContentSafety/stable/2023-10-01/contentsafety.json#L51 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: ContentSafety/stable/2023-10-01/contentsafety.json#L63 |
|
| 'PATCH' operation 'TextBlocklists_CreateOrUpdateTextBlocklist' should use method name 'Update'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: ContentSafety/stable/2023-10-01/contentsafety.json#L194 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: ContentSafety/stable/2023-10-01/contentsafety.json#L298 |
|
| Path parameter should specify characters allowed (pattern). Location: ContentSafety/stable/2023-10-01/contentsafety.json#L480 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: ContentSafety/stable/2023-10-01/contentsafety.json#L517 |
️️✔️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
|
|
issue link in private repo: https://github.com/Azure/azure-rest-api-specs-pr/issues/13971 |
This was referenced Aug 29, 2023
mikekistler
approved these changes
Aug 29, 2023
heaths
requested changes
Aug 29, 2023
mikekistler
requested changes
Aug 30, 2023
There was a problem hiding this comment.
This looks good but let's hold off merging until #25498 merges.
Hi @heaths, sorry for the confusion, this PR has been changed a lot since it's open, because there are much releasing plan adjustment from our side. We will avoid this by abandon old PR and creating a new version number and PR if there is big feature release scope change in the future. We may still hold this PR for one or two weeks to wait our SDK GA code complete, I will ask for your approval when it's ready to merge. Thanks! |
|
Can you convert it to a draft PR then, please? That helps a lot when triaging reviews. |
mikekistler
requested changes
Dec 6, 2023
weidongxu-microsoft
approved these changes
Dec 8, 2023
|
Another SDK comment is that the new operation should be added to client.tsp https://github.com/Azure/azure-rest-api-specs/blob/13a27780750b3130bf7aab374b523093c4560a6a/specification/cognitiveservices/ContentSafety/client.tsp |
Thanks for reminding, added the two new APIs to client.tsp |
heaths
approved these changes
Dec 8, 2023
arifibrahim4
pushed a commit
that referenced
this pull request
Feb 26, 2024
…ublic Preview (#25570) * Add ga contract for Content Safety * Update examples for 2023-10-01 * Resolve ModelValidation SpellCheck and Avocado * Fix typo * Fix minor errors in example and readme * Fix example * remove the 0430 content * update readme * re-format markdowm * Fix example * init content safety 2023-10-15-preview * init content safety 2023-10-15-previwe * update * format example * update read me file * update * update * update contract * update * update * update threshold * update new contract by add judgement kind enum * update description * u * update * updat length * update * update * update description for accept severity threshodl * update * merge with acs-ga * Add snippy contract * remove 8 sev levels for image * update contentsafety.json * Update snippy path * add type spec for jailbreak * compiled * update * update * refine * update * make 0,1,2,3,4,5,6,7 to 0, 1, 2, 3, ... and add comman in last enum value * update path * Update NL Snippy path * Resolve conflict * Update protected material API * update project sample * Change path name * Update protect material contract * update jailbreak * Remove project related contract (#20) * Remove project related things * Remove accepted * Remove examples * Merge main and recompile swagger * remove new version enum from GA version * Remove examples from 1015 * restore examples * Add examples for jailbreak and protected material * run prettier for example * commit add enum to stable * Add omit-unreachable-types: true to typespec * compile preview * Fix readme * remove blocklistItemId from AddOrUpdateBlocklistItems example * Resolve sdk issues * Fix typo --------- Co-authored-by: mengaims <mengai@microsoft.com> Co-authored-by: Lixiang Liu <lixiangliu@microsoft.com> Co-authored-by: Lixiang Liu <liulixiang1988@gmail.com> Co-authored-by: zhaiyutong <mo.huainian@163.com> Co-authored-by: mengaims <50131889+mengaims@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Data Plane API - Pull Request
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.
Is this review for (select one):
Change Scope
This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.
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 ApiViewcomment 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.
❔Got questions? Need additional info?? We are here to help!
Contact us!
The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.
Click here for links to tools, specs, guidelines & other good stuff
Tooling
Guidelines & Specifications
Helpful Links