Updates for documentation rule updates #28892

tjprescott · 2024-04-29T16:27:42Z

Reaction PR for the following TypeSpec Azure PRs:
Azure/typespec-azure#740
Azure/typespec-azure#710

openapi-pipeline-app · 2024-04-29T16:27:45Z

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

openapi-pipeline-app · 2024-04-29T16:27:46Z

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.

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

️❌TypeSpecAPIView: 0 Errors, 16 Warnings failed [Detail]

Rule	Message
⚠️ Failed to generate TypeSpec APIView. Please check the detail log and make sure TypeSpec compiler version is the latest.	"How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR."
⚠️ Failed to generate TypeSpec APIView. Please check the detail log and make sure TypeSpec compiler version is the latest.	"How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR."
⚠️ Failed to generate TypeSpec APIView. Please check the detail log and make sure TypeSpec compiler version is the latest.	"How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR."
⚠️ Failed to generate TypeSpec APIView. Please check the detail log and make sure TypeSpec compiler version is the latest.	"How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR."
⚠️ Failed to generate TypeSpec APIView. Please check the detail log and make sure TypeSpec compiler version is the latest.	"How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR."
⚠️ Failed to generate TypeSpec APIView. Please check the detail log and make sure TypeSpec compiler version is the latest.	"How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR."
⚠️ Failed to generate TypeSpec APIView. Please check the detail log and make sure TypeSpec compiler version is the latest.	"How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR."
⚠️ Failed to generate TypeSpec APIView. Please check the detail log and make sure TypeSpec compiler version is the latest.	"How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR."
⚠️ Failed to generate TypeSpec APIView. Please check the detail log and make sure TypeSpec compiler version is the latest.	"How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR."
⚠️ Failed to generate TypeSpec APIView. Please check the detail log and make sure TypeSpec compiler version is the latest.	"How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR."
⚠️ Failed to generate TypeSpec APIView. Please check the detail log and make sure TypeSpec compiler version is the latest.	"How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR."
⚠️ Failed to generate TypeSpec APIView. Please check the detail log and make sure TypeSpec compiler version is the latest.	"How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR."
⚠️ Failed to generate TypeSpec APIView. Please check the detail log and make sure TypeSpec compiler version is the latest.	"How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR."
⚠️ Failed to generate TypeSpec APIView. Please check the detail log and make sure TypeSpec compiler version is the latest.	"How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR."
⚠️ Failed to generate TypeSpec APIView. Please check the detail log and make sure TypeSpec compiler version is the latest.	"How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR."
⚠️ Failed to generate TypeSpec APIView. Please check the detail log and make sure TypeSpec compiler version is the latest.	"How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR."

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

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

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

Validation passes for SpellCheck.

️️✔️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 · 2024-04-29T16:27:46Z

Swagger Generation Artifacts

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

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

