{"_id":"59c32da8190c90003cb0d12d","project":"568bdc1483d2061900d86cdc","version":{"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","__v":19,"createdAt":"2017-08-30T20:39:44.453Z","releaseDate":"2017-08-30T20:39:44.453Z","categories":["59a7236e3fe4d90025117c10","59a72eb6cb0db3001b84cfe2","59a734eb757d030019b85af8","59c0243b1b2d07001a9d2b76","59c035e42126e10028effb12","59c06c40df5b3c0010584a13","59c1a5852cabe5002641a3e7","59c2fb00b2b45c0010b7a3d7","59c32ceb9aea850010ac4130","59c32e6e190c90003cb0d12f","59c33affb2b45c0010b7aa23","59c7dfa457bd8200105444dc","59c7e975c50cf30010d712a0","59cffdef0cd4dd0010294d54","59d0622ca91a810032c8f60c","59d06733c1aec60026253065","59d174d44ac471001a07b123","59d5a5e323e6e800103defb2","59ecf1d8ed507c001c52b255"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"0.0.0","version":"0"},"category":{"_id":"59c32ceb9aea850010ac4130","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-09-21T03:07:23.695Z","from_sync":false,"order":13,"slug":"schemas-api","title":"Schemas API"},"user":"58cc41f21751ce2f003be3b7","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-21T03:10:32.989Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[]},"settings":"59a760e7958d02000f67771f","auth":"optional","params":[{"_id":"59c32da8190c90003cb0d12e","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"schemaName"}],"url":"/:schemaName"},"isReference":false,"order":1,"body":"Get a schema by its file name.\n\nThe structures of JSON schemas themselves are highly variable, and aside from a requirement to include the standard JSON Schema address, they can contain any valid JSON required.\n\n# Parameters\n\n## path\n\n- schemaName (required): The file name of a JSON schema.\n\n# Responses\n\n## 200\n\n```\n{\n    \"schema\": \"JSON-SCHEMA-ADDRESS\"\n}\n```\n\n## 400\n\n- __No Query String Allowed:__ The standard error structure defines this error as invalid parameters, with additional parameters in the query string. In this context, it means that no query string is allowed at all when calling this endpoint.\n\n## 404\n\n- __Schema Not Found:__ This error means that a schema with the given file name was not found. The file does not need its full path attached, but any file name extension should be included.\n\n# Examples\n\n## HTTP\n\n```\nGET https://ioe.droplit.io/api/schemas/SCHEMA-NAME HTTP/1.1\n```\n\n## Droplit Console\n\n```\ndroplit schema read SCHEMA-NAME\n```","excerpt":"","slug":"schemas-info","type":"endpoint","title":"Get a schema by its file name."}

getGet a schema by its file name.


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

schemaName:
required
string

Documentation

Get a schema by its file name. The structures of JSON schemas themselves are highly variable, and aside from a requirement to include the standard JSON Schema address, they can contain any valid JSON required. # Parameters ## path - schemaName (required): The file name of a JSON schema. # Responses ## 200 ``` { "schema": "JSON-SCHEMA-ADDRESS" } ``` ## 400 - __No Query String Allowed:__ The standard error structure defines this error as invalid parameters, with additional parameters in the query string. In this context, it means that no query string is allowed at all when calling this endpoint. ## 404 - __Schema Not Found:__ This error means that a schema with the given file name was not found. The file does not need its full path attached, but any file name extension should be included. # Examples ## HTTP ``` GET https://ioe.droplit.io/api/schemas/SCHEMA-NAME HTTP/1.1 ``` ## Droplit Console ``` droplit schema read SCHEMA-NAME ```

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 }}