commonProperties

Copied to Clipboard

{ "$schema": "http://json-schema.org/draft-07/schema#", "$id": "commonProperties", "type": "object", "title": "Artifact common schema definitions", "definitions": { "id": { "type": "string", "examples": [ "5e5ea3bd16da51d52b4a8f9f" ] }, "name": { "type": "string", "examples": [ "artifact-wizard", "device-connection-health-check" ] }, "version": { "type": "string", "examples": [ "0.0.1", "0.1.0", "1.0.0", "1.1.1-2020.1.0" ] }, "description": { "type": "string", "examples": [ "Description about the functionality of an artifact" ] }, "author": { "type": "string", "examples": [ "Itential Artifacts" ] }, "license": { "type": "string", "examples": [ "Apache-2.0" ] }, "repository": { "type": "object", "properties": { "type": { "type": "string", "examples": [ "git" ] }, "url": { "type": "string", "examples": [ "https://gitlab.com:itentialopensource/pre-built-automations/content-workflow.git" ] } }, "required": [ "type", "url" ], "additionalProperties": false }, "keywords": { "type": "array", "items": { "type": "string", "examples": [ "Itential" ] } }, "IAPDependencies": { "type": "object" }, "gitlabId": { "type": "integer", "examples": [ 17866482 ] }, "readme": { "type": "string", "examples": [ "example of readme" ], "pattern": "^([\\S\\s]*)$" }, "success": { "type": "boolean", "description": "Status flag denoting the success (true) or failure (false) of the template's import operation.", "examples": [ "true" ] }, "message": { "type": "string", "description": "Message containing either confirmation of the import operation or the reason for the failure of the import operation." }, "created": { "description": "The imported template as it exists after being imported.", "oneOf": [ { "$ref": "artifact-schema" }, { "$ref": "profiles-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 ] } } }