[Microsoft.DevCenter] Update operation ID for SDK generation #25333
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
chrissmiller
requested review from
scgbear and
bexxx
and removed request for
a team
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 |
|---|---|---|
| environments.json | 2023-07-01-preview(eac615d) | 2023-07-01-preview(main) |
| Rule | Message |
|---|---|
|
The operation id has been changed from 'EnvironmentOperations_ListByEnvironment' to 'Environments_ListOperations'. This will impact generated code. New: Microsoft.DevCenter/preview/2023-07-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-07-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-07-01-preview/environments.json#L424:7 Old: Microsoft.DevCenter/preview/2023-07-01-preview/environments.json#L424:7 |
|
"new":"https://github.com/Azure/azure-rest-api-specs/blob/eac615dd9bcfd8e8f7f8d367e13fb767487af1e1/specification/devcenter/data-plane/Microsoft.DevCenter/preview/2023-07-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/same-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/same-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/same-version-c93b354fd9c14905bb574a8834c4d69b/specification/dev" |
️️✔️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.4) | new version | base version |
|---|---|---|
| package-2023-07-01-preview | package-2023-07-01-preview(eac615d) | package-2023-07-01-preview(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-07-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-07-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-07-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-07-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-07-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-07-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-07-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-07-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-07-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-07-01-preview/environments.json#L735 |
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json#L264 |
|
| OperationId for put method should contain both 'Create' and 'Update' Location: Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json#L528 |
|
| Schema with type: number should specify format Location: Microsoft.DevCenter/preview/2023-07-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-07-01-preview/devbox.json#L625 |
|
| Schema with type: number should specify format Location: Microsoft.DevCenter/preview/2023-07-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-07-01-preview/devbox.json#L683 |
|
| Schema with type: number should specify format Location: Microsoft.DevCenter/preview/2023-07-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-07-01-preview/devbox.json#L744 |
|
| Schema with type: number should specify format Location: Microsoft.DevCenter/preview/2023-07-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-07-01-preview/devbox.json#L802 |
|
| Schema with type: number should specify format Location: Microsoft.DevCenter/preview/2023-07-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-07-01-preview/devbox.json#L1114 |
|
| Schema name should be Pascal case. Location: Microsoft.DevCenter/preview/2023-07-01-preview/devbox.json#L1742 |
|
| 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-07-01-preview/devbox.json#L2326 |
|
| Schema with type: number should specify format Location: Microsoft.DevCenter/preview/2023-07-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-07-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-07-01-preview/environments.json#L1001 |
️️✔️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.
️️✔️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
|
|
Breaking change justification:
|
3 tasks
|
@jhendrixMSFT @scgbear @bexxx , would appreciate any review/next steps, provided justification/confirmation that the breaking change alert is a false alarm above (since SDKs have not been generated, and this change is a prereq for SDK gen for us). |
jhendrixMSFT
added
Approved-BreakingChange
jhendrixMSFT
approved these changes
Aug 30, 2023
|
Swagger pipeline restarted successfully, please wait for status update in this comment. |
jnlycklama
pushed a commit
that referenced
this pull request
Nov 8, 2023
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
We are starting the process of generating SDKs for the 2023-07-01-preview API version, and per previous guidance from the SDK board we need to ensure our operation IDs are consistent across our APIs. This PR updates our new operations APIs to follow the operationId pattern we've been recommended to use. This is the first API that introduces these operations, and there are no previously generated SDKs that include them.
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):
❔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