dpg typespec

[XiaofeiCao]

Data Plane API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

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

Guidelines & Specifications

• Azure REST API Guidelines
• OpenAPI Style Guidelines
• Azure Breaking Change Policy

Helpful Links

• Schedule a data plane REST API spec review

Getting help

• First, please carefully read through this PR description, from top to bottom.
• If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
• To understand what you must do next to merge this PR, see the 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.
• For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
  and https://aka.ms/ci-fix.
• If the PR CI checks appear to be stuck in 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.
• 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-test]

Next Steps to Merge

Next steps that must be taken to merge this PR:

• ❌ The required check named Swagger BreakingChange has failed. To unblock this PR, follow the process at aka.ms/brch.

[openapi-pipeline-app-test]

Swagger Generation Artifacts

️️✔️[ignore this check status; not blocking PR merge] ApiDocPreview succeeded [Detail] [Expand]

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

For more instructions, please refer to the FAQ .
• ⚠️Warning in generating from 52a12f5. 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] W: Target Packages (main/binary-amd64/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
  cmderr	[automation_init.sh] W: Target Packages (main/binary-all/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
  cmderr	[automation_init.sh] W: Target Translations (main/i18n/Translation-en) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
  cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-amd64) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
  cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-all) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
  cmderr	[automation_init.sh] W: Target Packages (main/binary-amd64/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
  cmderr	[automation_init.sh] W: Target Packages (main/binary-all/Packages) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
  cmderr	[automation_init.sh] W: Target Translations (main/i18n/Translation-en) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
  cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-amd64) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
  cmderr	[automation_init.sh] W: Target CNF (main/cnf/Commands-all) is configured multiple times in /etc/apt/sources.list.d/azure-cli.list:1 and /etc/apt/sources.list.d/azure-cli.sources:1
  cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
  cmderr	[automation_init.sh] npm notice
  cmderr	[automation_init.sh] npm notice New minor version of npm available! 10.7.0 -> 10.8.1
  cmderr	[automation_init.sh] npm notice Changelog: https://github.com/npm/cli/releases/tag/v10.8.1
  cmderr	[automation_init.sh] npm notice To update run: npm install -g [email protected]
  cmderr	[automation_init.sh] npm notice
  command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json

• ️✔️azure-ai-contentsafety [Preview SDK Changes]

  info	[Changelog] data-plan skip changelog generation temporarily

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

For more instructions, please refer to the FAQ .
• ❌Code Generator Failed in generating from 52a12f5. 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
  error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1
  warn	Warning: Package processing is skipped as the SDK generation fails. Please look into the above generation errors or report this issue through https://aka.ms/azsdk/support/specreview-channel.

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

For more instructions, please refer to the FAQ .
• ️✔️Succeeded in generating from 52a12f5. 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	Warning: File azure-sdk-for-js_tmp/initOutput.json not found to read. Please re-run the pipeline if the error is transitient error or report this issue through https://aka.ms/azsdk/support/specreview-channel.
  command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
  cmderr	[automation_generate.sh] [ERROR] Generate changelog failed: ENOENT: no such file or directory, open '/mnt/vss/_work/1/s/azure-sdk-for-js/sdk/contentsafety/ai-content-safety-rest/changelog-temp/package/review/rest/ai-content-safety.api.md'

• ️✔️@azure-rest/ai-content-safety [Preview SDK Changes]

  info	[Changelog]
  error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.

️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]

For more instructions, please refer to the FAQ .
• ️✔️Succeeded in generating from 52a12f5. SDK Automation 14.0.0

  command	./eng/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
  command	./eng/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json

