[Cognitive Services - Azure AI Content Safety] Address comments of sdk languages on GA #26353

JieZhou000 · 2023-10-24T10:02:18Z

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.

Link to API Spec engagement record issue:

Is this review for (select one):

a private preview
a public preview
GA release

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

Design Document:
Previous API Spec Doc:
Updated paths:

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.

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

💬 Teams Channel
💌 email

Click here for links to tools, specs, guidelines & other good stuff

Tooling

Open API validation tools were run on this PR. Go here to see how to fix errors
Spectral Linting
Open API Hub

Guidelines & Specifications

Helpful Links

Azure DevTools Wiki

openapi-pipeline-app · 2023-10-24T10:02:23Z

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-24T10:02:24Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

compared swaggers (via Oad v0.10.4)]	new version	base version
contentsafety.json	2023-10-01(343a71a)	2023-10-01(main)

️️✔️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-01	package-2023-10-01(343a71a)	package-2023-10-01(main)

The following errors/warnings exist before current PR submission:

Rule	Message
`❌` OperationIdNounVerb	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
`❌` OperationIdNounVerb	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
`❌` OperationIdNounVerb	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
`❌` OperationIdNounVerb	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
`❌` OperationIdNounVerb	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
`❌` OperationIdNounVerb	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
⚠️ SecurityDefinitionDescription	Security definition should have a description. Location: ContentSafety/stable/2023-10-01/contentsafety.json#L46
⚠️ SecurityDefinitionDescription	Security definition should have a description. Location: ContentSafety/stable/2023-10-01/contentsafety.json#L51
⚠️ PaginationResponse	Operation might be pageable. Consider adding the x-ms-pageable extension. Location: ContentSafety/stable/2023-10-01/contentsafety.json#L63
⚠️ PatchInOperationName	'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
⚠️ PaginationResponse	Operation might be pageable. Consider adding the x-ms-pageable extension. Location: ContentSafety/stable/2023-10-01/contentsafety.json#L298
⚠️ PathParameterSchema	Path parameter should specify characters allowed (pattern). Location: ContentSafety/stable/2023-10-01/contentsafety.json#L480
⚠️ PaginationResponse	Operation might be pageable. Consider adding the x-ms-pageable extension. Location: ContentSafety/stable/2023-10-01/contentsafety.json#L517
⚠️ EnumInsteadOfBoolean	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/stable/2023-10-01/contentsafety.json#L681
⚠️ SchemaNamesConvention	Schema name should be Pascal case. Location: ContentSafety/stable/2023-10-01/contentsafety.json#L744
⚠️ SchemaNamesConvention	Schema name should be Pascal case. Location: ContentSafety/stable/2023-10-01/contentsafety.json#L778
⚠️ SchemaNamesConvention	Schema name should be Pascal case. Location: ContentSafety/stable/2023-10-01/contentsafety.json#L791
⚠️ SchemaDescriptionOrTitle	Schema should have a description or title. Location: ContentSafety/stable/2023-10-01/contentsafety.json#L1042

️️✔️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]

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

openapi-pipeline-app · 2023-10-24T10:02:25Z

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

