Cadl dpg add convenience api

[weidongxu-microsoft]

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 engagement record.

• Link to 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 Open API document (swagger) if applicable, and the root paths that have been updated.}

• Design Document:
• Previous Open API Doc:
• Updated paths:

❔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

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

Helpful Links

• Azure DevTools Wiki

[openapi-workflow-bot]

Hi, @weidongxu-microsoft Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

[openapi-pipeline-app]

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.

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

Validation passes for Avocado.

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

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

️️✔️PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️❌CadlValidation: 2 Errors, 20 Warnings failed [Detail]

Rule	Message
❌ MissingExamplesDirectory	"details":"The 'examples' directory is missing in the cadl folder specification/cognitiveservices/data-plane/AnomalyDetector/stable/v1.1/cadl, please ensure the 'examples' is added in the PR."
❌ SwaggerNotExistInPR	"details":"the generated swagger file v1.1/openapi.json from cadl specification/cognitiveservices/data-plane/AnomalyDetector/stable/v1.1/cadl is not in the PR, please make sure it presents into the PR."
⚠️ @azure-tools/cadl-azure-core/documentation-required	The ModelProperty named 'x-ms-error' should have a documentation or description, please use decorator @doc to add it. Location: v1.1/cadl/univariate/models.cadl#L180
⚠️ @azure-tools/cadl-azure-core/documentation-required	The ModelProperty named 'body' should have a documentation or description, please use decorator @doc to add it. Location: v1.1/cadl/univariate/routes.cadl#L21
⚠️ @azure-tools/cadl-azure-core/documentation-required	The ModelProperty named 'body' should have a documentation or description, please use decorator @doc to add it. Location: v1.1/cadl/univariate/routes.cadl#L33
⚠️ @azure-tools/cadl-azure-core/documentation-required	The ModelProperty named 'body' should have a documentation or description, please use decorator @doc to add it. Location: v1.1/cadl/univariate/routes.cadl#L42
⚠️ @azure-tools/cadl-azure-core/documentation-required	The Model named 'ErrorResponse' should have a documentation or description, please use decorator @doc to add it. Location: v1.1/cadl/multivariate/models.cadl#L80
⚠️ @azure-tools/cadl-azure-core/documentation-required	The Model named 'AnomalyState' should have a documentation or description, please use decorator @doc to add it. Location: v1.1/cadl/multivariate/models.cadl#L142
⚠️ @azure-tools/cadl-azure-core/documentation-required	The Model named 'AnomalyValue' should have a documentation or description, please use decorator @doc to add it. Location: v1.1/cadl/multivariate/models.cadl#L151
⚠️ @azure-tools/cadl-azure-core/documentation-required	The Model named 'AnomalyInterpretation' should have a documentation or description, please use decorator @doc to add it. Location: v1.1/cadl/multivariate/models.cadl#L173
⚠️ @azure-tools/cadl-azure-core/documentation-required	The Model named 'CorrelationChanges' should have a documentation or description, please use decorator @doc to add it. Location: v1.1/cadl/multivariate/models.cadl#L185
⚠️ @azure-tools/cadl-azure-core/documentation-required	The ModelProperty named 'variableStates' should have a documentation or description, please use decorator @doc to add it. Location: v1.1/cadl/multivariate/models.cadl#L267
⚠️ @azure-tools/cadl-azure-core/documentation-required	The Model named 'LastDetectionRequest' should have a documentation or description, please use decorator @doc to add it. Location: v1.1/cadl/multivariate/models.cadl#L332
⚠️ @azure-tools/cadl-azure-core/documentation-required	The Model named 'LastDetectionResult' should have a documentation or description, please use decorator @doc to add it. Location: v1.1/cadl/multivariate/models.cadl#L358
⚠️ @azure-tools/cadl-azure-core/documentation-required	The ModelProperty named 'results' should have a documentation or description, please use decorator @doc to add it. Location: v1.1/cadl/multivariate/models.cadl#L360
⚠️ @azure-tools/cadl-azure-core/documentation-required	The ModelProperty named 'resultId' should have a documentation or description, please use decorator @doc to add it. Location: v1.1/cadl/multivariate/routes.cadl#L19
⚠️ @azure-tools/cadl-azure-core/documentation-required	The ModelProperty named 'body' should have a documentation or description, please use decorator @doc to add it. Location: v1.1/cadl/multivariate/routes.cadl#L38
⚠️ @azure-tools/cadl-azure-core/use-standard-operations	Operation 'ListMultivariateModels' should be defined using a signature from the Azure.Core namespace. Location: v1.1/cadl/multivariate/routes.cadl#L46
⚠️ @azure-tools/cadl-azure-core/use-standard-operations	Operation 'GetMultivariateModel' should be defined using a signature from the Azure.Core namespace. Location: v1.1/cadl/multivariate/routes.cadl#L77
⚠️ @azure-tools/cadl-azure-core/documentation-required	The ModelProperty named 'body' should have a documentation or description, please use decorator @doc to add it. Location: v1.1/cadl/multivariate/routes.cadl#L106
⚠️ @azure-tools/cadl-azure-core/casing-style	The names of Property types must use camelCase Location: v1.1/cadl/multivariate/routes.cadl#L111
⚠️ @azure-tools/cadl-azure-core/documentation-required	The ModelProperty named 'body' should have a documentation or description, please use decorator @doc to add it. Location: v1.1/cadl/multivariate/routes.cadl#L129

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

Validation passes for Summary.

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

[openapi-pipeline-app]

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️⚠️ azure-sdk-for-net-track2 warning [Detail]

• ⚠️Warning [Logs] Generate from a077d5bba7c0049f6a96a80415840300066c83df. 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
  warn	File azure-sdk-for-net_tmp/initOutput.json not found to read
  warn		specification/cognitiveservices/data-plane/AnomalyDetector/stable/v1.1/cadl/cadl-project.yaml skipped due to azure-sdk-for-net-track2 not found in cadl-project.yaml
  command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
  warn	No file changes detected after generation
  warn	Skip detect changed packages

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

• ⚠️Warning [Logs] Generate from a077d5bba7c0049f6a96a80415840300066c83df. 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: Skipping azure-nspkg as it is not installed.
  warn		specification/cognitiveservices/data-plane/AnomalyDetector/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! 8.19.2 -> 9.1.2
  cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.1.2>
  cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.1.2` to update!
  cmderr	[automation_generate.sh] npm notice
  warn	No file changes detected after generation
  warn	No package detected after generation

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

[openapi-pipeline-app]

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

[lmazuel]

Don't merge please