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

Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-01-03 10:40:03 +02:00
committed by GitHub
parent 19d7be31eb
commit cd32795595
12 changed files with 3847 additions and 3419 deletions

View File

@@ -1429,59 +1429,6 @@ paths:
$ref: '#/components/responses/invalid_request_error'
'500':
$ref: '#/components/responses/500_error'
'/gift-cards/{code}':
get:
operationId: GetGiftCardsCode
summary: Get Gift Card by Code
description: Retrieves a Gift Card by its associated unqiue code.
parameters:
- in: path
name: code
required: true
description: The unique Gift Card code.
schema:
type: string
x-codeSamples:
- lang: JavaScript
label: JS Client
source: >
import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries:
3 })
medusa.giftCards.retrieve(code)
.then(({ gift_card }) => {
console.log(gift_card.id);
});
- lang: Shell
label: cURL
source: >
curl --location --request GET
'https://medusa-url.com/store/gift-cards/{code}'
tags:
- Gift Card
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
gift_card:
$ref: '#/components/schemas/GiftCard'
'400':
$ref: '#/components/responses/400_error'
'404':
$ref: '#/components/responses/not_found_error'
'409':
$ref: '#/components/responses/invalid_state_error'
'422':
$ref: '#/components/responses/invalid_request_error'
'500':
$ref: '#/components/responses/500_error'
/customers/me/addresses:
post:
operationId: PostCustomersCustomerAddresses
@@ -2344,6 +2291,59 @@ paths:
$ref: '#/components/responses/invalid_request_error'
'500':
$ref: '#/components/responses/500_error'
'/gift-cards/{code}':
get:
operationId: GetGiftCardsCode
summary: Get Gift Card by Code
description: Retrieves a Gift Card by its associated unqiue code.
parameters:
- in: path
name: code
required: true
description: The unique Gift Card code.
schema:
type: string
x-codeSamples:
- lang: JavaScript
label: JS Client
source: >
import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries:
3 })
medusa.giftCards.retrieve(code)
.then(({ gift_card }) => {
console.log(gift_card.id);
});
- lang: Shell
label: cURL
source: >
curl --location --request GET
'https://medusa-url.com/store/gift-cards/{code}'
tags:
- Gift Card
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
gift_card:
$ref: '#/components/schemas/GiftCard'
'400':
$ref: '#/components/responses/400_error'
'404':
$ref: '#/components/responses/not_found_error'
'409':
$ref: '#/components/responses/invalid_state_error'
'422':
$ref: '#/components/responses/invalid_request_error'
'500':
$ref: '#/components/responses/500_error'
'/order-edits/{id}/complete':
post:
operationId: PostOrderEditsOrderEditComplete