Skip to content

docs: fix typo in docs contribution guide #3178

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions specs/ingestion/common/schemas/common.yml
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
createdAt:
type: string
description: Date of creation in RFC3339 format.
description: Date of creation in RFC 3339 format.

updatedAt:
type: string
description: Date of last update in RFC3339 format.
description: Date of last update in RFC 3339 format.

startedAt:
type: string
description: Date of start in RFC3339 format.
description: Date of start in RFC 3339 format.

finishedAt:
type: string
description: Date of finish in RFC3339 format.
description: Date of finish in RFC 3339 format.

publishedAt:
type: string
description: Date of publish RFC3339 format.
description: Date of publish RFC 3339 format.

DeleteResponse:
type: object
properties:
deletedAt:
type: string
description: Date of deletion in RFC3339 format.
description: Date of deletion in RFC 3339 format.
required:
- deletedAt

Expand Down Expand Up @@ -74,10 +74,10 @@ Window:
properties:
startDate:
type: string
description: Date in RFC3339 format representing the oldest data in the time window.
description: Date in RFC 3339 format representing the oldest data in the time window.
endDate:
type: string
description: Date in RFC3339 format representing the newest data in the time window.
description: Date in RFC 3339 format representing the newest data in the time window.
required:
- startDate
- endDate
8 changes: 4 additions & 4 deletions specs/ingestion/common/schemas/task.yml
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ TriggerType:
# schedule trigger

LastRun:
description: The last time the scheduled task ran in RFC3339 format.
description: The last time the scheduled task ran in RFC 3339 format.
type: string

Cron:
Expand Down Expand Up @@ -227,7 +227,7 @@ ScheduleTrigger:
lastRun:
$ref: '#/LastRun'
nextRun:
description: The next scheduled run of the task in RFC3339 format.
description: The next scheduled run of the task in RFC 3339 format.
type: string
required:
- type
Expand Down Expand Up @@ -368,10 +368,10 @@ OnDemandDateUtilsInput:
description: Input for a manually-triggered task whose source is of type `bigquery` and for which extracted data spans a given time range.
properties:
startDate:
description: Earliest date in RFC3339 format of the extracted data from Big Query.
description: Earliest date in RFC 3339 format of the extracted data from Big Query.
type: string
endDate:
description: Latest date in RFC3339 format of the extracted data from Big Query.
description: Latest date in RFC 3339 format of the extracted data from Big Query.
type: string
mapping:
$ref: '#/MappingInput'
Expand Down
4 changes: 2 additions & 2 deletions specs/ingestion/paths/runs/events/events.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ get:
- $ref: '../../../common/parameters.yml#/order'
- name: startDate
in: query
description: Date and time in RFC3339 format for the earliest events to retrieve. By default, the current time minus three hours is used.
description: Date and time in RFC 3339 format for the earliest events to retrieve. By default, the current time minus three hours is used.
schema:
type: string
- name: endDate
in: query
description: Date and time in RFC3339 format for the latest events to retrieve. By default, the current time is used.
description: Date and time in RFC 3339 format for the latest events to retrieve. By default, the current time is used.
schema:
type: string
responses:
Expand Down
4 changes: 2 additions & 2 deletions specs/ingestion/paths/runs/runs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ get:
- $ref: '../../common/parameters.yml#/order'
- name: startDate
in: query
description: Date in RFC3339 format for the earliest run to retrieve. By default, the current day minus seven days is used.
description: Date in RFC 3339 format for the earliest run to retrieve. By default, the current day minus seven days is used.
schema:
type: string
- name: endDate
in: query
description: Date in RFC3339 format for the latest run to retrieve. By default, the current day is used.
description: Date in RFC 3339 format for the latest run to retrieve. By default, the current day is used.
schema:
type: string
responses:
Expand Down
8 changes: 4 additions & 4 deletions website/docs/contributing/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ see [Add a new API client](./add-new-api-client.md).
## Prefer plain text

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

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

Expand Down Expand Up @@ -232,14 +232,14 @@ use the following terms consistently:

#### Example: date and time

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

```
createdAt:
type: string
description: Date and time when the object was created, in RFC3339 format.
description: Date and time when the object was created, in RFC 3339 format.
example: 2024-04-06T08:08:08Z
```

Expand All @@ -249,7 +249,7 @@ createdAt:
RFC 3339 is slightly less ambiguous than ISO 8601 and leads to more readable dates.
Since RFC 3339 is a _profile_ of ISO 8601,
every RFC 3339 date also complies with ISO 8601,
but not every ISO 8601 date complies with ISO 8601.
but not every ISO 8601 date complies with RFC 3339.

For example, `2024-04-06T00:00:00` conforms to both RFC 3339 and ISO 8601.
But `20240406T000000` only conforms to ISO 8601, which allows omitting the `-` and `:` separators.
Expand Down
Loading