Migrating Sphere to latest TypeSpec #24420

allenjzhang · 2023-06-13T16:29:42Z

No description provided.

openapi-workflow-bot · 2023-06-13T16:29:45Z

Hi, @allenjzhang 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. [email protected]

openapi-pipeline-app · 2023-06-13T16:29:46Z

Swagger Validation Report

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

There are no breaking changes.

compared swaggers (via Oad v0.10.4)]	new version	base version
azuresphere.json	2022-09-01-preview(7c52935)	2022-09-01-preview(main)

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

There are no breaking changes.

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

There is no credential detected.

️⚠️LintDiff: 0 Warnings warning [Detail]

compared tags (via openapi-validator v2.1.3)	new version	base version
package-2022-09-01-preview	package-2022-09-01-preview(7c52935)	package-2022-09-01-preview(main)

The following errors/warnings exist before current PR submission:

Rule	Message
`❌` OperationIdNounVerb	Per the Noun_Verb convention for Operation Ids, the noun 'Devices' 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: Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json#L2474
⚠️ ListInOperationName	Since operation response has model definition in array type, it should be of the form '_list'. Location: Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json#L2975
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json#L3490

️️✔️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 succeeded [Detail]

Rule	Message
`❌` InConsistentSwagger	"details":"The generated swagger file 2022-09-01-preview/azuresphere.json from typespec specification/sphere/Sphere.Management is not the same as the '/mnt/vss/_work/1/azure-rest-api-specs/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json' in PR, please make sure the swagger is consistent with the generated swagger. You can find the difference in the pipeline log."

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

Validation passes for Summary.

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

openapi-pipeline-app · 2023-06-13T16:29:47Z

Swagger Generation Artifacts

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

 Please click here to preview with your @microsoft account.

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

Breaking Changes Tracking

️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 753f386. 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		specification/sphere/Sphere.Management/tspconfig.yaml skipped due to azure-sdk-for-net-track2 not found in tspconfig.yaml
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json

️✔️Azure.ResourceManager.Sphere [View full logs] [Release SDK Changes]
- Azure.ResourceManager.Sphere.1.0.0-alpha.20230619.1.nupkg
```
info	[Changelog]
```

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

⚠️Warning [Logs]Release - Generate from 753f386. 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/sphere/Sphere.Management/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
cmderr	[automation_generate.sh]
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

️✔️track2_azure-mgmt-azuresphere [View full logs] [Release SDK Changes]
- azure_mgmt_azuresphere-1.0.0b1-py3-none-any.whl
- azure-mgmt-azuresphere-1.0.0b1.zip
```
info	[Changelog]   - Initial Release
```

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

⚠️Warning [Logs]Release - Generate from 753f386. 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
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json

️✔️azure-resourcemanager-sphere [View full logs] [Release SDK Changes]

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 753f386. SDK Automation 14.0.0

command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
warn		specification/sphere/Sphere.Management/tspconfig.yaml skipped due to azure-sdk-for-go not found in tspconfig.yaml
command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️sdk/resourcemanager/azuresphere/armazuresphere [View full logs] [Release SDK Changes]
```
info	[Changelog] This is a new package
info	[Changelog]
```

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 753f386. 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

️✔️@azure/arm-azuresphere [View full logs] [Release SDK Changes]
- azure-arm-azuresphere-1.0.0-beta.1.tgz
```
info	[Changelog]
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
```

️⚠️ azure-resource-manager-schemas warning [Detail]

⚠️Warning [Logs]Release - Generate from 753f386. Schema Automation 14.0.0

command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
cmderr	[initScript.sh] WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
cmderr	[initScript.sh] npm WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
cmderr	[initScript.sh] npm WARN old lockfile
warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
warn	No file changes detected after generation

️✔️sphere [View full logs]

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

openapi-pipeline-app · 2023-06-13T16:29:47Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/azuresphere/armazuresphere	https://apiview.dev/Assemblies/Review/05a1b251d3e54a0d8635051cd0962149
Java	azure-resourcemanager-sphere	https://apiview.dev/Assemblies/Review/33aa0e34547841dda4db3ac226d23c80
.Net	Azure.ResourceManager.Sphere	https://apiview.dev/Assemblies/Review/b3bac56fc8e944f6a6e41261f39b984a
JavaScript	@azure/arm-azuresphere	https://apiview.dev/Assemblies/Review/86657e77b3db4a5ea84a518d8d22c7cb

…into migrationSphere

mikeharder

This should be failing CI, because the folder added to eng/pipeline/typespec-ci.yml is incorrect. However, CI is ignoring this error rather than failing, which is a bug in CI I will fix: #24448

After this bug is fixed, I'd like to verify this PR fails CI as-is, then I will fix the folder name in typespec-ci.yml.

eng/pipelines/typespec-ci.yml

mikeharder · 2023-06-15T00:33:20Z

/azp run

azure-pipelines · 2023-06-15T00:33:34Z

