Skip to content

Commit

Permalink
Update swagger API doc
Browse files Browse the repository at this point in the history
  • Loading branch information
fdechelle committed Oct 18, 2016
1 parent 1f7c66d commit c6bd79c
Showing 1 changed file with 60 additions and 0 deletions.
60 changes: 60 additions & 0 deletions restapi/armadito-rest-api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -159,10 +159,18 @@ paths:
description: success
schema:
$ref: '#/definitions/Token'
headers:
X-Armadito-Api-Version:
description: The version of the API
type: string
default:
description: error
schema:
$ref: '#/definitions/Error'
headers:
X-Armadito-Api-Version:
description: The version of the API
type: string

/unregister:
get:
Expand All @@ -182,10 +190,18 @@ paths:
description: success
schema:
$ref: '#/definitions/Token'
headers:
X-Armadito-Api-Version:
description: The version of the API
type: string
default:
description: error
schema:
$ref: '#/definitions/Error'
headers:
X-Armadito-Api-Version:
description: The version of the API
type: string

/ping:
get:
Expand All @@ -205,10 +221,18 @@ paths:
# Use JSON Schema format
schema:
$ref: '#/definitions/Pong'
headers:
X-Armadito-Api-Version:
description: The version of the API
type: string
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
headers:
X-Armadito-Api-Version:
description: The version of the API
type: string

/event:
get:
Expand All @@ -231,6 +255,10 @@ paths:
description: event received OK
schema:
$ref: '#/definitions/Event'
headers:
X-Armadito-Api-Version:
description: The version of the API
type: string

/scan:
post:
Expand Down Expand Up @@ -264,10 +292,18 @@ paths:
responses:
200:
description: OK
headers:
X-Armadito-Api-Version:
description: The version of the API
type: string
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
headers:
X-Armadito-Api-Version:
description: The version of the API
type: string

/status:
get:
Expand All @@ -289,10 +325,18 @@ paths:
responses:
200:
description: OK
headers:
X-Armadito-Api-Version:
description: The version of the API
type: string
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
headers:
X-Armadito-Api-Version:
description: The version of the API
type: string

/browse:
get:
Expand All @@ -313,10 +357,18 @@ paths:
description: OK
schema:
$ref: '#/definitions/Path'
headers:
X-Armadito-Api-Version:
description: The version of the API
type: string
500:
description: OK
schema:
$ref: '#/definitions/Error'
headers:
X-Armadito-Api-Version:
description: The version of the API
type: string

/version:
get:
Expand All @@ -332,10 +384,18 @@ paths:
description: OK
schema:
$ref: '#/definitions/Version'
headers:
X-Armadito-Api-Version:
description: The version of the API
type: string
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
headers:
X-Armadito-Api-Version:
description: The version of the API
type: string


definitions:
Expand Down

0 comments on commit c6bd79c

Please sign in to comment.