Skip to content

Commit 3f245a1

Browse files
chore(apidocs): Fix inconsistencies in replay docs (#77506)
A couple small nits to make these docs a little more consistent with the rest: - Return/Fetch -> Retrieve - "Get list..." -> "List ..." - Capitalization, punctuation - Missing field type
1 parent 80901d0 commit 3f245a1

5 files changed

+9
-7
lines changed

src/sentry/replays/endpoints/organization_replay_count.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,12 +56,12 @@ class OrganizationReplayCountEndpoint(OrganizationEventsV2EndpointBase):
5656

5757
@extend_schema(
5858
examples=ReplayExamples.GET_REPLAY_COUNTS,
59-
operation_id="Return a Count of Replays",
59+
operation_id="Retrieve a Count of Replays",
6060
parameters=[
61-
GlobalParams.END,
6261
GlobalParams.ENVIRONMENT,
6362
GlobalParams.ORG_ID_OR_SLUG,
6463
GlobalParams.START,
64+
GlobalParams.END,
6565
GlobalParams.STATS_PERIOD,
6666
OrganizationParams.PROJECT,
6767
VisibilityParams.QUERY,
@@ -73,7 +73,7 @@ class OrganizationReplayCountEndpoint(OrganizationEventsV2EndpointBase):
7373
},
7474
)
7575
def get(self, request: Request, organization: Organization) -> Response:
76-
"""Return a count of replays for the given issue or transaction id."""
76+
"""Return a count of replays for the given issue or transaction ID."""
7777
if not features.has("organizations:session-replay", organization, actor=request.user):
7878
return Response(status=404)
7979

src/sentry/replays/endpoints/project_replay_details.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ def get(self, request: Request, project: Project, replay_id: str) -> Response:
8585
)
8686
def delete(self, request: Request, project: Project, replay_id: str) -> Response:
8787
"""
88-
Delete a replay
88+
Delete a replay.
8989
"""
9090

9191
if not features.has(

src/sentry/replays/endpoints/project_replay_recording_segment_details.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ class ProjectReplayRecordingSegmentDetailsEndpoint(ProjectEndpoint):
3232
}
3333

3434
@extend_schema(
35-
operation_id="Fetch Recording Segment",
35+
operation_id="Retrieve a Recording Segment",
3636
parameters=[
3737
GlobalParams.ORG_ID_OR_SLUG,
3838
GlobalParams.PROJECT_ID_OR_SLUG,

src/sentry/replays/endpoints/project_replay_viewed_by.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ class ProjectReplayViewedByEndpoint(ProjectEndpoint):
3939
permission_classes = (ProjectEventPermission,)
4040

4141
@extend_schema(
42-
operation_id="Get list of user who have viewed a replay",
42+
operation_id="List Users Who Have Viewed a Replay",
4343
parameters=[
4444
GlobalParams.ORG_ID_OR_SLUG,
4545
GlobalParams.PROJECT_ID_OR_SLUG,

src/sentry/replays/validators.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,8 @@ class ReplaySelectorValidator(serializers.Serializer):
106106
required=False,
107107
)
108108
project = serializers.ListField(
109-
required=False, help_text="The ID of the projects to filter by."
109+
required=False,
110+
help_text="The ID of the projects to filter by.",
111+
child=serializers.IntegerField(),
110112
)
111113
sort = serializers.CharField(help_text="The field to sort the output by.", required=False)

0 commit comments

Comments
 (0)