@@ -6,6 +6,8 @@ Andy Wilkinson;
6
6
:toc: left
7
7
:toclevels: 4
8
8
:sectlinks:
9
+ :operation-curl-request-title: Example request
10
+ :operation-http-response-title: Example response
9
11
10
12
[[overview]]
11
13
= Overview
@@ -97,20 +99,7 @@ The index provides the entry point into the service.
97
99
98
100
A `GET` request is used to access the index
99
101
100
- ==== Response structure
101
-
102
- include::{snippets}/index-example/response-fields.adoc[]
103
-
104
- ==== Example response
105
-
106
- include::{snippets}/index-example/http-response.adoc[]
107
-
108
-
109
-
110
- [[resources-index-links]]
111
- ==== Links
112
-
113
- include::{snippets}/index-example/links.adoc[]
102
+ operation::index-example[snippets='response-fields,http-response,links']
114
103
115
104
116
105
@@ -126,40 +115,16 @@ The Notes resources is used to create and list notes
126
115
127
116
A `GET` request will list all of the service's notes.
128
117
129
- ==== Response structure
130
-
131
- include::{snippets}/notes-list-example/response-fields.adoc[]
132
-
133
- ==== Example request
134
-
135
- include::{snippets}/notes-list-example/curl-request.adoc[]
136
-
137
- ==== Example response
138
-
139
- include::{snippets}/notes-list-example/http-response.adoc[]
140
-
141
- [[resources-notes-list-links]]
142
- ==== Links
118
+ operation::notes-list-example[snippets='response-fields,curl-request,http-response,links']
143
119
144
- include::{snippets}/notes-list-example/links.adoc[]
145
120
146
121
147
122
[[resources-notes-create]]
148
123
=== Creating a note
149
124
150
- A `POST` request is used to create a note
151
-
152
- ==== Request structure
153
-
154
- include::{snippets}/notes-create-example/request-fields.adoc[]
155
-
156
- ==== Example request
157
-
158
- include::{snippets}/notes-create-example/curl-request.adoc[]
159
-
160
- ==== Example response
125
+ A `POST` request is used to create a note.
161
126
162
- include::{snippets}/ notes-create-example/ http-response.adoc[ ]
127
+ operation:: notes-create-example[snippets='request-fields,curl-request, http-response' ]
163
128
164
129
165
130
@@ -175,22 +140,7 @@ The Tags resource is used to create and list tags.
175
140
176
141
A `GET` request will list all of the service's tags.
177
142
178
- ==== Response structure
179
-
180
- include::{snippets}/tags-list-example/response-fields.adoc[]
181
-
182
- ==== Example request
183
-
184
- include::{snippets}/tags-list-example/curl-request.adoc[]
185
-
186
- ==== Example response
187
-
188
- include::{snippets}/tags-list-example/http-response.adoc[]
189
-
190
- [[resources-tags-list-links]]
191
- ==== Links
192
-
193
- include::{snippets}/tags-list-example/links.adoc[]
143
+ operation::tags-list-example[snippets='response-fields,curl-request,http-response,links']
194
144
195
145
196
146
@@ -199,17 +149,7 @@ include::{snippets}/tags-list-example/links.adoc[]
199
149
200
150
A `POST` request is used to create a note
201
151
202
- ==== Request structure
203
-
204
- include::{snippets}/tags-create-example/request-fields.adoc[]
205
-
206
- ==== Example request
207
-
208
- include::{snippets}/tags-create-example/curl-request.adoc[]
209
-
210
- ==== Example response
211
-
212
- include::{snippets}/tags-create-example/http-response.adoc[]
152
+ operation::tags-create-example[snippets='request-fields,curl-request,http-response']
213
153
214
154
215
155
@@ -232,17 +172,7 @@ include::{snippets}/note-get-example/links.adoc[]
232
172
233
173
A `GET` request will retrieve the details of a note
234
174
235
- ==== Response structure
236
-
237
- include::{snippets}/note-get-example/response-fields.adoc[]
238
-
239
- ==== Example request
240
-
241
- include::{snippets}/note-get-example/curl-request.adoc[]
242
-
243
- ==== Example response
244
-
245
- include::{snippets}/note-get-example/http-response.adoc[]
175
+ operation::note-get-example[snippets='response-fields,curl-request-http-response']
246
176
247
177
248
178
@@ -286,17 +216,7 @@ include::{snippets}/tag-get-example/links.adoc[]
286
216
287
217
A `GET` request will retrieve the details of a tag
288
218
289
- ==== Response structure
290
-
291
- include::{snippets}/tag-get-example/response-fields.adoc[]
292
-
293
- ==== Example request
294
-
295
- include::{snippets}/tag-get-example/curl-request.adoc[]
296
-
297
- ==== Example response
298
-
299
- include::{snippets}/tag-get-example/http-response.adoc[]
219
+ operation::tag-get-example[snippets='response-fields,curl-request,http-response']
300
220
301
221
302
222
@@ -305,14 +225,4 @@ include::{snippets}/tag-get-example/http-response.adoc[]
305
225
306
226
A `PATCH` request is used to update a tag
307
227
308
- ==== Request structure
309
-
310
- include::{snippets}/tag-update-example/request-fields.adoc[]
311
-
312
- ==== Example request
313
-
314
- include::{snippets}/tag-update-example/curl-request.adoc[]
315
-
316
- ==== Example response
317
-
318
- include::{snippets}/tag-update-example/http-response.adoc[]
228
+ operation::tag-update-example[snippets='request-fields,curl-request,http-response']
0 commit comments