Skip to content

Commit 58bf231

Browse files
committed
Update the samples to use the new operation macro
Closes gh-362
1 parent 4a177de commit 58bf231

File tree

3 files changed

+28
-230
lines changed

3 files changed

+28
-230
lines changed

Diff for: samples/rest-notes-grails/src/docs/asciidoc/index.adoc

+5-31
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Andy Wilkinson; Jenn Strater
66
:toc: left
77
:toclevels: 4
88
:sectlinks:
9+
:operation-curl-request-title: Example request
10+
:operation-http-response-title: Example response
911

1012
[[overview]]
1113
= Overview
@@ -75,17 +77,7 @@ The Notes resources is used to create and list notes
7577

7678
A `GET` request will list all of the service's notes.
7779

78-
==== Response structure
79-
80-
include::{snippets}/notes-list-example/response-fields.adoc[]
81-
82-
==== Example request
83-
84-
include::{snippets}/notes-list-example/curl-request.adoc[]
85-
86-
==== Example response
87-
88-
include::{snippets}/notes-list-example/http-response.adoc[]
80+
operation::notes-list-example[snippets='response-fields,curl-request,http-response']
8981

9082

9183

@@ -94,31 +86,13 @@ include::{snippets}/notes-list-example/http-response.adoc[]
9486

9587
A `POST` request is used to create a note
9688

97-
==== Request structure
98-
99-
include::{snippets}/notes-create-example/request-fields.adoc[]
100-
101-
==== Example request
89+
operation::notes-create-example[snippets='request-fields,curl-request,http-response']
10290

103-
include::{snippets}/notes-create-example/curl-request.adoc[]
10491

105-
==== Example response
106-
107-
include::{snippets}/notes-create-example/http-response.adoc[]
10892

10993
[[resources-note-retrieve]]
11094
=== Retrieve a note
11195

11296
A `GET` request will retrieve the details of a note
11397

114-
==== Response structure
115-
116-
include::{snippets}/note-get-example/response-fields.adoc[]
117-
118-
==== Example request
119-
120-
include::{snippets}/note-get-example/curl-request.adoc[]
121-
122-
==== Example response
123-
124-
include::{snippets}/note-get-example/http-response.adoc[]
98+
operation::note-get-example[snippets='response-fields,curl-request,http-response']

Diff for: samples/rest-notes-spring-data-rest/src/main/asciidoc/api-guide.adoc

+11-101
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Andy Wilkinson;
66
:toc: left
77
:toclevels: 4
88
:sectlinks:
9+
:operation-curl-request-title: Example request
10+
:operation-http-response-title: Example response
911

1012
[[overview]]
1113
= Overview
@@ -97,20 +99,7 @@ The index provides the entry point into the service.
9799

98100
A `GET` request is used to access the index
99101

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']
114103

115104

116105

@@ -126,40 +115,16 @@ The Notes resources is used to create and list notes
126115

127116
A `GET` request will list all of the service's notes.
128117

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']
143119

144-
include::{snippets}/notes-list-example/links.adoc[]
145120

146121

147122
[[resources-notes-create]]
148123
=== Creating a note
149124

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.
161126

162-
include::{snippets}/notes-create-example/http-response.adoc[]
127+
operation::notes-create-example[snippets='request-fields,curl-request,http-response']
163128

164129

165130

@@ -175,22 +140,7 @@ The Tags resource is used to create and list tags.
175140

176141
A `GET` request will list all of the service's tags.
177142

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']
194144

195145

196146

@@ -199,17 +149,7 @@ include::{snippets}/tags-list-example/links.adoc[]
199149

200150
A `POST` request is used to create a note
201151

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']
213153

214154

215155

@@ -232,17 +172,7 @@ include::{snippets}/note-get-example/links.adoc[]
232172

233173
A `GET` request will retrieve the details of a note
234174

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']
246176

247177

248178

@@ -286,17 +216,7 @@ include::{snippets}/tag-get-example/links.adoc[]
286216

287217
A `GET` request will retrieve the details of a tag
288218

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']
300220

301221

302222

@@ -305,14 +225,4 @@ include::{snippets}/tag-get-example/http-response.adoc[]
305225

306226
A `PATCH` request is used to update a tag
307227

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

Comments
 (0)