-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger.yaml
101 lines (101 loc) · 2.93 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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
swagger: "2.0"
info:
description: "Manages simple updates from CouchDB to PouchDB."
version: "0.0.3"
title: "elevator"
contact:
name: "Josh Anderson"
email: "[email protected]"
license:
name: "GPLv3"
url: "https://www.gnu.org/licenses/gpl-3.0.en.html"
basePath: "/version"
schemes:
- "http"
paths:
/version/{group}:
get:
summary: "Returns the `version` document from the specified group."
produces:
- "application/json"
parameters:
- name: "group"
in: "path"
description: "The name of the group."
required: true
type: "string"
responses:
401:
description: "Bad request. Could be missing the group name."
200:
description: "Successfully retrieved the version document."
404:
description: "No database found, or no version document within the database."
/revs/{group}:
get:
summary: "Returns the revision property for specified document ids and all documents related to assessments not archived."
produces:
- "application/json"
consumes:
- "application/json"
parameters:
- name: "group"
in: "path"
description: "The name of the group."
required: true
type: "string"
- name: "ids"
in: "body"
description: "The name of the group."
required: true
schema:
type: "object"
properties:
ids:
type: "array"
items:
type: "string"
responses:
401:
description: "Bad request. Could be missing the group name."
200:
description: "Successfully retrieved revision numbers for requested ids."
schema:
type: "array"
items:
type: "object"
properties:
id:
type: "string"
value:
type: "object"
properties:
rev:
type: "string"
deleted:
type: "boolean"
404:
description: "No database found, or no version document within the database."
/fetch/{group}:
get:
summary: "Returns the requested docouments."
produces:
- "application/json"
parameters:
- name: "group"
in: "path"
description: "The name of the group."
required: true
type: "string"
responses:
401:
description: "Bad request. Could be missing the group name."
200:
description: "Successfully retrieved the requested documents."
schema:
type: "array"
items:
description: "A document representing a part of an assessment, or an update document."
type: "object"
404:
description: "No database found, or no version document within the database."