-
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
Fix topContributorCount to be optional with default of 10 #23806
Conversation
Hi, @mikekistler 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(e3d002f) | v1.1(main) |
Rule | Message |
---|---|
1025 - RequiredStatusChange |
The 'required' status changed from the old version('True') to the new version('False'). New: AnomalyDetector/stable/v1.1/openapi.json#L930:7 Old: AnomalyDetector/stable/v1.1/openapi.json#L930:7 |
1027 - DefaultValueChanged |
The new version has a different default value than the previous one. New: AnomalyDetector/stable/v1.1/openapi.json#L936:9 Old: AnomalyDetector/stable/v1.1/openapi.json#L936:9 |
️️✔️
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.0.1) | new version | base version |
---|---|---|
release_1_1 | release_1_1(e3d002f) | release_1_1(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#L71 |
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#L113 |
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#L160 |
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#L203 |
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#L239 |
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#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#L340 |
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#L390 |
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#L433 |
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#L476 |
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#L70 |
|
Operation might be pageable. Consider adding the x-ms-pageable extension. Location: AnomalyDetector/stable/v1.1/openapi.json#L70 |
|
Operation does not define an 'api-version' query parameter. Location: AnomalyDetector/stable/v1.1/openapi.json#L74 |
|
Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: AnomalyDetector/stable/v1.1/openapi.json#L75 |
|
Schema with type: string has unrecognized format: uri Location: AnomalyDetector/stable/v1.1/openapi.json#L87 |
|
Error response schema should contain an object property named error .Location: AnomalyDetector/stable/v1.1/openapi.json#L99 |
|
Operation does not define an 'api-version' query parameter. Location: AnomalyDetector/stable/v1.1/openapi.json#L116 |
|
Schema with type: string has unrecognized format: uri Location: AnomalyDetector/stable/v1.1/openapi.json#L122 |
|
Using post for a create operation is discouraged. Location: AnomalyDetector/stable/v1.1/openapi.json#L128 |
|
Schema with type: string has unrecognized format: uri Location: AnomalyDetector/stable/v1.1/openapi.json#L136 |
|
Error response schema should contain an object property named error .Location: AnomalyDetector/stable/v1.1/openapi.json#L148 |
|
Operation does not define an 'api-version' query parameter. Location: AnomalyDetector/stable/v1.1/openapi.json#L163 |
|
Response body schema of pageable response should contain top-level array property value Location: AnomalyDetector/stable/v1.1/openapi.json#L174 |
|
Error response schema should contain an object property named error .Location: AnomalyDetector/stable/v1.1/openapi.json#L186 |
|
Operation does not define an 'api-version' query parameter. Location: AnomalyDetector/stable/v1.1/openapi.json#L206 |
|
Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: AnomalyDetector/stable/v1.1/openapi.json#L207 |
|
Error response schema should contain an object property named error .Location: AnomalyDetector/stable/v1.1/openapi.json#L227 |
|
Operation does not define an 'api-version' query parameter. Location: AnomalyDetector/stable/v1.1/openapi.json#L242 |
|
Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: AnomalyDetector/stable/v1.1/openapi.json#L243 |
️️✔️
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, 1 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." |
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
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
|
Hi @mikekistler, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
@mikekistler to be clear, this is a correction and not a breaking service change? |
Sorry ... I should have stated this clearly in the description. This is a correction of the API definition to match the behavior of the service, which has not changed. |
This PR fixes the
topContributorCount
field ofMultivariateBatchDetectionOptions
to be optional with a default of 10.#23434 made a similar fix in
MultivariateLastDetectionOptions
but missed it inMultivariateBatchDetectionOptions
.