SAMJournal

class smarter.lib.journal.models.SAMJournal(*args, **kwargs)[source]

Bases: Model

Model representing a journal entry for changes made to the SAM database.

This model is used to maintain a comprehensive log of all modifications performed on the SAM database, whether those changes are initiated via the API (api/v1) or through CLI manifests. Each journal entry records the details of the operation, including the user responsible, the type of entity affected, the command executed, the request and response payloads, and the resulting status code.

Examples

Creating a new journal entry:

entry = SAMJournal(
    user=request.user,
    thing=SmarterJournalThings.CHAT.value,
    command=SmarterJournalCliCommands.CREATE.value,
    request={"data": "example"},
    response={"result": "success"},
    status_code=201
)
entry.save()