Skip to content

[Metrics Advisor] remove invalid granularity enum value; remove 'required' on secrets#14606

Merged
tjprescott merged 2 commits intoAzure:masterfrom
bowgong:ma-swagger-0531
Jun 1, 2021
Merged

[Metrics Advisor] remove invalid granularity enum value; remove 'required' on secrets#14606
tjprescott merged 2 commits intoAzure:masterfrom
bowgong:ma-swagger-0531

Conversation

@bowgong
Copy link
Member

@bowgong bowgong commented May 31, 2021

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Please ensure to add changelog with this PR by answering the following questions.

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No, no need to refresh for updates in this PR

Contribution checklist:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

  • Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

    • Adding new API(s)
    • Adding a new API version
    • Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
    • Adding a new service

  • Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

  • If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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.

Please follow the link to find more details on PR review process.

@bowgong bowgong requested a review from yangyuan as a code owner May 31, 2021 09:08
@openapi-workflow-bot
Copy link

openapi-workflow-bot bot commented May 31, 2021

Hi, @bowgong 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. vsswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 31, 2021 •
    edited
    Loading

    Swagger Validation Report

    ️❌BreakingChange: 2 Errors, 0 Warnings failed [Detail]
    Rule Message
    ❌ 1019 - RemovedEnumValue The new version is removing enum value(s) 'Secondly' from the old version.
    New: MetricsAdvisor/preview/v1.0/MetricsAdvisor.json#L1275:11
    Old: MetricsAdvisor/preview/v1.0/MetricsAdvisor.json#L1275:11
    ❌ 1019 - RemovedEnumValue The new version is removing enum value(s) 'Secondly' from the old version.
    New: MetricsAdvisor/preview/v1.0/MetricsAdvisor.json#L4596:9
    Old: MetricsAdvisor/preview/v1.0/MetricsAdvisor.json#L4605:9
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:

    Only 10 items are listed, please refer to log for more details.

    Rule Message
    ⚠️ R3017 - GuidUsage Guid used in model definition 'ValueCondition' for property 'metricId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: MetricsAdvisor/preview/v1.0/MetricsAdvisor.json#L2586
    ⚠️ R3017 - GuidUsage Guid used in model definition 'MetricAlertingConfiguration' for property 'anomalyDetectionConfigurationId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: MetricsAdvisor/preview/v1.0/MetricsAdvisor.json#L2604
    ⚠️ R3017 - GuidUsage Guid used in model definition 'AnomalyAlertingConfiguration' for property 'anomalyAlertingConfigurationId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: MetricsAdvisor/preview/v1.0/MetricsAdvisor.json#L2653
    ⚠️ R3017 - GuidUsage Guid used in model definition 'AnomalyResult' for property 'dataFeedId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: MetricsAdvisor/preview/v1.0/MetricsAdvisor.json#L2994
    ⚠️ R3017 - GuidUsage Guid used in model definition 'IncidentResult' for property 'dataFeedId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: MetricsAdvisor/preview/v1.0/MetricsAdvisor.json#L3130
    ⚠️ R3017 - GuidUsage Guid used in model definition 'AnomalyDetectionConfiguration' for property 'anomalyDetectionConfigurationId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: MetricsAdvisor/preview/v1.0/MetricsAdvisor.json#L3413
    ⚠️ R3017 - GuidUsage Guid used in model definition 'DataSourceCredential' for property 'dataSourceCredentialId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: MetricsAdvisor/preview/v1.0/MetricsAdvisor.json#L4147
    ⚠️ R3017 - GuidUsage Guid used in model definition 'Metric' for property 'metricId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: MetricsAdvisor/preview/v1.0/MetricsAdvisor.json#L4509
    ⚠️ R3017 - GuidUsage Guid used in model definition 'DataFeedDetail' for property 'dataFeedId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: MetricsAdvisor/preview/v1.0/MetricsAdvisor.json#L4580
    ⚠️ R3017 - GuidUsage Guid used in model definition 'MetricFeedback' for property 'feedbackId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: MetricsAdvisor/preview/v1.0/MetricsAdvisor.json#L5933
    ️️✔️Avocado succeeded [Detail] [Expand] 
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand] 
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand] 
    Validation passes for SemanticValidation.
    ️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand] 
    There is no credential detected.
    ️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand] 
    Validation passes for SDKTrack2Validation

    The following errors/warnings are introduced by current PR:

    |:speech_balloon: AutorestCore/Exception|"readme":"cognitiveservices/data-plane/MetricsAdvisor/readme.md",
    "tag":"release_1_0_preview",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"cognitiveservices/data-plane/MetricsAdvisor/readme.md",
    "tag":"release_1_0_preview",
    "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|


    The following errors/warnings exist before current PR submission:

    |:speech_balloon: AutorestCore/Exception|"readme":"cognitiveservices/data-plane/MetricsAdvisor/readme.md",
    "tag":"release_1_0_preview",
    "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|

    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand] 
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand] 
    Validation passes for SpellCheck.
    ️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand] 
    Validation passes for Lint(RPaaS).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    openapi-workflow-bot bot commented May 31, 2021

    [Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 31, 2021 •
    edited
    Loading

    Swagger pipeline restarted successfully, please wait for status update in this comment.

    @openapi-workflow-bot
    Copy link

    openapi-workflow-bot bot commented May 31, 2021

    Hi @bowgong, 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.

    @bowgong
    Copy link
    Member Author

    bowgong commented May 31, 2021

    The minimum granularity committed to customers is 300 seconds in the MA public preview. We used to open secondly level granularity to particular customers during the public preview. But for GA, the minimum granularity is 60 seconds or minutely. So secondly will be no longer valid.

    @bowgong bowgong changed the title [Metrics Advisor] remove invalid granularity enum value [Metrics Advisor] remove invalid granularity enum value; remove 'required' on secrets Jun 1, 2021
    @tjprescott
    Copy link
    Member

    tjprescott commented Jun 1, 2021

    @bowgong please follow the process outlined by the bot to request a breaking change review and approval.

    @johanste johanste added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Jun 1, 2021
    @johanste
    Copy link
    Member

    johanste commented Jun 1, 2021

    Preview library, preparing for GA.

    @tjprescott tjprescott merged commit 08f5e39 into Azure:master Jun 1, 2021
    @heaths heaths mentioned this pull request Jun 16, 2021
    Merged
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Reviewers

    @johanste johanste johanste approved these changes

    @yangyuan yangyuan Awaiting requested review from yangyuan yangyuan is a code owner

    Assignees

    @tjprescott tjprescott

    Labels

    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374

    Projects

    None yet

    Milestone

    No milestone

    Development

    Successfully merging this pull request may close these issues.

    3 participants

    @bowgong @tjprescott @johanste