prebuilts-document-schema

Copied to Clipboard

{ "$schema": "http://json-schema.org/draft-07/schema#", "$id": "prebuilts-document-schema", "type": "object", "title": "Artifact Database Document Schema", "properties": { "_id": { "type": "string", "examples": [ "5f46b038de73aa2264d5abab" ] }, "name": { "type": "string", "examples": [ "@itentialopensource/aggregate-functions-for-arrays", "@itentialopensource/cisco-nx-upgrade" ] }, "version": { "type": "string", "examples": [ "0.0.1", "0.1.0", "1.0.0", "1.1.1-2020.1.0" ] }, "description": { "type": "string", "examples": [ "A basic description" ] }, "author": { "$id": "#/properties/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 ] }, "components": { "$id": "#/properties/components", "type": "array", "items": { "$id": "#/properties/components/items", "type": "object", "required": [ "type", "name" ], "properties": { "type": { "$id": "#/properties/components/items/properties/type", "type": "string", "examples": [ "workflows, forms" ] }, "id": { "type": "string", "description": "The MongoDB id of the component", "examples": [ "5e5ea3bd16da51d52b4a8f9f" ] }, "name": { "type": "string", "examples": [ "artifact-wizard", "device-connection-health-check" ] } } } }, "readme": { "type": "string", "examples": [ "A readme uses markdown text." ] } }, "required": [ "name", "version", "description", "author", "license", "repository", "keywords", "IAPDependencies", "components", "readme" ], "additionalProperties": false }