Skip to content
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
2 changes: 1 addition & 1 deletion openapi/components/parameters/Before.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
16 changes: 8 additions & 8 deletions openapi/components/parameters/Filter.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions openapi/components/parameters/Limit.yaml
Original file line number Diff line number Diff line change
@@ -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.
Comment thread
JLekawa marked this conversation as resolved.
in: query
required: false
schema:
Expand Down
2 changes: 1 addition & 1 deletion openapi/components/schemas/Error.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion openapi/components/schemas/MenuBaseItem.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion openapi/paths/orders.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions openapi/paths/orders_{orderId}.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down