Skip to content

Commit

Permalink
[api] refs fibercrypto#4 - Add spec for [GET] /api/isalive
Browse files Browse the repository at this point in the history
  • Loading branch information
mauricio1802 committed Feb 26, 2019
1 parent 99f1732 commit edf6e10
Showing 1 changed file with 28 additions and 1 deletion.
29 changes: 28 additions & 1 deletion mauricio1802_specs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,34 @@ paths:
$ref : '#/components/schemas/genericError'



/api/IsAlive:
get:
summary: Return some general service info
description: Check if the server is running correctly
responses:
'200': #status code
description: A JSON object containing information about the service
content:
application/json:
schema:
type: object

properties:
name:
description: Name of the service
type: string
version:
description: Version of the service
type: string
env:
description: ENV_INFO environment variable value
type: string
isDebug:
description: Flag, wich indicates if the service is built in the debug configuration or not
type: boolean

default:
$ref: '#/components/schemas/genericError'



Expand Down

0 comments on commit edf6e10

Please sign in to comment.