Skip to content

Commit 81dc657

Browse files
committed
chore(ACI): Document detector filter params
1 parent 38f6946 commit 81dc657

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

src/sentry/apidocs/parameters.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -431,7 +431,13 @@ class DetectorParams:
431431
location="query",
432432
required=False,
433433
type=str,
434-
description="An optional search query for filtering monitors.",
434+
description="""An optional search query for filtering monitors.
435+
436+
Available fields are:
437+
- `name`
438+
- `type`: e.g. `error`, `metric_issue`, `issue_stream`
439+
- `assignee`: email, username, #team, me, none
440+
""",
435441
)
436442

437443
SORT = OpenApiParameter(

tests/sentry/workflow_engine/endpoints/test_organization_detector_index.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -413,6 +413,12 @@ def test_query_by_type(self) -> None:
413413
)
414414
assert {d["name"] for d in response.data} == {detector2.name}
415415

416+
issue_stream_resp = self.get_success_response(
417+
self.organization.slug,
418+
qs_params={"project": self.project.id, "query": "type:issue_stream"},
419+
)
420+
assert {d["name"] for d in issue_stream_resp.data} == {self.issue_stream_detector.name}
421+
416422
# Query for multiple types.
417423
response2 = self.get_success_response(
418424
self.organization.slug,

0 commit comments

Comments
 (0)