⚠️Warning [Logs] Generate from 4539708e7024bad1fcf4854bb1d852f856e2813a. 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: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
cmderr	[automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
warn		specification/cognitiveservices/ContentSafety/tspconfig.yaml skipped due to azure-sdk-for-python-track2 not found in tspconfig.yaml
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
cmderr	[automation_generate.sh] npm notice
cmderr	[automation_generate.sh] npm notice New major version of npm available! 9.8.1 -> 10.2.4
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.4>
cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
cmderr	[automation_generate.sh] npm notice
warn	No file changes detected after generation
warn	No package detected after generation

️❌ azure-sdk-for-net-track2 failed [Detail]

❌Failed [Logs] Generate from 4539708e7024bad1fcf4854bb1d852f856e2813a. SDK Automation 14.0.0

command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/Invoke-GenerateAndBuildV2.ps1:131
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 131 | �[0m               �[36;1mGeneratePackage `�[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m               ~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to build sdk. exit code: False
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m

❌Azure.AI.ContentSafety [View full logs] [Preview SDK Changes]
- Azure.AI.ContentSafety.1.0.0-alpha.20231121.1.nupkg
```
info	[Changelog]
```

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

⚠️Warning [Logs] Generate from 4539708e7024bad1fcf4854bb1d852f856e2813a. 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.3.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.3.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
warn	No file changes detected after generation
warn	No package detected after generation

️✔️azure-ai-contentsafety [View full logs] [Preview SDK Changes]

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

⚠️Warning [Logs] Generate from 4539708e7024bad1fcf4854bb1d852f856e2813a. 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
warn	No file changes detected after generation
warn	No package detected after generation

️✔️@azure-rest/ai-content-safety [View full logs] [Preview SDK Changes]
- azure-rest-ai-content-safety-1.0.0-beta.2.tgz
```
info	[Changelog]
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
```

️⚠️ azure-resource-manager-schemas warning [Detail]

⚠️Warning [Logs] Generate from 4539708e7024bad1fcf4854bb1d852f856e2813a. Schema Automation 14.0.0

command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
cmderr	[initScript.sh] npm notice
cmderr	[initScript.sh] npm notice New major version of npm available! 8.19.4 -> 10.2.4
cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.4>
cmderr	[initScript.sh] npm notice Run `npm install -g [email protected]` to update!
cmderr	[initScript.sh] npm notice
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
warn	Skip detect changed packages

️❌ azure-powershell failed [Detail]

❌Pipeline Framework Failed [Logs] Generate from 4539708e7024bad1fcf4854bb1d852f856e2813a. SDK Automation 14.0.0

command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
warn		specification/cognitiveservices/ContentSafety/tspconfig.yaml skipped due to azure-powershell not found in tspconfig.yaml
command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
SSL error: syscall failure: Broken pipe
Error: SSL error: syscall failure: Broken pipe

⚠️Az.cognitiveservices.DefaultTag [View full logs]

error	Fatal error: SSL error: syscall failure: Broken pipe
error	The following packages are still pending:
error		Az.cognitiveservices.DefaultTag

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

⚠️Warning [Logs] Generate from 4539708e7024bad1fcf4854bb1d852f856e2813a. 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: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
cmderr	[automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
warn		specification/cognitiveservices/data-plane/ContentSafety/readme.md skipped due to azure-sdk-for-python not found in swagger-to-sdk
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
cmderr	[automation_generate.sh]
cmderr	[automation_generate.sh] npm notice New major version of npm available! 9.8.1 -> 10.2.4
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.4>
cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
cmderr	[automation_generate.sh] npm notice

️✔️azure-ai-contentsafety [View full logs] [Preview SDK Changes]
- azure_ai_contentsafety-1.0.0-py3-none-any.whl
- azure-ai-contentsafety-1.0.0.zip
```
info	[Changelog] data-plan skip changelog generation temporarily
```

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

openapi-pipeline-app · 2023-10-24T10:02:26Z

Generated ApiView

Language	Package Name	ApiView Link
Python	azure-ai-contentsafety	https://apiview.dev/Assemblies/Review/586e7dd204304fe89cade4f4ba5de368
Java	azure-ai-contentsafety	https://apiview.dev/Assemblies/Review/7d5664b1c6d04fcba1b7e8f379adb70c
.Net	Azure.AI.ContentSafety	https://apiview.dev/Assemblies/Review/36e2b70e3dd646b981c35691ac106161
JavaScript	@azure-rest/ai-content-safety	https://apiview.dev/Assemblies/Review/2f3f0abc09844721a5e267b47b6e6224
Swagger	cognitiveservices-data-plane-ContentSafety	https://apiview.dev/Assemblies/Review/67fd9b163e634aaba7815a23f58d2517
TypeSpec	ContentSafety	https://apiview.dev/Assemblies/Review/14c49be1b86543848cdd0bf2db4a909e

MaryGao · 2023-10-31T08:18:15Z

/azp run

azure-pipelines · 2023-10-31T08:18:31Z

Azure Pipelines successfully started running 3 pipeline(s).

MaryGao · 2023-11-01T00:44:03Z

/azp run

azure-pipelines · 2023-11-01T00:44:19Z

Azure Pipelines successfully started running 3 pipeline(s).

Rename the options.

specification/cognitiveservices/ContentSafety/routes.tsp

add body annotation.

Zhojie/python 0

rename for java

ContentSafetyImageData

zhaiyutong · 2023-11-14T07:46:01Z

/azp run

azure-pipelines · 2023-11-14T07:46:14Z

Azure Pipelines successfully started running 3 pipeline(s).

specification/cognitiveservices/ContentSafety/models.tsp

specification/cognitiveservices/ContentSafety/client.tsp

openapi-pipeline-app · 2023-11-17T03:08:54Z

Swagger pipeline started successfully. If there is ApiView generated, it will be updated in this comment.

update

update version

* update * update

weidongxu-microsoft · 2023-11-21T05:57:38Z

Let me know when you need it merged.

@MaryGao if you have comment for JS, let Yutong know.

Split the client and rename the variables.

22603c9

JieZhou000 requested a review from yangyuan as a code owner October 24, 2023 10:02

openapi-assignment-bot bot assigned anuchandy Oct 24, 2023

mengaims changed the title ~~Split the client and rename the variables.~~ [[Cognitive Services - Azure AI Content Safety] ] Resolving comments of sdk languages on GA Oct 26, 2023

mengaims changed the title ~~[[Cognitive Services - Azure AI Content Safety] ] Resolving comments of sdk languages on GA~~ [Cognitive Services - Azure AI Content Safety] Address comments of sdk languages on GA Oct 26, 2023

mengaims marked this pull request as draft October 26, 2023 06:43

Update JS package-dir config in tspconfig (#26)

e78d0b9

JieZhou000 and others added 3 commits November 8, 2023 15:19

Add projected name.

86d8146

add doc.

266ff3c

Merge pull request #27 from mengaims/zhojie/csharp_1

8314231

Rename the options.

microsoft-github-policy-service bot added the TypeSpec Authored with TypeSpec label Nov 8, 2023

MaryGao reviewed Nov 13, 2023

View reviewed changes

specification/cognitiveservices/ContentSafety/routes.tsp Outdated Show resolved Hide resolved

MaryGao reviewed Nov 13, 2023

View reviewed changes

specification/cognitiveservices/ContentSafety/routes.tsp Outdated Show resolved Hide resolved

JieZhou000 and others added 5 commits November 13, 2023 17:20

add body annotation.

c06404f

Merge pull request #28 from mengaims/zhojie/csharp-2

28a1844

add body annotation.

add

c60dbf5

add projected name.

82bde69

update

27161e1

JieZhou000 and others added 3 commits November 14, 2023 13:38

Add projected name for python.

bdd7cf8

rename to options.

09d8cdf

Merge pull request #31 from mengaims/zhojie/python_0

5b210b8

Zhojie/python 0

AzureRestAPISpecReview added the data-plane label Nov 14, 2023

JieZhou000 and others added 4 commits November 14, 2023 14:37

rename for java

a9d7727

Merge pull request #32 from mengaims/zhojie/java_0

2fa8f10

rename for java

update

ca02f98

Merge pull request #29 from mengaims/yutongzhai/java-projected-name

570de77

ContentSafetyImageData

zhaiyutong mentioned this pull request Nov 15, 2023

Add AACS GA JAVA SDK Azure/azure-sdk-for-java#37626

Merged

6 tasks

weidongxu-microsoft reviewed Nov 15, 2023

View reviewed changes

specification/cognitiveservices/ContentSafety/models.tsp Outdated Show resolved Hide resolved

weidongxu-microsoft reviewed Nov 15, 2023

View reviewed changes

specification/cognitiveservices/ContentSafety/client.tsp Show resolved Hide resolved

weidongxu-microsoft reviewed Nov 15, 2023

View reviewed changes

specification/cognitiveservices/ContentSafety/client.tsp Outdated Show resolved Hide resolved

JieZhou000 marked this pull request as ready for review November 17, 2023 03:08

yutong-zzzz and others added 5 commits November 21, 2023 10:47

update

4093694

Merge pull request #33 from mengaims/yutongzhai/remove-java-bloburi

27f520c

update

update

802ea57

Merge pull request #34 from mengaims/yutongzhai/fix-version

b8277ee

update version

update files (#35)

343a71a

* update * update

weidongxu-microsoft approved these changes Nov 21, 2023

View reviewed changes

weidongxu-microsoft merged commit 164375e into Azure:main Nov 21, 2023
28 of 30 checks passed

zhaiyutong deleted the zhojie/csharp_0 branch February 2, 2024 08:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Cognitive Services - Azure AI Content Safety] Address comments of sdk languages on GA #26353

[Cognitive Services - Azure AI Content Safety] Address comments of sdk languages on GA #26353

JieZhou000 commented Oct 24, 2023 •

edited by openapi-workflow-bot bot

Loading

openapi-pipeline-app bot commented Oct 24, 2023 •

edited

Loading

openapi-pipeline-app bot commented Oct 24, 2023 •

edited

Loading

openapi-pipeline-app bot commented Oct 24, 2023 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented Oct 24, 2023 •

edited

Loading

MaryGao commented Oct 31, 2023

azure-pipelines bot commented Oct 31, 2023

MaryGao commented Nov 1, 2023

azure-pipelines bot commented Nov 1, 2023

zhaiyutong commented Nov 14, 2023

azure-pipelines bot commented Nov 14, 2023

openapi-pipeline-app bot commented Nov 17, 2023

weidongxu-microsoft commented Nov 21, 2023

[Cognitive Services - Azure AI Content Safety] Address comments of sdk languages on GA #26353

[Cognitive Services - Azure AI Content Safety] Address comments of sdk languages on GA #26353

Conversation

JieZhou000 commented Oct 24, 2023 • edited by openapi-workflow-bot bot Loading

Data Plane API - Pull Request

API Info: The Basics

Change Scope

Viewing API changes

Suppressing failures

❔Got questions? Need additional info?? We are here to help!

Tooling

Guidelines & Specifications

Helpful Links

openapi-pipeline-app bot commented Oct 24, 2023 • edited Loading

Next Steps to Merge

openapi-pipeline-app bot commented Oct 24, 2023 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Oct 24, 2023 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented Oct 24, 2023 • edited Loading

Generated ApiView

MaryGao commented Oct 31, 2023

azure-pipelines bot commented Oct 31, 2023

MaryGao commented Nov 1, 2023

azure-pipelines bot commented Nov 1, 2023

zhaiyutong commented Nov 14, 2023

azure-pipelines bot commented Nov 14, 2023

openapi-pipeline-app bot commented Nov 17, 2023

weidongxu-microsoft commented Nov 21, 2023

JieZhou000 commented Oct 24, 2023 •

edited by openapi-workflow-bot bot

Loading

openapi-pipeline-app bot commented Oct 24, 2023 •

edited

Loading

openapi-pipeline-app bot commented Oct 24, 2023 •

edited

Loading

openapi-pipeline-app bot commented Oct 24, 2023 •

edited

Loading

openapi-pipeline-app bot commented Oct 24, 2023 •

edited

Loading