mirror of
https://github.com/netbox-community/netbox.git
synced 2025-08-08 16:48:16 -06:00
Add model documentation
This commit is contained in:
parent
f82de2b3fd
commit
1e57915a11
17
docs/models/extras/notification.md
Normal file
17
docs/models/extras/notification.md
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
# Notification
|
||||||
|
|
||||||
|
A notification alerts a user that a specific action has taken place in NetBox, such as an object being modified or a background job completing. A notification may be generated via a user's [subscription](./subscription.md) to a particular object, or by an event rule targeting a [notification group](./notificationgroup.md) of which the user is a member.
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
### User
|
||||||
|
|
||||||
|
The recipient of the notification.
|
||||||
|
|
||||||
|
### Object
|
||||||
|
|
||||||
|
The object to which the notification relates.
|
||||||
|
|
||||||
|
### Event Type
|
||||||
|
|
||||||
|
The type of event indicated by the notification.
|
17
docs/models/extras/notificationgroup.md
Normal file
17
docs/models/extras/notificationgroup.md
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
# Notification Group
|
||||||
|
|
||||||
|
A set of NetBox users and/or groups of users identified as recipients for certain [notifications](./notification.md).
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
### Name
|
||||||
|
|
||||||
|
The name of the notification group.
|
||||||
|
|
||||||
|
### Users
|
||||||
|
|
||||||
|
One or more users directly designated as members of the notification group.
|
||||||
|
|
||||||
|
### Groups
|
||||||
|
|
||||||
|
All users of any selected groups are considered as members of the notification group.
|
15
docs/models/extras/subscription.md
Normal file
15
docs/models/extras/subscription.md
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
# Subscription
|
||||||
|
|
||||||
|
A record indicating that a user is to be notified of any changes to a particular NetBox object. A notification maps exactly one user to exactly one object.
|
||||||
|
|
||||||
|
When an object to which a user is subscribed changes, a [notification](./notification.md) is generated for the user.
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
### User
|
||||||
|
|
||||||
|
The subscribed user.
|
||||||
|
|
||||||
|
### Object
|
||||||
|
|
||||||
|
The object to which the user is subscribed.
|
@ -225,8 +225,11 @@ nav:
|
|||||||
- ExportTemplate: 'models/extras/exporttemplate.md'
|
- ExportTemplate: 'models/extras/exporttemplate.md'
|
||||||
- ImageAttachment: 'models/extras/imageattachment.md'
|
- ImageAttachment: 'models/extras/imageattachment.md'
|
||||||
- JournalEntry: 'models/extras/journalentry.md'
|
- JournalEntry: 'models/extras/journalentry.md'
|
||||||
|
- Notification: 'models/extras/notification.md'
|
||||||
|
- NotificationGroup: 'models/extras/notificationgroup.md'
|
||||||
- SavedFilter: 'models/extras/savedfilter.md'
|
- SavedFilter: 'models/extras/savedfilter.md'
|
||||||
- StagedChange: 'models/extras/stagedchange.md'
|
- StagedChange: 'models/extras/stagedchange.md'
|
||||||
|
- Subscription: 'models/extras/subscription.md'
|
||||||
- Tag: 'models/extras/tag.md'
|
- Tag: 'models/extras/tag.md'
|
||||||
- Webhook: 'models/extras/webhook.md'
|
- Webhook: 'models/extras/webhook.md'
|
||||||
- IPAM:
|
- IPAM:
|
||||||
|
Loading…
Reference in New Issue
Block a user