forked from Princeton-CDH/bluemountainsprings
-
Notifications
You must be signed in to change notification settings - Fork 0
/
springs.yaml
69 lines (62 loc) · 1.79 KB
/
springs.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
# Example YAML to get you started quickly.
# Be aware that YAML has indentation based scoping.
# Code completion support is available so start typing for available options.
swagger: '2.0'
# This is your document metadata
info:
version: "0.1.0"
title: Blue Mountain Springs
# Describe your paths here
paths:
# This is a path endpoint. Change it.
/springs:
# This is a HTTP operation
get:
# Describe this verb here. Note: you can use markdown
description: |
The top level of the service. The list of available resources.
# This is array of GET operation parameters:
# Expected responses for this operation:
responses:
# Response code
200:
description: Successful response
# A schema describing your response object.
# Use JSON Schema format
schema:
title: ArrayofResources
type: array
items:
title: Resource
type: object
properties:
name:
type: string
single:
type: boolean
# Magazine spring
/springs/magazines:
get:
description:
The set of magazines
responses:
200:
description: Successful response
schema:
title: ArrayofMagazines
type: array
items:
type: object
properties:
bmtnid:
type: string
primaryTitle:
type: string
primaryLanguage:
type: string
startDate:
type: string
endDate:
type: string
uri:
type: string