Adding documentation for properties #29382

hamshavathimunibyraiah · 2024-06-10T22:32:16Z

Adding documentation for properties

Choose a PR Template

Switch to "Preview" on this description then select one of the choices below.

Click here to open a PR for a Data Plane API.

Click here to open a PR for a Control Plane (ARM) API.

…d js SDK generation

openapi-pipeline-app · 2024-06-10T22:32:20Z

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-06-10T22:32:20Z

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.

️️✔️SwaggerAPIView 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.

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

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

️️✔️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-06-10T22:32:21Z

Swagger Generation Artifacts

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

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

⚠️Warning in generating from 7c6b93918e13dd758e143b40530139b491e34f67. 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] Get-ChildItem: /mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:807
cmderr	[Invoke-GenerateAndBuildV2.ps1] Line |
cmderr	[Invoke-GenerateAndBuildV2.ps1]  807 |  … rtifacts += Get-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s …
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

️✔️Azure.AI.Translation.Document [Preview SDK Changes]
```
info	[Changelog]
```

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

⚠️Warning in generating from 7c6b93918e13dd758e143b40530139b491e34f67. 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 npm@10.8.1
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-translation-document [Preview SDK Changes]
- azure-ai-translation-document-1.1.0b1.zip
- azure_ai_translation_document-1.1.0b1-py3-none-any.whl
```
info	[Changelog] data-plan skip changelog generation temporarily
```

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

❌Code Generator Failed in generating from 7c6b93918e13dd758e143b40530139b491e34f67. 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
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
cmderr	[generate.py] Traceback (most recent call last):
cmderr	[generate.py]   File "/mnt/vss/_work/1/s/azure-sdk-for-java/./eng/mgmt/automation/generate.py", line 376, in <module>
cmderr	[generate.py]     main()
cmderr	[generate.py]   File "/mnt/vss/_work/1/s/azure-sdk-for-java/./eng/mgmt/automation/generate.py", line 289, in main
cmderr	[generate.py]     return sdk_automation(args["config"][0], args["config"][1])
cmderr	[generate.py]   File "/mnt/vss/_work/1/s/azure-sdk-for-java/./eng/mgmt/automation/generate.py", line 114, in sdk_automation
cmderr	[generate.py]     packages = sdk_automation_typespec(config)
cmderr	[generate.py]   File "/mnt/vss/_work/1/s/azure-sdk-for-java/./eng/mgmt/automation/generate.py", line 226, in sdk_automation_typespec
cmderr	[generate.py]     packages.append(sdk_automation_typespec_project_data(tsp_project, config))
cmderr	[generate.py]   File "/mnt/vss/_work/1/s/azure-sdk-for-java/eng/mgmt/automation/generate_data.py", line 34, in sdk_automation_typespec_project
cmderr	[generate.py]     succeeded, require_sdk_integration, sdk_folder, service, module = generate_typespec_project(
cmderr	[generate.py]   File "/mnt/vss/_work/1/s/azure-sdk-for-java/eng/mgmt/automation/generate_utils.py", line 373, in generate_typespec_project
cmderr	[generate.py]     logging.info("SDK folder: " + sdk_folder)
cmderr	[generate.py] TypeError: can only concatenate str (not "NoneType") to str
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-java]: ./eng/mgmt/automation/generate.py
warn	Skip package processing as generation is failed

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

❌Code Generator Failed in generating from 7c6b93918e13dd758e143b40530139b491e34f67. 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	File azure-sdk-for-js_tmp/initOutput.json not found to read
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] Command failed: pwsh ./eng/common/scripts/TypeSpec-Project-Process.ps1 /mnt/vss/_work/1/s/azure-rest-api-specs/specification/translation/Azure.AI.DocumentTranslation 7c6b93918e13dd758e143b40530139b491e34f67 https://github.com/Azure/azure-rest-api-specs
cmderr	[automation_generate.sh] [ERROR] Command failed: pwsh ./eng/common/scripts/TypeSpec-Project-Process.ps1 /mnt/vss/_work/1/s/azure-rest-api-specs/specification/translation/Azure.AI.DocumentTranslation 7c6b93918e13dd758e143b40530139b491e34f67 https://github.com/Azure/azure-rest-api-specs
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-js]: sh .scripts/automation_generate.sh
warn	Skip package processing as generation is failed

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