• ️✔️azure-ai-contentsafety [Preview SDK Changes] Breaking Change Detected

  info	[Changelog] ### Breaking Changes
  info	[Changelog]
  info	[Changelog] #### `models.AnalyzeTextOptions` was modified
  info	[Changelog]
  info	[Changelog] * `getText()` was removed
  info	[Changelog]
  info	[Changelog] ### Features Added
  info	[Changelog]
  info	[Changelog] #### `models.AddOrUpdateTextBlocklistItemsResult` was modified
  info	[Changelog]
  info	[Changelog] * `toJson(com.azure.json.JsonWriter)` was added
  info	[Changelog] * `fromJson(com.azure.json.JsonReader)` was added
  info	[Changelog]
  info	[Changelog] #### `BlocklistAsyncClient` was modified
  info	[Changelog]
  info	[Changelog] * `createOrUpdateTextBlocklist(java.lang.String,models.TextBlocklist)` was added
  info	[Changelog]
  info	[Changelog] #### `models.AnalyzeTextResult` was modified
  info	[Changelog]
  info	[Changelog] * `toJson(com.azure.json.JsonWriter)` was added
  info	[Changelog] * `fromJson(com.azure.json.JsonReader)` was added
  info	[Changelog]
  info	[Changelog] #### `models.TextBlocklistMatch` was modified
  info	[Changelog]
  info	[Changelog] * `toJson(com.azure.json.JsonWriter)` was added
  info	[Changelog] * `fromJson(com.azure.json.JsonReader)` was added
  info	[Changelog]
  info	[Changelog] #### `models.AnalyzeImageOptions` was modified
  info	[Changelog]
  info	[Changelog] * `toJson(com.azure.json.JsonWriter)` was added
  info	[Changelog] * `fromJson(com.azure.json.JsonReader)` was added
  info	[Changelog]
  info	[Changelog] #### `models.TextBlocklistItem` was modified
  info	[Changelog]
  info	[Changelog] * `toJson(com.azure.json.JsonWriter)` was added
  info	[Changelog] * `fromJson(com.azure.json.JsonReader)` was added
  info	[Changelog]
  info	[Changelog] #### `models.RemoveTextBlocklistItemsOptions` was modified
  info	[Changelog]
  info	[Changelog] * `fromJson(com.azure.json.JsonReader)` was added
  info	[Changelog] * `toJson(com.azure.json.JsonWriter)` was added
  info	[Changelog]
  info	[Changelog] #### `models.TextBlocklist` was modified
  info	[Changelog]
  info	[Changelog] * `fromJson(com.azure.json.JsonReader)` was added
  info	[Changelog] * `toJson(com.azure.json.JsonWriter)` was added
  info	[Changelog]
  info	[Changelog] #### `models.AnalyzeTextOptions` was modified
  info	[Changelog]
  info	[Changelog] * `toJson(com.azure.json.JsonWriter)` was added
  info	[Changelog] * `fromJson(com.azure.json.JsonReader)` was added
  info	[Changelog] * `getText2()` was added
  info	[Changelog]
  info	[Changelog] #### `implementation.JsonMergePatchHelper$TextBlocklistAccessor` was modified
  info	[Changelog]
  info	[Changelog] * `isJsonMergePatch(models.TextBlocklist)` was added
  info	[Changelog]
  info	[Changelog] #### `models.ImageCategoriesAnalysis` was modified
  info	[Changelog]
  info	[Changelog] * `fromJson(com.azure.json.JsonReader)` was added
  info	[Changelog] * `toJson(com.azure.json.JsonWriter)` was added
  info	[Changelog]
  info	[Changelog] #### `models.AnalyzeImageResult` was modified
  info	[Changelog]
  info	[Changelog] * `fromJson(com.azure.json.JsonReader)` was added
  info	[Changelog] * `toJson(com.azure.json.JsonWriter)` was added
  info	[Changelog]
  info	[Changelog] #### `models.AddOrUpdateTextBlocklistItemsOptions` was modified
  info	[Changelog]
  info	[Changelog] * `toJson(com.azure.json.JsonWriter)` was added
  info	[Changelog] * `fromJson(com.azure.json.JsonReader)` was added
  info	[Changelog]
  info	[Changelog] #### `models.ContentSafetyImageData` was modified
  info	[Changelog]
  info	[Changelog] * `toJson(com.azure.json.JsonWriter)` was added
  info	[Changelog] * `fromJson(com.azure.json.JsonReader)` was added
  info	[Changelog]
  info	[Changelog] #### `models.TextCategoriesAnalysis` was modified
  info	[Changelog]
  info	[Changelog] * `fromJson(com.azure.json.JsonReader)` was added
  info	[Changelog] * `toJson(com.azure.json.JsonWriter)` was added
  info	[Changelog]
  info	[Changelog] #### `BlocklistClient` was modified
  info	[Changelog]
  info	[Changelog] * `createOrUpdateTextBlocklist(java.lang.String,models.TextBlocklist)` was added
  info	[Changelog]
  info	[Changelog]

  Parse Suppression File Errors
  No suppression file added.

  Please refer to the guidance for suppressing SDK breaking changes.

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

