For the complete documentation index, see llms.txt. This page is also available as Markdown.

Schema Preview from Zip

POST /schemas/import/file/preview

Previews the schema from a zip file without importing it into the local database.

Authentication: Bearer token required (Authorization: Bearer <token>)

Permission: Permissions.SCHEMAS_SCHEMA_CREATE


Request

Request Body

The request body must be the raw binary content of a .zip file containing schema files.

Content-Type: application/octet-stream


Response

Success Response

Status: 200 OK

[
  {
    "id": "63e3e5e8a01b3c001234abcd",
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Carbon Offset Schema",
    "entity": "VC",
    "version": "1.0.0",
    "document": {
      "$id": "#CarbonOffset",
      "$schema": "http://json-schema.org/draft-07/schema",
      "type": "object",
      "properties": {}
    }
  }
]

Error Responses

Status
Description

401 Unauthorized

Missing or invalid token

403 Forbidden

Insufficient permissions

422 Unprocessable Entity

File is missing or empty

500 Internal Server Error

Unexpected server failure

Last updated