Skip to content

Commit 8035347

Browse files
authored
fix(dashboards): Deprecate discover in docs (#84979)
`discover` is deprecated, so we should get rid of it in our examples and API docs for the Discover Saved Query API. Closes #12618
1 parent 74223e5 commit 8035347

File tree

3 files changed

+4
-7
lines changed

3 files changed

+4
-7
lines changed

src/sentry/apidocs/examples/dashboard_examples.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@
6161
}
6262
],
6363
"limit": None,
64-
"widgetType": "discover",
64+
"widgetType": "transaction-like",
6565
"layout": {"w": 2, "y": 0, "h": 2, "minH": 2, "x": 0},
6666
}
6767
],

src/sentry/apidocs/examples/discover_saved_query_examples.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"name": "Transactions by Volume",
66
"projects": [],
77
"version": 2,
8-
"queryDataset": "discover",
8+
"queryDataset": "transaction-like",
99
"datasetSource": "unknown",
1010
"expired": False,
1111
"dateCreated": "2024-07-25T19:35:38.422859Z",
@@ -93,7 +93,7 @@
9393
"name": "All Events",
9494
"projects": [],
9595
"version": 2,
96-
"queryDataset": "discover",
96+
"queryDataset": "transaction-like",
9797
"datasetSource": "unknown",
9898
"expired": False,
9999
"dateCreated": "2024-07-25T19:35:38.422859Z",

src/sentry/discover/endpoints/serializers.py

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,7 @@ class DiscoverSavedQuerySerializer(serializers.Serializer):
4040
queryDataset = serializers.ChoiceField(
4141
choices=DiscoverSavedQueryTypes.as_text_choices(),
4242
default=DiscoverSavedQueryTypes.get_type_name(DiscoverSavedQueryTypes.ERROR_EVENTS),
43-
help_text="""The dataset you would like to query. Allowed values are:
44-
- error-events
45-
- transaction-like
46-
""",
43+
help_text="The dataset you would like to query. Note: `discover` is a **deprecated** value. The allowed values are: `error-events`, `transaction-like`",
4744
)
4845
start = serializers.DateTimeField(
4946
required=False, allow_null=True, help_text="The saved start time for this saved query."

0 commit comments

Comments
 (0)