Skip to content

chore(ACI): Document detector filter params #111742

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ceorourke merged 1 commit into from
Mar 27, 2026
Merged

chore(ACI): Document detector filter params #111742

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion src/sentry/apidocs/parameters.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -431,7 +431,13 @@ class DetectorParams:
location="query",
required=False,
type=str,
description="An optional search query for filtering monitors.",
description="""An optional search query for filtering monitors.

Available fields are:
- `name`
- `type`: e.g. `error`, `metric_issue`, `issue_stream`
- `assignee`: email, username, #team, me, none
""",
)

SORT = OpenApiParameter(
Expand Down
6 changes: 6 additions & 0 deletions tests/sentry/workflow_engine/endpoints/test_organization_detector_index.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -413,6 +413,12 @@ def test_query_by_type(self) -> None:
)
assert {d["name"] for d in response.data} == {detector2.name}

issue_stream_resp = self.get_success_response(
self.organization.slug,
qs_params={"project": self.project.id, "query": "type:issue_stream"},
)
assert {d["name"] for d in issue_stream_resp.data} == {self.issue_stream_detector.name}

# Query for multiple types.
response2 = self.get_success_response(
self.organization.slug,
Expand Down
Loading