❌Code Generator Failed in generating from 9f87a1402f079c3c5f1c71d244984eaaa9fa119d. 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.
cmderr	[automation_init.sh]
cmderr	[automation_init.sh] npm notice New minor version of npm available! 10.5.0 -> 10.6.0
cmderr	[automation_init.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.6.0>
cmderr	[automation_init.sh] npm notice Run `npm install -g npm@10.6.0` to update!
cmderr	[automation_init.sh] npm notice
warn		specification/ai/HealthInsights/HealthInsights.OpenAPI/tspconfig.yaml skipped due to azure-sdk-for-python not found in tspconfig.yaml
warn		specification/cognitiveservices/Language.AnalyzeText/tspconfig.yaml skipped due to azure-sdk-for-python not found in tspconfig.yaml
warn		specification/cognitiveservices/Language.Conversations/tspconfig.yaml skipped due to azure-sdk-for-python not found in tspconfig.yaml
warn		specification/cognitiveservices/OpenAI.Inference/tspconfig.yaml skipped due to azure-sdk-for-python not found in tspconfig.yaml
warn		specification/confidentialledger/Microsoft.ManagedCcf/tspconfig.yaml skipped due to azure-sdk-for-python not found in tspconfig.yaml
warn		specification/devopsinfrastructure/Microsoft.DevOpsInfrastructure/tspconfig.yaml skipped due to azure-sdk-for-python not found in tspconfig.yaml
warn		specification/vmware/Microsoft.AVS/tspconfig.yaml skipped due to azure-sdk-for-python 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
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-net-track2 failed [Detail]

❌Pipeline Framework Failed in generating from 9f87a1402f079c3c5f1c71d244984eaaa9fa119d. SDK Automation 14.0.0

Only showing 10 items here. Refer to log for details.

cmderr	[Invoke-GenerateAndBuildV2.ps1]      |                ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1]      | Cannot find path
cmderr	[Invoke-GenerateAndBuildV2.ps1]      | '/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because
cmderr	[Invoke-GenerateAndBuildV2.ps1]      | it does not exist.
cmderr	[Invoke-GenerateAndBuildV2.ps1] GeneratePackage: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/Invoke-GenerateAndBuildV2.ps1:131
cmderr	[Invoke-GenerateAndBuildV2.ps1] Line |
cmderr	[Invoke-GenerateAndBuildV2.ps1]  131 |                GeneratePackage `
cmderr	[Invoke-GenerateAndBuildV2.ps1]      |                ~~~~~~~~~~~~~~~~~
cmderr	[Invoke-GenerateAndBuildV2.ps1]      | Failed to generate sdk artifact
fatal: 'sdkAuto/28892/' is not a valid branch name

❌Azure.AI.Vision.ImageAnalysis [Preview SDK Changes]
```
info	[Changelog]
```

❌

Only showing 10 items here. Refer to log for details.

error
error		Azure.AI.Language.AnalyzeText
error		Azure.AI.Language.Conversations
error
error
error
error
error		Azure.AI.ChatProtocol
error		Azure.Data.SchemaRegistry
error

❌
❌Azure.AI.Language.AnalyzeText
❌Azure.AI.Language.Conversations
❌
❌
❌
❌
❌Azure.AI.ChatProtocol
❌Azure.Data.SchemaRegistry
❌

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

❌Pipeline Framework Failed in generating from 9f87a1402f079c3c5f1c71d244984eaaa9fa119d. 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
cmderr	[init.sh] npm notice New minor version of npm available! 10.5.0 -> 10.6.0
cmderr	[init.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.6.0>
cmderr	[init.sh] npm notice Run `npm install -g npm@10.6.0` to update!
cmderr	[init.sh] npm notice
warn		specification/ai/HealthInsights/HealthInsights.OpenAPI/tspconfig.yaml skipped due to azure-sdk-for-java not found in tspconfig.yaml
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
cmderr	[generate.py] error: unknown-identifier - Unknown identifier bodyRoot @ /mnt/vss/_work/1/s/azure-sdk-for-java/sdk/vision/azure-ai-vision-imageanalysis/TempTypeSpecFiles/ImageAnalysis/routes.tsp
cmderr	[generate.py] error: unknown-decorator - Unknown decorator @ /mnt/vss/_work/1/s/azure-sdk-for-java/sdk/vision/azure-ai-vision-imageanalysis/TempTypeSpecFiles/ImageAnalysis/routes.tsp
cmderr	[generate.py] error: unknown-identifier - Unknown identifier bodyRoot @ /mnt/vss/_work/1/s/azure-sdk-for-java/sdk/vision/azure-ai-vision-imageanalysis/TempTypeSpecFiles/ImageAnalysis/routes.tsp
cmderr	[generate.py] error: unknown-decorator - Unknown decorator @ /mnt/vss/_work/1/s/azure-sdk-for-java/sdk/vision/azure-ai-vision-imageanalysis/TempTypeSpecFiles/ImageAnalysis/routes.tsp
The "path" argument must be of type string. Received undefined

️✔️azure-ai-vision-imageanalysis [Preview SDK Changes]
- pom.xml
- azure-ai-vision-imageanalysis-1.0.0-beta.3.jar
- azure-ai-vision-imageanalysis-1.0.0-beta.3-sources.jar

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

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

openapi-pipeline-app · 2024-04-29T16:27:47Z

Generated ApiView

Language	Package Name	ApiView Link
Java	azure-ai-vision-imageanalysis	There is no API change compared with the previous version

…essions with no reason as "MUST be fixed at next update."

* Fix up missing union documentation. * Clean up version enum suppressions. Mark documentation required suppressions with no reason as "MUST be fixed at next update."

Fix up missing union documentation.

f75f233

tjprescott requested review from NonStatic2014, Kishp01, yangyuan, hmlam, nickghardwick, lmazuel, deyaaeldeen, JoshLove-msft, swathipil, conniey and minhanh-phan as code owners April 29, 2024 16:27

tjprescott requested a review from timotheeguerin April 29, 2024 16:27

Clean up version enum suppressions. Mark documentation required suppr…

2f85425

…essions with no reason as "MUST be fixed at next update."

tjprescott force-pushed the tsp/fixUnionDocumentaiton branch from dfb621d to 2f85425 Compare April 29, 2024 16:35

AzureRestAPISpecReview added the TypeSpec Authored with TypeSpec label Apr 29, 2024

tjprescott merged commit cc7cd96 into typespec-next Apr 29, 2024
23 of 29 checks passed

tjprescott deleted the tsp/fixUnionDocumentaiton branch April 29, 2024 17:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updates for documentation rule updates #28892

Updates for documentation rule updates #28892

tjprescott commented Apr 29, 2024

openapi-pipeline-app bot commented Apr 29, 2024 •

edited

Loading

openapi-pipeline-app bot commented Apr 29, 2024 •

edited

Loading

openapi-pipeline-app bot commented Apr 29, 2024 •

edited

Loading

openapi-pipeline-app bot commented Apr 29, 2024 •

edited

Loading

Updates for documentation rule updates #28892

Updates for documentation rule updates #28892

Conversation

tjprescott commented Apr 29, 2024

openapi-pipeline-app bot commented Apr 29, 2024 • edited Loading

Next Steps to Merge

openapi-pipeline-app bot commented Apr 29, 2024 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Apr 29, 2024 • edited Loading

Swagger Generation Artifacts

openapi-pipeline-app bot commented Apr 29, 2024 • edited Loading

Generated ApiView

openapi-pipeline-app bot commented Apr 29, 2024 •

edited

Loading

openapi-pipeline-app bot commented Apr 29, 2024 •

edited

Loading

openapi-pipeline-app bot commented Apr 29, 2024 •

edited

Loading

openapi-pipeline-app bot commented Apr 29, 2024 •

edited

Loading