-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
[HealthInsights] Remove import of typespec-autorest #24598
[HealthInsights] Remove import of typespec-autorest #24598
Conversation
mikeharder
commented
Jun 27, 2023
•
edited
Loading
edited
- Causes small change in generated autorest, but I think the removed content was redundant anyway
- Partially fixes Remove imports of typespec-autorest #24565
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
openapi.json | 2023-03-01-preview(2480705) | 2023-03-01-preview(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.3) | new version | base version |
---|---|---|
2023-03-01-preview | 2023-03-01-preview(2480705) | 2023-03-01-preview(main) |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
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#L184 |
XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L230 |
RequiredReadOnlyProperties |
Property 'jobId' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1546 |
RequiredReadOnlyProperties |
Property 'createdDateTime' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1546 |
RequiredReadOnlyProperties |
Property 'expirationDateTime' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1546 |
RequiredReadOnlyProperties |
Property 'lastUpdateDateTime' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1546 |
RequiredReadOnlyProperties |
Property 'status' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1546 |
RequiredReadOnlyProperties |
Property 'jobId' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1902 |
RequiredReadOnlyProperties |
Property 'createdDateTime' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1902 |
RequiredReadOnlyProperties |
Property 'expirationDateTime' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1902 |
RequiredReadOnlyProperties |
Property 'lastUpdateDateTime' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1902 |
RequiredReadOnlyProperties |
Property 'status' is a required property. It should not be marked as 'readonly' Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1902 |
Security definition should have a description. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L43 |
|
header parameter name 'Repeatability-Request-ID' should be kebab case. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L70 |
|
Parameter should have a description. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L76 |
|
Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L147 |
|
header parameter name 'Repeatability-Request-ID' should be kebab case. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L195 |
|
Parameter should have a description. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L201 |
|
Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L272 |
|
Schema should have a description or title. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L370 |
|
Schema name should be Pascal case. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L430 |
|
Schema name should be Pascal case. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L465 |
|
Schema name should be Pascal case. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L478 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1497 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1502 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1515 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1856 |
|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L1861 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️
~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
CadlAPIView succeeded [Detail] [Expand]
️❌
TypeSpecAPIView: 0 Errors, 2 Warnings failed [Detail]
Rule | Message |
---|---|
"How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR." | |
"How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR." |
️❌
ModelValidation: 2 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 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#L211: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.
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 Generation Artifacts
|
Generated ApiView
|
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. |
/azp run |
Azure Pipelines successfully started running 2 pipeline(s). |
@timotheeguerin: I believe this PR is causing this spec to fail check "Swagger ModelValidation". Compare to this no-op PR which passes the same check. So I think these |
Actually this might be a red herring, because "Swagger ModelValidation" always passes if there is no change to the swagger files. Let me update the "no-op" PR to actually change the output swagger. |
Errors in "Swagger ModelValidation" are unrelated to this PR. Will open an issue to get them fixed in main. |
- Causes small change in generated autorest, but I think the removed content was redundant anyway - Partially fixes Azure#24565