[Microsoft.DevCenter] Add 2023-09-01-preview dataplane version #25335
Conversation
This file contains 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
…07-01-preview to version 2023-09-01-preview
Next Steps to Merge |
|
Hi, @chrissmiller! Thank you for your pull request. To help get your PR merged: Generated ApiView comment added to this PR. You can use ApiView to show API versions diff. |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| devcenter.json | 2023-09-01-preview(f1b8865) | 2023-04-01(main) |
| devcenter.json | 2023-09-01-preview(f1b8865) | 2023-07-01-preview(main) |
| environments.json | 2023-09-01-preview(f1b8865) | 2023-04-01(main) |
| environments.json | 2023-09-01-preview(f1b8865) | 2023-07-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
|
"new":"https://github.com/Azure/azure-rest-api-specs/blob/f1b886532a28aae136c7dafc9d20a0edf96967ac/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-09-01-preview/devbox.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json", "details":"Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.57/common/temp/node_modules/.pnpm/@Azure[email protected]/node_modules/autorest/dist/app.js" --v2 --input-file=/mnt/vss/_work/1/cross-version-c93b354fd9c14905bb574a8834c4d69b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=old --output-folder=/tmp\nERROR: Schema violation: No enum match for: operation-location\n - file:///mnt/vss/_work/1/cross-version-c93b354fd9c14905bb574a8834c4d69b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json:825:10 ($.paths["/projects/projectName/users/userId/devboxes/devBoxName:repair"].post["x-ms-long-running-operation-options"]["final-state-via"])\nERROR: Schema violation: No enum match for: operation-location\n - file:///mnt/vss/_work/1/cross-version-c93b354fd9c14905bb574a8834c4d69b/specification/" |
| The operation id has been changed from 'EnvironmentOperations_ListByEnvironment' to 'Environments_ListOperations'. This will impact generated code. New: Microsoft.DevCenter/preview/2023-09-01-preview/environments.json#L314:7 Old: Microsoft.DevCenter/preview/2023-07-01-preview/environments.json#L314:7 |
|
| The operation id has been changed from 'EnvironmentOperations_GetByEnvironment' to 'Environments_GetOperation'. This will impact generated code. New: Microsoft.DevCenter/preview/2023-09-01-preview/environments.json#L372:7 Old: Microsoft.DevCenter/preview/2023-07-01-preview/environments.json#L372:7 |
|
| The operation id has been changed from 'EnvironmentOperations_GetLogs' to 'Environments_GetLogsByOperation'. This will impact generated code. New: Microsoft.DevCenter/preview/2023-09-01-preview/environments.json#L424:7 Old: Microsoft.DevCenter/preview/2023-07-01-preview/environments.json#L424:7 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.4) | new version | base version |
|---|---|---|
| package-2023-09-01-preview | package-2023-09-01-preview(f1b8865) | default(main) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
Per the Noun_Verb convention for Operation Ids, the noun 'DevBoxes' 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.DevCenter/preview/2023-09-01-preview/devbox.json#L421 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Environments' 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.DevCenter/preview/2023-09-01-preview/environments.json#L62 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Environments' 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.DevCenter/preview/2023-09-01-preview/environments.json#L113 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Environments' 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.DevCenter/preview/2023-09-01-preview/environments.json#L164 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Environments' 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.DevCenter/preview/2023-09-01-preview/environments.json#L219 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Environments' 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.DevCenter/preview/2023-09-01-preview/environments.json#L275 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Environments' 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.DevCenter/preview/2023-09-01-preview/environments.json#L588 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Environments' 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.DevCenter/preview/2023-09-01-preview/environments.json#L639 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Environments' 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.DevCenter/preview/2023-09-01-preview/environments.json#L690 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Environments' 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.DevCenter/preview/2023-09-01-preview/environments.json#L735 |
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.DevCenter/preview/2023-09-01-preview/devbox.json#L264 |
|
| OperationId for put method should contain both 'Create' and 'Update' Location: Microsoft.DevCenter/preview/2023-09-01-preview/devbox.json#L528 |
|
| Schema with type: number should specify format Location: Microsoft.DevCenter/preview/2023-09-01-preview/devbox.json#L592 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.DevCenter/preview/2023-09-01-preview/devbox.json#L625 |
|
| Schema with type: number should specify format Location: Microsoft.DevCenter/preview/2023-09-01-preview/devbox.json#L653 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.DevCenter/preview/2023-09-01-preview/devbox.json#L683 |
|
| Schema with type: number should specify format Location: Microsoft.DevCenter/preview/2023-09-01-preview/devbox.json#L714 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.DevCenter/preview/2023-09-01-preview/devbox.json#L744 |
|
| Schema with type: number should specify format Location: Microsoft.DevCenter/preview/2023-09-01-preview/devbox.json#L772 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.DevCenter/preview/2023-09-01-preview/devbox.json#L802 |
|
| Schema with type: number should specify format Location: Microsoft.DevCenter/preview/2023-09-01-preview/devbox.json#L830 |
|
| Since operation response has model definition in array type, it should be of the form '_list'. Location: Microsoft.DevCenter/preview/2023-09-01-preview/devbox.json#L1114 |
|
| Schema name should be Pascal case. Location: Microsoft.DevCenter/preview/2023-09-01-preview/devbox.json#L1746 |
|
| 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/preview/2023-09-01-preview/devbox.json#L2330 |
|
| Error response should contain a x-ms-error-code header. Location: Microsoft.DevCenter/preview/2023-09-01-preview/devcenter.json#L69 |
|
| Error response should contain a x-ms-error-code header. Location: Microsoft.DevCenter/preview/2023-09-01-preview/devcenter.json#L108 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.DevCenter/preview/2023-09-01-preview/devcenter.json#L260 |
|
| Schema with type: number should specify format Location: Microsoft.DevCenter/preview/2023-09-01-preview/environments.json#L280 |
|
| 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/preview/2023-09-01-preview/environments.json#L997 |
|
| 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/preview/2023-09-01-preview/environments.json#L1001 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The JSON file has a circular reference. readme: specification/devcenter/data-plane/readme.md json: Microsoft.DevCenter/preview/2023-09-01-preview/devcenter.json |
️️✔️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.
️️✔️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).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
|
Swagger pipeline restarted successfully, please wait for status update in this comment. |
Generated ApiView
|
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
|
Hi @chrissmiller! The automation detected breaking changes in this pull request. As a result, it added the
|
|
Hi @chrissmiller! 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. |
|
Automatic PR validation restarted. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛. |
|
Automatic PR validation restarted. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛. |
|
Hi @chrissmiller, one or multiple validation error/warning suppression(s) is detected in your PR. Please follow the Swagger-Suppression-Process to get approval. |
|
Automatic PR validation restarted. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛. |
|
Automatic PR validation restarted. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛. |
|
Breaking Change Alerts:
Please disregard the operation ID changes; we are updating 2023-07-01-preview, which this spec is based on, in this PR. |
|
Automatic PR validation started. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛. |
|
We probably still need the context on |
|
Breaking changes previously reviewed and approved in #24291 |
mikekistler
added
the
Approved-BreakingChange
weidongxu-microsoft
approved these changes
Aug 18, 2023
|
Approved. If no one have opinion in a few days, I will add the label and merge it. |
weidongxu-microsoft
added
APIStewardshipBoard-SignedOff
weidongxu-microsoft
deleted the
chrissmiller-devcenter-Microsoft.DevCenter-2023-09-01-preview
branch
|
Swagger pipeline restarted successfully, please wait for status update in this comment. |
|
I've merged the PR. I am not sure if meeting schedule would automatically be cancelled. Would you cancel it, if not cancelled automatically? So that the slot could be potentially used by other team. |
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.
Data Plane API - Pull Request
Introducing a displayName property for project, pool, and environment type resources. This mirrors a change on our control plane spec, so that we can surface these properties on the dataplane and improve discoverability/interpretability of these resource types.
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.
Is this review for (select one):
Change Scope
This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.
❔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
fix #25340