Skip to content

Commit c53628a

Browse files
fix(apidocs): Move Issue Alert Rule APIs to Alerts & Notifications (#57600)
This PR renames the Notifications section to Alerts & Notifications, and moves the Issue Alert Rule APIs to this section. <img width="1512" alt="image" src="https://github.com/getsentry/sentry/assets/45607721/2716783b-af50-4f6a-86e7-d95db55ef08c">
1 parent a635a0c commit c53628a

File tree

6 files changed

+16
-15
lines changed

6 files changed

+16
-15
lines changed

src/sentry/api/endpoints/notifications/notification_actions_details.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929

3030

3131
@region_silo_endpoint
32-
@extend_schema(tags=["Notifications"])
32+
@extend_schema(tags=["Alerts"])
3333
class NotificationActionsDetailsEndpoint(OrganizationEndpoint):
3434
publish_status = {
3535
"DELETE": ApiPublishStatus.PUBLIC,

src/sentry/api/endpoints/notifications/notification_actions_index.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ class NotificationActionsPermission(OrganizationPermission):
4848

4949

5050
@region_silo_endpoint
51-
@extend_schema(tags=["Notifications"])
51+
@extend_schema(tags=["Alerts"])
5252
class NotificationActionsIndexEndpoint(OrganizationEndpoint):
5353
publish_status = {
5454
"GET": ApiPublishStatus.PUBLIC,

src/sentry/api/endpoints/project_rule_details.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ class ProjectRuleDetailsPutSerializer(serializers.Serializer):
9494
)
9595

9696

97-
@extend_schema(tags=["Events"])
97+
@extend_schema(tags=["Alerts"])
9898
@region_silo_endpoint
9999
class ProjectRuleDetailsEndpoint(RuleEndpoint):
100100
publish_status = {

src/sentry/api/endpoints/project_rules.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -441,7 +441,7 @@ class ProjectRulesPostSerializer(serializers.Serializer):
441441
)
442442

443443

444-
@extend_schema(tags=["Events"])
444+
@extend_schema(tags=["Alerts"])
445445
@region_silo_endpoint
446446
class ProjectRulesEndpoint(ProjectEndpoint):
447447
publish_status = {

src/sentry/apidocs/api_ownership_stats_dont_modify.json

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -671,6 +671,7 @@
671671
"OrganizationProjectsExperimentEndpoint::POST",
672672
"OrganizationSCIMMemberDetails::PUT",
673673
"OrganizationSCIMTeamDetails::PUT",
674+
"ReleaseThresholdIndexEndpoint::GET",
674675
"ReleaseThresholdStatusIndexEndpoint::GET"
675676
],
676677
"unknown": [
@@ -707,7 +708,7 @@
707708
]
708709
},
709710
"telemetry-experience": {
710-
"block_start": 709,
711+
"block_start": 710,
711712
"public": [],
712713
"private": [],
713714
"experimental": [
@@ -726,7 +727,7 @@
726727
]
727728
},
728729
"team-starfish": {
729-
"block_start": 727,
730+
"block_start": 729,
730731
"public": [],
731732
"private": [],
732733
"experimental": [],
@@ -736,7 +737,7 @@
736737
]
737738
},
738739
"growth": {
739-
"block_start": 737,
740+
"block_start": 739,
740741
"public": [],
741742
"private": [],
742743
"experimental": [],
@@ -745,7 +746,7 @@
745746
]
746747
},
747748
"feedback-backend": {
748-
"block_start": 746,
749+
"block_start": 748,
749750
"public": [],
750751
"private": [],
751752
"experimental": [
@@ -757,7 +758,7 @@
757758
"unknown": []
758759
},
759760
"replay-backend": {
760-
"block_start": 758,
761+
"block_start": 760,
761762
"public": [],
762763
"private": [],
763764
"experimental": [],
@@ -766,7 +767,7 @@
766767
]
767768
},
768769
"profiling": {
769-
"block_start": 767,
770+
"block_start": 769,
770771
"public": [],
771772
"private": [],
772773
"experimental": [],
@@ -782,7 +783,7 @@
782783
]
783784
},
784785
"team-web-sdk-frontend": {
785-
"block_start": 783,
786+
"block_start": 785,
786787
"public": [],
787788
"private": [
788789
"SourceMapDebugBlueThunderEditionEndpoint::GET"
@@ -791,7 +792,7 @@
791792
"unknown": []
792793
},
793794
"hybrid-cloud": {
794-
"block_start": 792,
795+
"block_start": 794,
795796
"public": [],
796797
"private": [],
797798
"experimental": [],

src/sentry/apidocs/build.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -123,9 +123,9 @@ def get_old_json_components(filename: str) -> json.JSONData:
123123
},
124124
},
125125
{
126-
"name": "Notifications",
127-
"x-sidebar-name": "Notifications",
128-
"description": "Endpoints for Notifications",
126+
"name": "Alerts",
127+
"x-sidebar-name": "Alerts & Notifications",
128+
"description": "Endpoints for Alerts and Notifications",
129129
"x-display-description": False,
130130
"externalDocs": {
131131
"description": "Found an error? Let us know.",

0 commit comments

Comments
 (0)