-
Notifications
You must be signed in to change notification settings - Fork 5.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[TypeSpec] Upgrade to 0.45.0 #24326
[TypeSpec] Upgrade to 0.45.0 #24326
Conversation
mikeharder
commented
Jun 6, 2023
•
edited
Loading
edited
- "specs - typespec - ci" is passing
- "Swagger BreakingChange" is failing due to a known breaking change
- First item here: https://github.com/Azure/typespec-azure/issues/3091#issuecomment-1572982611)
- "Swagger ModelValidation" is failing because the failures were ignored in the PR where the spec was first added
- Unrelated to TypeSpec upgrade so not blocking
- Tracking issue: [Cognitive Services - Health Insights] Swagger ModelValidation failures #24328
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(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 |
---|---|
OperationIdNounVerb |
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 |
OperationIdNounVerb |
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 |
OperationIdNounVerb |
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 |
OperationIdNounVerb |
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 |
OperationIdNounVerb |
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 |
LroExtension |
Operations with a 202 response must specify x-ms-long-running-operation: true .Location: AnomalyDetector/stable/v1.1/openapi.json#L280 |
OperationIdNounVerb |
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 |
OperationIdNounVerb |
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 |
OperationIdNounVerb |
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 |
OperationIdNounVerb |
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 |
OperationIdNounVerb |
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 |
OperationIdNounVerb |
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 |
AvoidAnonymousTypes |
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 |
OperationIdNounVerb |
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 |
OperationIdNounVerb |
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 |
OperationIdNounVerb |
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 |
OperationIdNounVerb |
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 |
AvoidAnonymousTypes |
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 |
OperationIdNounVerb |
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 |
LroExtension |
Operations with a 202 response must specify x-ms-long-running-operation: true .Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L59 |
XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L105 |
LroExtension |
Operations with a 202 response must specify x-ms-long-running-operation: true .Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L190 |
XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L236 |
RequiredReadOnlyProperties |
Property 'jobId' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1558 |
RequiredReadOnlyProperties |
Property 'createdDateTime' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1558 |
RequiredReadOnlyProperties |
Property 'expirationDateTime' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1558 |
RequiredReadOnlyProperties |
Property 'lastUpdateDateTime' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1558 |
RequiredReadOnlyProperties |
Property 'status' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1558 |
RequiredReadOnlyProperties |
Property 'jobId' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1914 |
RequiredReadOnlyProperties |
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 |
---|---|
RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE |
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 |
RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE |
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 |
RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE |
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 |
RESPONSE_STATUS_CODE_NOT_IN_EXAMPLE |
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
|
- Required for apiview
Hi @mikeharder, Your PR has some issues. Please fix the CI sequentially by following the order of
|