Update operation names to minimize changes to the API Documentation#28329
Merged
Update operation names to minimize changes to the API Documentation#28329
Conversation
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see https://aka.ms/azsdk/specreview/merge. |
Swagger Validation Report
|
| Compared specs (v0.10.5) | new version | base version |
|---|---|---|
| devcenter.json | 2023-04-01(c818fca) | 2023-04-01(main) |
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
1008 - ModifiedOperationId |
The operation id has been changed from 'DevBoxesDevCenter_ListAllDevBoxes' to 'DevCenter_ListAllDevBoxes'. This will impact generated code. New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L55:7 Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L55:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'DevCenterOperations_ListProjects' to 'DevCenter_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#L94:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'DevCenterOperations_GetProject' to 'DevCenter_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#L133:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'EnvironmentsOperations_ListCatalogs' to 'Environments_ListCatalogsByProject'. This will impact generated code. New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L179:7 Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L179:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'EnvironmentsOperations_GetCatalog' to 'Environments_GetCatalog'. This will impact generated code. New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L228:7 Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L228:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'EnvironmentsOperations_ListEnvironmentDefinitionsByCatalog' to 'Environments_ListEnvironmentDefinitionsByCatalog'. This will impact generated code. New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L284:7 Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L284:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'EnvironmentsOperations_GetEnvironmentDefinition' to 'Environments_GetEnvironmentDefinition'. This will impact generated code. New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L337:7 Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L337:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'EnvironmentsOperations_ListEnvironmentDefinitions' to 'Environments_ListEnvironmentDefinitionsByProject'. This will impact generated code. New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L403:7 Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L403:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'EnvironmentsOperations_ListEnvironmentTypes' to 'Environments_ListEnvironmentTypes'. This will impact generated code. New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L449:7 Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L449:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'EnvironmentsOperations_ListAllEnvironments' to 'Environments_ListEnvironments'. This will impact generated code. New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L495:7 Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L495:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'SharedOperations_GetProjectOperationStatus' to 'OperationStatuses_Get'. This will impact generated code. New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L541:7 Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L541:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'DevBoxesOperations_ListPools' to 'DevBoxes_ListPools'. This will impact generated code. New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L594:7 Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L594:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'DevBoxesOperations_GetPool' to 'DevBoxes_GetPool'. This will impact generated code. New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L643:7 Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L643:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'DevBoxesOperations_ListSchedules' to 'DevBoxes_ListSchedulesByPool'. This will impact generated code. New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L696:7 Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L696:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'DevBoxesOperations_GetSchedule' to 'DevBoxes_GetScheduleByPool'. This will impact generated code. New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L752:7 Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L752:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'DevBoxesOperations_ListDevBoxes' to 'DevBoxes_ListDevBoxesByUser'. This will impact generated code. New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L812:7 Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L812:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'DevBoxesOperations_GetDevBox' to 'DevBoxes_GetDevBoxByUser'. This will impact generated code. New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L865:7 Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L865:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'DevBoxesOperations_CreateDevBox' to 'DevBoxes_CreateDevBox'. This will impact generated code. New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L929:7 Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L929:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'DevBoxesOperations_DeleteDevBox' to 'DevBoxes_DeleteDevBox'. This will impact generated code. New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1010:7 Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1010:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'DevBoxesOperations_StartDevBox' to 'DevBoxes_StartDevBox'. This will impact generated code. New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1079:7 Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1079:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'DevBoxesOperations_StopDevBox' to 'DevBoxes_StopDevBox'. This will impact generated code. New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1153:7 Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1153:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'DevBoxesOperations_RestartDevBox' to 'DevBoxes_RestartDevBox'. This will impact generated code. New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1234:7 Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1234:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'DevBoxesOperations_ListDevBoxActions' to 'DevBoxes_ListActions'. This will impact generated code. New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1308:7 Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1308:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'DevBoxesOperations_GetDevBoxAction' to 'DevBoxes_GetAction'. This will impact generated code. New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1377:7 Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1377:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'DevBoxesOperations_SkipAction' to 'DevBoxes_SkipAction'. This will impact generated code. New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1453:7 Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1453:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'DevBoxesOperations_DelayAction' to 'DevBoxes_DelayAction'. This will impact generated code. New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1526:7 Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1526:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'DevBoxesOperations_DelayAllActions' to 'DevBoxes_DelayActions'. This will impact generated code. New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1611:7 Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1611:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'DevBoxesOperations_GetRemoteConnection' to 'DevBoxes_GetRemoteConnection'. This will impact generated code. New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1689:7 Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1689:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'EnvironmentsOperations_ListEnvironments' to 'Environments_ListEnvironmentsByUser'. This will impact generated code. New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1746:7 Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1746:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'EnvironmentsOperations_GetEnvironment' to 'Environments_GetEnvironmentByUser'. This will impact generated code. New: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1799:7 Old: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1799:7 |
️️✔️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 specs (v2.2.0) | new version | base version |
|---|---|---|
| package-2023-04-01 | package-2023-04-01(c818fca) | package-2023-04-01(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
| Security definition should have a description. Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L43 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L291 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L298 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L410 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L456 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L502 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L558 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L660 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L713 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L769 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L776 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L819 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L826 |
|
| OperationId for put method should contain both 'Create' and 'Update' Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L930 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L936 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L943 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L950 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1017 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1024 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1031 |
|
| 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 |
|
| 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 |
|
| 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 |
|
| 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 |
|
| 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 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1696 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1703 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1710 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L1753 |
|
| 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]
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced Mar 19, 2024
|
PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts. |
570505b to
c818fca
Compare
catalinaperalta
approved these changes
Mar 20, 2024
Member
catalinaperalta
left a comment
There was a problem hiding this comment.
Approving the suppression to allow the team to keep their docs close to what they had before the swagger->TypeSpec migration.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR's changes have the only purpose make the Dev Center API Documentation (updated in tsp pr) match our previous public API doc. For that, we are updating some of the operation names to have the generated
operationIdmatch our old one. This shouldn't impact how our service is described nor the generated sdks.