Azure Pipelines successfully started running 2 pipeline(s).

eng/pipelines/typespec-ci.yml

mikeharder

Failing CI due to several instances of this error:

/mnt/vss/_work/1/s/specification/sphere/Sphere.Management/common.tsp:102:27
error deprecated: Deprecated: object is deprecated. Please use {} for an empty model,
`Record<unknown>` for a record with unknown property types, `unknown[]` for an array.

https://dev.azure.com/azure-sdk/public/_build/results?buildId=2847944&view=logs&j=9cd39ef8-47c1-5b58-08db-8c3708712f1b&t=fc9dfc5e-afbb-5dcd-1f9e-c63049dbf79d&l=21

mikeharder · 2023-06-15T22:29:12Z

/azp run

azure-pipelines · 2023-06-15T22:29:24Z

Azure Pipelines successfully started running 2 pipeline(s).

mikeharder · 2023-06-15T22:59:10Z

/azp run

azure-pipelines · 2023-06-15T22:59:22Z

Azure Pipelines successfully started running 2 pipeline(s).

* WIP migrating Sphere * Adding to CI * Add trailing newline * Fix path to spec in eng/pipelines/typespec-ci.yml * Fixed deprecation & documentation on enums * tsp format * Fix spelling * Add PR trigger for specification/sphere --------- Co-authored-by: Mike Harder <[email protected]>

WIP migrating Sphere

e783c0d

openapi-assignment-bot bot assigned keryul Jun 13, 2023

allenjzhang marked this pull request as draft June 13, 2023 16:29

azure-sdk mentioned this pull request Jun 13, 2023

[AutoPR sdk/resourcemanager/azuresphere/armazuresphere] Migrating Sphere to latest TypeSpec azure-sdk/azure-sdk-for-go#6130

Closed

AzureRestAPISpecReview added Cadl Authored with Cadl resource-manager RPaaS labels Jun 13, 2023

allenjzhang requested a review from markcowl June 14, 2023 18:29

allenjzhang marked this pull request as ready for review June 14, 2023 18:29

allenjzhang added 2 commits June 14, 2023 11:54

Adding to CI

897e0d7

Merge branch 'main' of https://github.com/Azure/azure-rest-api-specs …

fe80c69

…into migrationSphere

allenjzhang requested review from allegradomel and mikeharder June 14, 2023 18:58

mikeharder requested changes Jun 14, 2023

View reviewed changes

mikeharder reviewed Jun 15, 2023

View reviewed changes

eng/pipelines/typespec-ci.yml Outdated Show resolved Hide resolved

Add trailing newline

50d7981

mikeharder self-assigned this Jun 15, 2023

mikeharder reviewed Jun 15, 2023

View reviewed changes

eng/pipelines/typespec-ci.yml Outdated Show resolved Hide resolved

Fix path to spec in eng/pipelines/typespec-ci.yml

a5722a8

mikeharder requested changes Jun 15, 2023

View reviewed changes

allenjzhang and others added 2 commits June 15, 2023 15:08

Fixed deprecation & documentation on enums

a845a66

tsp format

b43c6aa

Fix spelling

c388b60

mikeharder approved these changes Jun 15, 2023

View reviewed changes

mikeharder added 2 commits June 16, 2023 18:12

Merge branch 'main' into migrationSphere

ebf0573

Add PR trigger for specification/sphere

7c52935

allenjzhang merged commit 753f386 into Azure:main Jun 19, 2023

mikeharder unassigned keryul Jun 20, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrating Sphere to latest TypeSpec #24420

Migrating Sphere to latest TypeSpec #24420

allenjzhang commented Jun 13, 2023

openapi-workflow-bot bot commented Jun 13, 2023

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

edited

Loading

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

edited

Loading

Breaking Changes Tracking

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

edited

Loading

mikeharder left a comment

mikeharder commented Jun 15, 2023

azure-pipelines bot commented Jun 15, 2023

mikeharder left a comment

mikeharder commented Jun 15, 2023

azure-pipelines bot commented Jun 15, 2023

mikeharder commented Jun 15, 2023

azure-pipelines bot commented Jun 15, 2023

Migrating Sphere to latest TypeSpec #24420

Migrating Sphere to latest TypeSpec #24420

Conversation

allenjzhang commented Jun 13, 2023

openapi-workflow-bot bot commented Jun 13, 2023

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

Swagger Validation Report

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

Swagger Generation Artifacts

Breaking Changes Tracking

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

Generated ApiView

mikeharder left a comment

Choose a reason for hiding this comment

mikeharder commented Jun 15, 2023

azure-pipelines bot commented Jun 15, 2023

mikeharder left a comment

Choose a reason for hiding this comment

mikeharder commented Jun 15, 2023

azure-pipelines bot commented Jun 15, 2023

mikeharder commented Jun 15, 2023

azure-pipelines bot commented Jun 15, 2023

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

edited

Loading

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

edited

Loading

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

edited

Loading