chore(docs): Updated API Reference (v2) (#8954)
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]
committed by
GitHub
GitHub
parent
6652db45ef
commit
edc19e748b
@@ -63,12 +63,12 @@ get:
|
||||
with `-`.
|
||||
- name: q
|
||||
in: query
|
||||
description: The payment's q.
|
||||
description: Search term to filter the payment's searchable properties.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: q
|
||||
description: The payment's q.
|
||||
description: Search term to filter the payment's searchable properties.
|
||||
- name: id
|
||||
in: query
|
||||
required: false
|
||||
@@ -76,13 +76,13 @@ get:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: id
|
||||
description: The payment's ID.
|
||||
description: Filter by a payment ID.
|
||||
- type: array
|
||||
description: The payment's ID.
|
||||
description: Filter by payment IDs.
|
||||
items:
|
||||
type: string
|
||||
title: id
|
||||
description: The id's ID.
|
||||
description: A payment ID.
|
||||
- name: payment_session_id
|
||||
in: query
|
||||
required: false
|
||||
@@ -90,20 +90,24 @@ get:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: payment_session_id
|
||||
description: The payment's payment session id.
|
||||
description: >-
|
||||
Filter by a payment session ID to retrieve its associated
|
||||
payments.
|
||||
- type: array
|
||||
description: The payment's payment session id.
|
||||
description: >-
|
||||
Filter by payment session IDs to retrieve their associated
|
||||
payments.
|
||||
items:
|
||||
type: string
|
||||
title: payment_session_id
|
||||
description: The payment session id's details.
|
||||
description: A payment session's ID.
|
||||
- name: created_at
|
||||
in: query
|
||||
description: The payment's created at.
|
||||
description: Filter by the payment's creation date.
|
||||
required: false
|
||||
schema:
|
||||
type: object
|
||||
description: The payment's created at.
|
||||
description: Filter by the payment's creation date.
|
||||
properties:
|
||||
$and:
|
||||
type: array
|
||||
@@ -161,150 +165,6 @@ get:
|
||||
description: >-
|
||||
Filter by values not matching the conditions in this
|
||||
parameter.
|
||||
properties:
|
||||
$and:
|
||||
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
|
||||
$or:
|
||||
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
|
||||
$eq:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: $eq
|
||||
description: Filter by an exact match.
|
||||
- type: array
|
||||
description: Filter by an exact match.
|
||||
items:
|
||||
type: string
|
||||
title: $eq
|
||||
description: Filter by an exact match.
|
||||
$ne:
|
||||
type: string
|
||||
title: $ne
|
||||
description: Filter by values not equal to this parameter.
|
||||
$in:
|
||||
type: array
|
||||
description: Filter by values in this array.
|
||||
items:
|
||||
type: string
|
||||
title: $in
|
||||
description: Filter by values in this array.
|
||||
$nin:
|
||||
type: array
|
||||
description: Filter by values not in this array.
|
||||
items:
|
||||
type: string
|
||||
title: $nin
|
||||
description: Filter by values not in this array.
|
||||
$not:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: $not
|
||||
description: >-
|
||||
Filter by values not matching the conditions in 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
|
||||
parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $not
|
||||
description: >-
|
||||
Filter by values not matching the conditions in this
|
||||
parameter.
|
||||
$gt:
|
||||
type: string
|
||||
title: $gt
|
||||
description: >-
|
||||
Filter by values greater than this parameter. Useful for
|
||||
numbers and dates only.
|
||||
$gte:
|
||||
type: string
|
||||
title: $gte
|
||||
description: >-
|
||||
Filter by values greater than or equal to this parameter.
|
||||
Useful for numbers and dates only.
|
||||
$lt:
|
||||
type: string
|
||||
title: $lt
|
||||
description: >-
|
||||
Filter by values less than this parameter. Useful for
|
||||
numbers and dates only.
|
||||
$lte:
|
||||
type: string
|
||||
title: $lte
|
||||
description: >-
|
||||
Filter by values less than or equal to this parameter.
|
||||
Useful for numbers and dates only.
|
||||
$like:
|
||||
type: string
|
||||
title: $like
|
||||
description: Apply a `like` filter. Useful for strings only.
|
||||
$re:
|
||||
type: string
|
||||
title: $re
|
||||
description: Apply a regex filter. Useful for strings only.
|
||||
$ilike:
|
||||
type: string
|
||||
title: $ilike
|
||||
description: >-
|
||||
Apply a case-insensitive `like` filter. Useful for strings
|
||||
only.
|
||||
$fulltext:
|
||||
type: string
|
||||
title: $fulltext
|
||||
description: Filter to apply on full-text properties.
|
||||
$overlap:
|
||||
type: array
|
||||
description: >-
|
||||
Filter arrays that have overlapping values with this
|
||||
parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $overlap
|
||||
description: >-
|
||||
Filter arrays that have overlapping values with this
|
||||
parameter.
|
||||
$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.
|
||||
$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.
|
||||
$exists:
|
||||
type: boolean
|
||||
title: $exists
|
||||
description: >-
|
||||
Filter by whether a value for this parameter exists (not
|
||||
`null`).
|
||||
- type: array
|
||||
description: >-
|
||||
Filter by values not matching the conditions in this
|
||||
@@ -382,11 +242,11 @@ get:
|
||||
description: Filter by whether a value for this parameter exists (not `null`).
|
||||
- name: updated_at
|
||||
in: query
|
||||
description: The payment's updated at.
|
||||
description: Filter by the payment's update date.
|
||||
required: false
|
||||
schema:
|
||||
type: object
|
||||
description: The payment's updated at.
|
||||
description: Filter by the payment's update date.
|
||||
properties:
|
||||
$and:
|
||||
type: array
|
||||
@@ -444,150 +304,6 @@ get:
|
||||
description: >-
|
||||
Filter by values not matching the conditions in this
|
||||
parameter.
|
||||
properties:
|
||||
$and:
|
||||
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
|
||||
$or:
|
||||
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
|
||||
$eq:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: $eq
|
||||
description: Filter by an exact match.
|
||||
- type: array
|
||||
description: Filter by an exact match.
|
||||
items:
|
||||
type: string
|
||||
title: $eq
|
||||
description: Filter by an exact match.
|
||||
$ne:
|
||||
type: string
|
||||
title: $ne
|
||||
description: Filter by values not equal to this parameter.
|
||||
$in:
|
||||
type: array
|
||||
description: Filter by values in this array.
|
||||
items:
|
||||
type: string
|
||||
title: $in
|
||||
description: Filter by values in this array.
|
||||
$nin:
|
||||
type: array
|
||||
description: Filter by values not in this array.
|
||||
items:
|
||||
type: string
|
||||
title: $nin
|
||||
description: Filter by values not in this array.
|
||||
$not:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: $not
|
||||
description: >-
|
||||
Filter by values not matching the conditions in 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
|
||||
parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $not
|
||||
description: >-
|
||||
Filter by values not matching the conditions in this
|
||||
parameter.
|
||||
$gt:
|
||||
type: string
|
||||
title: $gt
|
||||
description: >-
|
||||
Filter by values greater than this parameter. Useful for
|
||||
numbers and dates only.
|
||||
$gte:
|
||||
type: string
|
||||
title: $gte
|
||||
description: >-
|
||||
Filter by values greater than or equal to this parameter.
|
||||
Useful for numbers and dates only.
|
||||
$lt:
|
||||
type: string
|
||||
title: $lt
|
||||
description: >-
|
||||
Filter by values less than this parameter. Useful for
|
||||
numbers and dates only.
|
||||
$lte:
|
||||
type: string
|
||||
title: $lte
|
||||
description: >-
|
||||
Filter by values less than or equal to this parameter.
|
||||
Useful for numbers and dates only.
|
||||
$like:
|
||||
type: string
|
||||
title: $like
|
||||
description: Apply a `like` filter. Useful for strings only.
|
||||
$re:
|
||||
type: string
|
||||
title: $re
|
||||
description: Apply a regex filter. Useful for strings only.
|
||||
$ilike:
|
||||
type: string
|
||||
title: $ilike
|
||||
description: >-
|
||||
Apply a case-insensitive `like` filter. Useful for strings
|
||||
only.
|
||||
$fulltext:
|
||||
type: string
|
||||
title: $fulltext
|
||||
description: Filter to apply on full-text properties.
|
||||
$overlap:
|
||||
type: array
|
||||
description: >-
|
||||
Filter arrays that have overlapping values with this
|
||||
parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $overlap
|
||||
description: >-
|
||||
Filter arrays that have overlapping values with this
|
||||
parameter.
|
||||
$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.
|
||||
$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.
|
||||
$exists:
|
||||
type: boolean
|
||||
title: $exists
|
||||
description: >-
|
||||
Filter by whether a value for this parameter exists (not
|
||||
`null`).
|
||||
- type: array
|
||||
description: >-
|
||||
Filter by values not matching the conditions in this
|
||||
@@ -665,11 +381,11 @@ get:
|
||||
description: Filter by whether a value for this parameter exists (not `null`).
|
||||
- name: deleted_at
|
||||
in: query
|
||||
description: The payment's deleted at.
|
||||
description: Filter by the payment's deletion date.
|
||||
required: false
|
||||
schema:
|
||||
type: object
|
||||
description: The payment's deleted at.
|
||||
description: Filter by the payment's deletion date.
|
||||
properties:
|
||||
$and:
|
||||
type: array
|
||||
@@ -727,150 +443,6 @@ get:
|
||||
description: >-
|
||||
Filter by values not matching the conditions in this
|
||||
parameter.
|
||||
properties:
|
||||
$and:
|
||||
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
|
||||
$or:
|
||||
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
|
||||
$eq:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: $eq
|
||||
description: Filter by an exact match.
|
||||
- type: array
|
||||
description: Filter by an exact match.
|
||||
items:
|
||||
type: string
|
||||
title: $eq
|
||||
description: Filter by an exact match.
|
||||
$ne:
|
||||
type: string
|
||||
title: $ne
|
||||
description: Filter by values not equal to this parameter.
|
||||
$in:
|
||||
type: array
|
||||
description: Filter by values in this array.
|
||||
items:
|
||||
type: string
|
||||
title: $in
|
||||
description: Filter by values in this array.
|
||||
$nin:
|
||||
type: array
|
||||
description: Filter by values not in this array.
|
||||
items:
|
||||
type: string
|
||||
title: $nin
|
||||
description: Filter by values not in this array.
|
||||
$not:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: $not
|
||||
description: >-
|
||||
Filter by values not matching the conditions in 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
|
||||
parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $not
|
||||
description: >-
|
||||
Filter by values not matching the conditions in this
|
||||
parameter.
|
||||
$gt:
|
||||
type: string
|
||||
title: $gt
|
||||
description: >-
|
||||
Filter by values greater than this parameter. Useful for
|
||||
numbers and dates only.
|
||||
$gte:
|
||||
type: string
|
||||
title: $gte
|
||||
description: >-
|
||||
Filter by values greater than or equal to this parameter.
|
||||
Useful for numbers and dates only.
|
||||
$lt:
|
||||
type: string
|
||||
title: $lt
|
||||
description: >-
|
||||
Filter by values less than this parameter. Useful for
|
||||
numbers and dates only.
|
||||
$lte:
|
||||
type: string
|
||||
title: $lte
|
||||
description: >-
|
||||
Filter by values less than or equal to this parameter.
|
||||
Useful for numbers and dates only.
|
||||
$like:
|
||||
type: string
|
||||
title: $like
|
||||
description: Apply a `like` filter. Useful for strings only.
|
||||
$re:
|
||||
type: string
|
||||
title: $re
|
||||
description: Apply a regex filter. Useful for strings only.
|
||||
$ilike:
|
||||
type: string
|
||||
title: $ilike
|
||||
description: >-
|
||||
Apply a case-insensitive `like` filter. Useful for strings
|
||||
only.
|
||||
$fulltext:
|
||||
type: string
|
||||
title: $fulltext
|
||||
description: Filter to apply on full-text properties.
|
||||
$overlap:
|
||||
type: array
|
||||
description: >-
|
||||
Filter arrays that have overlapping values with this
|
||||
parameter.
|
||||
items:
|
||||
type: string
|
||||
title: $overlap
|
||||
description: >-
|
||||
Filter arrays that have overlapping values with this
|
||||
parameter.
|
||||
$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.
|
||||
$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.
|
||||
$exists:
|
||||
type: boolean
|
||||
title: $exists
|
||||
description: >-
|
||||
Filter by whether a value for this parameter exists (not
|
||||
`null`).
|
||||
- type: array
|
||||
description: >-
|
||||
Filter by values not matching the conditions in this
|
||||
@@ -951,7 +523,9 @@ get:
|
||||
required: false
|
||||
schema:
|
||||
type: array
|
||||
description: The payment's $and.
|
||||
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
|
||||
@@ -960,7 +534,9 @@ get:
|
||||
required: false
|
||||
schema:
|
||||
type: array
|
||||
description: The payment's $or.
|
||||
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
|
||||
@@ -983,7 +559,7 @@ get:
|
||||
schema:
|
||||
allOf:
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
description: The paginated list of payments.
|
||||
required:
|
||||
- limit
|
||||
- offset
|
||||
@@ -992,23 +568,23 @@ get:
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The payment's limit.
|
||||
description: The maximum number of returned items.
|
||||
offset:
|
||||
type: number
|
||||
title: offset
|
||||
description: The payment's offset.
|
||||
description: The number of items skipped before the returned items.
|
||||
count:
|
||||
type: number
|
||||
title: count
|
||||
description: The payment's count.
|
||||
description: The total number of payments.
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
description: The paginated list of payments.
|
||||
required:
|
||||
- payments
|
||||
properties:
|
||||
payments:
|
||||
type: array
|
||||
description: The payment's payments.
|
||||
description: The list of payments.
|
||||
items:
|
||||
$ref: ../components/schemas/AdminPayment.yaml
|
||||
'400':
|
||||
|
||||
Reference in New Issue
Block a user