noterik/insync-json-schema repository overview

⁠insync-json-schema

JSON Schema for validating JSON requests/entities in InSync. Includes a Docker file that hosts the json schema files on port 80 by default.

⁠Entity types

⁠location.schema.json

Defines a location in InSync in the new structure (project > facility > program > category > test > experiment > measurement).

⁠file.base.schema.json

Contains fields that are shared among all file types. This does not validate any actual files, rather it serves to be extended into a specific file type.

⁠file.definitions.json

Contains the different types of file definitions. Contains the following types:

• generic: This is a generic file, so anything that isn't a video basically.
• video: This is a video file.
• all: One of any of the above.

⁠file.schema.json

This validates the final file entity that is written to the database along with a location.

⁠synchronised.schema.json

This validates the synchronisation nodes that are needed for certain file types.

⁠metadata.schema.json

Contains field definitions for location specific metadata fields.

⁠Action types

These actions provide entrypoints validate UPLOAD, UPDATE and DELETE actions. Only UPLOAD and UPDATE implemented for now.

⁠upload.action.schema.json

This validates the json for an UPLOAD action that can be submitted to the InSync ingest.

⁠update.action.schema.json

This validates the json for an UPDATE action that can be submitted to the InSync ingest.

⁠delete.action.schema.json

This validates the json for a DELETE action that can be submitted to the InSync ingest.