Skip to content

Commit

Permalink
fix: Remove unsupported definition list syntax (#10739)
Browse files Browse the repository at this point in the history
  • Loading branch information
chargome committed Jul 23, 2024
1 parent f13e2f6 commit a715187
Show file tree
Hide file tree
Showing 30 changed files with 240 additions and 239 deletions.
38 changes: 19 additions & 19 deletions develop-docs/sdk/check-ins.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The following fields exist:

`check_in_id`

: **String, required**. Check-In ID (unique and client generated).
**String, required**. Check-In ID (unique and client generated).

This may be provided as a empty UUID (128 bit zero value) to indicate to
Sentry that the checkin should update the most recent "in_progress" check-in.
Expand All @@ -36,36 +36,36 @@ The following fields exist:

`monitor_slug`

: **String, required**. The distinct slug of the monitor.
**String, required**. The distinct slug of the monitor.

`status`

: **String, required**. The status of the check-in. Can be one of the following:
**String, required**. The status of the check-in. Can be one of the following:
- `in_progress`: The check-in has started.
- `ok`: The check-in has completed successfully.
- `error`: The check-in has failed.

`duration`

: _Number, optional_. The duration of the check-in in seconds. Will only take effect if the
_Number, optional_. The duration of the check-in in seconds. Will only take effect if the
status is `ok` or `error`.

`release`

: _String, optional_. The release.
_String, optional_. The release.

`environment`

: _String, optional_. The environment.
_String, optional_. The environment.

`monitor_config`

: _Object, optional_. A monitor configuration (defined below) that is stored with the
_Object, optional_. A monitor configuration (defined below) that is stored with the
check-in in order to verify the state of the monitor at the time of the check-in.

`contexts`

: _Object, optional_. A dictionary of contextual information about the environment running
_Object, optional_. A dictionary of contextual information about the environment running
the check-in. Right now we only support the [trace context](https://develop.sentry.dev/sdk/event-payloads/contexts/#trace-context)
and use the `trace_id` in order to link check-ins to associated errors.

Expand Down Expand Up @@ -99,37 +99,37 @@ The following fields exist under the `monitor_config` key:

`schedule`

: **Object, required**. [See schedule configuration](#schedule-configuration).
**Object, required**. [See schedule configuration](#schedule-configuration).

`checkin_margin`

: _Number, optional_. The allowed margin of minutes after the expected
_Number, optional_. The allowed margin of minutes after the expected
check-in time that the monitor will not be considered missed for.

`max_runtime`

: _Number, optional_. The allowed duration in minutes that the monitor
_Number, optional_. The allowed duration in minutes that the monitor
may be `in_progress` for before being considered failed due to timeout.

`failure_issue_threshold`

: _Number, optional_. The number of consecutive failed check-ins it takes
_Number, optional_. The number of consecutive failed check-ins it takes
before an issue is created.

`recovery_threshold`

: _Number, optional_. The number of consecutive OK check-ins it takes
_Number, optional_. The number of consecutive OK check-ins it takes
before an issue is resolved.

`timezone`

: _String, optional_. A [`tz
_String, optional_. A [`tz
database`](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) string
representing the timezone which the monitor's execution schedule is in.

`owner`

: _String, optional_. An actor identifier string. This looks like
_String, optional_. An actor identifier string. This looks like
`user:john@example.com` `team:a-sentry-team`. IDs can also be used but will
result in a poor DX.

Expand All @@ -142,20 +142,20 @@ monitors frontend APIs.

`type`

: **String, required**. One of `crontab` or `interval`.
**String, required**. One of `crontab` or `interval`.

#### Using `crontab`

`value`

: **String, required**. The crontab schedule string, e.g. `0 * * * *`.
**String, required**. The crontab schedule string, e.g. `0 * * * *`.

#### Using `interval`

`value`

: **Number, required**. The interval value.
**Number, required**. The interval value.

`unit`

: **String, required**. The interval unit. Should be one of `year`, `month`, `week`, `day`, `hour`, `minute`.
**String, required**. The interval unit. Should be one of `year`, `month`, `week`, `day`, `hour`, `minute`.
6 changes: 3 additions & 3 deletions develop-docs/sdk/client-reports.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -75,14 +75,14 @@ The following fields exist:

`timestamp`

: _String | Number, optional_. The timestamp of when the client report was created.
_String | Number, optional_. The timestamp of when the client report was created.
Must be an ISO DateTime string or a UNIX timestamp. If not sent, the server
will assume the current UTC timestamp. In the data model, this is called
`received`.

`discarded_events`

: _List of outcome objects_ {`reason`, `category`, `quantity`}
_List of outcome objects_ (`reason`, `category`, `quantity`)

- `reason`: A string reason that defines why events were lost.
- `category`: The data category for which the discard reason applies. These are the same data categories used for [rate limits](/sdk/rate-limiting/#definitions).
Expand Down Expand Up @@ -111,7 +111,7 @@ that SDKs send these under normal operation:

`rate_limited_events`, `filtered_events`, `filtered_sampling_events`

: _List of outcome objects_ {`reason`, `category`, `quantity`}
_List of outcome objects_ (`reason`, `category`, `quantity`)

These function like `discarded_events` but identify events that were rate limited,
filtered or filtered by by dynamic sampling _at a relay_. Client SDKs must never
Expand Down
14 changes: 7 additions & 7 deletions develop-docs/sdk/envelopes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ There are two generic headers for every Item:

`type`

: **String, required.** Specifies the type of this Item and its contents. Based
**String, required.** Specifies the type of this Item and its contents. Based
on the Item type, more headers may be required. See [Data Model](#data-model) for a list
of all Item types.

Expand Down Expand Up @@ -323,7 +323,7 @@ encoded in JSON.

`event_id`

: **UUID String, required.** Corresponds to the `event_id` field of the event
**UUID String, required.** Corresponds to the `event_id` field of the event
payload. Clients are required to generate an event identifier ahead of time
and set it at least in the Envelope headers. If the identifier mismatches
between the Envelope and payload, the Envelope header takes precedence.
Expand All @@ -346,7 +346,7 @@ in JSON.

`event_id`

: **UUID String, required.** Corresponds to the `event_id` field of the
**UUID String, required.** Corresponds to the `event_id` field of the
transaction payload. Clients are required to generate an event identifier
ahead of time and set it at least in the Envelope headers. If the identifier
mismatches between the Envelope and payload, the Envelope header takes
Expand Down Expand Up @@ -380,13 +380,13 @@ file. It is always associated to an event or transaction.

`event_id`

: **UUID String, required.** The identifier of the event or transaction.
**UUID String, required.** The identifier of the event or transaction.

**Additional Item Headers:**

`filename`

: **String, required.** The name of the uploaded file without a path component.
**String, required.** The name of the uploaded file without a path component.

`attachment_type`

Expand Down Expand Up @@ -486,7 +486,7 @@ The item contains a user feedback / user report JSON payload:

`event_id`

: **UUID String, required.** The identifier of the event or transaction.
**UUID String, required.** The identifier of the event or transaction.


`email`
Expand All @@ -511,7 +511,7 @@ The item contains a user feedback / user report JSON payload:

`event_id`

: **UUID String, required.** The identifier of the event or transaction.
**UUID String, required.** The identifier of the event or transaction.

**Additional Item Headers:**

Expand Down
Loading

0 comments on commit a715187

Please sign in to comment.