Minor updates to MVAD from .NET user studies#23701
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(b54902f) | v1.1(main) |
| Rule | Message |
|---|---|
1023 - TypeFormatChanged |
The new version has a different format than the previous one. New: AnomalyDetector/stable/v1.1/openapi.json#L931:9 Old: AnomalyDetector/stable/v1.1/openapi.json#L926:9 |
1023 - TypeFormatChanged |
The new version has a different format than the previous one. New: AnomalyDetector/stable/v1.1/openapi.json#L756:9 Old: AnomalyDetector/stable/v1.1/openapi.json#L756:9 |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 6 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| release_1_1 | release_1_1(b54902f) | release_1_1(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Schema with type: string has unrecognized format: uri Location: AnomalyDetector/stable/v1.1/openapi.json#L87 |
||
| Schema with type: string has unrecognized format: uri Location: AnomalyDetector/stable/v1.1/openapi.json#L122 |
||
| Schema with type: string has unrecognized format: uri Location: AnomalyDetector/stable/v1.1/openapi.json#L136 |
||
| Schema with type: string has unrecognized format: uri Location: AnomalyDetector/stable/v1.1/openapi.json#L254 |
||
| Schema with type: string has unrecognized format: uri Location: AnomalyDetector/stable/v1.1/openapi.json#L296 |
||
| Schema with type: string has unrecognized format: uri Location: AnomalyDetector/stable/v1.1/openapi.json#L314 |
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 |
|
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 |
|
| Using post for a create operation is discouraged. 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#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 valueLocation: 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 |
|
Error response schema should contain an object property named error.Location: AnomalyDetector/stable/v1.1/openapi.json#L266 |
|
Operations with a 202 response should specify x-ms-long-running-operation: true.Location: AnomalyDetector/stable/v1.1/openapi.json#L279 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: AnomalyDetector/stable/v1.1/openapi.json#L279 |
️️✔️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 succeeded [Detail] [Expand]
️️✔️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: 17 Errors, 5 Warnings failed [Detail]
| Rule | Message |
|---|---|
unknown-identifier |
Unknown identifier Cadl Location: specification/cognitiveservices/OpenAI.Authoring/model.routes.tsp#L9 |
unknown-identifier |
Unknown identifier Cadl Location: specification/cognitiveservices/OpenAI.Authoring/model.routes.tsp#L10 |
unknown-identifier |
Unknown identifier Cadl Location: specification/cognitiveservices/OpenAI.Authoring/finetune.tsp#L93 |
unknown-decorator |
Unknown decorator Location: specification/cognitiveservices/OpenAI.Authoring/finetune.tsp#L93 |
unknown-identifier |
Unknown identifier route Location: specification/cognitiveservices/OpenAI.Authoring/model.routes.tsp#L27 |
unknown-decorator |
Unknown decorator Location: specification/cognitiveservices/OpenAI.Authoring/model.routes.tsp#L27 |
unknown-identifier |
Unknown identifier get Location: specification/cognitiveservices/OpenAI.Authoring/model.routes.tsp#L28 |
unknown-decorator |
Unknown decorator Location: specification/cognitiveservices/OpenAI.Authoring/model.routes.tsp#L28 |
import-not-found |
Couldn't resolve import "@azure-tools/typespec-client-generator-core" Location: specification/cognitiveservices/OpenAI.Inference/routes.tsp#L4 |
invalid-ref |
Namespace Azure doesn't have member ClientGenerator Location: specification/cognitiveservices/OpenAI.Inference/routes.tsp#L12 |
unknown-identifier |
Unknown identifier convenientAPI Location: specification/cognitiveservices/OpenAI.Inference/routes.tsp#L19 |
unknown-decorator |
Unknown decorator Location: specification/cognitiveservices/OpenAI.Inference/routes.tsp#L19 |
unknown-identifier |
Unknown identifier convenientAPI Location: specification/cognitiveservices/OpenAI.Inference/routes.tsp#L26 |
unknown-decorator |
Unknown decorator Location: specification/cognitiveservices/OpenAI.Inference/routes.tsp#L26 |
SwaggerNotExistInPR |
"details":"The generated swagger file specification/cognitiveservices/AnomalyDetector/openapi.json from typespec specification/cognitiveservices/AnomalyDetector is not in the PR, please make sure it presents into the PR." |
MissingExamplesDirectory |
"details":"The 'examples' directory is missing in the typespec folder specification/cognitiveservices/OpenAI.Authoring, please ensure the 'examples' is added in the PR." |
MissingExamplesDirectory |
"details":"The 'examples' directory is missing in the typespec folder specification/cognitiveservices/OpenAI.Inference, please ensure the 'examples' is added in the PR." |
| "details":"The configuration 'azure-resource-provider-folder' for '@azure-tools/typespec-autorest' is missing in the tspconfig.yaml under folder specification/cognitiveservices/AnomalyDetector, please ensure it is added in the configuration of the emitter '@azure-tools/typespec-autorest'." |
|
| "details":"The configuration 'output-file' for '@azure-tools/typespec-autorest' is missing in the tspconfig.yaml under folder specification/cognitiveservices/OpenAI.Authoring, please ensure it is added in the configuration of the emitter '@azure-tools/typespec-autorest'." |
|
| "details":"The configuration 'azure-resource-provider-folder' for '@azure-tools/typespec-autorest' is missing in the tspconfig.yaml under folder specification/cognitiveservices/OpenAI.Authoring, please ensure it is added in the configuration of the emitter '@azure-tools/typespec-autorest'." |
|
| "details":"The configuration 'output-file' for '@azure-tools/typespec-autorest' is missing in the tspconfig.yaml under folder specification/cognitiveservices/OpenAI.Inference, please ensure it is added in the configuration of the emitter '@azure-tools/typespec-autorest'." |
|
| "details":"The configuration 'azure-resource-provider-folder' for '@azure-tools/typespec-autorest' is missing in the tspconfig.yaml under folder specification/cognitiveservices/OpenAI.Inference, please ensure it is added in the configuration of the emitter '@azure-tools/typespec-autorest'." |
️️✔️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. |
Data Plane API - Pull Request
This PR makes minor, non-breaking changes to the Multivariate Anomaly Detector REST API. Some changes may trigger warnings about impacts to SDKs, but the SDKs are still in beta so the changes should be allowed.
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.
Is this review for (select one):
Change Scope
This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.
❔Got questions? Need additional info?? We are here to help!
Contact us!
The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.
Click here for links to tools, specs, guidelines & other good stuff
Tooling
Guidelines & Specifications
Helpful Links