{ "$id": "formDocument", "title": "form document", "description": "A form document", "type": "object", "properties": { "_id": { "type": "string", "pattern": "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" }, "name": { "$ref": "#/definitions/formName" }, "groups": { "$ref": "#/definitions/groups" }, "created": { "type": "string", "format": "date-time" }, "created_by": { "$ref": "#/definitions/user" }, "last_updated": { "type": "string", "format": "date-time" }, "last_updated_by": { "$ref": "#/definitions/user" }, "elements": { "$ref": "#/definitions/elements" }, "children": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/field" } } }, "required": [ "name", "children", "elements" ], "definitions": { "formName": { "type": "string", "examples": [ "Form 123" ] }, "ObjectId": { "type": "string", "pattern": "^[0-9a-f]{24}$" }, "uuidv4": { "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "groups": { "type": "array", "items": { "$ref": "#/definitions/ObjectId" } }, "user": { "$ref": "#/definitions/ObjectId" }, "elements": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "examples": [ "service_model" ] }, "id": { "type": "object", "properties": { "name": { "type": "string", "examples": [ "/ncs:services/test_devices:service_name" ] } }, "required": [ "name" ] } }, "required": [ "type", "id" ] }, "examples": [ [ { "type": "method", "id": { "name": "method_name_1" } } ] ] }, "field": { "type": "object", "required": [ "properties", "id", "type" ], "properties": { "id": { "type": "string", "oneOf": [ { "pattern": "^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" }, { "pattern": "cont-." } ] }, "element": { "type": "string", "examples": [ "{\"type\":\"service_model\",\"id\":{\"name\":\"/ncs:services/devices:stringified_json\"}" ] }, "type": { "type": "string", "examples": [ "container" ] }, "name": { "type": "string", "examples": [ "vlan_id_123" ] }, "display_name": { "type": "string", "examples": [ "vlan" ] }, "source_type": { "type": "string", "enum": [ "service_model", "custom", "method" ] }, "source": { "type": "string", "examples": [ "/ncs:services/abc_devices:ios.device" ] }, "key": { "type": "string", "examples": [ "service.vlanid", "key_545385c3-fc66-491b-bf6f-abc2214366dc" ] }, "properties": { "type": "object", "properties": { "type": { "type": "string", "examples": [ "leafref" ] }, "path": { "type": "string", "examples": [ "/ncs:devices/ncs:device/ncs:name" ] }, "min": { "anyOf": [ { "type": "string", "examples": [ "1" ] }, { "type": "integer", "examples": [ 1 ] }, { "type": "null" } ] }, "max": { "anyOf": [ { "type": "string", "examples": [ "4" ] }, { "type": "integer", "examples": [ 1 ] }, { "type": "null" } ] }, "minLength": { "anyOf": [ { "type": "string", "examples": [ "1" ] }, { "type": "integer", "examples": [ 1 ] }, { "type": "null" } ] }, "maxLength": { "anyOf": [ { "type": "string", "examples": [ "4" ] }, { "type": "integer", "examples": [ 1 ] }, { "type": "null" } ] }, "default": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "direction": { "type": "string", "examples": [ "vertical" ] }, "required": { "type": "boolean" }, "enforce": { "type": "boolean" }, "hidden": { "type": "boolean" } } } }, "examples": [ { "type": "field", "name": "ipaddress", "properties": { "type": "string", "prefix": "" }, "description": "IP address", "element": "{\"type\":\"method\",\"id\":{\"name\":\"method_name_1\"}}", "source_type": "method", "source": "method_name_1", "id": "a40044c2-f378-4b2b-a81a-41d78979e583", "yangkey": "", "key": "method_name_1.ipAddress" } ] } } }
2023.1 (latest)