aboutsummaryrefslogtreecommitdiff
path: root/doc/schema/1.0/get_token.json
diff options
context:
space:
mode:
authorMilo Casagrande <milo.casagrande@linaro.org>2015-05-13 10:30:25 +0200
committerMilo Casagrande <milo.casagrande@linaro.org>2015-05-13 10:30:25 +0200
commit80a8bd071fac122b9c41f1a2487a1c52156c1ce2 (patch)
tree5794a200f1cf17b74e5f4de40d974eab2014b986 /doc/schema/1.0/get_token.json
parenta7fe94335ef0422633eab06d426d760f9b1eb26d (diff)
Rename schema files and fix references.
* Rename the schema file names or some of them will be served by the API backend resulting in 404 errors.
Diffstat (limited to 'doc/schema/1.0/get_token.json')
-rw-r--r--doc/schema/1.0/get_token.json66
1 files changed, 66 insertions, 0 deletions
diff --git a/doc/schema/1.0/get_token.json b/doc/schema/1.0/get_token.json
new file mode 100644
index 0000000..5e5bc00
--- /dev/null
+++ b/doc/schema/1.0/get_token.json
@@ -0,0 +1,66 @@
+{
+ "$schema": "http://api.kernelci.org/json-schema/1.0/get_token.json",
+ "id": "http://api.kernelci.org/json-schema/1.0/get_token.json",
+ "title": "token",
+ "description": "A token used to interact with the API",
+ "type": "object",
+ "properties": {
+ "version": {
+ "type": "string",
+ "description": "The version number of this JSON schema",
+ "enum": ["1.0"]
+ },
+ "_id": {
+ "type": "string",
+ "description": "The ID associated with this object"
+ },
+ "name": {
+ "type": "string",
+ "description": "The name associated with this token"
+ },
+ "created_on": {
+ "type": "object",
+ "description": "Creation date of the object",
+ "properties": {
+ "$date": {
+ "type": "number",
+ "description": "Milliseconds from epoch time"
+ }
+ }
+ },
+ "token": {
+ "type": "string",
+ "description": "The token that will be used to interact with the API"
+ },
+ "expires_on": {
+ "type": "object",
+ "description": "The date when the token is supposed to expire",
+ "properties": {
+ "$date": {
+ "type": "number",
+ "description": "Milliseconds from epoch time"
+ }
+ }
+ },
+ "expired": {
+ "type": "boolean",
+ "description": "If the token has expired"
+ },
+ "username": {
+ "type": "string",
+ "description": "The user name associated with the token"
+ },
+ "email": {
+ "type": "string",
+ "description": "The email address associated with the token"
+ },
+ "ip_address": {
+ "type": "array",
+ "description": "List of IP addresses the token is restricted to"
+ },
+ "properties": {
+ "type": "array",
+ "description": "An array of length 16 of integer values; each value defines a properties of the token"
+ }
+ }
+}