chore(docs): Generated API Reference (#4706)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
committed by
GitHub
parent
efdea04963
commit
658339767b
@@ -1,18 +1,21 @@
|
||||
title: Notification Provider
|
||||
description: Represents a notification provider plugin and holds its installation status.
|
||||
description: >-
|
||||
A notification provider represents a notification service installed in the
|
||||
Medusa backend, either through a plugin or backend customizations. It holds
|
||||
the notification service's installation status.
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
- is_installed
|
||||
properties:
|
||||
id:
|
||||
description: The id of the notification provider as given by the plugin.
|
||||
description: The ID of the notification provider as given by the notification service.
|
||||
type: string
|
||||
example: sendgrid
|
||||
is_installed:
|
||||
description: >-
|
||||
Whether the plugin is installed in the current version. Plugins that are
|
||||
no longer installed are not deleted by will have this field set to
|
||||
`false`.
|
||||
Whether the notification service is installed in the current version. If a
|
||||
notification service is no longer installed, the `is_installed` attribute
|
||||
is set to `false`.
|
||||
type: boolean
|
||||
default: true
|
||||
|
||||
Reference in New Issue
Block a user