azure-rest-api-specs icon indicating copy to clipboard operation
azure-rest-api-specs copied to clipboard

[Microsoft.DevCenter] Dataplane moving to TypeSpec

Open drielenr opened this issue 2 years ago • 5 comments

DevCenter dataplane API 2023-04-01 moving to TypeSpec

Add initial TypeSpec support for devcenter dataplane. This change is not related to an API update and API 2023-04-01 (GA) has been already released.

❔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.

Click here for links to tools, specs, guidelines & other good stuff

Tooling

Guidelines & Specifications

Helpful Links

drielenr avatar Oct 24 '23 21:10 drielenr

Next Steps to Merge

✅ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).

Swagger Validation Report

️❌BreakingChange: 87 Errors, 0 Warnings failed [Detail]
Compared specs (v0.10.5) new version base version
devcenter.json 2023-04-01(1a268b7) 2023-04-01(main)
environments.json 2023-04-01(1a268b7) 2023-04-01(main)

Only 30 items are listed, please refer to log for more details.

Rule Message
1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/projects/{projectName}/environments' removed or restructured?
Old: Microsoft.DevCenter/stable/2023-04-01/environments.json#L45:5
1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/projects/{projectName}/users/{userId}/environments' removed or restructured?
Old: Microsoft.DevCenter/stable/2023-04-01/environments.json#L93:5
1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/projects/{projectName}/users/{userId}/environments/{environmentName}' removed or restructured?
Old: Microsoft.DevCenter/stable/2023-04-01/environments.json#L144:5
1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/projects/{projectName}/catalogs' removed or restructured?
Old: Microsoft.DevCenter/stable/2023-04-01/environments.json#L313:5
1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/projects/{projectName}/catalogs/{catalogName}' removed or restructured?
Old: Microsoft.DevCenter/stable/2023-04-01/environments.json#L361:5
1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/projects/{projectName}/environmentDefinitions' removed or restructured?
Old: Microsoft.DevCenter/stable/2023-04-01/environments.json#L406:5
1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/projects/{projectName}/catalogs/{catalogName}/environmentDefinitions' removed or restructured?
Old: Microsoft.DevCenter/stable/2023-04-01/environments.json#L454:5
1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/projects/{projectName}/catalogs/{catalogName}/environmentDefinitions/{definitionName}' removed or restructured?
Old: Microsoft.DevCenter/stable/2023-04-01/environments.json#L505:5
1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/projects/{projectName}/environmentTypes' removed or restructured?
Old: Microsoft.DevCenter/stable/2023-04-01/environments.json#L553:5
1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'Environment' removed or renamed?
New: Microsoft.DevCenter/stable/2023-04-01/environments.json#L36:3
Old: Microsoft.DevCenter/stable/2023-04-01/environments.json#L602:3
1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'CloudErrorBody' removed or renamed?
New: Microsoft.DevCenter/stable/2023-04-01/environments.json#L36:3
Old: Microsoft.DevCenter/stable/2023-04-01/environments.json#L602:3
1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'ProjectNameParameter' removed or renamed?
New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L3740:3
Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L271:3
1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'ProjectNameMethodParameter' removed or renamed?
New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L3740:3
Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L271:3
1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'ApiVersionParameter' removed or renamed?
New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L3740:3
Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L271:3
1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'FilterParameter' removed or renamed?
New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L3740:3
Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L271:3
1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'TopParameter' removed or renamed?
New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L3740:3
Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L271:3
1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'UserIdParameter' removed or renamed?
New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L3740:3
Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L271:3
1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'EndpointParameter' removed or renamed?
New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L3740:3
Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L271:3
1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'EnvironmentNameParameter' removed or renamed?
New: Microsoft.DevCenter/stable/2023-04-01/environments.json#L37:3
Old: Microsoft.DevCenter/stable/2023-04-01/environments.json#L949:3
1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'CatalogNameParameter' removed or renamed?
New: Microsoft.DevCenter/stable/2023-04-01/environments.json#L37:3
Old: Microsoft.DevCenter/stable/2023-04-01/environments.json#L949:3
1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'EnvironmentDefinitionNameParameter' removed or renamed?
New: Microsoft.DevCenter/stable/2023-04-01/environments.json#L37:3
Old: Microsoft.DevCenter/stable/2023-04-01/environments.json#L949:3
1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'TopParameter' removed or renamed?
New: Microsoft.DevCenter/stable/2023-04-01/environments.json#L37:3
Old: Microsoft.DevCenter/stable/2023-04-01/environments.json#L949:3
1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'ProjectNameParameter' removed or renamed?
New: Microsoft.DevCenter/stable/2023-04-01/environments.json#L37:3
Old: Microsoft.DevCenter/stable/2023-04-01/environments.json#L949:3
1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'ApiVersionParameter' removed or renamed?
New: Microsoft.DevCenter/stable/2023-04-01/environments.json#L37:3
Old: Microsoft.DevCenter/stable/2023-04-01/environments.json#L949:3
1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'UserIdParameter' removed or renamed?
New: Microsoft.DevCenter/stable/2023-04-01/environments.json#L37:3
Old: Microsoft.DevCenter/stable/2023-04-01/environments.json#L949:3
1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'EndpointParameter' removed or renamed?
New: Microsoft.DevCenter/stable/2023-04-01/environments.json#L37:3
Old: Microsoft.DevCenter/stable/2023-04-01/environments.json#L949:3
1008 - ModifiedOperationId The operation id has been changed from 'DevCenter_ListProjects' to 'DevCenterOperations_ListProjects'. This will impact generated code.
New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L94:7
Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L45:7
1008 - ModifiedOperationId The operation id has been changed from 'DevCenter_GetProject' to 'DevCenterOperations_GetProject'. This will impact generated code.
New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L133:7
Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L87:7
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L97:9
Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L50:9
1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L105:13
Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L65:13
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 40 Warnings warning [Detail]
Compared specs (v2.2.0) new version base version
package-2023-04-01 package-2023-04-01(1a268b7) package-2023-04-01(main)

