[Event Grid Data Plane] Added GA apiversion 2023-11-01 #26425
Merged
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
Next Steps to MergeNext steps that must be taken to merge this PR:
|
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| EventGrid.json | 2023-06-01-preview(cf4872c) | 2023-06-01-preview(main) |
| Rule | Message |
|---|---|
|
The new version is missing a path that was found in the old version. Was path '/topics/{topicName}/eventsubscriptions/{eventSubscriptionName}:renewLock' removed or restructured? Old: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L405:5 |
|
The new version is missing a definition that was found in the old version. Was 'RenewLockOptions' removed or renamed? New: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L361:3 Old: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L460:3 |
|
The order of parameter 'releaseOptions' was changed. New: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L246:9 Old: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L246:9 |
|
The optional parameter 'releaseDelayInSeconds' was removed in the new version. Old: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L264:11 |
️❌Breaking Change(Cross-Version): 1 Errors, 4 Warnings failed [Detail]
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| EventGrid.json | 2023-11-01(cf4872c) | 2023-10-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
| Rule | Message |
|---|---|
|
"new":"https://github.com/Azure/azure-rest-api-specs/blob/cf4872c469bdb136b46acb16ab30c177b52d1d83/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2023-11-01/EventGrid.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/EventGrid.json", "details":"Breaking change detector (OAD) invoked AutoRest. AutoRest threw a runtime error. First 6 lines of stack trace follow, indexed. First line should contain AutoRest command line invocation details. Second line should contain the main message reported by AutoRest. ==================== 1: Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.61/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/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/EventGrid.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=old --output-folder=/tmp -------------------- 2: ERROR: Schema violation: Additional properties not allowed: ?overload=customEvent, ?overload=cloudEvent, ?overload=EventGridEvent -------------------- 3: - file:///mnt/vss/_work/1/cross-version-c93b354fd9c14905bb574a8834c4d69b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/EventGrid.json:33:2 ($["x-ms-paths"]) -------------------- 4: FATAL: swagger-document/individual/schema-validator - FAILED -------------------- 5: FATAL: Error: [OperationAbortedException] Error occurred. Exiting. -------------------- 6: Process() cancelled due to exception : [OperationAbortedException] Error occurred. Exiting. --------------------" |
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
| The new version is missing a path that was found in the old version. Was path '/topics/{topicName}/eventsubscriptions/{eventSubscriptionName}:renewLock' removed or restructured? Old: Microsoft.EventGrid/preview/2023-10-01-preview/EventGrid.json#L405:5 |
|
| The new version is missing a definition that was found in the old version. Was 'RenewLockOptions' removed or renamed? New: Microsoft.EventGrid/stable/2023-11-01/EventGrid.json#L361:3 Old: Microsoft.EventGrid/preview/2023-10-01-preview/EventGrid.json#L465:3 |
|
| The order of parameter 'releaseOptions' was changed. New: Microsoft.EventGrid/stable/2023-11-01/EventGrid.json#L246:9 Old: Microsoft.EventGrid/preview/2023-10-01-preview/EventGrid.json#L246:9 |
|
| The optional parameter 'releaseDelayInSeconds' was removed in the new version. Old: Microsoft.EventGrid/preview/2023-10-01-preview/EventGrid.json#L264:11 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| package-2023-06-01-preview | package-2023-06-01-preview(cf4872c) | package-2023-06-01-preview(main) |
| package-2023-10-01-preview | package-2023-10-01-preview(cf4872c) | default(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.EventGrid/preview/2023-06-01-preview/EventGrid.json#L45 |
|
| OperationId should be of the form 'Noun_Verb' Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L58 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L67 |
|
| Since operation response has model definition in array type, it should be of the form '_list'. Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L115 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L115 |
|
| OperationId should be of the form 'Noun_Verb' Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L116 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L122 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L129 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L184 |
|
| OperationId should be of the form 'Noun_Verb' Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L185 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L191 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L198 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L243 |
|
| OperationId should be of the form 'Noun_Verb' Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L244 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L250 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L257 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L302 |
|
| OperationId should be of the form 'Noun_Verb' Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L303 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L309 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L316 |
|
| Schema name should be Pascal case. Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L403 |
|
| Schema name should be Pascal case. Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L437 |
|
| Schema name should be Pascal case. Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L450 |
|
| Property should have a defined type. Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L495 |
|
| Security definition should have a description. Location: Microsoft.EventGrid/stable/2023-11-01/EventGrid.json#L45 |
|
| OperationId should be of the form 'Noun_Verb' Location: Microsoft.EventGrid/stable/2023-11-01/EventGrid.json#L58 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.EventGrid/stable/2023-11-01/EventGrid.json#L67 |
|
| Since operation response has model definition in array type, it should be of the form '_list'. Location: Microsoft.EventGrid/stable/2023-11-01/EventGrid.json#L115 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.EventGrid/stable/2023-11-01/EventGrid.json#L115 |
|
| OperationId should be of the form 'Noun_Verb' Location: Microsoft.EventGrid/stable/2023-11-01/EventGrid.json#L116 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 16 Errors, 0 Warnings failed [Detail]
️️✔️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 Generation Artifacts
|
Generated ApiView
|
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
|
Hi @batrived! 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. |
This was referenced Oct 26, 2023
|
Approved by @JeffreyRichter by email |
|
Swagger pipeline restarted successfully, please wait for status update in this comment. |
This was referenced Nov 6, 2023
mikeharder
added a commit
that referenced
this pull request
Nov 6, 2023
- Continuation of #26425 - Update generate autorest with latest version of TypeSpec packages
jnlycklama
pushed a commit
that referenced
this pull request
Nov 8, 2023
* Adding the GA api version * Fixing the order of api versions * Fixing build issue
jnlycklama
pushed a commit
that referenced
this pull request
Nov 8, 2023
- Continuation of #26425 - Update generate autorest with latest version of TypeSpec packages
zman-ms
pushed a commit
that referenced
this pull request
Jan 10, 2024
* Adding the GA api version * Fixing the order of api versions * Fixing build issue
zman-ms
pushed a commit
that referenced
this pull request
Jan 10, 2024
- Continuation of #26425 - Update generate autorest with latest version of TypeSpec packages
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
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.
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiViewcomment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get 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