azure-rest-api-specs icon indicating copy to clipboard operation
azure-rest-api-specs copied to clipboard

Remove the deprecated classic alerts from spec

Open grchris-microsoft opened this issue 1 year ago • 8 comments

ARM (Control Plane) API Specification Update Pull Request

[!TIP] Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

spec_pr_review_workflow_diagram

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • [ ] New resource provider.
  • [ ] New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
  • [ ] Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • [ ] Update existing version to fix OpenAPI spec quality issues in S360.
  • [ ] Convert existing OpenAPI spec to TypeSpec spec (do not combine this with implementing changes for a new API version).
  • [X] Other, please clarify:
    • I'm removing the deprecated classic alerts specs

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood and followed the instructions by checking all the boxes:

  • [x] I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • [x] I have reviewed following Resource Provider guidelines, including ARM resource provider contract and REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure and https://aka.ms/ci-fix.
  • For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run. This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

grchris-microsoft avatar Sep 29 '24 13:09 grchris-microsoft

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/monitor/armmonitor https://apiview.dev/Assemblies/Review/14110b73692e404ca82e994b5fe313ad?revisionId=914876b0a0984c7097b84f3ea4c01a3a
JavaScript @azure/arm-monitor https://apiview.dev/Assemblies/Review/6bb257ec6c7a48e3812505db443df4ae?revisionId=25b9051f828646c98e0c537779d0e1d2
Java azure-resourcemanager-monitor-generated https://apiview.dev/Assemblies/Review/c5eba455f3ab4ce4bf0c0a2da8091fce?revisionId=a6827668b0cf47d79abb95cb9cd21a4a
.Net Azure.ResourceManager.Monitor There is no API change compared with the previous version

/azp run

grchris-microsoft avatar Oct 07 '24 15:10 grchris-microsoft

Commenter does not have sufficient privileges for PR 30787 in repo Azure/azure-rest-api-specs

azure-pipelines[bot] avatar Oct 07 '24 15:10 azure-pipelines[bot]

/azp run

grchris-microsoft avatar Oct 08 '24 11:10 grchris-microsoft

Commenter does not have sufficient privileges for PR 30787 in repo Azure/azure-rest-api-specs

azure-pipelines[bot] avatar Oct 08 '24 11:10 azure-pipelines[bot]

@grchris-microsoft: What questions do you have about the failing checks in this PR?

mikeharder avatar Oct 14 '24 20:10 mikeharder

@grchris-microsoft: What questions do you have about the failing checks in this PR? @mikeharder @mentat9

The thing here is that the errors appearing in this PR are not related to my changes.

I tried to make a quick fix, but unfortunately every fix led to a bunch of new issues, so it requires a bit more effort than just changing the type. We will definitely need to do that at some point, but it's not in the scope of the current PR (which deals with deprecating another service).

grchris-microsoft avatar Oct 30 '24 08:10 grchris-microsoft

@grchris-microsoft: What questions do you have about the failing checks in this PR? @mikeharder @mentat9

The thing here is that the errors appearing in this PR are not related to my changes.

I tried to make a quick fix, but unfortunately every fix led to a bunch of new issues, so it requires a bit more effort than just changing the type. We will definitely need to do that at some point, but it's not in the scope of the current PR (which deals with deprecating another service).

For check Swagger ModelValidation, add suppressions to your readme.md.

For check LintDiff, there are two problems:

  1. The tool is crashing with errors like this. The results are essentially invalid if the tool is crashing, since we don't know what errors we might be missing. The first step would be to fix any errors causing LintDiff to crash.
{
  "type": "AutoRest exception",
  "message": "Ref '#/parameters/MetricNamesParameter' is not referencing a valid location. paths,/{resourceUri}/providers/Microsoft.Insights/metricBaselines,get,parameters,1",
  "readmeUrl": "https://github.com/Azure/azure-rest-api-specs/blob/9c1415bb9a549f3de047387131af5eb0d36f9f79/specification/monitor/resource-manager/readme.md",
  "tag": "package-2021-05-metrics",
  "context": "after"
},
  1. Your spec has so many un-suppressed errors and warnings, it overwhelms our tooling infrastructure. The log file is over 80MB.
SDK Errors/Warnings
===================
Errors:    Before:  5809  - After:  798
Warnings:  Before:  7414  - After:  735

You might be able to add suppressions to readme.md for these as well. But if your spec has this many errors/warnings, and they've been ignored for a long time, I wonder if LintDiff is even providing any value for your spec any more.

mikeharder avatar Nov 11 '24 22:11 mikeharder

API change check

APIView has identified API level changes in this PR and created following API reviews.

Microsoft.Insights

azure-sdk avatar Nov 14 '24 09:11 azure-sdk

Added label Approved-LintDiff. The linter is crashing on the version of the spec already in main, but the spec looks valid, so I need to debug what's wrong with our linter.

mikeharder avatar Dec 04 '24 21:12 mikeharder