JSON schema change

This event occurs whenever a JSON schema is added, updated, or removed.
More information: Understanding data events

Type: object
Domain: dataplatform
Event: json_schema_change
Version: 1

change_type required

Title: Change type identifier
Type: string
Must be one of the following:
INSERT
MODIFY
REMOVE

schema_domain required

Title: Event domain of the JSON schema
Type: string
Example:
authorization
dataplatform
transaction

schema_event_type required

Title: Event type of the JSON schema
Type: string
Example:
authorization-event
json_schema_change
creation

schema_name required

Title: Complete name of the JSON schema
Type: string
Example:
authorization/authorization-event-1
dataplatform/json_schema_change-1
transaction/creation-1

schema_version required

Title: Event schema version of the JSON schema
Type: string
Example:
1
2

new_schema

Title: New JSON Schema (after MODIFY or INSERT operation)
Type: string
Example:
{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"Example JSON Schema","description":"Example new description","required":["some_field"],"properties":{"some_field":{"type":"string","title":"Some field title"}}}

old_schema

Title: Previous JSON Schema (before MODIFY or REMOVE operation)
Type: string
Example:
{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","title":"Example JSON Schema","description":"Example old description","required":["some_field"],"properties":{"some_field":{"type":"string","title":"Some field title"}}}

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "JSON schema change",
    "description": "This event occurs whenever a JSON schema is added, updated, or removed. \n More information: <a href='https://developers.pismo.io/pismo-docs/docs/event-data' target='_blank'>Understanding data events</a>",
    "required": [
        "change_type",
        "schema_domain",
        "schema_event_type",
        "schema_name",
        "schema_version"
    ],
    "properties": {
        "change_type": {
            "type": "string",
            "title": "Change type identifier",
            "enum": [
                "INSERT",
                "MODIFY",
                "REMOVE"
            ]
        },
        "schema_domain": {
            "type": "string",
            "title": "Event domain of the JSON schema",
            "examples": [
                "authorization",
                "dataplatform",
                "transaction"
            ]
        },
        "schema_event_type": {
            "type": "string",
            "title": "Event type of the JSON schema",
            "examples": [
                "authorization-event",
                "json_schema_change",
                "creation"
            ]
        },
        "schema_name": {
            "type": "string",
            "title": "Complete name of the JSON schema",
            "examples": [
                "authorization/authorization-event-1",
                "dataplatform/json_schema_change-1",
                "transaction/creation-1"
            ]
        },
        "schema_version": {
            "type": "string",
            "title": "Event schema version of the JSON schema",
            "examples": [
                "1",
                "2"
            ]
        },
        "new_schema": {
            "type": "string",
            "title": "New JSON Schema (after MODIFY or INSERT operation)",
            "examples": [
                "{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"type\":\"object\",\"title\":\"Example JSON Schema\",\"description\":\"Example new description\",\"required\":[\"some_field\"],\"properties\":{\"some_field\":{\"type\":\"string\",\"title\":\"Some field title\"}}}"
            ]
        },
        "old_schema": {
            "type": "string",
            "title": "Previous JSON Schema (before MODIFY or REMOVE operation)",
            "examples": [
                "{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"type\":\"object\",\"title\":\"Example JSON Schema\",\"description\":\"Example old description\",\"required\":[\"some_field\"],\"properties\":{\"some_field\":{\"type\":\"string\",\"title\":\"Some field title\"}}}"
            ]
        }
    }
}

{
    "change_type": "INSERT",
    "schema_domain": "authorization",
    "schema_event_type": "authorization-event",
    "schema_name": "authorization/authorization-event-1",
    "schema_version": "1",
    "new_schema": "{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"type\":\"object\",\"title\":\"Example JSON Schema\",\"description\":\"Example new description\",\"required\":[\"some_field\"],\"properties\":{\"some_field\":{\"type\":\"string\",\"title\":\"Some field title\"}}}",
    "old_schema": "{\"$schema\":\"http://json-schema.org/draft-07/schema#\",\"type\":\"object\",\"title\":\"Example JSON Schema\",\"description\":\"Example old description\",\"required\":[\"some_field\"],\"properties\":{\"some_field\":{\"type\":\"string\",\"title\":\"Some field title\"}}}"
}

Updated 21 days ago