Skip to content

Commit abc0110

Browse files
authored
docs: fix typo in docs contribution guide (#3178)
1 parent 7f7eca0 commit abc0110

File tree

5 files changed

+20
-20
lines changed

5 files changed

+20
-20
lines changed

specs/ingestion/common/schemas/common.yml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
11
createdAt:
22
type: string
3-
description: Date of creation in RFC3339 format.
3+
description: Date of creation in RFC 3339 format.
44

55
updatedAt:
66
type: string
7-
description: Date of last update in RFC3339 format.
7+
description: Date of last update in RFC 3339 format.
88

99
startedAt:
1010
type: string
11-
description: Date of start in RFC3339 format.
11+
description: Date of start in RFC 3339 format.
1212

1313
finishedAt:
1414
type: string
15-
description: Date of finish in RFC3339 format.
15+
description: Date of finish in RFC 3339 format.
1616

1717
publishedAt:
1818
type: string
19-
description: Date of publish RFC3339 format.
19+
description: Date of publish RFC 3339 format.
2020

2121
DeleteResponse:
2222
type: object
2323
properties:
2424
deletedAt:
2525
type: string
26-
description: Date of deletion in RFC3339 format.
26+
description: Date of deletion in RFC 3339 format.
2727
required:
2828
- deletedAt
2929

@@ -74,10 +74,10 @@ Window:
7474
properties:
7575
startDate:
7676
type: string
77-
description: Date in RFC3339 format representing the oldest data in the time window.
77+
description: Date in RFC 3339 format representing the oldest data in the time window.
7878
endDate:
7979
type: string
80-
description: Date in RFC3339 format representing the newest data in the time window.
80+
description: Date in RFC 3339 format representing the newest data in the time window.
8181
required:
8282
- startDate
8383
- endDate

specs/ingestion/common/schemas/task.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ TriggerType:
188188
# schedule trigger
189189

190190
LastRun:
191-
description: The last time the scheduled task ran in RFC3339 format.
191+
description: The last time the scheduled task ran in RFC 3339 format.
192192
type: string
193193

194194
Cron:
@@ -227,7 +227,7 @@ ScheduleTrigger:
227227
lastRun:
228228
$ref: '#/LastRun'
229229
nextRun:
230-
description: The next scheduled run of the task in RFC3339 format.
230+
description: The next scheduled run of the task in RFC 3339 format.
231231
type: string
232232
required:
233233
- type
@@ -368,10 +368,10 @@ OnDemandDateUtilsInput:
368368
description: Input for a manually-triggered task whose source is of type `bigquery` and for which extracted data spans a given time range.
369369
properties:
370370
startDate:
371-
description: Earliest date in RFC3339 format of the extracted data from Big Query.
371+
description: Earliest date in RFC 3339 format of the extracted data from Big Query.
372372
type: string
373373
endDate:
374-
description: Latest date in RFC3339 format of the extracted data from Big Query.
374+
description: Latest date in RFC 3339 format of the extracted data from Big Query.
375375
type: string
376376
mapping:
377377
$ref: '#/MappingInput'

specs/ingestion/paths/runs/events/events.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@ get:
1818
- $ref: '../../../common/parameters.yml#/order'
1919
- name: startDate
2020
in: query
21-
description: Date and time in RFC3339 format for the earliest events to retrieve. By default, the current time minus three hours is used.
21+
description: Date and time in RFC 3339 format for the earliest events to retrieve. By default, the current time minus three hours is used.
2222
schema:
2323
type: string
2424
- name: endDate
2525
in: query
26-
description: Date and time in RFC3339 format for the latest events to retrieve. By default, the current time is used.
26+
description: Date and time in RFC 3339 format for the latest events to retrieve. By default, the current time is used.
2727
schema:
2828
type: string
2929
responses:

specs/ingestion/paths/runs/runs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,12 @@ get:
1717
- $ref: '../../common/parameters.yml#/order'
1818
- name: startDate
1919
in: query
20-
description: Date in RFC3339 format for the earliest run to retrieve. By default, the current day minus seven days is used.
20+
description: Date in RFC 3339 format for the earliest run to retrieve. By default, the current day minus seven days is used.
2121
schema:
2222
type: string
2323
- name: endDate
2424
in: query
25-
description: Date in RFC3339 format for the latest run to retrieve. By default, the current day is used.
25+
description: Date in RFC 3339 format for the latest run to retrieve. By default, the current day is used.
2626
schema:
2727
type: string
2828
responses:

website/docs/contributing/docs.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ see [Add a new API client](./add-new-api-client.md).
1919
## Prefer plain text
2020

2121
The `description` properties of OpenAPI objects support [CommonMark](https://commonmark.org/),
22-
the specs are used in contexts where Markdown isn't supported.
22+
but the specs are used in contexts where Markdown isn't supported.
2323

2424
To make using the specs in these contexts easier, follow these guidelines:
2525

@@ -232,14 +232,14 @@ use the following terms consistently:
232232

233233
#### Example: date and time
234234

235-
Use _Date and time ..., in RFC3339 format_.
235+
Use _Date and time ..., in RFC 3339 format_.
236236
Don't link to the RFC, and don't use ISO 8601.
237237
Don't use _timestamp_ for dates and times.
238238

239239
```
240240
createdAt:
241241
type: string
242-
description: Date and time when the object was created, in RFC3339 format.
242+
description: Date and time when the object was created, in RFC 3339 format.
243243
example: 2024-04-06T08:08:08Z
244244
```
245245
@@ -249,7 +249,7 @@ createdAt:
249249
RFC 3339 is slightly less ambiguous than ISO 8601 and leads to more readable dates.
250250
Since RFC 3339 is a _profile_ of ISO 8601,
251251
every RFC 3339 date also complies with ISO 8601,
252-
but not every ISO 8601 date complies with ISO 8601.
252+
but not every ISO 8601 date complies with RFC 3339.
253253
254254
For example, `2024-04-06T00:00:00` conforms to both RFC 3339 and ISO 8601.
255255
But `20240406T000000` only conforms to ISO 8601, which allows omitting the `-` and `:` separators.

0 commit comments

Comments
 (0)