azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Published
20 hours ago •
Azure
Azure
Feature/anomaly detector tsp
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:
❔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
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
Hi, @minkefusiji Thanks for your PR. I am workflow bot for review process. Here are some small tips.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️❌BreakingChange: 71 Errors, 0 Warnings failed [Detail]
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| openapi.json | v1.1(4854f07) | v1.1(main) |
Only 30 items are listed, please refer to log for more details.
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 27 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.3) | new version | base version |
|---|---|---|
| release_1_1 | release_1_1(4854f07) | release_1_1(main) |
[must fix]The following errors/warnings are introduced by current PR:
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 'Multivariate' 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: AnomalyDetector/stable/v1.1/openapi.json#L72 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Multivariate' 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: AnomalyDetector/stable/v1.1/openapi.json#L114 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Multivariate' 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: AnomalyDetector/stable/v1.1/openapi.json#L161 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Multivariate' 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: AnomalyDetector/stable/v1.1/openapi.json#L204 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Multivariate' 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: AnomalyDetector/stable/v1.1/openapi.json#L240 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true.Location: AnomalyDetector/stable/v1.1/openapi.json#L280 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Multivariate' 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: AnomalyDetector/stable/v1.1/openapi.json#L281 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Multivariate' 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: AnomalyDetector/stable/v1.1/openapi.json#L341 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Univariate' 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: AnomalyDetector/stable/v1.1/openapi.json#L391 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Univariate' 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: AnomalyDetector/stable/v1.1/openapi.json#L434 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Univariate' 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: AnomalyDetector/stable/v1.1/openapi.json#L477 |
| :warning: VersionConvention | API version should be a date in YYYY-MM-DD format, optionally suffixed with '-preview'. Location: AnomalyDetector/stable/v1.1/openapi.json#L5 |
| :warning: PageableOperation | Based on the response model schema, operation 'Multivariate_GetMultivariateBatchDetectionResult' might be pageable. Consider adding the x-ms-pageable extension. Location: AnomalyDetector/stable/v1.1/openapi.json#L71 |
| :warning: PaginationResponse | Operation might be pageable. Consider adding the x-ms-pageable extension. Location: AnomalyDetector/stable/v1.1/openapi.json#L71 |
| :warning: VersionPolicy | Operation does not define an 'api-version' query parameter. Location: AnomalyDetector/stable/v1.1/openapi.json#L75 |
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: AnomalyDetector/stable/v1.1/openapi.json#L76 |
| :warning: ErrorResponse | Error response schema should contain an object property named error.Location: AnomalyDetector/stable/v1.1/openapi.json#L100 |
| :warning: VersionPolicy | Operation does not define an 'api-version' query parameter. Location: AnomalyDetector/stable/v1.1/openapi.json#L117 |
| :warning: Post201Response | Using post for a create operation is discouraged. Location: AnomalyDetector/stable/v1.1/openapi.json#L129 |
| :warning: ErrorResponse | Error response schema should contain an object property named error.Location: AnomalyDetector/stable/v1.1/openapi.json#L149 |
| :warning: VersionPolicy | Operation does not define an 'api-version' query parameter. Location: AnomalyDetector/stable/v1.1/openapi.json#L164 |
| :warning: PaginationResponse | Response body schema of pageable response should contain top-level array property valueLocation: AnomalyDetector/stable/v1.1/openapi.json#L175 |
| :warning: ErrorResponse | Error response schema should contain an object property named error.Location: AnomalyDetector/stable/v1.1/openapi.json#L187 |
| :warning: VersionPolicy | Operation does not define an 'api-version' query parameter. Location: AnomalyDetector/stable/v1.1/openapi.json#L207 |
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: AnomalyDetector/stable/v1.1/openapi.json#L208 |
| :warning: ErrorResponse | Error response schema should contain an object property named error.Location: AnomalyDetector/stable/v1.1/openapi.json#L228 |
| :warning: VersionPolicy | Operation does not define an 'api-version' query parameter. Location: AnomalyDetector/stable/v1.1/openapi.json#L243 |
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: AnomalyDetector/stable/v1.1/openapi.json#L244 |
| :warning: ErrorResponse | Error response schema should contain an object property named error.Location: AnomalyDetector/stable/v1.1/openapi.json#L267 |
| :warning: PaginationResponse | Operation might be pageable. Consider adding the x-ms-pageable extension. Location: AnomalyDetector/stable/v1.1/openapi.json#L280 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView 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.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️❌TypeSpec Validation: 3 Errors, 20 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"details":"The 'examples' directory is missing in the typespec folder specification/cognitiveservices/OpenAI.Inference, please ensure the 'examples' is added in the PR." |
|
"details":"The generated swagger file 2022-12-01/openapi.json from typespec specification/cognitiveservices/OpenAI.Inference is not on the branch." |
|
"details":"The generated swagger file 2023-03-15-preview/openapi.json from typespec specification/cognitiveservices/OpenAI.Inference is not on the branch." |
| :warning: @azure-tools/typespec-azure-core/documentation-required | The Enum named 'UnivariateTimeGranularity' should have a documentation or description, please use decorator @doc to add it. Location: cognitiveservices/AnomalyDetector/univariate/models.tsp#L36 |
| :warning: @azure-tools/typespec-azure-core/documentation-required | The EnumMember named 'Yearly' should have a documentation or description, please use decorator @doc to add it. Location: cognitiveservices/AnomalyDetector/univariate/models.tsp#L37 |
| :warning: @azure-tools/typespec-azure-core/documentation-required | The EnumMember named 'Monthly' should have a documentation or description, please use decorator @doc to add it. Location: cognitiveservices/AnomalyDetector/univariate/models.tsp#L38 |
| :warning: @azure-tools/typespec-azure-core/documentation-required | The EnumMember named 'Weekly' should have a documentation or description, please use decorator @doc to add it. Location: cognitiveservices/AnomalyDetector/univariate/models.tsp#L39 |
| :warning: @azure-tools/typespec-azure-core/documentation-required | The EnumMember named 'Daily' should have a documentation or description, please use decorator @doc to add it. Location: cognitiveservices/AnomalyDetector/univariate/models.tsp#L40 |
| :warning: @azure-tools/typespec-azure-core/documentation-required | The EnumMember named 'Hourly' should have a documentation or description, please use decorator @doc to add it. Location: cognitiveservices/AnomalyDetector/univariate/models.tsp#L41 |
| :warning: @azure-tools/typespec-azure-core/documentation-required | The EnumMember named 'PerMinute' should have a documentation or description, please use decorator @doc to add it. Location: cognitiveservices/AnomalyDetector/univariate/models.tsp#L42 |
| :warning: @azure-tools/typespec-azure-core/documentation-required | The EnumMember named 'PerSecond' should have a documentation or description, please use decorator @doc to add it. Location: cognitiveservices/AnomalyDetector/univariate/models.tsp#L43 |
| :warning: @azure-tools/typespec-azure-core/documentation-required | The EnumMember named 'PerMicrosecond' should have a documentation or description, please use decorator @doc to add it. Location: cognitiveservices/AnomalyDetector/univariate/models.tsp#L44 |
| :warning: @azure-tools/typespec-azure-core/documentation-required | The EnumMember named 'None' should have a documentation or description, please use decorator @doc to add it. Location: cognitiveservices/AnomalyDetector/univariate/models.tsp#L45 |
| :warning: @azure-tools/typespec-azure-core/documentation-required | The Enum named 'MultivariateAlignMode' should have a documentation or description, please use decorator @doc to add it. Location: cognitiveservices/AnomalyDetector/multivariate/models.tsp#L38 |
| :warning: @azure-tools/typespec-azure-core/documentation-required | The EnumMember named 'Inner' should have a documentation or description, please use decorator @doc to add it. Location: cognitiveservices/AnomalyDetector/multivariate/models.tsp#L39 |
| :warning: @azure-tools/typespec-azure-core/documentation-required | The EnumMember named 'Outer' should have a documentation or description, please use decorator @doc to add it. Location: cognitiveservices/AnomalyDetector/multivariate/models.tsp#L40 |
| :warning: @azure-tools/typespec-azure-core/documentation-required | The Enum named 'MultivariateModelStatus' should have a documentation or description, please use decorator @doc to add it. Location: cognitiveservices/AnomalyDetector/multivariate/models.tsp#L43 |
| :warning: @azure-tools/typespec-autorest/union-unsupported | Unions cannot be emitted to OpenAPI v2 unless all options are literals of the same type. Location: cognitiveservices/OpenAI.Inference/models/completions.create.tsp#L198 |
| :warning: @azure-tools/typespec-autorest/union-unsupported | Unions cannot be emitted to OpenAPI v2 unless all options are literals of the same type. Location: cognitiveservices/OpenAI.Inference/models/chat.completions.tsp#L162 |
| :warning: @azure-tools/typespec-autorest/union-unsupported | Unions cannot be emitted to OpenAPI v2 unless all options are literals of the same type. Location: cognitiveservices/OpenAI.Inference/models/completions.create.tsp#L198 |
| :warning: @azure-tools/typespec-autorest/union-unsupported | Unions cannot be emitted to OpenAPI v2 unless all options are literals of the same type. Location: cognitiveservices/OpenAI.Inference/models/chat.completions.tsp#L162 |
| :warning: MissingTypeSpecProjectConfig | "details":"The configuration 'output-file' for '@azure-tools/typespec-autorest' is missing in the tspconfig.yaml under folder specification/cognitiveservices/OpenAI.Inference, please ensure it is added in the configuration of the emitter '@azure-tools/typespec-autorest'." |
| :warning: MissingTypeSpecProjectConfig | "details":"The configuration 'azure-resource-provider-folder' for '@azure-tools/typespec-autorest' is missing in the tspconfig.yaml under folder specification/cognitiveservices/OpenAI.Inference, please ensure it is added in the configuration of the emitter '@azure-tools/typespec-autorest'." |
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️❌ azure-sdk-for-net-track2 failed [Detail]
❌Failed [Logs] Generate from 11fd324c4d1e188d7e11488b8340a5cce1c7833f. SDK Automation 14.0.0command 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:126 cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1mLine | cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m 126 | [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.AnomalyDetector [View full logs] [Preview SDK Changes]info [Changelog]
️⚠️ azure-sdk-for-python warning [Detail]
⚠️Warning [Logs] Generate from 11fd324c4d1e188d7e11488b8340a5cce1c7833f. SDK Automation 14.0.0command 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] notice cmderr [automation_generate.sh] npm notice New minor version of npm available! 9.5.1 -> 9.7.1 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.7.1> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice
️✔️azure-ai-anomalydetector [View full logs] [Preview SDK Changes]info [Changelog] data-plan skip changelog generation temporarily
️⚠️ azure-sdk-for-java warning [Detail]
⚠️Warning [Logs] Generate from 11fd324c4d1e188d7e11488b8340a5cce1c7833f. SDK Automation 14.0.0command ./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.1.2 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.1.2 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip warn specification/cognitiveservices/data-plane/AnomalyDetector/readme.md skipped due to azure-sdk-for-java not found in swagger-to-sdk command ./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json cmderr [generate.py] cmderr [generate.py] npm notice New major version of npm available! 8.19.4 -> 9.7.1 cmderr [generate.py] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.7.1> cmderr [generate.py] npm notice Run `npm install -g [email protected]` to update! cmderr [generate.py] npm notice
️✔️azure-ai-anomalydetector [View full logs] [Preview SDK Changes]
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 11fd324c4d1e188d7e11488b8340a5cce1c7833f. SDK Automation 14.0.0command 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 warn specification/cognitiveservices/data-plane/AnomalyDetector/readme.md skipped due to azure-sdk-for-js not found in swagger-to-sdk 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/anomalydetector/ai-anomaly-detector-rest/changelog-temp/package/CHANGELOG.md'
️✔️@azure-rest/ai-anomaly-detector [View full logs] [Preview SDK Changes]info [Changelog] error breakingChangeTracking is enabled, but version or changelogItem is not found in output.
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Swagger | v1.1 | https://apiview.dev/Assemblies/Review/5614eb8a995448538bc88b59aabae850 |
| TypeSpec | AnomalyDetector | https://apiview.dev/Assemblies/Review/35a74f70fddd4af285331748c2b4ac65 |
| Python | azure-ai-anomalydetector | https://apiview.dev/Assemblies/Review/a85e8efc08d843bc95aa7a5dfe6228a5 |
| Java | azure-ai-anomalydetector | https://apiview.dev/Assemblies/Review/3eaa82fb212e4e39a5f8fe90e4a37066 |
| JavaScript | @azure-rest/ai-anomaly-detector | https://apiview.dev/Assemblies/Review/57ce9d8aa4744035ae5995ce607ef9ad |
| .Net | Azure.AI.AnomalyDetector | https://apiview.dev/Assemblies/Review/92ca1712b9b0467d97a5957f3b0f6e54 |
Hi @minkefusiji, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki. If you want to know the production traffic statistic, please see ARM Traffic statistic. If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback. Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.
Hi @minkefusiji, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.
| Task | How to fix | Priority |
|---|---|---|
| Avocado | Fix-Avocado | High |
| Semantic validation | Fix-SemanticValidation-Error | High |
| Model validation | Fix-ModelValidation-Error | High |
| LintDiff | Fix-LintDiff | high |
![azure-pipelines[bot] avatar](https://avatars.githubusercontent.com/in/9426?v=4 "Published by a pub.dev verified publisher"){kind=small}
The typespec validation errors are not related to this PR. @mikekistler, i think all the break changes are expected, so could you help to approve those breaking changes?
@chunyu3 , dotnet sdk generation succeeds but test fails to build, can you have a look at the errors?
The tsp format bug is fixed in @typespec/[email protected], which was just updated in main and merged to this branch. New CI run:
https://dev.azure.com/azure-sdk/public/_build/results?buildId=2851117&view=logs&j=9cd39ef8-47c1-5b58-08db-8c3708712f1b&t=b0666886-a1bc-5f0b-4c5c-3e4f20acee0f
@minkefusiji: Can you please fix the documentation-required errors by adding docs, and also run tsp format **/* in your service directory to format your *.tsp files?
Hi, @minkefusiji. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.
@minkefusiji: Are you still planning to merge this PR at some point? If so, we can help you get the spec passing all checks and merged into main. If not, are you OK if we close the PR?
Hi @mikeharder, we'll add a bit more commits to this PR this week, please don't close yet, thank you so much!
Hi, @minkefusiji. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.
![microsoft-github-policy-service[bot] avatar](https://avatars.githubusercontent.com/in/95686?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hi, @minkefusiji. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.
Hi, @minkefusiji. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.