Create a schema

Creates a new schema. Schemas contains a set of rules and constraints that can be used to validate records. Each schema has a record property which references the type of records that can be validated using the schema. A schema can optionally extend another one by using the `extend` property which references the parent schema by its handle. If a record type has at least one schema, a schema will be mandatory for all records of that type. To specify which schema should be used to validate a record, the `schema` property must be passed when creating or updating a record.

Authorization

AuthorizationRequiredBearer <token>

JWT signed by private key. The presence of this token is not mandatory. It becomes required through the configuration of authorization access rules that requires a token to grant access. Once sent, the token is validated for its format, signature and expiration, regardless of the presence of access rules.

In: header

Request Body

application/jsonRequired

Schema body

hashRequiredstring

Pattern: "^[A-Fa-f0-9]{64}$"

metaRequiredobject

dataRequiredobject & object

Header Parameters

x-ledgerstring | string

The unique identifier of ledger in context for multi tenant requests.

curl -X POST "http://localhost:3000/v2/schemas" \
  -H "x-ledger: bog" \
  -H "Content-Type: application/json" \
  -d '{
    "hash": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
    "meta": {
      "proofs": [
        {
          "method": "ed25519-v2",
          "public": "WAweF9PHlboQoW0z8NqhZXFmzUTaV74NRFAd/aILprE=",
          "digest": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
          "result": "0G2gvSfBx6MwPT8ShBaiYx7zwa5Kqc4Cq3S3NXV1m5/ZPozoH/SUouuhi9sQU+f0yo0eX4ygH7PzE3PAdlxsCQ==",
          "custom": {
            "moment": "2019-01-01T00:00:00.000Z",
            "type": "PERSON",
            "reference": 3284759238475
          }
        }
      ]
    },
    "data": {
      "handle": "tran:12345@pbz.hr",
      "parent": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
      "access": [
        {
          "signer": {
            "format": "ed25519-raw",
            "public": {
              "$eq": "WAweF9PHlboQoW0z8NqhZXFmzUTaV74NRFAd/aILprE="
            },
            "custom": {
              "type": "person",
              "age": {
                "$gte": 21
              }
            },
            "handle": {
              "$in": [
                "admin"
              ]
            }
          },
          "record": "any",
          "action": "any",
          "invoke": "wallet.canSpendAllChangedRouteTargets",
          "bearer": {
            "iss": "company.org",
            "sub": "admin",
            "aud": "ledger",
            "hsh": true,
            "$signer": {
              "format": "ed25519-raw",
              "public": {
                "$eq": "WAweF9PHlboQoW0z8NqhZXFmzUTaV74NRFAd/aILprE="
              },
              "custom": {
                "type": "person",
                "age": {
                  "$gte": 21
                }
              },
              "handle": {
                "$in": [
                  "admin"
                ]
              }
            }
          },
          "filter": {
            "schema": "bank"
          },
          "change": {
            "schema": "p2p"
          }
        }
      ],
      "custom": {
        "type": "PERSON",
        "reference": 3284759238475
      },
      "format": "json-schema",
      "record": "anchor",
      "schema": {},
      "extend": "tran:12345@pbz.hr"
    }
  }'

Created schema

{
  "hash": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
  "meta": {
    "proofs": [
      {
        "method": "ed25519-v2",
        "public": "WAweF9PHlboQoW0z8NqhZXFmzUTaV74NRFAd/aILprE=",
        "digest": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
        "result": "0G2gvSfBx6MwPT8ShBaiYx7zwa5Kqc4Cq3S3NXV1m5/ZPozoH/SUouuhi9sQU+f0yo0eX4ygH7PzE3PAdlxsCQ==",
        "custom": {
          "moment": "2019-01-01T00:00:00.000Z",
          "type": "PERSON",
          "reference": 3284759238475
        }
      }
    ],
    "owners": [
      "WAweF9PHlboQoW0z8NqhZXFmzUTaV74NRFAd/aILprE="
    ],
    "moment": "2019-08-24T14:15:22Z",
    "status": "string",
    "labels": [
      "preferred"
    ]
  },
  "luid": "$wlt.7mSVWFKX-Tfx2NsNj",
  "data": {
    "handle": "tran:12345@pbz.hr",
    "parent": "4969e3c012b66d88cec597bf337fc01eab8d651e6ed2d5c40236cc1f7d93435a",
    "access": [
      {
        "signer": {
          "format": "ed25519-raw",
          "public": {
            "$eq": "WAweF9PHlboQoW0z8NqhZXFmzUTaV74NRFAd/aILprE="
          },
          "custom": {
            "type": "person",
            "age": {
              "$gte": 21
            }
          },
          "handle": {
            "$in": [
              "admin"
            ]
          }
        },
        "record": "any",
        "action": "any",
        "invoke": "wallet.canSpendAllChangedRouteTargets",
        "bearer": {
          "iss": "company.org",
          "sub": "admin",
          "aud": "ledger",
          "hsh": true,
          "$signer": {
            "format": "ed25519-raw",
            "public": {
              "$eq": "WAweF9PHlboQoW0z8NqhZXFmzUTaV74NRFAd/aILprE="
            },
            "custom": {
              "type": "person",
              "age": {
                "$gte": 21
              }
            },
            "handle": {
              "$in": [
                "admin"
              ]
            }
          }
        },
        "filter": {
          "schema": "bank"
        },
        "change": {
          "schema": "p2p"
        }
      }
    ],
    "custom": {
      "type": "PERSON",
      "reference": 3284759238475
    },
    "format": "json-schema",
    "record": "anchor",
    "schema": {},
    "extend": "tran:12345@pbz.hr"
  }
}

Create a schema

Authorization

Request Body

Header Parameters

Response

TypeScript