multipaz-records-server/org.multipaz.records.request/identitySchema

identitySchema

suspend fun identitySchema(call: ApplicationCall)

Handles schema GET request.

Returns field names, descriptions, and types for core data and records that are supported by this system-of-record server.

Response:

{ "schema": [
    {
      "identifier": <record type name>,  // or "core" for core data
      "display_name": <record type description>,
      "type": {  // "type" also can be one of the primitive types
        "type": "complex",
        "attributes": [
          {
            "identifier": <field name>,
            "display_name": <field description>,
            "type": "string"  // can also be "date", "number", "boolean", "blob", or "picture"
                 // also "type" can be an object describing a "complex" type using "attributes",
                 // or an "options" type, using "options" map (option ids -> labels)
                 // complex types can be described in the top-level types array and used by name
          },
          ...
        ]
      }
    },
    ...
  ],
  "types": {
    "typeName1": {  ... }  // named complex types
  }
}