asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: generate OAS for 2.11.2 (#13925)

Browse Source
This commit is contained in:
Shahed Nasser
2025-10-31 16:15:46 +02:00
committed by GitHub
parent 13d7d15be5
commit 604ff55a5b
403 changed files with 17473 additions and 5392 deletions
Download Patch File Download Diff File Expand all files Collapse all files

117
www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml
View File

@@ -20,65 +20,6 @@ get:
type: string
externalDocs:
url: https://docs.medusajs.com/api/store#publishable-api-key
- name: fields
in: query
description: >-
Comma-separated fields that should be included in the returned data. if
a field is prefixed with `+` it will be added to the default fields,
using `-` will remove it from the default fields. without prefix it will
replace the entire default fields. This API route restricts the fields
that can be selected. Learn how to override the retrievable fields in
the [Retrieve Custom
Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links)
documentation.
required: false
schema:
type: string
title: fields
description: >-
Comma-separated fields that should be included in the returned data.
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields. This API route
restricts the fields that can be selected. Learn how to override the
retrievable fields in the [Retrieve Custom
Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links)
documentation.
externalDocs:
url: '#select-fields-and-relations'
- name: offset
in: query
description: The number of items to skip when retrieving a list.
required: false
schema:
type: number
title: offset
description: The number of items to skip when retrieving a list.
externalDocs:
url: '#pagination'
- name: limit
in: query
description: Limit the number of items returned in the list.
required: false
schema:
type: number
title: limit
description: Limit the number of items returned in the list.
externalDocs:
url: '#pagination'
- name: order
in: query
description: >-
The field to sort the data by. By default, the sort order is ascending.
To change the order to descending, prefix the field name with `-`.
required: false
schema:
type: string
title: order
description: >-
The field to sort the data by. By default, the sort order is
ascending. To change the order to descending, prefix the field name
with `-`.
- name: city
in: query
description: Filter by the address's city.
@@ -132,14 +73,62 @@ get:
type: string
title: q
description: Search term to filter the address's searchable properties.
- name: with_deleted
- name: company
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
oneOf:
- type: string
title: company
description: Filter addresses by company.
- type: array
description: Filter addresses by companies.
items:
type: string
title: company
description: A company.
- name: province
in: query
required: false
schema:
oneOf:
- type: string
title: province
description: Filter addresses by province.
- type: array
description: Filter addresses by provinces.
items:
type: string
title: province
description: A province.
- name: $and
in: query
description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
required: false
schema:
type: array
description: >-
Join query parameters with an AND condition. Each object's content is
the same type as the expected query parameters.
items:
type: object
title: $and
- name: $or
in: query
description: >-
Join query parameters with an OR condition. Each object's content is the
same type as the expected query parameters.
required: false
schema:
type: array
description: >-
Join query parameters with an OR condition. Each object's content is
the same type as the expected query parameters.
items:
type: object
title: $or
security:
- cookie_auth: []
- jwt_token: []

2
www/apps/api-reference/specs/store/paths/store_orders_{id}_transfer_decline.yaml
View File

@@ -46,7 +46,7 @@ post:
content:
application/json:
schema:
$ref: ../components/schemas/StoreDeclineOrderTransferRequest.yaml
$ref: ../components/schemas/StoreDeclineOrderTransfer.yaml
x-codeSamples:
- lang: JavaScript
label: JS SDK

35
www/apps/api-reference/specs/store/paths/store_products_{id}.yaml
View File

@@ -102,41 +102,6 @@ get:
The ID of the customer's cart. If set, the cart's region and shipping
address's country code and province are used instead of the
`region_id`, `country_code`, and `province` properties.
- name: limit
in: query
description: Limit the number of items returned in the list.
required: false
schema:
type: number
title: limit
description: Limit the number of items returned in the list.
externalDocs:
url: '#pagination'
- name: offset
in: query
description: The number of items to skip when retrieving a list.
required: false
schema:
type: number
title: offset
description: The number of items to skip when retrieving a list.
externalDocs:
url: '#pagination'
- name: order
in: query
description: >-
The field to sort the data by. By default, the sort order is ascending.
To change the order to descending, prefix the field name with `-`.
required: false
schema:
type: string
title: order
description: >-
The field to sort the data by. By default, the sort order is
ascending. To change the order to descending, prefix the field name
with `-`.
externalDocs:
url: '#pagination'
x-codeSamples:
- lang: JavaScript
label: JS SDK