chore(docs): Generated API Reference (#2882)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2022-12-22 17:09:49 +02:00
committed by GitHub
parent 233d6904f8
commit 4814045036
477 changed files with 17312 additions and 17713 deletions

View File

@@ -0,0 +1,55 @@
title: Idempotency Key
description: >-
Idempotency Key is used to continue a process in case of any failure that
might occur.
type: object
required:
- idempotency_key
properties:
id:
type: string
description: The idempotency key's ID
example: ikey_01G8X9A7ESKAJXG2H0E6F1MW7A
idempotency_key:
description: >-
The unique randomly generated key used to determine the state of a
process.
type: string
externalDocs:
url: >-
https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
description: Learn more how to use the idempotency key.
created_at:
description: Date which the idempotency key was locked.
type: string
format: date-time
locked_at:
description: Date which the idempotency key was locked.
type: string
format: date-time
request_method:
description: The method of the request
type: string
example: POST
request_params:
type: object
description: The parameters passed to the request
example:
id: cart_01G8ZH853Y6TFXWPG5EYE81X63
request_path:
description: The request's path
type: string
example: /store/carts/cart_01G8ZH853Y6TFXWPG5EYE81X63/complete
response_code:
type: string
description: The response's code.
example: 200
response_body:
type: object
description: The response's body
example:
id: cart_01G8ZH853Y6TFXWPG5EYE81X63
recovery_point:
type: string
description: Where to continue from.
default: started