Browse Source

fix(apidocs): fix typos in release API docs (#74998)

noticed some typos on
https://docs.sentry.io/api/releases/retrieve-release-health-session-statistics/
Michelle Zhang 7 months ago
parent
commit
447b656cf5
2 changed files with 20 additions and 14 deletions
  1. 12 8
      src/sentry/api/endpoints/organization_sessions.py
  2. 8 6
      src/sentry/apidocs/parameters.py

+ 12 - 8
src/sentry/api/endpoints/organization_sessions.py

@@ -66,14 +66,18 @@ class OrganizationSessionsEndpoint(OrganizationEndpoint):
     )
     def get(self, request: Request, organization) -> Response:
         """
-        Returns a time series of release health session statistics for projects bound to an "
-        "organization.\n\nThe interval and date range are subject to certain restrictions and rounding "
-        "rules.\n\nThe date range is rounded to align with the interval, and is rounded to at least one "
-        "hour. The interval can at most be one day and at least one hour currently. It has to cleanly "
-        "divide one day, for rounding reasons.\n\nBecause of technical limitations, this endpoint returns "
-        "at most 10000 data points. For example, if you select a 90 day window grouped by releases, "
-        "you will see at most `floor(10k / (90 + 1)) = 109` releases. To get more results, reduce the "
-        "`statsPeriod`."
+        Returns a time series of release health session statistics for projects bound to an organization.
+
+        The interval and date range are subject to certain restrictions and rounding rules.
+
+        The date range is rounded to align with the interval, and is rounded to at least one
+        hour. The interval can at most be one day and at least one hour currently. It has to cleanly
+        divide one day, for rounding reasons.
+
+        Because of technical limitations, this endpoint returns
+        at most 10000 data points. For example, if you select a 90 day window grouped by releases,
+        you will see at most `floor(10k / (90 + 1)) = 109` releases. To get more results, reduce the
+        `statsPeriod`."
         """
 
         def data_fn(offset: int, limit: int) -> SessionsQueryResult:

+ 8 - 6
src/sentry/apidocs/parameters.py

@@ -547,12 +547,14 @@ class SessionsParams:
         required=True,
         type=str,
         many=True,
-        description="""The list of fields to query.\n\nThe available fields are\n  - `sum(session)`\n  - `count_unique("
-                    "user)`\n  - `avg`, `p50`, `p75`, `p90`, `p95`, `p99`, `max` applied to `session.duration`. For "
-                    "example, `p99(session.duration)`. Session duration is [no longer being recorded]("
-                    "https://github.com/getsentry/sentry/discussions/42716) as of on Jan 12, 2023. Returned data may "
-                    "be incomplete.\n  - `crash_rate`, `crash_free_rate` applied to `user` or `session`. For example, "
-                    "`crash_free_rate(user)`""",
+        description="""The list of fields to query.
+
+The available fields are
+- `sum(session)`
+- `count_unique(user)`
+- `avg`, `p50`, `p75`, `p90`, `p95`, `p99`, `max` applied to `session.duration`. For example, `p99(session.duration)`. Session duration is [no longer being recorded](https://github.com/getsentry/sentry/discussions/42716) as of on Jan 12, 2023. Returned data may be incomplete.
+- `crash_rate`, `crash_free_rate` applied to `user` or `session`. For example,`crash_free_rate(user)`
+""",
     )
     INTERVAL = OpenApiParameter(
         name="interval",