[must fix]The following errors/warnings are introduced by current PR:

Only 30 items are listed, please refer to log for more details.

Rule Message Related RPC [For API reviewers]
:warning: SecurityDefinitionDescription Security definition should have a description.
Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L43
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L291
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L298
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L410
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L456
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L502
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L558
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L660
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L713
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L769
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L776
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L819
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L826
:warning: OperationId OperationId for put method should contain both 'Create' and 'Update'
Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L930
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L936
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L943
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L950
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1017
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1024
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1031
:warning: LongRunningOperationsOptionsValidator A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled.
Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1078
RPC-Async-V1-05
:warning: LongRunningOperationsOptionsValidator A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled.
Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1152
RPC-Async-V1-05
:warning: 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.DevCenter/stable/2023-04-01/devcenter.json#L1190
:warning: LongRunningOperationsOptionsValidator A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled.
Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1233
RPC-Async-V1-05
:warning: ListInOperationName Since operation response has model definition in array type, it should be of the form '_list'.
Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1611
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1696
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1703
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1710
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1753
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1760
️️✔️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?

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 failed [Detail]
  • Failed [Logs] Generate from 95618f7666ff2959919f3a2d3fba5ba60dec1a40. 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/devcenter/data-plane/readme.md skipped due to azure-sdk-for-net-track2 not found in swagger-to-sdk
    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:131[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] [31;1m[0m[36;1mLine |[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] [31;1m[0m[36;1m[36;1m 131 | [0m               [36;1mGeneratePackage `[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] [31;1m[0m[36;1m[36;1m[0m[36;1m[0m[36;1m     | [31;1m               ~~~~~~~~~~~~~~~~~[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] [31;1m[0m[36;1m[36;1m[0m[36;1m[0m[36;1m[31;1m[31;1m[36;1m     | [31;1mFailed to build sdk. exit code: False[0m
  • Azure.Developer.DevCenter [View full logs]  [Preview SDK Changes]
    info	[Changelog]
️⚠️ azure-sdk-for-python warning [Detail]
  • ⚠️Warning [Logs] Generate from 95618f7666ff2959919f3a2d3fba5ba60dec1a40. 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: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
    cmderr	[automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
    cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
    warn		specification/devcenter/data-plane/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] npm notice
    cmderr	[automation_generate.sh] npm notice New minor version of npm available! 10.2.4 -> 10.5.0
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.5.0>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
    cmderr	[automation_generate.sh] npm notice
  • ️✔️azure-developer-devcenter [View full logs]  [Preview SDK Changes]
    info	[Changelog] data-plan skip changelog generation temporarily
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from 95618f7666ff2959919f3a2d3fba5ba60dec1a40. 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
    warn		specification/devcenter/data-plane/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/devcenter/developer-devcenter-rest/changelog-temp/package/CHANGELOG.md'
  • ️✔️@azure-rest/developer-devcenter [View full logs]  [Preview SDK Changes]
    info	[Changelog]
    error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
️⚠️ azure-sdk-for-java warning [Detail]
  • ⚠️Warning [Logs] Generate from 95618f7666ff2959919f3a2d3fba5ba60dec1a40. 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 -> 24.0
    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 -> 24.0
    cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
    cmderr	[init.sh]   % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
    cmderr	[init.sh]                                  Dload  Upload   Total   Spent    Left  Speed
    cmderr	[init.sh] 
      0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0   0     0  1295k      0 --:--:-- --:--:-- --:--:-- 1295k
    cmderr	[init.sh]  notice
    cmderr	[init.sh] npm notice New minor version of npm available! 10.2.4 -> 10.5.0
    cmderr	[init.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.5.0>
    cmderr	[init.sh] npm notice Run `npm install -g [email protected]` to update!
    cmderr	[init.sh] npm notice
    cmderr	[init.sh] Downloading https://nodejs.org/dist/v18.15.0/node-v18.15.0-linux-x64.tar.xz...
    cmderr	[init.sh] Computing checksum with sha256sum
    cmderr	[init.sh] Checksums matched!
    warn		specification/devcenter/data-plane/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
  • ️✔️azure-developer-devcenter [View full logs]  [Preview SDK Changes]
Posted by Swagger Pipeline | How to fix these errors?

Hi @drielenr! For review efficiency consideration, when creating a new API version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version.
For more details refer to the wiki.

/azp run

mikeharder avatar Mar 02 '24 06:03 mikeharder

Azure Pipelines successfully started running 4 pipeline(s).

azure-pipelines[bot] avatar Mar 02 '24 06:03 azure-pipelines[bot]