-
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
[typespec-next] Add linter rules to tspconfig.yaml #25675
Merged
mikeharder
merged 15 commits into
Azure:typespec-next
from
mikeharder:typespec-next-3313
Sep 7, 2023
Merged
[typespec-next] Add linter rules to tspconfig.yaml #25675
mikeharder
merged 15 commits into
Azure:typespec-next
from
mikeharder:typespec-next-3313
Sep 7, 2023
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
Automatic PR validation restarted. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛. |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
openapi.json | v1.1(96f511d) | v1.1(main) |
openapi.json | 2023-03-01-preview(96f511d) | 2023-03-01-preview(main) |
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️
LintDiff: 2 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.4) | new version | base version |
---|---|---|
release_1_1 | release_1_1(96f511d) | release_1_1(typespec-next) |
2023-03-01-preview | 2023-03-01-preview(96f511d) | 2023-03-01-preview(typespec-next) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
Schema name should be Pascal case. Location: AnomalyDetector/stable/v1.1/openapi.json#L520 |
||
Schema name should be Pascal case. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L492 |
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#L155 |
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#L243 |
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 |
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 |
XmsEnumValidation |
The enum types should have x-ms-enum type extension set with appropriate options. Location: HealthInsights/preview/2023-03-01-preview/openapi.json#L231 |
API version should be a date in YYYY-MM-DD format, optionally suffixed with '-preview'. Location: AnomalyDetector/stable/v1.1/openapi.json#L5 |
|
Based on the response model schema, operation 'Multivariate_GetMultivariateBatchDetectionResult' might be pageable. Consider adding the x-ms-pageable extension. Location: AnomalyDetector/stable/v1.1/openapi.json#L71 |
|
Operation might be pageable. Consider adding the x-ms-pageable extension. Location: AnomalyDetector/stable/v1.1/openapi.json#L71 |
|
Operation does not define an 'api-version' query parameter. Location: AnomalyDetector/stable/v1.1/openapi.json#L75 |
|
Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: AnomalyDetector/stable/v1.1/openapi.json#L76 |
|
Error response schema should contain an object property named error .Location: AnomalyDetector/stable/v1.1/openapi.json#L94 |
|
Operation does not define an 'api-version' query parameter. Location: AnomalyDetector/stable/v1.1/openapi.json#L117 |
|
Response body schema of pageable response should contain top-level array property value Location: AnomalyDetector/stable/v1.1/openapi.json#L128 |
|
Error response schema should contain an object property named error .Location: AnomalyDetector/stable/v1.1/openapi.json#L134 |
|
Operation does not define an 'api-version' query parameter. Location: AnomalyDetector/stable/v1.1/openapi.json#L158 |
|
Using post for a create operation is discouraged. Location: AnomalyDetector/stable/v1.1/openapi.json#L170 |
|
Error response schema should contain an object property named error .Location: AnomalyDetector/stable/v1.1/openapi.json#L184 |
|
Operation does not define an 'api-version' query parameter. Location: AnomalyDetector/stable/v1.1/openapi.json#L207 |
|
Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: AnomalyDetector/stable/v1.1/openapi.json#L208 |
|
Error response schema should contain an object property named error .Location: AnomalyDetector/stable/v1.1/openapi.json#L225 |
|
Operation does not define an 'api-version' query parameter. Location: AnomalyDetector/stable/v1.1/openapi.json#L246 |
|
Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: AnomalyDetector/stable/v1.1/openapi.json#L247 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️❌
TypeSpecAPIView: 0 Errors, 5 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." | |
"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." | |
"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#L212:18 ExampleUrl: preview/2023-03-01-preview/examples/SuccessfulTrialMatcherRequest.json#L149:16 |
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌
PrettierCheck: 2 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
HowToFix |
Code style issues found path: AnomalyDetector/stable/v1.1/openapi.json |
HowToFix |
Code style issues found path: HealthInsights/preview/2023-03-01-preview/openapi.json |
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️
Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
/azp run |
Azure Pipelines successfully started running 2 pipeline(s). |
/azp run |
Azure Pipelines successfully started running 2 pipeline(s). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
BreakingChangeReviewRequired
<valid label in PR review process>add this label when breaking change review is required
data-plane
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.
Failing checks
@azure-tools/typespec-apiview
is not compatible with dev versions