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

chore(docs): Updated API Reference (v2) (#8954)

Browse Source 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-09-03 07:18:42 +00:00
committed by GitHub
parent 6652db45ef
commit edc19e748b
157 changed files with 16009 additions and 35955 deletions
Download Patch File Download Diff File Expand all files Collapse all files

202
www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml
View File

@@ -63,11 +63,11 @@ get:
with `-`.
- name: deleted_at
in: query
description: The exchange's deleted at.
description: Filter by an exchange's deletion date.
required: false
schema:
type: object
description: The exchange's deleted at.
description: Filter by an exchange's deletion date.
properties:
$and:
type: array
@@ -91,11 +91,11 @@ get:
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
description: Filter by multiple exact matches.
items:
type: string
title: $eq
description: Filter by an exact match.
description: An exact match.
$ne:
type: string
title: $ne
@@ -106,21 +106,19 @@ get:
items:
type: string
title: $in
description: Filter by values in this array.
description: The value to match.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
description: The value not to match.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching this parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
@@ -148,50 +146,46 @@ get:
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
description: Filter by multiple exact matches.
items:
type: string
title: $eq
description: Filter by an exact match.
description: The value to match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
description: Filter by values not matching this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
description: The value to match.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
description: The value to not match
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching this parameter
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
Filter by values not matching the values of this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: The values to not match.
$gt:
type: string
title: $gt
@@ -242,9 +236,7 @@ get:
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
description: The value to match.
$contains:
type: array
description: >-
@@ -253,16 +245,14 @@ get:
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
description: The values to match.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
description: The values to match.
$exists:
type: boolean
title: $exists
@@ -270,15 +260,11 @@ get:
Filter by whether a value for this parameter exists (not
`null`).
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching those in this parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: The values to not match.
$gt:
type: string
title: $gt
@@ -325,33 +311,33 @@ get:
items:
type: string
title: $overlap
description: Filter arrays that have overlapping values with this parameter.
description: The values to match.
$contains:
type: array
description: Filter arrays that contain some of the values of this parameter.
items:
type: string
title: $contains
description: Filter arrays that contain some of the values of this parameter.
description: The values to match.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
description: The values to match.
$exists:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
- name: q
in: query
description: The exchange's q.
description: Search term to apply on an exchange's searchable properties.
required: false
schema:
type: string
title: q
description: The exchange's q.
description: Search term to apply on an exchange's searchable properties.
- name: id
in: query
required: false
@@ -359,13 +345,13 @@ get:
oneOf:
- type: string
title: id
description: The exchange's ID.
description: Filter by an exchange ID.
- type: array
description: The exchange's ID.
description: Filter by exchange IDs.
items:
type: string
title: id
description: The id's ID.
description: An exchange ID.
- name: order_id
in: query
required: false
@@ -373,13 +359,13 @@ get:
oneOf:
- type: string
title: order_id
description: The exchange's order id.
description: Filter by an exchange's order ID.
- type: array
description: The exchange's order id.
description: Filter by order IDs that the exchanges belong to.
items:
type: string
title: order_id
description: The order id's details.
description: An order's ID.
- name: status
in: query
required: false
@@ -387,20 +373,20 @@ get:
oneOf:
- type: string
title: status
description: The exchange's status.
description: Filter by an exchange's status.
- type: array
description: The exchange's status.
description: Filter by exchange statuses.
items:
type: string
title: status
description: The status's details.
description: An exchange status.
- name: created_at
in: query
description: The exchange's created at.
description: Filter by the exchange's creation date.
required: false
schema:
type: object
description: The exchange's created at.
description: Filter by the exchange's creation date.
properties:
$and:
type: array
@@ -424,11 +410,11 @@ get:
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
description: Filter by multiple exact matches.
items:
type: string
title: $eq
description: Filter by an exact match.
description: An exact match.
$ne:
type: string
title: $ne
@@ -439,21 +425,19 @@ get:
items:
type: string
title: $in
description: Filter by values in this array.
description: The value to match.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
description: The value not to match.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching this parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
@@ -481,50 +465,46 @@ get:
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
description: Filter by multiple exact matches.
items:
type: string
title: $eq
description: Filter by an exact match.
description: The value to match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
description: Filter by values not matching this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
description: The value to match.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
description: The value to not match
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching this parameter
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
Filter by values not matching the values of this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: The values to not match.
$gt:
type: string
title: $gt
@@ -575,9 +555,7 @@ get:
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
description: The value to match.
$contains:
type: array
description: >-
@@ -586,16 +564,14 @@ get:
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
description: The values to match.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
description: The values to match.
$exists:
type: boolean
title: $exists
@@ -603,15 +579,11 @@ get:
Filter by whether a value for this parameter exists (not
`null`).
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching those in this parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: The values to not match.
$gt:
type: string
title: $gt
@@ -658,32 +630,32 @@ get:
items:
type: string
title: $overlap
description: Filter arrays that have overlapping values with this parameter.
description: The values to match.
$contains:
type: array
description: Filter arrays that contain some of the values of this parameter.
items:
type: string
title: $contains
description: Filter arrays that contain some of the values of this parameter.
description: The values to match.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
description: The values to match.
$exists:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
- name: updated_at
in: query
description: The exchange's updated at.
description: Filter by the exchange's update date.
required: false
schema:
type: object
description: The exchange's updated at.
description: Filter by the exchange's update date.
properties:
$and:
type: array
@@ -707,11 +679,11 @@ get:
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
description: Filter by multiple exact matches.
items:
type: string
title: $eq
description: Filter by an exact match.
description: An exact match.
$ne:
type: string
title: $ne
@@ -722,21 +694,19 @@ get:
items:
type: string
title: $in
description: Filter by values in this array.
description: The value to match.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
description: The value not to match.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching this parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
@@ -764,50 +734,46 @@ get:
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
description: Filter by multiple exact matches.
items:
type: string
title: $eq
description: Filter by an exact match.
description: The value to match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
description: Filter by values not matching this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
description: The value to match.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
description: The value to not match
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching this parameter
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
Filter by values not matching the values of this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: The values to not match.
$gt:
type: string
title: $gt
@@ -858,9 +824,7 @@ get:
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
description: The value to match.
$contains:
type: array
description: >-
@@ -869,16 +833,14 @@ get:
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
description: The values to match.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
description: The values to match.
$exists:
type: boolean
title: $exists
@@ -886,15 +848,11 @@ get:
Filter by whether a value for this parameter exists (not
`null`).
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
description: Filter by values not matching those in this parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
description: The values to not match.
$gt:
type: string
title: $gt
@@ -941,21 +899,21 @@ get:
items:
type: string
title: $overlap
description: Filter arrays that have overlapping values with this parameter.
description: The values to match.
$contains:
type: array
description: Filter arrays that contain some of the values of this parameter.
items:
type: string
title: $contains
description: Filter arrays that contain some of the values of this parameter.
description: The values to match.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
description: The values to match.
$exists:
type: boolean
title: $exists