Skip to content

Commit

Permalink
Add username_api.raml
Browse files Browse the repository at this point in the history
This raml file describe api specification for username_api

Closes manu-chroma#15
  • Loading branch information
seeeturtle committed Mar 18, 2018
1 parent 17a4f7d commit 1fa8c37
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions username_api.raml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
#%RAML 1.0

title: username-availability API
version: v1
protocols: [ HTTPS ]
baseUri: https://username-availability.herokuapp.com

types:
Check:
type: object
properties:
avatar?: null | string
possible: boolean
profile?: string
status?: number
url: string
usable: boolean

/check:
/{website}:
uriParameters:
website:
type: string
required: true
/{username}:
uriParameters:
username:
type: string
required: true
get:
description: Retrieve json for result of checking username
responses:
200:
body:
application/json:
type: Check

0 comments on commit 1fa8c37

Please sign in to comment.