[EGv2] Fix pipeline#24098
Merged
lmazuel merged 6 commits intoAzure:feature/eventgrid/typespecfrom May 22, 2023
Merged
Conversation
|
Hi, @l0lawrence 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 |
Swagger Validation Report
|
| Rule | Message |
|---|---|
|
"new":"https://github.com/Azure/azure-rest-api-specs/blob/d8f3627be7d77b5c1feedd523f84bc966dfb2ad6/specification/eventgrid/data-plane/Microsoft.EventGrid/preview/2023-06-01-preview/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":"Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.54/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/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\nERROR: Schema violation: Additional properties not allowed: ?overload=customEvent, ?overload=cloudEvent, ?overload=EventGridEvent\n - 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"])\nFATAL: swagger-document/individual/schema-validator - FAILED\nFATAL: Error: [OperationAbortedException] Error occurred. Exiting.\nProcess() cancelled due to exception : [OperationAbortedException] Error occurred. Exiting.\n" |
️❌LintDiff: 1 Errors, 27 Warnings failed [Detail]
| compared tags (via openapi-validator v2.1.2) | new version | base version |
|---|---|---|
| package-2023-06-01-preview | package-2023-06-01-preview(d8f3627) | default(feature/eventgrid/typespec) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
Paths in x-ms-paths must overload a normal path in the paths section, i.e. a path in the x-ms-paths must either be same as a path in the paths section or a path in the paths sections followed by additional parameters. Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L286 |
|
| Security definition should have a description. Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L43 |
||
| 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#L52 |
||
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L52 |
||
| Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L52 |
||
| OperationId should be of the form 'Noun_Verb' Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L53 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L59 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L66 |
||
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L114 |
||
| Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L114 |
||
| OperationId should be of the form 'Noun_Verb' Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L115 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L121 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L128 |
||
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L171 |
||
| Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L171 |
||
| OperationId should be of the form 'Noun_Verb' Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L172 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L178 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L185 |
||
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L228 |
||
| Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L228 |
||
| OperationId should be of the form 'Noun_Verb' Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L229 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L235 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L242 |
||
| Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L287 |
||
| Schema name should be Pascal case. Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L386 |
||
| Schema name should be Pascal case. Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L422 |
||
| Schema name should be Pascal case. Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L435 |
||
| Property should have a defined type. Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L482 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| Don't use x-ms-paths except where necessary to support legacy APIs. Location: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L285 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 5 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
x-ms-example not found in ReceiveCloudEvents. Url: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L52:15 |
|
x-ms-example not found in AcknowledgeCloudEvents. Url: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L114:15 |
|
x-ms-example not found in ReleaseCloudEvents. Url: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L171:15 |
|
x-ms-example not found in RejectCloudEvents. Url: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L228:15 |
|
x-ms-example not found in PublishCloudEvents. Url: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L287:15 |
️❌SemanticValidation: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Path parameter is declared but is not defined: apiVersion JsonUrl: Microsoft.EventGrid/preview/2023-06-01-preview/EventGrid.json#L287:15 |
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
ghost
added
the
lmazuel
approved these changes
May 22, 2023
lmazuel
added a commit
that referenced
this pull request
May 22, 2023
* start typespec * adding eventgrid typespec for api w/ TODOs * update eventgrid typespec with latest eventgrid v2 operations * don't require content-type if there is no body * Update specification/eventgrid/typespec/main.tsp Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com> * Update specification/eventgrid/typespec/main.tsp Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com> * changing naming of cloudevent and added in data_base64 * openapi.json * Update specification/eventgrid/typespec/main.tsp Co-authored-by: Libba Lawrence <llawrence@microsoft.com> * Update specification/eventgrid/typespec/main.tsp Co-authored-by: Libba Lawrence <llawrence@microsoft.com> * Update specification/eventgrid/typespec/main.tsp Co-authored-by: Libba Lawrence <llawrence@microsoft.com> * lockTokens format, updated json, optional? params * address code review comments * name_change * add @internal for python * Update specification/eventgrid/Azure.Messaging.EventGrid/main.tsp Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com> * move @internal to client.tsp (#23538) * rename (#23565) * [EventGrid Typespec] breaking changes with april release of typespec (#23539) * breaking changes with april release of typespec * unknown type * [EG Typespec] Update Release behavior (#23699) * update behavior * just behavior * Add tspconfig and remove AAD auth (#23717) * add tspconfig * add namespace * remove oauth * [EG TypeSpec] Archboard Comments (#23696) * refactoring off of apiview * keep as int * no duration * aligning ack and release * remove behavioral change * ack to release * initial naming changes * Update ReleaseResult doc Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com> * Update AckResult doc Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com> * versioning twice-- remove one instance --------- Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com> * Address couple of stewardship team feedback. These include: 1. Rename CloudEventEvent to simply CloudEvent, 2. Add more description to the operations including the possible erorr codes, 3. Add PublishResult with empty Json object as successful response for the Publish operation, 4. Others. * Add support for missing Reject operation + adding deliveryAttemptCount to BrokerProperties + Adding query parameter for release operation for deliveryDelayInSeconds * Update failedTokens/SuccessfulTokens Description to address code review comments * Update to match service behavior (#23754) * Update to match service behavior * remove locktoken * [EGv2] Editing unused variables (#23917) * event delivery delay not in preview * remove from url comment * [EGv2] Version dependency on Azure.Core (#23936) * verioning fix * spacing mishap? * [EventGrid] Deliveryattempt change (#23960) * deliveryCount 5/1 * small typo * [EventGrid] Remove internal (#23995) * remove internal * remove client.tsp * remove waitWaitTime (#24078) * move location of json file (#24076) * [Egv2] Encode param (#24080) * encode * remove num default on duration --------- Co-authored-by: Laurent Mazuel <laurent.mazuel@gmail.com> * [EGv2] Fix pipeline (#24098) * regen off new commit for encode * reference preview tag * ignore word * update readme to have both apis * update with next autorest * change format to int32 --------- Co-authored-by: Ashraf Hamad <ahamad@ntdev.microsoft.com> Co-authored-by: Laurent Mazuel <laurent.mazuel@gmail.com> Co-authored-by: JoshLove-msft <54595583+JoshLove-msft@users.noreply.github.com> Co-authored-by: Ashraf Hamad <ahamad-MS@users.noreply.github.com>
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
3 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.
No description provided.