Skip to content
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

Merged
merged 1 commit into from
May 5, 2023

Conversation

mikekistler
Copy link
Member

This PR fixes the topContributorCount field of MultivariateBatchDetectionOptions to be optional with a default of 10.

#23434 made a similar fix in MultivariateLastDetectionOptions but missed it in MultivariateBatchDetectionOptions.

@mikekistler mikekistler requested a review from yangyuan as a code owner May 3, 2023 23:00
@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 May 3, 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(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
    ⚠️ 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
    ⚠️ SchemaTypeAndFormat Schema with type: string has unrecognized format: uri
    Location: AnomalyDetector/stable/v1.1/openapi.json#L87
    ⚠️ 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
    ⚠️ SchemaTypeAndFormat Schema with type: string has unrecognized format: uri
    Location: AnomalyDetector/stable/v1.1/openapi.json#L122
    ⚠️ Post201Response Using post for a create operation is discouraged.
    Location: AnomalyDetector/stable/v1.1/openapi.json#L128
    ⚠️ SchemaTypeAndFormat Schema with type: string has unrecognized format: uri
    Location: AnomalyDetector/stable/v1.1/openapi.json#L136
    ⚠️ 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
    ️️✔️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
    ⚠️ Failed to generate TypeSpec APIView. Please check the detail log and make sure TypeSpec compiler version is the latest. "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.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 3, 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-net-track2 failed [Detail]
    • Failed [Logs]Release - Generate from 66e6396. 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 66e6396. 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
      cmderr	[automation_generate.sh]
      cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.5.1 -> 9.6.6
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.6>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.6.6` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️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 66e6396. 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.6
      cmderr	[generate.py] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.6>
      cmderr	[generate.py] npm notice Run `npm install -g npm@9.6.6` to update!
      cmderr	[generate.py] npm notice
    • ️✔️azure-ai-anomalydetector [View full logs]  [Release SDK Changes]
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 66e6396. 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.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 3, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Python azure-ai-anomalydetector https://apiview.dev/Assemblies/Review/a6bcc95c79fa4775bcf093b3daffead9
    Java azure-ai-anomalydetector https://apiview.dev/Assemblies/Review/7055666b71284fdfb1e23b7a57b93e1b
    .Net Azure.AI.AnomalyDetector https://apiview.dev/Assemblies/Review/fd422ee15de346ac9f9c466543756e88
    JavaScript @azure-rest/ai-anomaly-detector https://apiview.dev/Assemblies/Review/fc67d55452fc404fbd395d165c2d95e3

    @ghost ghost added the Cognitive Services label May 3, 2023
    @mikekistler mikekistler assigned lmazuel and unassigned anuchandy May 3, 2023
    @AzureRestAPISpecReview AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required data-plane labels May 3, 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.

    @mikekistler mikekistler requested a review from heaths May 5, 2023 16:28
    @heaths
    Copy link
    Member

    heaths commented May 5, 2023

    @mikekistler to be clear, this is a correction and not a breaking service change?

    @mikekistler
    Copy link
    Member Author

    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.

    @mikekistler mikekistler added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label May 5, 2023
    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