{ "$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" ] }, "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 ] }, "enabled": { "type": "boolean", "description": "A flag that denotes if the repository configuration is connected", "enum": [ true, false ] }, "total": { "type": "integer", "description": "The total number of documents", "minimum": 0, "examples": [ 1, 5, 10, 20, 50 ] }, "type": { "type": "string", "description": "The type of Repository", "enum": [ "gitlab" ] }, "hostname": { "type": "string", "description": "The hostname of the Respository endpoint", "examples": [ "gitlab.com" ] }, "path": { "type": "string", "description": "The path of the Repository endpoint", "examples": [ "itentialopensource/pre-built-automations" ] }, "credentials": { "type": "object", "properties": { "token": { "type": "string", "description": "An access token used to make HTTP requests", "examples": [ "uTc_P4pnMAEsLbQHmyOt" ] } }, "additionalProperties": false }, "config": { "type": "string", "description": "The name of the repository configuration that will be used to fetch Prebuilts", "examples": [ "@itentialopensource" ] }, "objectId": { "type": "string", "pattern": "^[0-9a-f]{24}$", "description": "String representation of a MongoDB ObjectId", "examples": [ "5cb7b531d06cceb89fd21b1c" ] } } }
2023.2 (latest)