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:
committed by
GitHub
parent
6652db45ef
commit
edc19e748b
@@ -63,12 +63,12 @@ get:
|
||||
with `-`.
|
||||
- name: q
|
||||
in: query
|
||||
description: The notification's q.
|
||||
description: Search term to apply on the notification's searchable properties.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: q
|
||||
description: The notification's q.
|
||||
description: Search term to apply on the notification's searchable properties.
|
||||
- name: id
|
||||
in: query
|
||||
required: false
|
||||
@@ -76,13 +76,13 @@ get:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: id
|
||||
description: The notification's ID.
|
||||
description: Filter by a notification ID.
|
||||
- type: array
|
||||
description: The notification's ID.
|
||||
description: Filter by notification IDs.
|
||||
items:
|
||||
type: string
|
||||
title: id
|
||||
description: The id's ID.
|
||||
description: A notification ID.
|
||||
- name: channel
|
||||
in: query
|
||||
required: false
|
||||
@@ -90,19 +90,23 @@ get:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: channel
|
||||
description: The notification's channel.
|
||||
description: Filter by a notification channel.
|
||||
example: email
|
||||
- type: array
|
||||
description: The notification's channel.
|
||||
description: Filter by notification channels.
|
||||
items:
|
||||
type: string
|
||||
title: channel
|
||||
description: The channel's details.
|
||||
description: A notification channel.
|
||||
example: email
|
||||
- name: $and
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
type: array
|
||||
description: The notification'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
|
||||
@@ -111,7 +115,9 @@ get:
|
||||
required: false
|
||||
schema:
|
||||
type: array
|
||||
description: The notification'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
|
||||
|
||||
Reference in New Issue
Block a user