Conversation
|
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. vscswagger@microsoft.com |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| openapi.json | v1.1(7758832) | v1.1(main) |
| contentsafety.json | 2023-04-30-preview(7758832) | 2023-04-30-preview(main) |
| openapi.json | 2023-03-01-preview(7758832) | 2023-03-01-preview(main) |
| fleets.json | 2022-09-02-preview(7758832) | 2022-09-02-preview(main) |
| fleets.json | 2023-03-15-preview(7758832) | 2023-03-15-preview(main) |
| widgets.json | 2022-11-01-preview(7758832) | 2022-11-01-preview(main) |
| TrafficController.json | 2023-05-01-preview(7758832) | 2023-05-01-preview(main) |
| openapi.json | v3.0(7758832) | v3.0(main) |
️️✔️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.2) | new version | base version |
|---|---|---|
| release_1_1 | release_1_1(7758832) | release_1_1(main) |
| package-2023-04-30-preview | package-2023-04-30-preview(7758832) | package-2023-04-30-preview(main) |
| 2023-03-01-preview | 2023-03-01-preview(7758832) | 2023-03-01-preview(main) |
| package-2023-03-preview | package-2023-03-preview(7758832) | package-2023-03-preview(main) |
| package-2022-09-preview | package-2022-09-preview(7758832) | package-2022-09-preview(main) |
| package-2022-11-01-preview | package-2022-11-01-preview(7758832) | package-2022-11-01-preview(main) |
| default | default(7758832) | default(main) |
| release_3_0 | release_3_0(7758832) | release_3_0(main) |
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#L161 |
|
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#L240 |
|
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#L159 |
|
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#L203 |
|
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#L265 |
|
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#L413 |
|
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#L442 |
|
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#L493 |
|
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#L1558 |
|
Property 'createdDateTime' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1558 |
|
Property 'expirationDateTime' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1558 |
|
Property 'lastUpdateDateTime' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1558 |
|
Property 'status' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1558 |
|
Property 'jobId' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1914 |
|
Property 'createdDateTime' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1914 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
Validation passes for ServiceAPIReadinessTest.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 4 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Following response status codes 200 for operation OncoPhenotype_CreateJob were present in the swagger spec, however they were not present in x-ms-examples. Please provide them. Url: HealthInsights/preview/2023-03-01-preview/openapi.json#L86:18 ExampleUrl: preview/2023-03-01-preview/examples/SuccessfulOncoPhenotypeRequest.json#L52:16 |
|
Following response status codes 200 for operation OncoPhenotype_CreateJob were present in the swagger spec, however they were not present in x-ms-examples. Please provide them. Url: HealthInsights/preview/2023-03-01-preview/openapi.json#L86:18 ExampleUrl: preview/2023-03-01-preview/examples/SuccessfulOncoPhenotypeRequest.json#L52:16 |
|
Following response status codes 200 for operation TrialMatcher_CreateJob were present in the swagger spec, however they were not present in x-ms-examples. Please provide them. Url: HealthInsights/preview/2023-03-01-preview/openapi.json#L217:18 ExampleUrl: preview/2023-03-01-preview/examples/SuccessfulTrialMatcherRequest.json#L149:16 |
|
Following response status codes 200 for operation TrialMatcher_CreateJob were present in the swagger spec, however they were not present in x-ms-examples. Please provide them. Url: HealthInsights/preview/2023-03-01-preview/openapi.json#L217:18 ExampleUrl: preview/2023-03-01-preview/examples/SuccessfulTrialMatcherRequest.json#L149:16 |
️️✔️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.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced Jun 6, 2023
- Required for apiview
mikeharder
requested review from
a team,
alvinli222,
circy9,
matthchr,
palma21,
weinong and
yangyuan
as code owners
mikeharder
requested review from
markcowl,
scgbear and
stewartadam
and removed request for
a team
markcowl
approved these changes
Jun 7, 2023
|
Hi @mikeharder, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Jun 7, 2023
Closed
harryli0108
pushed a commit
to harryli0108/azure-rest-api-specs
that referenced
this pull request
Jul 28, 2023
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.
Uh oh!
There was an error while loading. Please reload this page.