Skip to content

Minor updates to MVAD from .NET user studies#23701

Merged
lmazuel merged 1 commit intoAzure:mainfrom
mikekistler:mvad-update2
Apr 27, 2023
Merged

Minor updates to MVAD from .NET user studies#23701
lmazuel merged 1 commit intoAzure:mainfrom
mikekistler:mvad-update2

Conversation

@mikekistler
Copy link
Member

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.

  • Link to API Spec engagement record issue:

Is this review for (select one):

  • a private preview
  • a public preview
  • GA release

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.

  • Design Document:
  • Previous API Spec Doc:
  • Updated paths:

❔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

@mikekistler mikekistler requested a review from yangyuan as a code owner April 25, 2023 00:48
@openapi-workflow-bot
Copy link

Hi, @mikekistler Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Apr 25, 2023

    Swagger Validation Report

    ️❌BreakingChange: 2 Errors, 0 Warnings failed [Detail]
    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]
    ⚠️ SchemaTypeAndFormat Schema with type: string has unrecognized format: uri
    Location: AnomalyDetector/stable/v1.1/openapi.json#L87
    ⚠️ SchemaTypeAndFormat Schema with type: string has unrecognized format: uri
    Location: AnomalyDetector/stable/v1.1/openapi.json#L122
    ⚠️ SchemaTypeAndFormat Schema with type: string has unrecognized format: uri
    Location: AnomalyDetector/stable/v1.1/openapi.json#L136
    ⚠️ SchemaTypeAndFormat Schema with type: string has unrecognized format: uri
    Location: AnomalyDetector/stable/v1.1/openapi.json#L254
    ⚠️ SchemaTypeAndFormat Schema with type: string has unrecognized format: uri
    Location: AnomalyDetector/stable/v1.1/openapi.json#L296
    ⚠️ SchemaTypeAndFormat 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
    ⚠️ VersionConvention API version should be a date in YYYY-MM-DD format, optionally suffixed with '-preview'.
    Location: AnomalyDetector/stable/v1.1/openapi.json#L5
    ⚠️ PageableOperation 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
    ⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
    Location: AnomalyDetector/stable/v1.1/openapi.json#L70
    ⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
    Location: AnomalyDetector/stable/v1.1/openapi.json#L74
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: AnomalyDetector/stable/v1.1/openapi.json#L75
    ⚠️ ErrorResponse Error response schema should contain an object property named error.
    Location: AnomalyDetector/stable/v1.1/openapi.json#L99
    ⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
    Location: AnomalyDetector/stable/v1.1/openapi.json#L116
    ⚠️ Post201Response Using post for a create operation is discouraged.
    Location: AnomalyDetector/stable/v1.1/openapi.json#L128
    ⚠️ ErrorResponse Error response schema should contain an object property named error.
    Location: AnomalyDetector/stable/v1.1/openapi.json#L148
    ⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
    Location: AnomalyDetector/stable/v1.1/openapi.json#L163
    ⚠️ PaginationResponse Response body schema of pageable response should contain top-level array property value
    Location: AnomalyDetector/stable/v1.1/openapi.json#L174
    ⚠️ ErrorResponse Error response schema should contain an object property named error.
    Location: AnomalyDetector/stable/v1.1/openapi.json#L186
    ⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
    Location: AnomalyDetector/stable/v1.1/openapi.json#L206
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: AnomalyDetector/stable/v1.1/openapi.json#L207
    ⚠️ ErrorResponse Error response schema should contain an object property named error.
    Location: AnomalyDetector/stable/v1.1/openapi.json#L227
    ⚠️ VersionPolicy Operation does not define an 'api-version' query parameter.
    Location: AnomalyDetector/stable/v1.1/openapi.json#L242
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: AnomalyDetector/stable/v1.1/openapi.json#L243
    ⚠️ ErrorResponse Error response schema should contain an object property named error.
    Location: AnomalyDetector/stable/v1.1/openapi.json#L266
    ⚠️ LroExtension Operations with a 202 response should specify x-ms-long-running-operation: true.
    Location: AnomalyDetector/stable/v1.1/openapi.json#L279
    ⚠️ PaginationResponse 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."
    ⚠️ MissingTypeSpecProjectConfig "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'."
    ⚠️ MissingTypeSpecProjectConfig "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'."
    ⚠️ MissingTypeSpecProjectConfig "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'."
    ⚠️ MissingTypeSpecProjectConfig "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'."
    ⚠️ MissingTypeSpecProjectConfig "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.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Apr 25, 2023

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking


    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 16c3fae. SDK Automation 14.0.0
      command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
      warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
      warn		specification/cognitiveservices/data-plane/AnomalyDetector/readme.md skipped due to azure-sdk-for-js not found in swagger-to-sdk
      command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
      cmderr	[automation_generate.sh] [ERROR] Generate changelog failed: ENOENT: no such file or directory, open '/mnt/vss/_work/1/s/azure-sdk-for-js/sdk/anomalydetector/ai-anomaly-detector-rest/changelog-temp/package/CHANGELOG.md'
    • ️✔️@azure-rest/ai-anomaly-detector [View full logs]  [Release SDK Changes]
      info	[Changelog]
      error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
    ️❌ azure-sdk-for-net-track2 failed [Detail]
    • Failed [Logs]Release - Generate from 16c3fae. SDK Automation 14.0.0
      command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
      command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/Invoke-GenerateAndBuildV2.ps1:145
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 145 | �[0m         �[36;1mGeneratePackage `�[0m
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to build sdk. exit code: False
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
    • Azure.AI.AnomalyDetector [View full logs]  [Release SDK Changes]
      info	[Changelog]
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 16c3fae. SDK Automation 14.0.0
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
      cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
      warn		specification/cognitiveservices/data-plane/AnomalyDetector/readme.md skipped due to azure-sdk-for-python not found in swagger-to-sdk
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    • ️✔️azure-ai-anomalydetector [View full logs]  [Release SDK Changes]
      info	[Changelog] data-plan skip changelog generation temporarily
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 16c3fae. SDK Automation 14.0.0
      command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
      cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.1.2
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.1.2
      cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
      warn		specification/cognitiveservices/data-plane/AnomalyDetector/readme.md skipped due to azure-sdk-for-java not found in swagger-to-sdk
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
      cmderr	[generate.py] npm notice
      cmderr	[generate.py] npm notice New major version of npm available! 8.19.4 -> 9.6.5
      cmderr	[generate.py] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.5>
      cmderr	[generate.py] npm notice Run `npm install -g npm@9.6.5` to update!
      cmderr	[generate.py] npm notice
    • ️✔️azure-ai-anomalydetector [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @ghost ghost added the Cognitive Services label Apr 25, 2023
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Apr 25, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Python azure-ai-anomalydetector https://apiview.dev/Assemblies/Review/9a9bddb3280246cf80aee269f63d8fd1
    .Net Azure.AI.AnomalyDetector Create ApiView failed. Please ask PR assignee for help
    Java azure-ai-anomalydetector Create ApiView failed. Please ask PR assignee for help
    JavaScript @azure-rest/ai-anomaly-detector https://apiview.dev/Assemblies/Review/0fb1f1833cbd47d9b6795668abfee4f9

    @AzureRestAPISpecReview AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required data-plane labels Apr 25, 2023
    @openapi-workflow-bot
    Copy link

    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.
    Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.
    Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required Cognitive Services data-plane

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    5 participants