chore(docs): Generated API Reference (#3262)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
67f9429293
commit
4fb22e8ba5
@@ -4,11 +4,20 @@ description: >-
|
||||
might occur.
|
||||
type: object
|
||||
required:
|
||||
- created_at
|
||||
- id
|
||||
- idempotency_key
|
||||
- locked_at
|
||||
- recovery_point
|
||||
- response_code
|
||||
- response_body
|
||||
- request_method
|
||||
- request_params
|
||||
- request_path
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The idempotency key's ID
|
||||
type: string
|
||||
example: ikey_01G8X9A7ESKAJXG2H0E6F1MW7A
|
||||
idempotency_key:
|
||||
description: >-
|
||||
@@ -25,31 +34,37 @@ properties:
|
||||
format: date-time
|
||||
locked_at:
|
||||
description: Date which the idempotency key was locked.
|
||||
nullable: true
|
||||
type: string
|
||||
format: date-time
|
||||
request_method:
|
||||
description: The method of the request
|
||||
nullable: true
|
||||
type: string
|
||||
example: POST
|
||||
request_params:
|
||||
type: object
|
||||
description: The parameters passed to the request
|
||||
nullable: true
|
||||
type: object
|
||||
example:
|
||||
id: cart_01G8ZH853Y6TFXWPG5EYE81X63
|
||||
request_path:
|
||||
description: The request's path
|
||||
nullable: true
|
||||
type: string
|
||||
example: /store/carts/cart_01G8ZH853Y6TFXWPG5EYE81X63/complete
|
||||
response_code:
|
||||
type: string
|
||||
description: The response's code.
|
||||
nullable: true
|
||||
type: string
|
||||
example: 200
|
||||
response_body:
|
||||
type: object
|
||||
description: The response's body
|
||||
nullable: true
|
||||
type: object
|
||||
example:
|
||||
id: cart_01G8ZH853Y6TFXWPG5EYE81X63
|
||||
recovery_point:
|
||||
type: string
|
||||
description: Where to continue from.
|
||||
type: string
|
||||
default: started
|
||||
|
||||
Reference in New Issue
Block a user