[typespec-next] React to azure/typespec-azure#3121 #24615
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
Member
mikeharder
commented
Jun 27, 2023
mikeharder
commented
- Sort autorest output with json schema
- Sort autorest output with json schema
mikeharder
requested review from
palma21,
weinong,
alvinli222,
matthchr,
circy9,
yangyuan and
a team
as code owners
|
Hi, @mikeharder 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. [email protected] |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| openapi.json | v1.1(43ad749) | v1.1(main) |
| generated.json | 2023-06-01-preview(43ad749) | 2023-06-01-preview(main) |
| generated.json | 2022-12-01(43ad749) | 2022-12-01(main) |
| generated.json | 2023-05-15(43ad749) | 2023-05-15(main) |
| contentsafety.json | 2023-04-30-preview(43ad749) | 2023-04-30-preview(main) |
| openapi.json | 2023-03-01-preview(43ad749) | 2023-03-01-preview(main) |
| mccfgov.json | 2023-06-01-preview(43ad749) | 2023-06-01-preview(main) |
| fleets.json | 2022-09-02-preview(43ad749) | 2022-09-02-preview(main) |
| fleets.json | 2023-03-15-preview(43ad749) | 2023-03-15-preview(main) |
| containerstorage.json | 2023-03-01-preview(43ad749) | 2023-03-01-preview(main) |
| widgets.json | 2022-11-01-preview(43ad749) | 2022-11-01-preview(main) |
| TrafficController.json | 2023-05-01-preview(43ad749) | 2023-05-01-preview(main) |
| azuresphere.json | 2022-09-01-preview(43ad749) | 2022-09-01-preview(main) |
| openapi.json | v3.0(43ad749) | v3.0(main) |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.3) | new version | base version |
|---|---|---|
| default | default(43ad749) | default(typespec-next) |
| default | default(43ad749) | default(typespec-next) |
| default | default(43ad749) | default(typespec-next) |
| default | default(43ad749) | default(typespec-next) |
| default | default(43ad749) | default(typespec-next) |
| default | default(43ad749) | default(typespec-next) |
| default | default(43ad749) | default(typespec-next) |
| default | default(43ad749) | default(typespec-next) |
| default | default(43ad749) | default(typespec-next) |
| default | default(43ad749) | default(typespec-next) |
| default | default(43ad749) | default(typespec-next) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
Per the Noun_Verb convention for Operation Ids, the noun 'Multivariate' 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: AnomalyDetector/stable/v1.1/openapi.json#L72 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Multivariate' 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: AnomalyDetector/stable/v1.1/openapi.json#L114 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Multivariate' 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: AnomalyDetector/stable/v1.1/openapi.json#L155 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Multivariate' 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: AnomalyDetector/stable/v1.1/openapi.json#L204 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Multivariate' 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: AnomalyDetector/stable/v1.1/openapi.json#L243 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true.Location: AnomalyDetector/stable/v1.1/openapi.json#L280 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Multivariate' 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: AnomalyDetector/stable/v1.1/openapi.json#L281 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Multivariate' 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: AnomalyDetector/stable/v1.1/openapi.json#L341 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Univariate' 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: AnomalyDetector/stable/v1.1/openapi.json#L391 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Univariate' 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: AnomalyDetector/stable/v1.1/openapi.json#L434 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Univariate' 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: AnomalyDetector/stable/v1.1/openapi.json#L477 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'TextBlocklists' 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: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L97 |
|
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L108 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'TextBlocklists' 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: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L156 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'TextBlocklists' 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: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L200 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'TextBlocklists' 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: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L262 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'TextBlocklists' 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: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L410 |
|
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L439 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'TextBlocklists' 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: ContentSafety/preview/2023-04-30-preview/contentsafety.json#L487 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true.Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L59 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L105 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true.Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L190 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L236 |
|
Property 'jobId' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1534 |
|
Property 'createdDateTime' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1534 |
|
Property 'expirationDateTime' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1534 |
|
Property 'lastUpdateDateTime' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1534 |
|
Property 'status' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1534 |
|
Property 'jobId' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1883 |
|
Property 'createdDateTime' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1883 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 14 Errors, 0 Warnings failed [Detail]
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️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.
mikeharder
requested review from
stewartadam and
johanste
and removed request for
a team
Swagger Generation Artifacts
|
Generated ApiView
|
ghost
added
This was referenced Jun 27, 2023
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
|
Hi @mikeharder! The automation detected breaking changes in this pull request. As a result, it added the |
|
Hi @mikeharder! Your PR has some issues. Please fix the CI issues, if present, in following order:
If you need further help, please reach out on the Teams channel aka.ms/azsdk/support/specreview-channel. |
timotheeguerin
approved these changes
Jun 27, 2023
There was a problem hiding this comment.
Compared a few in https://jsondiff.com and showing no diff in semantic meaning
This was referenced Jun 27, 2023
This was referenced Jun 27, 2023
This was referenced Jun 27, 2023
|
Failures in "Swagger ModelValidation":
|
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.