Home Schema Example JSON Schema

Data Flow Event


This schema describes data events for Jarvis modules.

Provider Sync

Type: object

Provider sync event happens when sync_modules is executed against a module with Provider.

No Additional Properties

Provider Key

Type: string

The unique provider key at time of the event.

Must be at least 1 characters long

Syncer Arguments

Type: object

The value of syncer_kwargs for provider syncing.

Provider CUD

Type: object

Provider CUD event happens when a Provider model is created, updated, or deleted. This is implemented via django signals.

No Additional Properties

Provider Key

Type: string

The unique provider key at time of the event.

Must be at least 1 characters long

Operation

Type: enum (of string)

Whether it is a create, update, or delete.

Must be one of:

  • "create"
  • "update"
  • "delete"

Value

Type: object

The value of the Provider after the event. For delete events, this will be the final value of the provider before deletion.

Module CUD

Type: object

Module CUD event happens when a Module is created, updated, or deleted. This is implemented via django signals.

No Additional Properties

Operation

Type: enum (of string)

Whether it is a create, update, or delete.

Must be one of:

  • "create"
  • "update"
  • "delete"

Value

Type: object

The value of the Module model after the event. For delete events, this will be the final value of the module before deletion.

Elasticsearch Index Ops

Type: object

Elasticsearch Index Ops event happens when a write operation is performed via the elasticsearch_indices management command.

No Additional Properties

Operation

Type: enum (of string)

Whether it is a create, set, prune, or reindex.

Must be one of:

  • "create"
  • "set"
  • "prune"
  • "reindex"

Old Index

Type: string

Name of old index replaced as a result of set operations.

Must be at least 1 characters long

New Index

Type: string

Name of new index created as a result of create, set, and reindex operations.

Must be at least 1 characters long

Source Index

Type: string

Name of source index where we reindex from.

Must be at least 1 characters long

Deleted Indices

Type: array of string

Array of indices deleted in the prune operation

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

Raw Response

Type: object

Raw response from Elasticsearch.