-
Notifications
You must be signed in to change notification settings - Fork 2
/
apiary.apib
243 lines (188 loc) · 7.33 KB
/
apiary.apib
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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
FORMAT: 1A
HOST: http://bergcms.local/
# Berg CMS
The Berg CMS uses a simple API allowing consumers to view the stored articles and change them.
## Articles of the Actual Issue [/articles]
### List All Articles [GET /articles]
Returns all the articles of the actual issue.
+ Response 200 (application/json; charset=utf-8)
{
"articles": [
{
"id": 25,
"priority": 100,
"type": "A|F|K|A1|F1|A2|F2|A3|F3",
"chapter": "1:Introduction",
"title": "Title of the article",
"header": "Heading part of the article.",
"body": "The main part of the article.",
"footer": "Buttom part of the article.",
"lastChanged": "yyyymmdd-hhmmss-dd;ip:port;user"
}
]
}
### Get Article [GET /articles/{id}]
Returns a specific article that can be displayed and edited.
+ Parameters
+ id: 25 (number) - the number of the desired article.
+ Response 200 (application/json; charset=utf-8)
{
"id": 25,
"priority": 100,
"type": "F",
"chapter": "1:Introduction",
"title": "Title of the article",
"header": "Heading part of the article.",
"body": "The main part of the article.",
"footer": "Buttom part of the article.",
"lastChanged": "20160715-102748-Fr \/ 127.0.0.1:40142 \/ -"
}
### Create New Article or Copy Article [POST /articles]
Creates an empty article when empty request is used.
Main purpose is to reserve the unique ID for this article.
Creates a new article from an existing one when the Request provides
the id of the article that should be copied.
+ Request (application/json)
+ Response 201 (application/json; charset=utf-8)
{
"id": 26,
"priority": 100,
"type": "A",
"chapter": "",
"title": "",
"header": "",
"body": "",
"footer": "",
"lastChanged": ""
}
+ Request (application/json)
{
"chapter": "Introduction",
"title": "Title of the article"
}
+ Response 201 (application/json; charset=utf-8)
{
"id": 27,
"priority": 100,
"type": "A",
"chapter": "Introduction",
"title": "Title of the article",
"header": "",
"body": "",
"footer": "",
"lastChanged": ""
}
### Change Article [PUT /articles/{id}]
Changes a previously created or retrieved article.
The request has to provide two article structures.
The one that was retrieved from the server and the changed article.
The server will just store the changed information if the article was not changed in the meantime.
The comparison is performed attribute by attribute.
The id must not be changed.
The lastChanged attribute overwrites the existing one, when the information is stored into the database.
Attribute defintion:
- oldArticle: Article retrieved from the server.
- newArticle: This is the changed version of the article that should be stored on the server.
- actualArticle: This is article stored in the database after performing the PUT operation.
- changedArticle: This is the version of the article at the beginning of the PUT operation.
The first response is returned when oldArticle matches the changedArticle.
The seconde response is returned when oldArticle and changedArticle are different.
+ Parameters
+ id: 25 (number) - the number of the edited article.
+ Request (application/json)
{
"oldArticle": {
"id": 25,
"priority": 100,
"type": "F",
"chapter": "1:Introduction",
"title": "Title of the article",
"header": "Heading part of the article.",
"body": "The main part of the article.",
"footer": "Buttom part of the article.",
"lastChanged": "20160715-102748-Fr \/ 127.0.0.1:40142 \/ -"
},
"newArticle": {
"id": 25,
"priority": 100,
"type": "A",
"chapter": "Introduction",
"title": "Changed Title",
"header": "",
"body": "Some text within the article.",
"footer": ""
}
}
+ Response 200
{
"actualArticle": {
"id": 25,
"priority": 100,
"type": "A",
"chapter": "Introduction",
"title": "Changed Title",
"header": "",
"body": "Some text within the article.",
"footer": "",
"lastChanged": "20160715-102748-Fr \/ 127.0.0.1:40142 \/ -"
}
}
+ Response 200
{
"actualArticle": {
"id": 25,
"priority": 200,
"type": "A",
"chapter": "1:Introduction",
"title": "Changed Title",
"header": "",
"body": "Some text within the article.",
"footer": "",
"lastChanged": "20160715-102748-Fr \/ 127.0.0.1:40142 \/ -"
},
"oldArticle": {
"id": 25,
"priority": 100,
"type": "F",
"chapter": "1:Introduction",
"title": "Title of the article",
"header": "Heading part of the article.",
"body": "The main part of the article.",
"footer": "Buttom part of the article.",
"lastChanged": "20160715-082748-Fr \/ 127.0.0.1:40142 \/ -"
},
"newArticle": {
"id": 25,
"priority": 100,
"type": "A",
"chapter": "1:Introduction",
"title": "Changed Title",
"header": "",
"body": "Some text within the article.",
"footer": "",
"lastChanged": "20160715-102748-Fr \/ 127.0.0.1:40142 \/ -"
},
"changedArticle": {
"id": 25,
"priority": 200,
"type": "F",
"chapter": "1:Introduction",
"title": "Title of the article",
"header": "Heading part of the article.",
"body": "The main part of the article.",
"footer": "Buttom part of the article.",
"lastChanged": "20160715-092748-Fr \/ 127.0.0.1:32849 \/ -"
}
}
### Delete Article [DELETE /articles/{id}]
Deletes the given article from the database. It is stored in the backup database for error recovery.
+ Parameters
+ id: 25 (number) - the number of the desired article.
+ Response 200
## Publishing the actual issue [/print]
The actual issue is extracted from the database (.csv) and transpiled to LaTeX.
Then PdfLaTeX is used to typeset the final document and returned as PDF.
### Process and return the actual issue [GET /print/{type}]
+ Parameters
+ type: final (string) - the type is one of final, draft, final w/o images and ebook.
+ Response 200 (application/pdf)