[AnomalyDetector] Add doc decorators #24303

mikeharder · 2023-06-05T22:09:37Z

Fixes linter error added in TypeSpec 0.45.0

Passing CI

https://dev.azure.com/azure-sdk/public/_build/results?buildId=2824041&view=results

openapi-workflow-bot · 2023-06-05T22:09:41Z

Hi, @mikeharder 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 · 2023-06-05T22:09:41Z

Swagger Validation Report

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

There are no breaking changes.

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

There are no breaking changes.

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

There is no credential detected.

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

Validation passes for LintDiff.

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

Validation passes for Avocado.

️️✔️ApiReadinessCheck succeeded [Detail] [Expand]

️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]

Validation passes for ServiceAPIReadinessTest.

️️✔️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: 4 Errors, 6 Warnings failed [Detail]

Rule	Message
`❌` InConsistentSwagger	"details":"The generated swagger file v1.1/openapi.json from typespec specification/cognitiveservices/AnomalyDetector is not the same as the '/mnt/vss/_work/1/azure-rest-api-specs/specification/cognitiveservices/data-plane/AnomalyDetector/stable/v1.1/openapi.json' in PR, please make sure the swagger is consistent with the generated swagger. You can find the difference in the pipeline log."
`❌` MissingExamplesDirectory	"details":"The 'examples' directory is missing in the typespec folder specification/cognitiveservices/OpenAI.Inference, please ensure the 'examples' is added in the PR."
`❌` SwaggerNotExistInPRBranch	"details":"The generated swagger file 2022-12-01/openapi.json from typespec specification/cognitiveservices/OpenAI.Inference is not on the branch."
`❌` SwaggerNotExistInPRBranch	"details":"The generated swagger file 2023-03-15-preview/openapi.json from typespec specification/cognitiveservices/OpenAI.Inference is not on the branch."
⚠️ @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
⚠️ @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
⚠️ @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
⚠️ @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
⚠️ 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'."
⚠️ 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.

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

openapi-pipeline-app · 2023-06-05T22:09:42Z

Swagger Generation Artifacts

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

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

Breaking Changes Tracking

️❌ azure-sdk-for-python failed [Detail]

❌Code Generator Failed [Logs] Generate from ef5bfdf5e39c00616e8ffe120fef43a1a3021350. 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 minor version of npm available! 9.5.1 -> 9.6.7
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.7>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.6.7` to update!
cmderr	[automation_generate.sh] npm notice
cmdout	[automation_generate.sh] [Autorest]/mnt/vss/_work/1/s/azure-sdk-for-python_tmp/venv-sdk/auto_temp.json does not exist!!!Error happened during codegen
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-python]: sh scripts/automation_generate.sh
warn	Skip package processing as generation is failed

️❌ azure-sdk-for-java failed [Detail]

❌Failed [Logs] Generate from ef5bfdf5e39c00616e8ffe120fef43a1a3021350. 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.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] npm notice
cmderr	[generate.py] npm notice New major version of npm available! 8.19.4 -> 9.6.7
cmderr	[generate.py] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.7>
cmderr	[generate.py] npm notice Run `npm install -g npm@9.6.7` to update!
cmderr	[generate.py] npm notice
warn	No file changes detected after generation

❌azure-ai-anomalydetector [View full logs]
- pom.xml

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

❌Failed [Logs] Generate from ef5bfdf5e39c00616e8ffe120fef43a1a3021350. 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:145
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 145 | �[0m         �[36;1mGeneratePackage `�[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to generate sdk. exit code: False
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGet-ChildItem: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:800
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 800 | �[0m … rtifacts += �[36;1mGet-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s�[0m …
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mCannot find path
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m'/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1mit does not exist.
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/Invoke-GenerateAndBuildV2.ps1:145
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 145 | �[0m         �[36;1mGeneratePackage `�[0m
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to generate sdk artifact
cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m

❌Azure.AI.AnomalyDetector [View full logs] [Preview SDK Changes]
```
info	[Changelog]
```

️🔄 azure-sdk-for-js inProgress [Detail]

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

openapi-pipeline-app · 2023-06-05T22:09:42Z

Generated ApiView

Language	Package Name	ApiView Link
TypeSpec	AnomalyDetector	https://apiview.dev/Assemblies/Review/dd1cb59fd83c4610a8e2d2bf7c383471

specification/cognitiveservices/AnomalyDetector/main.tsp

[AnomalyDetector] Add doc decorators

19e5865

ghost added the Cognitive Services label Jun 5, 2023

mikeharder mentioned this pull request Jun 5, 2023

Tsp next 045 #24265

Closed

tsp compile

18fbff4

AzureRestAPISpecReview added the data-plane label Jun 5, 2023

azure-sdk mentioned this pull request Jun 5, 2023

[AutoPR Azure.AI.AnomalyDetector] [AnomalyDetector] Add doc decorators azure-sdk/azure-sdk-for-net#4072

Closed

mikeharder marked this pull request as ready for review June 5, 2023 22:27

mikeharder requested a review from yangyuan as a code owner June 5, 2023 22:27

openapi-assignment-bot bot assigned jhendrixMSFT Jun 5, 2023

mikeharder requested a review from markcowl June 5, 2023 22:27

markcowl requested changes Jun 5, 2023

View reviewed changes

specification/cognitiveservices/AnomalyDetector/main.tsp Show resolved Hide resolved

mikeharder closed this Jun 5, 2023

mikeharder deleted the anomaly-detector-docs branch June 5, 2023 22:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[AnomalyDetector] Add doc decorators #24303

[AnomalyDetector] Add doc decorators #24303

mikeharder commented Jun 5, 2023 •

edited

Loading

openapi-workflow-bot bot commented Jun 5, 2023

openapi-pipeline-app bot commented Jun 5, 2023 •

edited

Loading

openapi-pipeline-app bot commented Jun 5, 2023 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented Jun 5, 2023 •

edited

Loading

[AnomalyDetector] Add doc decorators #24303

[AnomalyDetector] Add doc decorators #24303

Conversation

mikeharder commented Jun 5, 2023 • edited Loading

Passing CI

openapi-workflow-bot bot commented Jun 5, 2023

openapi-pipeline-app bot commented Jun 5, 2023 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Jun 5, 2023 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented Jun 5, 2023 • edited Loading

Generated ApiView

mikeharder commented Jun 5, 2023 •

edited

Loading

openapi-pipeline-app bot commented Jun 5, 2023 •

edited

Loading

openapi-pipeline-app bot commented Jun 5, 2023 •

edited

Loading

openapi-pipeline-app bot commented Jun 5, 2023 •

edited

Loading