-
Notifications
You must be signed in to change notification settings - Fork 3
/
swagger.yaml
75 lines (73 loc) · 1.85 KB
/
swagger.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
swagger: '2.0'
info:
title: Web API Skeleton
description: Skeleton for Dropwizard Web APIs
version: '0.0'
license:
name: GNU Affero General Public License Version 3
url: http://www.gnu.org/licenses/agpl-3.0.en.html
externalDocs:
description: GitHub Repository
url: https://github.com/osu-mist/web-api-skeleton
host: localhost
schemes:
- http
basePath: /api/v0
consumes:
- text/plain
produces:
- text/plain
paths:
/:
get:
summary: Get information
description: Build and runtime information about the application.
parameters:
- $ref: '#/parameters/pretty'
responses:
200:
description: Object containing information
schema:
$ref: '#/definitions/Info'
parameters:
pretty:
name: pretty
in: query
type: boolean
required: false
description: If true, JSON response will be pretty-printed
definitions:
Info:
properties:
name:
type: string
description: Name of the API.
time:
type: string
description: Build time in ISO 8601 format.
unixTime:
type: integer
description: Build time as milliseconds since the unix epoch.
commit:
type: string
description: Git commit hash of the revision which was built.
documentation:
type: string
description: Filename of the swagger specification for the API.
Error:
properties:
status:
type: integer
description: HTTP status code.
developerMessage:
type: string
description: An error string aimed at developers.
userMesage:
type: string
description: An error string aimed at end users.
code:
type: integer
description: Error code.
details:
type: string
description: A link to further information about the error.