Publish Microsoft.DevCenter 2023-04-01 stable API version#22970
Merged
weidongxu-microsoft merged 3 commits intomainfrom Mar 31, 2023
Merged
Publish Microsoft.DevCenter 2023-04-01 stable API version#22970weidongxu-microsoft merged 3 commits intomainfrom
weidongxu-microsoft merged 3 commits intomainfrom
Conversation
chrissmiller
requested review from
vicancy and
weidongxu-microsoft
and removed request for
a team
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| devcenter.json | 2023-04-01(552eaca) | 2023-01-01-preview(main) |
| environments.json | 2023-04-01(552eaca) | 2023-01-01-preview(main) |
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/552eaca3fb1940d5ec303746017d1764861031e6/specification/devcenter/data-plane/Microsoft.DevCenter/stable/2023-04-01/devbox.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-01-01-preview/devbox.json", "details":"Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.47/common/temp/node_modules/.pnpm/@Azure+oad@0.10.4/node_modules/autorest/dist/app.js" --v2 --input-file=/mnt/vss/_work/1/cross-version-c93b354fd9c14905bb574a8834c4d69b/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-01-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-01-01-preview/devbox.json:715:10 ($.paths["/projects/projectName/users/userId/devboxes/devBoxName:restart"].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" |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2023-04-01 | package-2023-04-01(552eaca) | 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/stable/2023-04-01/devbox.json#L369 |
|
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/stable/2023-04-01/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/stable/2023-04-01/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/stable/2023-04-01/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/stable/2023-04-01/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/stable/2023-04-01/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/stable/2023-04-01/environments.json#L423 |
|
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/stable/2023-04-01/environments.json#L474 |
|
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/stable/2023-04-01/environments.json#L525 |
|
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/stable/2023-04-01/environments.json#L570 |
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.DevCenter/stable/2023-04-01/devbox.json#L212 |
|
| OperationId for put method should contain both 'Create' and 'Update' Location: Microsoft.DevCenter/stable/2023-04-01/devbox.json#L476 |
|
| Schema with type: number should specify format Location: Microsoft.DevCenter/stable/2023-04-01/devbox.json#L540 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.DevCenter/stable/2023-04-01/devbox.json#L573 |
|
| Schema with type: number should specify format Location: Microsoft.DevCenter/stable/2023-04-01/devbox.json#L601 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.DevCenter/stable/2023-04-01/devbox.json#L631 |
|
| Schema with type: number should specify format Location: Microsoft.DevCenter/stable/2023-04-01/devbox.json#L662 |
|
| A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled. Location: Microsoft.DevCenter/stable/2023-04-01/devbox.json#L692 |
|
| Schema with type: number should specify format Location: Microsoft.DevCenter/stable/2023-04-01/devbox.json#L720 |
|
| Since operation response has model definition in array type, it should be of the form '_list'. Location: Microsoft.DevCenter/stable/2023-04-01/devbox.json#L1004 |
|
| Schema name should be Pascal case. Location: Microsoft.DevCenter/stable/2023-04-01/devbox.json#L1498 |
|
| 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/devbox.json#L1796 |
|
| Error response should contain a x-ms-error-code header. Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L69 |
|
| Error response should contain a x-ms-error-code header. Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L108 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L247 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.DevCenter/stable/2023-04-01/devcenter.json#L254 |
|
| Schema with type: number should specify format Location: Microsoft.DevCenter/stable/2023-04-01/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/stable/2023-04-01/environments.json#L817 |
|
| 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/environments.json#L821 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The JSON file has a circular reference. readme: specification/devcenter/data-plane/readme.md json: Microsoft.DevCenter/stable/2023-04-01/devcenter.json |
️️✔️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]
️️✔️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.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
|
Swagger pipeline restarted successfully, please wait for status update in this comment. |
Generated ApiView
|
|
Hi, @chrissmiller Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
|
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. For more details refer to the wiki. Or you could onboard API spec pipeline |
Contributor
Author
|
@anuchandy Is there anything we need to do for getting this merged? All changes have gone through API board review, as this is a copy of our published preview API. |
mikekistler
reviewed
Mar 24, 2023
Member
mikekistler
left a comment
mikekistler
left a comment
There was a problem hiding this comment.
I looked one more time and found one minor issue. Is this too late to fix?
I looked at the prior PRs and it seems we just missed this -- sorry.
specification/devcenter/data-plane/Microsoft.DevCenter/stable/2023-04-01/devbox.json
Show resolved
Hide resolved
specification/devcenter/data-plane/Microsoft.DevCenter/stable/2023-04-01/environments.json
Show resolved
Hide resolved
Contributor
Author
|
@anuchandy We're OK to get this merged whenever :) |
weidongxu-microsoft
added
the
APIStewardshipBoard-SignedOff
JoshLove-msft
pushed a commit
to JoshLove-msft/azure-rest-api-specs
that referenced
this pull request
Apr 25, 2023
* Add base * Update API version * Update readme
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
5 participants
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
Copying 2023-01-01-preview API version into 2023-04-01 stable API version. This API has no changes from 2023-01-01-preview, and is copied verbatim (only changes are the API version changes).
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your engagement record.
Is this review for (select one):
Change Scope
N/A (no changes from previous approval)
❔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