From a1d9556f2c3e719d396012c096f69a0f816b6366 Mon Sep 17 00:00:00 2001
From: joshua1b <joshua1b2823@gmail.com>
Date: Fri, 12 Jan 2018 00:30:20 +0900
Subject: [PATCH] Add username_api.raml

This raml file describe api specification for username_api

Closes https://github.com/manu-chroma/username-availability-checker/issues/15
---
 username_api.raml | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 username_api.raml

diff --git a/username_api.raml b/username_api.raml
new file mode 100644
index 0000000..1d86be3
--- /dev/null
+++ b/username_api.raml
@@ -0,0 +1,33 @@
+#%RAML 1.0
+
+title: username-availability API
+version: v1
+protocols: [ HTTPS ]
+baseUri: https://username-availability.herokuapp.com/
+
+types:
+  statusCode:
+    type: number
+    minimum: 100
+    maximum: 599
+    format: int64
+  Check:
+    type: object
+    properties:
+      avatar?: null | string
+      possible: boolean
+      profile?: string
+      status?: statusCode
+      url: string
+      usable: boolean
+
+/check:
+  /{website}:
+    /{username}:
+      get:
+        description: Retrieve json for result of checking username
+        responses:
+          200:
+            body:
+              application/json:
+                type: Check