Skip to content

Commit 1ada048

Browse files
authored
chore(docs): clarify updated_since description (#866)
1 parent db4196b commit 1ada048

3 files changed

Lines changed: 7 additions & 5 deletions

File tree

doc/compiled.json

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8674,7 +8674,7 @@
86748674
},
86758675
{
86768676
"name": "updated_since",
8677-
"description": "Only include keys that have been updated since the given date. The date must be in ISO 8601 format (e.g., `2023-01-01T00:00:00Z`).\n",
8677+
"description": "Only include translations and keys that have been updated since the given date. The date must be in ISO 8601 format (e.g., `2023-01-01T00:00:00Z`).\n",
86788678
"in": "query",
86798679
"schema": {
86808680
"type": "string"
@@ -8846,8 +8846,9 @@
88468846
"properties": {}
88478847
},
88488848
"updated_since": {
8849-
"description": "Only include keys that have been updated since the given date. The date must be in ISO 8601 format (e.g., `2023-01-01T00:00:00Z`).\n",
8850-
"type": "string"
8849+
"description": "Only include translations and keys that have been updated since the given date. The date must be in ISO 8601 format (e.g., `2023-01-01T00:00:00Z`).\n",
8850+
"type": "string",
8851+
"example": "2023-01-01T00:00:00Z"
88518852
}
88528853
}
88538854
}

paths/locale_downloads/create.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,9 @@ requestBody:
8787
properties: {}
8888
updated_since:
8989
description: |
90-
Only include keys that have been updated since the given date. The date must be in ISO 8601 format (e.g., `2023-01-01T00:00:00Z`).
90+
Only include translations and keys that have been updated since the given date. The date must be in ISO 8601 format (e.g., `2023-01-01T00:00:00Z`).
9191
type: string
92+
example: "2023-01-01T00:00:00Z"
9293
responses:
9394
"201":
9495
description: Created

paths/locales/download.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ parameters:
145145
- en
146146
- name: updated_since
147147
description: |
148-
Only include keys that have been updated since the given date. The date must be in ISO 8601 format (e.g., `2023-01-01T00:00:00Z`).
148+
Only include translations and keys that have been updated since the given date. The date must be in ISO 8601 format (e.g., `2023-01-01T00:00:00Z`).
149149
in: query
150150
schema:
151151
type: string

0 commit comments

Comments
 (0)