[openapi-pipeline-app-test]

Generated ApiView

Language	Package Name	ApiView Link
Java	azure-ai-contentsafety	https://apiviewstagingtest.com/Assemblies/Review/85abc443e88f4c26b278ef14dd4c2365?revisionId=7ecb114f2ea94368a64c4134506509cf
.Net	Azure.AI.ContentSafety	https://apiviewstagingtest.com/Assemblies/Review/691f0761a725401a9075ac85acb58dc5?revisionId=d30d5be64a8045089115d5af53a8f2fc
JavaScript	@azure-rest/ai-content-safety	https://apiviewstagingtest.com/Assemblies/Review/0c85a9f11cfd461c8b009eb01c88b4a2?revisionId=4bceabba979a442eb9acfcc2b3c76493
Python	azure-ai-contentsafety	https://apiviewstagingtest.com/Assemblies/Review/b1ce525b31904c30a20c3aa2b734590b?revisionId=8100b191ba1b4ae1bc57a06dbe82af55
TypeSpec	ContentSafety	https://apiviewstagingtest.com/Assemblies/Review/3664b8944c2b4ad288655f7e805b7476?revisionId=818178914d9b4da8a78bc0f5e61316e1

[openapi-pipeline-app-test]

Swagger Validation Report

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

There are no breaking changes.

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

There are no breaking changes.

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

️️✔️[ignore this check status; not blocking PR merge] Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️TypeSpecAPIView succeeded [Detail] [Expand]

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

There is no credential detected.

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

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

Validation passes for Avocado.

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️[ignore this check status; not blocking PR merge] SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️PR Summary succeeded [Detail] [Expand]

️️✔️Automated merging requirements met succeeded [Detail] [Expand]

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

[XiaofeiCao]

/azp run

[azure-pipelines]

No pipelines are associated with this pull request.

[XiaofeiCao]

/azp run

[azure-pipelines]

No pipelines are associated with this pull request.

[azure-pipelines]

No pipelines are associated with this pull request.

[XiaofeiCao]

/azp run

[azure-pipelines]

No pipelines are associated with this pull request.

[XiaofeiCao]

/azp run

[azure-pipelines]

No pipelines are associated with this pull request.

[XiaofeiCao]

/azp run

[azure-pipelines]

No pipelines are associated with this pull request.

[XiaofeiCao]

/azp run

[azure-pipelines]

No pipelines are associated with this pull request.

[XiaofeiCao]

/azp run

[azure-pipelines]

No pipelines are associated with this pull request.

[XiaofeiCao]

/azp run

[azure-pipelines]

No pipelines are associated with this pull request.

[XiaofeiCao]

/azp run

[azure-pipelines]

No pipelines are associated with this pull request.

[XiaofeiCao]

/azp run

[azure-pipelines]

No pipelines are associated with this pull request.

[XiaofeiCao]

/azp run

[azure-pipelines]

No pipelines are associated with this pull request.