metadata.audit.json Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of audit Show documentation
Lightblue Audit Hook components
The newest version!
{
    "entityInfo": {
        "name": "audit",
        "defaultVersion": "0.2.0-SNAPSHOT",
        "datastore": {
            "backend": "mongo",
            "datasource": "mongo",
            "collection": "audit"
        }
    },
    "schema": {
        "name": "audit",
        "version": {
            "value": "0.2.0-SNAPSHOT",
            "changelog": "Initial version"
        },
        "status": {
            "value": "active"
        },
        "access": {
            "insert": ["anyone"],
            "find": ["anyone"],
            "update": ["anyone"],
            "delete": ["anyone"]
        },
        "fields": {
            "entityName": {
                "type": "string",
                "description": "Name of the entity audited",
                "constraints": {
                    "required": true
                }
            },
            "versionText": {
                "type": "string",
                "description": "Version of entity audited",
                "constraints": {
                    "required": true
                }
            },
            "lastUpdateDate": {
                "type": "date",
                "description": "When the value was changed.",
                "constraints": {
                    "required": true
                }
            },
            "lastUpdatedBy": {
                "type": "string",
                "description": "Who changed the field."
            },
            "identity": {
                "type": "array",
                "description": "The fields that identify the audited document",
                "items": {
                    "type": "object",
                    "fields": {
                        "fieldText": {
                            "type": "string",
                            "description": "The path for this identity field.",
                            "constraints": {
                                "required": true
                            }
                        },
                        "valueText": {
                            "type": "string",
                            "description": "The value for this identity field.",
                            "constraints": {
                                "required": true
                            }
                        }
                    }
                }
            },
            "audits": {
                "type": "array",
                "description": "All data changes for this entity instance",
                "items": {
                    "type": "object",
                    "fields": {
                        "fieldText": {
                            "type": "string",
                            "description": "Path audited.",
                            "constraints": {
                                "required": true
                            }
                        },
                        "oldValue": {
                            "type": "string",
                            "description": "Previous value at the path."
                        },
                        "newValue": {
                            "type": "string",
                            "description": "New value at the path."
                        }
                    }
                }
            }
        }
    }
}