common-schema

Copied to Clipboard

{ "$schema": "http://json-schema.org/draft-07/schema#", "$id": "common-schema", "type": "object", "title": "Common schema definitions", "definitions": { "status": { "type": "string", "description": "The status of the API request.", "enum": [ "OK", "Created" ] }, "message": { "type": "string", "description": "Message containing either confirmation of the operation or the reason for the failure of the operation.", "examples": [ "A sample success message" ] }, "data": { "description": "The imported template as it exists after being imported.", "oneOf": [ { "$ref": "profiles-schema" }, { "$ref": "services-schema" }, { "$ref": "prebuilts-schema" } ] }, "limit": { "type": "integer", "description": "Number of results to return. Used for pagination.", "default": 25, "minimum": 0, "examples": [ 1, 10, 50 ] }, "skip": { "type": "integer", "description": "Number of results to skip. Used for pagination.", "default": 0, "minimum": 0, "examples": [ 1, 10, 50 ] }, "order": { "type": "integer", "description": "The sort direction: 1 for ascending or -1 for descending.", "default": 1, "enum": [ -1, 1 ] }, "sort": { "type": "string", "description": "Field to sort by. Default is name.", "default": "name", "enum": [ "name" ] }, "isActive": { "type": "boolean", "description": "Is profile the active profile.", "examples": [ true, false ] }, "activeSync": { "type": "boolean", "description": "Is active profile in sync with the system.", "examples": [ true, false ] }, "total": { "type": "integer", "description": "The total number of documents", "minimum": 0, "examples": [ 1, 5, 10, 20, 50 ] } } }