{"_id":"582789acbe5c080f00a5a857","__v":0,"parentDoc":null,"project":"568bdc1483d2061900d86cdc","user":"573b7f42fdc9d320001b777d","version":{"_id":"582789aabe5c080f00a5a7fe","__v":10,"project":"568bdc1483d2061900d86cdc","createdAt":"2016-11-12T21:29:14.915Z","releaseDate":"2016-11-12T21:29:14.915Z","categories":["582789abbe5c080f00a5a7ff","582789abbe5c080f00a5a800","582789abbe5c080f00a5a801","582789abbe5c080f00a5a802","582789abbe5c080f00a5a803","582789abbe5c080f00a5a804","582789abbe5c080f00a5a805","582789abbe5c080f00a5a806","582789abbe5c080f00a5a807","582789abbe5c080f00a5a808","5827ea984ca29e0f00137a9e","583df597887db62f00644283","583df5d9c622791900e78da5","5845cd8763c11b250037967d","5845d13063c11b2500379681","5859e859e3306d1900126725","587aeb9a01cf3a0f008359eb","587c422af45e2d0f005e200d","587d84dc82f6f30f004ceee5"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"beta2","version_clean":"0.0.0","version":"0"},"category":{"_id":"582789abbe5c080f00a5a808","version":"582789aabe5c080f00a5a7fe","__v":0,"project":"568bdc1483d2061900d86cdc","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-05-17T20:31:57.558Z","from_sync":false,"order":12,"slug":"schemas","title":"Schemas"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-18T22:22:58.985Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"code":"{\n  \"title\": \"JSON schema for service class JSON files\",\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"object\",\n  \"definitions\": {\n    \"event\": {\n      \"type\": \"object\",\n      \"additionalProperties\": false,\n      \"properties\": {\n        \"description\": {\n          \"type\": \"string\",\n          \"description\": \"A description of the event\"\n        }\n      },\n      \"required\": [\"description\"]\n    },\n    \"method\": {\n      \"type\": \"object\",\n      \"additionalProperties\": false,\n      \"properties\": {\n        \"description\": {\n          \"type\": \"string\",\n          \"description\": \"A description of the method\"\n        }\n      },\n      \"required\": [\"description\"]\n    },\n    \"property\": {\n      \"type\": \"object\",\n      \"additionalProperties\": false,\n      \"dependencies\": {\n        \"value-max\": [\"value-min\"],\n        \"value-min\": [\"value-max\"]\n      },\n      \"properties\": {\n        \"access\": {\n          \"type\": \"string\",\n          \"description\": \"How this property is accessed\",\n          \"enum\": [\"static\", \"read\"]\n        },\n        \"description\": {\n          \"type\": \"string\",\n          \"description\": \"A description of the property\"\n        },\n        \"preset-break\": {\n          \"type\": \"string\",\n          \"description\": \"\"\n        },\n        \"preset-exclude\": {\n          \"type\": \"boolean\",\n          \"description\": \"\"\n        },\n        \"preset-include\": {\n          \"type\": \"boolean\",\n          \"description\": \"\"\n        },\n        \"preset-override\": {\n          \"type\": \"string\",\n          \"description\": \"\"\n        },\n        \"value-max\": {\n          \"type\": [\"number\", \"string\"],\n          \"description\": \"The maximum value the property may be set to\",\n          \"pattern\": \"^(0x)?[0-9a-fA-F]+$\"\n        },\n        \"value-min\": {\n          \"type\": [\"number\", \"string\"],\n          \"description\": \"The minimum value the property may be set to\",\n          \"pattern\": \"^(0x)?[0-9a-fA-F]+$\"\n        },\n        \"value-type\": {\n          \"type\": \"string\",\n          \"description\": \"The type of value for this property\",\n          \"enum\": [\"string\", \"uri\"]\n        },\n        \"values\": {\n          \"type\": \"array\",\n          \"description\": \"An enumeration of allowable values\"\n        }\n      }\n    }\n  },\n  \"additionalProperties\":false,\n  \"properties\": {\n    \"events\": {\n      \"type\": \"object\",\n      \"additionalProperties\": { \"$ref\": \"#/definitions/event\" },\n      \"description\": \"The events of the service class\"\n    },\n    \"important\": {\n      \"type\": \"boolean\",\n      \"description\": \"\"\n    },\n    \"name\": {\n      \"type\": \"string\",\n      \"description\": \"The name of the Service Class\"\n    },\n    \"methods\": {\n      \"type\": \"object\",\n      \"additionalProperties\": { \"$ref\":\"#/definitions/method\" },\n      \"description\": \"The methods of the service class\"\n    },\n    \"properties\": {\n      \"type\": \"object\",\n      \"additionalProperties\": { \"$ref\": \"#/definitions/property\" },\n      \"description\": \"The properties of the service class\"\n    }\n  },\n  \"required\": [\"name\"]\n}","name":"","status":200,"language":"json"},{"language":"text","code":"","name":"","status":404}]},"settings":"572c39957c8eff0e00aaa18b","examples":{"codes":[{"language":"http","code":"GET https://ioe.droplit.io/api/schemas/service.json HTTP/1.1"}]},"method":"get","auth":"optional","params":[{"_id":"573ceb42a5de210e00875cfb","ref":"","in":"path","required":false,"desc":"name of the schema file","default":"","type":"string","name":"schemaName"}],"url":"/schemas/:schemaName"},"isReference":true,"order":1,"body":"","excerpt":"Get schema definition","slug":"read-schemas","type":"endpoint","title":"Read"}

getRead

Get schema definition

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

schemaName:
string
name of the schema file

Examples


Result Format


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}