feat(discover): Add docs for organization_events #34768
Conversation
- This adds a new doc sections for Visibility called `Discover and Performance`
| @@ -17,6 +18,50 @@ class GLOBAL_PARAMS: | |||
| type=str, | |||
| location="path", | |||
| ) | |||
| STATS_PERIOD = OpenApiParameter( | |||
There was a problem hiding this comment.
I think OpenApiParameter maps to URL parameters, not query parameters
There was a problem hiding this comment.
drf serializers map to query parameters
There was a problem hiding this comment.
I don't think so, its what the location param on the OpenApiParameter is for so you can define whether the parameter is a part of the path or the query
Based on docs you can do header, cookie or form parameters too:
https://drf-spectacular.readthedocs.io/en/latest/drf_yasg.html?highlight=location#parameter-location
| @@ -46,6 +91,51 @@ class ISSUE_ALERT_PARAMS: | |||
| ) | |||
|
|
|||
|
|
|||
| class VISIBILITY_PARAMS: | |||
| QUERY = OpenApiParameter( | |||
There was a problem hiding this comment.
Is this a visibility-only param? I think we use it in several places outside of visibility.
There was a problem hiding this comment.
This is a specific Query to Visibility (see the bit about the search syntax)
|
Also, probably out of scope for this pr, but I think this part should say something like,
|
Co-authored-by: edwardgou-sentry <[email protected]> Co-authored-by: Ash Anand <[email protected]>
Discover and Performanceeventsendpoint (which replaces the soon to be deprecatedeventsv2endpoint) as the first endpoint in the documentationPreview