From c677d12964ce7dfaa8c01cbebe0f5766f0f0cd96 Mon Sep 17 00:00:00 2001 From: JLekawa Date: Thu, 2 Jul 2026 12:05:56 +0200 Subject: [PATCH 1/2] docs(other): update descriptions --- openapi/components/parameters/Filter.yaml | 16 ++++++++-------- openapi/components/parameters/Limit.yaml | 4 ++-- openapi/components/schemas/Error.yaml | 2 +- openapi/components/schemas/MenuBaseItem.yaml | 2 +- openapi/paths/orders.yaml | 2 +- openapi/paths/orders_{orderId}.yaml | 4 ++-- 6 files changed, 15 insertions(+), 15 deletions(-) diff --git a/openapi/components/parameters/Filter.yaml b/openapi/components/parameters/Filter.yaml index 401bc2e..1e6f24d 100644 --- a/openapi/components/parameters/Filter.yaml +++ b/openapi/components/parameters/Filter.yaml @@ -5,16 +5,16 @@ description: |- **Format:** `field1:value1 field2:value2` **Supported operators:** - - `field:value` - Exact match - - `field:value1,value2` - Match any of the comma-separated values (OR) - - Time ranges: Use `30d` (30 days), `7d` (7 days), `1h` (1 hour), etc. + - `field:value` - exact match + - `field:value1,value2` - match any of the comma-separated values (OR) + - Time ranges: use `30d` (30 days), `7d` (7 days), `1h` (1 hour), etc. **Examples:** - - `status:placed` - Filter by single status. - - `status:placed,completed` - Filter by multiple statuses. - - `createdAt:30d` - Filter orders created in the last 30 days. - - `orderId:ord_01h1s5z6vf2mm1mz3hevnn9va7` - Filter by specific order ID. - - `status:placed createdAt:7d` - Combine multiple filters. + - `status:placed` - filter by single status. + - `status:placed,completed` - filter by multiple statuses. + - `createdAt:30d` - filter orders created in the last 30 days. + - `orderId:ord_01h1s5z6vf2mm1mz3hevnn9va7` - filter by specific order ID. + - `status:placed createdAt:7d` - combine multiple filters. in: query required: false schema: diff --git a/openapi/components/parameters/Limit.yaml b/openapi/components/parameters/Limit.yaml index 42050c4..b960de0 100644 --- a/openapi/components/parameters/Limit.yaml +++ b/openapi/components/parameters/Limit.yaml @@ -1,7 +1,7 @@ name: limit description: | - Use to return a number of results per page. - If there is more data, use in combination with `after` to page through the data. + Specify the number of results per page. + If there is more data, use in combination with `after` to page through all results. in: query required: false schema: diff --git a/openapi/components/schemas/Error.yaml b/openapi/components/schemas/Error.yaml index ac9640e..9c8f312 100644 --- a/openapi/components/schemas/Error.yaml +++ b/openapi/components/schemas/Error.yaml @@ -20,7 +20,7 @@ properties: format: uri-reference description: | URI reference that identifies the specific occurrence of the problem, e.g. by adding a fragment identifier or sub-path to the problem type. - May be used to locate the root of this problem in the source code. + Can be used to locate the root of this problem in the source code. example: '/some/uri-reference#specific-occurrence-context' details: description: Additional error details. diff --git a/openapi/components/schemas/MenuBaseItem.yaml b/openapi/components/schemas/MenuBaseItem.yaml index d96f3d3..b683d8c 100644 --- a/openapi/components/schemas/MenuBaseItem.yaml +++ b/openapi/components/schemas/MenuBaseItem.yaml @@ -36,7 +36,7 @@ properties: - string - 'null' format: binary - description: Photo of the menu item. Must be a PNG image and less than 1MB. + description: Photo of the menu item. Must be a PNG image less than 1MB in size. photoUrl: readOnly: true type: string diff --git a/openapi/paths/orders.yaml b/openapi/paths/orders.yaml index b76b367..7b816e4 100644 --- a/openapi/paths/orders.yaml +++ b/openapi/paths/orders.yaml @@ -35,7 +35,7 @@ post: summary: Create order description: | Create a new order. - Order items cannot be changed - if they need to be updated, the order should be canceled and a new one placed. + Order items cannot be changed - if they need to be updated, cancel the order and place a new one. operationId: createOrder security: - OAuth2: diff --git a/openapi/paths/orders_{orderId}.yaml b/openapi/paths/orders_{orderId}.yaml index bddd4a7..48109bf 100644 --- a/openapi/paths/orders_{orderId}.yaml +++ b/openapi/paths/orders_{orderId}.yaml @@ -47,7 +47,7 @@ patch: summary: Partially update an order description: | Update an existing order status. - Order items cannot be changed - if they need to be updated, the order should be canceled and a new one placed. + Order items cannot be changed - if they need to be updated, cancel the order and place a new one. operationId: updateOrder security: - OAuth2: @@ -104,7 +104,7 @@ delete: summary: Delete an order description: | Delete the order. - To keep the order history, the order should be canceled instead of deleted. + To keep the order history, cancel the order instead of deleting it. operationId: deleteOrder security: - OAuth2: From 4be4393fddd9db794a6500317b309e92ef290fe7 Mon Sep 17 00:00:00 2001 From: JLekawa Date: Thu, 2 Jul 2026 14:08:14 +0200 Subject: [PATCH 2/2] docs(other): fix description --- openapi/components/parameters/Before.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openapi/components/parameters/Before.yaml b/openapi/components/parameters/Before.yaml index ea713db..a719dc6 100644 --- a/openapi/components/parameters/Before.yaml +++ b/openapi/components/parameters/Before.yaml @@ -2,6 +2,6 @@ name: before in: query required: false description: | - Use the `startCursor` as a value for the `before` parameter to get the next page. + Use the `startCursor` as a value for the `before` parameter to get the previous page. schema: type: string