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 Jan 12, 2018
1 parent c29956f commit 200ce15
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions username_api.raml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
#%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
status: statusCode
url: string

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

0 comments on commit 200ce15

Please sign in to comment.