Skip to content

Commit a715187

Browse files
authored
fix: Remove unsupported definition list syntax (#10739)
1 parent f13e2f6 commit a715187

30 files changed

+240
-239
lines changed

develop-docs/sdk/check-ins.mdx

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The following fields exist:
2727

2828
`check_in_id`
2929

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

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

3737
`monitor_slug`
3838

39-
: **String, required**. The distinct slug of the monitor.
39+
**String, required**. The distinct slug of the monitor.
4040

4141
`status`
4242

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

4848
`duration`
4949

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

5353
`release`
5454

55-
: _String, optional_. The release.
55+
_String, optional_. The release.
5656

5757
`environment`
5858

59-
: _String, optional_. The environment.
59+
_String, optional_. The environment.
6060

6161
`monitor_config`
6262

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

6666
`contexts`
6767

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

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

100100
`schedule`
101101

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

104104
`checkin_margin`
105105

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

109109
`max_runtime`
110110

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

114114
`failure_issue_threshold`
115115

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

119119
`recovery_threshold`
120120

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

124124
`timezone`
125125

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

130130
`owner`
131131

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

@@ -142,20 +142,20 @@ monitors frontend APIs.
142142

143143
`type`
144144

145-
: **String, required**. One of `crontab` or `interval`.
145+
**String, required**. One of `crontab` or `interval`.
146146

147147
#### Using `crontab`
148148

149149
`value`
150150

151-
: **String, required**. The crontab schedule string, e.g. `0 * * * *`.
151+
**String, required**. The crontab schedule string, e.g. `0 * * * *`.
152152

153153
#### Using `interval`
154154

155155
`value`
156156

157-
: **Number, required**. The interval value.
157+
**Number, required**. The interval value.
158158

159159
`unit`
160160

161-
: **String, required**. The interval unit. Should be one of `year`, `month`, `week`, `day`, `hour`, `minute`.
161+
**String, required**. The interval unit. Should be one of `year`, `month`, `week`, `day`, `hour`, `minute`.

develop-docs/sdk/client-reports.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,14 +75,14 @@ The following fields exist:
7575

7676
`timestamp`
7777

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

8383
`discarded_events`
8484

85-
: _List of outcome objects_ {`reason`, `category`, `quantity`}
85+
_List of outcome objects_ (`reason`, `category`, `quantity`)
8686

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

112112
`rate_limited_events`, `filtered_events`, `filtered_sampling_events`
113113

114-
: _List of outcome objects_ {`reason`, `category`, `quantity`}
114+
_List of outcome objects_ (`reason`, `category`, `quantity`)
115115

116116
These function like `discarded_events` but identify events that were rate limited,
117117
filtered or filtered by by dynamic sampling _at a relay_. Client SDKs must never

develop-docs/sdk/envelopes.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ There are two generic headers for every Item:
184184

185185
`type`
186186

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

@@ -323,7 +323,7 @@ encoded in JSON.
323323

324324
`event_id`
325325

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

347347
`event_id`
348348

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

381381
`event_id`
382382

383-
: **UUID String, required.** The identifier of the event or transaction.
383+
**UUID String, required.** The identifier of the event or transaction.
384384

385385
**Additional Item Headers:**
386386

387387
`filename`
388388

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

391391
`attachment_type`
392392

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

487487
`event_id`
488488

489-
: **UUID String, required.** The identifier of the event or transaction.
489+
**UUID String, required.** The identifier of the event or transaction.
490490

491491

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

512512
`event_id`
513513

514-
: **UUID String, required.** The identifier of the event or transaction.
514+
**UUID String, required.** The identifier of the event or transaction.
515515

516516
**Additional Item Headers:**
517517

0 commit comments

Comments
 (0)