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 user's q.
|
||||
description: The search term to filter the user's searchable properties.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: q
|
||||
description: The user's q.
|
||||
description: The search term to filter the user's searchable properties.
|
||||
- name: id
|
||||
in: query
|
||||
required: false
|
||||
@@ -76,45 +76,45 @@ get:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: id
|
||||
description: The user's ID.
|
||||
description: Filter by a user's ID.
|
||||
- type: array
|
||||
description: The user's ID.
|
||||
description: Filter by user IDs.
|
||||
items:
|
||||
type: string
|
||||
title: id
|
||||
description: The id's ID.
|
||||
description: A user's ID.
|
||||
- name: email
|
||||
in: query
|
||||
description: The user's email.
|
||||
description: Filter by an email.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: email
|
||||
description: The user's email.
|
||||
description: Filter by an email.
|
||||
format: email
|
||||
- name: first_name
|
||||
in: query
|
||||
description: The user's first name.
|
||||
description: Filter by a first name.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: first_name
|
||||
description: The user's first name.
|
||||
description: Filter by a first name.
|
||||
- name: last_name
|
||||
in: query
|
||||
description: The user's last name.
|
||||
description: Filter by a last name.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: last_name
|
||||
description: The user's last name.
|
||||
description: Filter by a last name.
|
||||
- name: created_at
|
||||
in: query
|
||||
description: The user's created at.
|
||||
description: Filter by a user's creation date.
|
||||
required: false
|
||||
schema:
|
||||
type: object
|
||||
description: The user's created at.
|
||||
description: Filter by a user's creation date.
|
||||
properties:
|
||||
$and:
|
||||
type: array
|
||||
@@ -172,150 +172,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
|
||||
@@ -393,11 +249,11 @@ get:
|
||||
description: Filter by whether a value for this parameter exists (not `null`).
|
||||
- name: updated_at
|
||||
in: query
|
||||
description: The user's updated at.
|
||||
description: Filter by a user's update date.
|
||||
required: false
|
||||
schema:
|
||||
type: object
|
||||
description: The user's updated at.
|
||||
description: Filter by a user's update date.
|
||||
properties:
|
||||
$and:
|
||||
type: array
|
||||
@@ -455,150 +311,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
|
||||
@@ -676,11 +388,11 @@ get:
|
||||
description: Filter by whether a value for this parameter exists (not `null`).
|
||||
- name: deleted_at
|
||||
in: query
|
||||
description: The user's deleted at.
|
||||
description: Filter by a user's deletion date.
|
||||
required: false
|
||||
schema:
|
||||
type: object
|
||||
description: The user's deleted at.
|
||||
description: Filter by a user's deletion date.
|
||||
properties:
|
||||
$and:
|
||||
type: array
|
||||
@@ -738,150 +450,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
|
||||
|
||||
Reference in New Issue
Block a user