From 35cd9eaa5d4b103310cf7fb6c8acedc860329f7b Mon Sep 17 00:00:00 2001 From: Kyle Consalus Date: Wed, 7 Oct 2026 10:48:47 -0700 Subject: [PATCH] fix(alerts): Exclude deprecated alert rule params from Monitor API docs --- src/sentry/monitors/serializers.py | 6 ++++++ src/sentry/monitors/validators.py | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/src/sentry/monitors/serializers.py b/src/sentry/monitors/serializers.py index d9f27163e269..cad56c227e5e 100644 --- a/src/sentry/monitors/serializers.py +++ b/src/sentry/monitors/serializers.py @@ -9,6 +9,7 @@ from sentry.api.serializers import ProjectSerializerResponse, Serializer, register, serialize from sentry.api.serializers.models.actor import ActorSerializer, ActorSerializerResponse +from sentry.apidocs.omissions import sentry_schema_serializer from sentry.models.environment import Environment from sentry.models.project import Project from sentry.monitors.models import ( @@ -175,6 +176,11 @@ class MonitorSerializerResponseOptional(TypedDict, total=False): alertRule: MonitorAlertRuleSerializerResponse +@sentry_schema_serializer( + omit_from_public_schema={ + "alertRule": "Deprecated issue alert configuration; use the dedicated Workflow APIs.", + } +) class MonitorSerializerResponse(MonitorSerializerResponseOptional): id: str name: str diff --git a/src/sentry/monitors/validators.py b/src/sentry/monitors/validators.py index bcb1d3046800..7e71a14dfdef 100644 --- a/src/sentry/monitors/validators.py +++ b/src/sentry/monitors/validators.py @@ -19,6 +19,7 @@ from sentry.api.fields.sentry_slug import SentrySerializerSlugField from sentry.api.serializers.rest_framework import CamelSnakeSerializer from sentry.api.serializers.rest_framework.project import ProjectField +from sentry.apidocs.omissions import sentry_schema_serializer from sentry.constants import ObjectStatus from sentry.db.models import BoundedPositiveIntegerField from sentry.db.models.fields.slug import DEFAULT_SLUG_MAX_LENGTH @@ -362,6 +363,11 @@ def validate(self, attrs): return attrs +@sentry_schema_serializer( + omit_from_public_schema={ + "alert_rule": "Deprecated issue alert configuration; use the dedicated Workflow APIs.", + } +) class MonitorValidator(CamelSnakeSerializer): project = ProjectField( scope="project:read",