openapi-pipeline-app · 2024-06-10T22:32:21Z

Generated ApiView

Language	Package Name	ApiView Link
TypeSpec	Azure.AI.DocumentTranslation	https://apiview.dev/Assemblies/Review/acf80310b66941048f99ebf23977c036?revisionId=191abd59ff874380812c341e6f7ec881

mikeharder · 2024-06-11T18:41:48Z

@hamshavathimunibyraiah, @razvanbadea-msft, @rkmanda: This PR should not have been merged with changes to package-lock.json. These files should only be changed by the repo maintainers (the Azure SDK EngSys team).

I will create a PR to revert these changes to package-lock.json, and I will create an issue to add a check to automatically block PRs which edit package.json or package-lock.json.

* Adding documentation of properties and making some changes to java and js SDK generation * Reverting the tspconfig change * fixing formatting * Fixing typeSpec validation error on build

Adding documentation of properties and making some changes to java an…

aa389b9

…d js SDK generation

hamshavathimunibyraiah requested a review from catalinaperalta June 10, 2024 22:32

AzureRestAPISpecReview added the TypeSpec Authored with TypeSpec label Jun 10, 2024

This was referenced Jun 10, 2024

[AutoPR azure-ai-translation-document] Adding documentation for properties azure-sdk/azure-sdk-for-python#7316

Closed

[AutoPR Azure.AI.Translation.Document] Adding documentation for properties azure-sdk/azure-sdk-for-net#8159

Closed

hamshavathimunibyraiah added 2 commits June 10, 2024 15:52

Reverting the tspconfig change

496cb9b

fixing formatting

4f11a33

hamshavathimunibyraiah changed the title ~~Adding documentation of properties and making some changes to java an…~~ Adding documentation for properties Jun 10, 2024

Fixing typeSpec validation error on build

67409d9

hamshavathimunibyraiah requested review from weshaggard, mikeharder and konrad-jamrozik as code owners June 11, 2024 01:23

hamshavathimunibyraiah changed the title ~~Adding documentation for properties~~ MergeRequested : Adding documentation for properties Jun 11, 2024

hamshavathimunibyraiah changed the title ~~MergeRequested : Adding documentation for properties~~ Adding documentation for properties Jun 11, 2024

hamshavathimunibyraiah added the MergeRequested label Jun 11, 2024

razvanbadea-msft approved these changes Jun 11, 2024

View reviewed changes

razvanbadea-msft merged commit 8284623 into Azure:main Jun 11, 2024
36 of 39 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding documentation for properties #29382

Adding documentation for properties #29382

hamshavathimunibyraiah commented Jun 10, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jun 10, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jun 10, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jun 10, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jun 10, 2024 •

edited

Loading

mikeharder commented Jun 11, 2024

Adding documentation for properties #29382

Adding documentation for properties #29382

Conversation

hamshavathimunibyraiah commented Jun 10, 2024 • edited Loading

Choose a PR Template

openapi-pipeline-app bot commented Jun 10, 2024 • edited Loading

Next Steps to Merge

openapi-pipeline-app bot commented Jun 10, 2024 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Jun 10, 2024 • edited Loading

Swagger Generation Artifacts

openapi-pipeline-app bot commented Jun 10, 2024 • edited Loading

Generated ApiView

mikeharder commented Jun 11, 2024

hamshavathimunibyraiah commented Jun 10, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jun 10, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jun 10, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jun 10, 2024 •

edited

Loading

openapi-pipeline-app bot commented Jun 10, 2024 •

edited

Loading