Conversation
github-actions
bot
added
the
Scope: Backend
malwilley
approved these changes
Jan 9, 2026
src/sentry/workflow_engine/endpoints/serializers/detector_serializer.py
Outdated
Show resolved
Hide resolved
saponifi3d
reviewed
Jan 9, 2026
| owner: str | None | ||
| createdById: str | None | ||
| owner: ActorSerializerResponse | None | ||
| createdBy: str | None |
Contributor
There was a problem hiding this comment.
@malwilley was createdById being used in the UI?
Member
There was a problem hiding this comment.
I don't think createdById was ever being returned, it only exists on this serializer type. We use createdBy on the frontend
| dateUpdated: datetime | ||
| dataSources: list[dict] | ||
| conditionGroup: dict | ||
| dataSources: list[dict] | None |
Contributor
There was a problem hiding this comment.
should dataSources allow for None? I think it'd fine o the processing side, just not sure if we have any existing use cases for not having a data source on a detector rn.
Member
Author
There was a problem hiding this comment.
Error monitors have a data source of None - I guess from a user perspective (since they won't be making those) it must always have one though. Let me see if I can remove it without the API docs tests failing.
ceorourke
deleted the
ceorourke/document-OrganizationDetectorIndexEndpoint-GET
branch
ceorourke
added a commit
that referenced
this pull request
Jan 20, 2026
…t POST (#105882) Follow up to #106025 to add documentation for the POST `OrganizationDetectorIndexEndpoint`. This will not be published yet, but in order to deploy this in pieces we'll set the `publish_status` to `PUBLIC` all at once and add the sidebar item for workflow engine. The POST endpoint handles multiple detector types with various additional body params which isn't supported in our API documentation (it expects a single serializer), so I've done something similar to how we document the [issue alert creation endpoint](https://github.com/getsentry/sentry/blob/master/src/sentry/api/endpoints/project_rules.py#L282). This will need updating if we add more detector types, but unless the documentation framework is changed to support multiple serializers this is the best we can do. <img width="2692" height="15998" alt="localhost_3000_api_workflows_create-a-monitor-for-a-project_" src="https://github.com/user-attachments/assets/e2fcfdf7-0020-44c1-a4e2-7bd6b0bf6fc9" />
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add documentation for the GET
OrganizationDetectorIndexEndpoint.This will not be published yet, but in order to deploy the workflow engine API documentation in pieces we'll set the
publish_statustoPUBLICall at once and add the sidebar item for workflow engine.