angus-sdoc 0.0.4 → 0.0.5
Sign up to get free protection for your applications and to get access to all the features.
|
@@ -3,7 +3,7 @@ module Angus
|
|
|
3
3
|
class Definitions::Service
|
|
4
4
|
|
|
5
5
|
# @!attribute [rw] name
|
|
6
|
-
# @return [String] the name of the
|
|
6
|
+
# @return [String] the name of the service.
|
|
7
7
|
attr_accessor :name
|
|
8
8
|
|
|
9
9
|
# @!attribute [rw] code_name
|
|
@@ -12,7 +12,7 @@ module Angus
|
|
|
12
12
|
attr_accessor :code_name
|
|
13
13
|
|
|
14
14
|
# @!attribute [rw] version
|
|
15
|
-
# @return [String] the version of the
|
|
15
|
+
# @return [String] the version of the service.
|
|
16
16
|
attr_accessor :version
|
|
17
17
|
|
|
18
18
|
# @!attribute [rw] messages
|
|
@@ -4,38 +4,51 @@ module Angus
|
|
|
4
4
|
module SDoc
|
|
5
5
|
class HtmlFormatter
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
7
|
+
ENGLISH_LANG = 'en'
|
|
8
|
+
|
|
9
|
+
# Generates the html for the service definition.
|
|
10
|
+
#
|
|
11
|
+
# @param [Angus::SDoc::Definitions::Service] service_definition the service definition.
|
|
12
|
+
# @param [String] language The language to user for the documentation, defaults to english
|
|
13
|
+
#
|
|
14
|
+
# @return [String] the generated html.
|
|
15
|
+
def self.format_service(service_definition, language = nil)
|
|
16
|
+
@service = service_definition
|
|
17
|
+
@language = language || ENGLISH_LANG
|
|
18
|
+
|
|
19
|
+
erb(:doc, @language)
|
|
20
|
+
end
|
|
16
21
|
|
|
17
|
-
|
|
18
|
-
|
|
22
|
+
def self.erb(template, language = nil)
|
|
23
|
+
template_name = if language
|
|
24
|
+
"#{template}.#{language}.erb"
|
|
25
|
+
else
|
|
26
|
+
"#{template}.erb"
|
|
27
|
+
end
|
|
19
28
|
|
|
20
|
-
|
|
29
|
+
template = File.open(File.join(templates_path, template_name)).read
|
|
30
|
+
ERB.new(template).result(binding)
|
|
31
|
+
end
|
|
32
|
+
private_class_method :erb
|
|
21
33
|
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
34
|
+
def self.operation_path(operation)
|
|
35
|
+
"/#{@service.code_name}/api/#{@service.version}#{operation.path}"
|
|
36
|
+
end
|
|
37
|
+
private_class_method :operation_path
|
|
26
38
|
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
end
|
|
39
|
+
def self.h_type(type, service)
|
|
40
|
+
if service.representations_hash.include?(type)
|
|
41
|
+
"<a href='#representation-#{service.representations_hash[type].name}'>#{type}</a>"
|
|
42
|
+
else
|
|
43
|
+
type
|
|
33
44
|
end
|
|
45
|
+
end
|
|
46
|
+
private_class_method :h_type
|
|
34
47
|
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
end
|
|
48
|
+
def self.templates_path
|
|
49
|
+
File.join(File.dirname(__FILE__), 'templates')
|
|
38
50
|
end
|
|
51
|
+
private_class_method :templates_path
|
|
39
52
|
|
|
40
53
|
end
|
|
41
54
|
end
|
|
@@ -1,30 +1,34 @@
|
|
|
1
1
|
<%
|
|
2
2
|
glossary_terms_hash = @service.glossary.terms_hash
|
|
3
|
+
title = "#{@service.name} service API documentation"
|
|
3
4
|
%>
|
|
4
5
|
|
|
5
6
|
<html>
|
|
6
7
|
<head>
|
|
7
|
-
<title
|
|
8
|
+
<title><%= title %></title>
|
|
8
9
|
|
|
9
|
-
<style type=
|
|
10
|
+
<style type='text/css' media='screen'>
|
|
10
11
|
<%= erb :styles %>
|
|
11
12
|
</style>
|
|
12
13
|
</head>
|
|
13
14
|
<body>
|
|
14
|
-
<div class=
|
|
15
|
-
<h1
|
|
16
|
-
<h4>
|
|
15
|
+
<div class='content'>
|
|
16
|
+
<h1><%= title %></h1>
|
|
17
|
+
<h4>Code name</h4>
|
|
17
18
|
<p><%= @service.code_name %></p>
|
|
18
19
|
|
|
19
|
-
<
|
|
20
|
+
<h4>Version</h4>
|
|
21
|
+
<p><%= @service.version %></p>
|
|
22
|
+
|
|
23
|
+
<h3>Operations</h3>
|
|
20
24
|
<p>
|
|
21
|
-
|
|
25
|
+
Here are the available API operations.
|
|
22
26
|
</p>
|
|
23
27
|
|
|
24
28
|
<table>
|
|
25
29
|
<thead>
|
|
26
30
|
<tr>
|
|
27
|
-
<td
|
|
31
|
+
<td>Operations Index</td>
|
|
28
32
|
</tr>
|
|
29
33
|
</thead>
|
|
30
34
|
<tbody>
|
|
@@ -32,7 +36,7 @@
|
|
|
32
36
|
<% operations.each do |operation| %>
|
|
33
37
|
<tr>
|
|
34
38
|
<td>
|
|
35
|
-
<a href=
|
|
39
|
+
<a href='#operation-<%= controller_name %>-<%= operation.code_name %>'>
|
|
36
40
|
<%= controller_name %>#<%= operation.code_name %>
|
|
37
41
|
</a>
|
|
38
42
|
</td>
|
|
@@ -46,12 +50,12 @@
|
|
|
46
50
|
<p></p>
|
|
47
51
|
<table>
|
|
48
52
|
<thead>
|
|
49
|
-
<tr><td
|
|
53
|
+
<tr><td>Proxy Operations Index</td></tr>
|
|
50
54
|
</thead>
|
|
51
55
|
<tbody>
|
|
52
56
|
<% @service.proxy_operations.each do |operation| %>
|
|
53
57
|
<tr><td>
|
|
54
|
-
<a href=
|
|
58
|
+
<a href='#proxy-operation-<%= operation.code_name %>'>
|
|
55
59
|
<%= operation.code_name %>
|
|
56
60
|
</a>
|
|
57
61
|
</td></tr>
|
|
@@ -62,41 +66,38 @@
|
|
|
62
66
|
|
|
63
67
|
<% @service.operations.each do |(controller_name, operations)| %>
|
|
64
68
|
<% operations.each do |operation| %>
|
|
65
|
-
<div class=
|
|
69
|
+
<div class='operation' id='operation-<%= controller_name %>-<%= operation.code_name %>'>
|
|
66
70
|
<h4>
|
|
67
71
|
<%= operation.name %>
|
|
68
72
|
</h4>
|
|
69
73
|
|
|
70
|
-
<h5>
|
|
74
|
+
<h5>Description</h5>
|
|
71
75
|
<p><%= operation.description %></p>
|
|
72
76
|
|
|
73
|
-
<
|
|
74
|
-
<p>Presente desde versión inicial</p>
|
|
75
|
-
|
|
76
|
-
<table class="vertical-header split">
|
|
77
|
+
<table class='vertical-header split'>
|
|
77
78
|
<tbody>
|
|
78
79
|
<tr>
|
|
79
|
-
<td>
|
|
80
|
+
<td>HTTP Method</td>
|
|
80
81
|
<td><%= operation.http_method %></td>
|
|
81
82
|
</tr>
|
|
82
83
|
<tr>
|
|
83
84
|
<td>URI</td>
|
|
84
|
-
<td><%= operation
|
|
85
|
+
<td><%= operation_path(operation) %></td>
|
|
85
86
|
</tr>
|
|
86
87
|
<tr>
|
|
87
|
-
<td>
|
|
88
|
+
<td>Code name</td>
|
|
88
89
|
<td><%= operation.code_name %></td>
|
|
89
90
|
</tr>
|
|
90
91
|
</tbody>
|
|
91
92
|
</table>
|
|
92
93
|
|
|
93
|
-
<%
|
|
94
|
-
<h5>
|
|
94
|
+
<% unless operation.uri_elements.empty? %>
|
|
95
|
+
<h5>URI Params</h5>
|
|
95
96
|
<table>
|
|
96
97
|
<thead>
|
|
97
98
|
<tr>
|
|
98
|
-
<td>
|
|
99
|
-
<td>
|
|
99
|
+
<td>Parameter</td>
|
|
100
|
+
<td>Description</td>
|
|
100
101
|
</tr>
|
|
101
102
|
</thead>
|
|
102
103
|
<tbody>
|
|
@@ -114,13 +115,13 @@
|
|
|
114
115
|
|
|
115
116
|
|
|
116
117
|
<% if !operation.request_elements.empty? %>
|
|
117
|
-
<h5>
|
|
118
|
+
<h5>Request params</h5>
|
|
118
119
|
<table>
|
|
119
120
|
<thead>
|
|
120
121
|
<tr>
|
|
121
|
-
<td>
|
|
122
|
-
<td>
|
|
123
|
-
<td>
|
|
122
|
+
<td>Name</td>
|
|
123
|
+
<td>Description</td>
|
|
124
|
+
<td>Required?</td>
|
|
124
125
|
</tr>
|
|
125
126
|
</thead>
|
|
126
127
|
<tbody>
|
|
@@ -129,14 +130,16 @@
|
|
|
129
130
|
<td><%= element.name %></td>
|
|
130
131
|
<td>
|
|
131
132
|
<%= element.description %><br />
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
133
|
+
Type: <%= h_type(element.type, @service) %><br />
|
|
134
|
+
Restrictions: <%= element.constraints %><br />
|
|
135
|
+
Valid Values: <%= element.valid_values %><br />
|
|
135
136
|
<% if glossary_terms_hash.include?(element.name)
|
|
136
137
|
glossary_term = glossary_terms_hash[element.name]
|
|
137
138
|
%>
|
|
138
|
-
|
|
139
|
-
<a href=
|
|
139
|
+
Glossary:
|
|
140
|
+
<a href='#glossary-term-<%= glossary_term.short_name %>'>
|
|
141
|
+
<%= glossary_term.long_name %>
|
|
142
|
+
</a>
|
|
140
143
|
<br />
|
|
141
144
|
<% end %>
|
|
142
145
|
</td>
|
|
@@ -148,13 +151,13 @@
|
|
|
148
151
|
<% end %>
|
|
149
152
|
|
|
150
153
|
<% if !operation.response_elements.empty? %>
|
|
151
|
-
<h5>
|
|
154
|
+
<h5>Response elements</h5>
|
|
152
155
|
<table>
|
|
153
156
|
<thead>
|
|
154
157
|
<tr>
|
|
155
|
-
<td>
|
|
156
|
-
<td>
|
|
157
|
-
<td>
|
|
158
|
+
<td>Name</td>
|
|
159
|
+
<td>Description</td>
|
|
160
|
+
<td>Required?</td>
|
|
158
161
|
</tr>
|
|
159
162
|
</thead>
|
|
160
163
|
<tbody>
|
|
@@ -164,12 +167,12 @@
|
|
|
164
167
|
<td>
|
|
165
168
|
<%= element.description %><br />
|
|
166
169
|
<% if element.type %>
|
|
167
|
-
|
|
170
|
+
Type: <%= h_type(element.type, @service) %><br />
|
|
168
171
|
<% else %>
|
|
169
|
-
|
|
172
|
+
Container: <%= h_type(element.elements_type, @service) %><br />
|
|
170
173
|
<% end %>
|
|
171
174
|
<% if element.default %>
|
|
172
|
-
|
|
175
|
+
Default value: <%= element.default %>
|
|
173
176
|
<% end %>
|
|
174
177
|
</td>
|
|
175
178
|
<td><%= element.required %></td>
|
|
@@ -180,14 +183,14 @@
|
|
|
180
183
|
<% end %>
|
|
181
184
|
|
|
182
185
|
<% if !operation.messages.empty? %>
|
|
183
|
-
<h5>
|
|
186
|
+
<h5>Messages</h5>
|
|
184
187
|
<table>
|
|
185
188
|
<thead>
|
|
186
189
|
<tr>
|
|
187
|
-
<td>
|
|
188
|
-
<td>
|
|
189
|
-
<td>
|
|
190
|
-
<td>
|
|
190
|
+
<td>Level</td>
|
|
191
|
+
<td>Key</td>
|
|
192
|
+
<td>Description</td>
|
|
193
|
+
<td>HTTP Status Code</td>
|
|
191
194
|
</tr>
|
|
192
195
|
</thead>
|
|
193
196
|
<tbody>
|
|
@@ -206,16 +209,16 @@
|
|
|
206
209
|
<% end %>
|
|
207
210
|
<% end %>
|
|
208
211
|
|
|
209
|
-
<h3>
|
|
212
|
+
<h3>Representations</h3>
|
|
210
213
|
<% @service.representations.each do |representation| %>
|
|
211
|
-
<div class=
|
|
214
|
+
<div class='representation' id='representation-<%= representation.name %>'>
|
|
212
215
|
<h4><%= representation.name %></h4>
|
|
213
216
|
<table>
|
|
214
217
|
<thead>
|
|
215
218
|
<tr>
|
|
216
|
-
<td>
|
|
217
|
-
<td>
|
|
218
|
-
<td>
|
|
219
|
+
<td>Name</td>
|
|
220
|
+
<td>Description</td>
|
|
221
|
+
<td>Required?</td>
|
|
219
222
|
</tr>
|
|
220
223
|
</thead>
|
|
221
224
|
<tbody>
|
|
@@ -225,9 +228,9 @@
|
|
|
225
228
|
<td>
|
|
226
229
|
<%= field.description %><br />
|
|
227
230
|
<% if field.type %>
|
|
228
|
-
|
|
231
|
+
Type: <%= h_type(field.type, @service) %><br />
|
|
229
232
|
<% else %>
|
|
230
|
-
|
|
233
|
+
Container: <%= h_type(field.elements_type, @service) %><br />
|
|
231
234
|
<% end %>
|
|
232
235
|
</td>
|
|
233
236
|
<td><%= field.required %></td>
|
|
@@ -239,25 +242,25 @@
|
|
|
239
242
|
<% end %>
|
|
240
243
|
|
|
241
244
|
<% if @service.proxy_operations.any? %>
|
|
242
|
-
<h3>
|
|
243
|
-
<div id=
|
|
245
|
+
<h3>Proxy Operations</h3>
|
|
246
|
+
<div id='proxy_operations' class='proxy_operations'>
|
|
244
247
|
<table>
|
|
245
248
|
<thead>
|
|
246
249
|
<tr>
|
|
247
|
-
<td>
|
|
248
|
-
<td>
|
|
250
|
+
<td>Code name</td>
|
|
251
|
+
<td>HTTP Method</td>
|
|
249
252
|
<td>URI</td>
|
|
250
|
-
<td>
|
|
253
|
+
<td>Service</td>
|
|
251
254
|
</tr>
|
|
252
255
|
</thead>
|
|
253
256
|
<tbody>
|
|
254
257
|
<% @service.proxy_operations.each do |operation| %>
|
|
255
|
-
<tr id=
|
|
258
|
+
<tr id='proxy-operation-<%= operation.code_name %>'>
|
|
256
259
|
<td>
|
|
257
260
|
<%= operation.code_name %>
|
|
258
261
|
</td>
|
|
259
262
|
<td><%= operation.http_method %></td>
|
|
260
|
-
<td><%= operation
|
|
263
|
+
<td><%= operation_path(operation) %></td>
|
|
261
264
|
<td><%= operation.service_name %></td>
|
|
262
265
|
</tr>
|
|
263
266
|
<% end %>
|
|
@@ -267,19 +270,19 @@
|
|
|
267
270
|
<% end %>
|
|
268
271
|
|
|
269
272
|
<% if @service.glossary.terms.any? %>
|
|
270
|
-
<h3>
|
|
271
|
-
<div class=
|
|
273
|
+
<h3>Glossary</h3>
|
|
274
|
+
<div class='glossary'>
|
|
272
275
|
<table>
|
|
273
276
|
<thead>
|
|
274
277
|
<tr>
|
|
275
|
-
<td>
|
|
276
|
-
<td>
|
|
277
|
-
<td>
|
|
278
|
+
<td>Short Name</td>
|
|
279
|
+
<td>Long Name</td>
|
|
280
|
+
<td>Description</td>
|
|
278
281
|
</tr>
|
|
279
282
|
</thead>
|
|
280
283
|
<tbody>
|
|
281
284
|
<% @service.glossary.terms.each do |term| %>
|
|
282
|
-
<tr id=
|
|
285
|
+
<tr id='glossary-term-<%= term.short_name %>'>
|
|
283
286
|
<td><%= term.short_name %></td>
|
|
284
287
|
<td><%= term.long_name %></td>
|
|
285
288
|
<td><%= term.description %></td>
|
|
@@ -0,0 +1,296 @@
|
|
|
1
|
+
<%
|
|
2
|
+
glossary_terms_hash = @service.glossary.terms_hash
|
|
3
|
+
%>
|
|
4
|
+
|
|
5
|
+
<html>
|
|
6
|
+
<head>
|
|
7
|
+
<title>Especificación API de Servicio <%= @service.name %></title>
|
|
8
|
+
|
|
9
|
+
<style type='text/css' media='screen'>
|
|
10
|
+
<%= erb :styles %>
|
|
11
|
+
</style>
|
|
12
|
+
</head>
|
|
13
|
+
<body>
|
|
14
|
+
<div class='content'>
|
|
15
|
+
<h1>Especificación API de Servicio <%= @service.name %></h1>
|
|
16
|
+
<h4>Nombre en código</h4>
|
|
17
|
+
<p><%= @service.code_name %></p>
|
|
18
|
+
|
|
19
|
+
<h4>Versión</h4>
|
|
20
|
+
<p><%= @service.version %></p>
|
|
21
|
+
|
|
22
|
+
<h3>Operaciones</h3>
|
|
23
|
+
<p>
|
|
24
|
+
En esta sección se describen las operaciones presentadas por este servicio.
|
|
25
|
+
</p>
|
|
26
|
+
|
|
27
|
+
<table>
|
|
28
|
+
<thead>
|
|
29
|
+
<tr>
|
|
30
|
+
<td>Índice de Operaciones</td>
|
|
31
|
+
</tr>
|
|
32
|
+
</thead>
|
|
33
|
+
<tbody>
|
|
34
|
+
<% @service.operations.each do |(controller_name, operations)| %>
|
|
35
|
+
<% operations.each do |operation| %>
|
|
36
|
+
<tr>
|
|
37
|
+
<td>
|
|
38
|
+
<a href='#operation-<%= controller_name %>-<%= operation.code_name %>'>
|
|
39
|
+
<%= controller_name %>#<%= operation.code_name %>
|
|
40
|
+
</a>
|
|
41
|
+
</td>
|
|
42
|
+
</tr>
|
|
43
|
+
<% end %>
|
|
44
|
+
<% end %>
|
|
45
|
+
</tbody>
|
|
46
|
+
</table>
|
|
47
|
+
|
|
48
|
+
<% if @service.proxy_operations.any? %>
|
|
49
|
+
<p></p>
|
|
50
|
+
<table>
|
|
51
|
+
<thead>
|
|
52
|
+
<tr><td>Índice de Operaciones Proxy</td></tr>
|
|
53
|
+
</thead>
|
|
54
|
+
<tbody>
|
|
55
|
+
<% @service.proxy_operations.each do |operation| %>
|
|
56
|
+
<tr><td>
|
|
57
|
+
<a href='#proxy-operation-<%= operation.code_name %>'>
|
|
58
|
+
<%= operation.code_name %>
|
|
59
|
+
</a>
|
|
60
|
+
</td></tr>
|
|
61
|
+
<% end %>
|
|
62
|
+
</tbody>
|
|
63
|
+
</table>
|
|
64
|
+
<% end %>
|
|
65
|
+
|
|
66
|
+
<% @service.operations.each do |(controller_name, operations)| %>
|
|
67
|
+
<% operations.each do |operation| %>
|
|
68
|
+
<div class='operation' id='operation-<%= controller_name %>-<%= operation.code_name %>'>
|
|
69
|
+
<h4>
|
|
70
|
+
<%= operation.name %>
|
|
71
|
+
</h4>
|
|
72
|
+
|
|
73
|
+
<h5>Descripción</h5>
|
|
74
|
+
<p><%= operation.description %></p>
|
|
75
|
+
|
|
76
|
+
<table class='vertical-header split'>
|
|
77
|
+
<tbody>
|
|
78
|
+
<tr>
|
|
79
|
+
<td>Método</td>
|
|
80
|
+
<td><%= operation.http_method %></td>
|
|
81
|
+
</tr>
|
|
82
|
+
<tr>
|
|
83
|
+
<td>URI</td>
|
|
84
|
+
<td><%= operation_path(operation) %></td>
|
|
85
|
+
</tr>
|
|
86
|
+
<tr>
|
|
87
|
+
<td>Nombre interno</td>
|
|
88
|
+
<td><%= operation.code_name %></td>
|
|
89
|
+
</tr>
|
|
90
|
+
</tbody>
|
|
91
|
+
</table>
|
|
92
|
+
|
|
93
|
+
<% if !operation.uri_elements.empty? %>
|
|
94
|
+
<h5>Parametros de Path URI</h5>
|
|
95
|
+
<table>
|
|
96
|
+
<thead>
|
|
97
|
+
<tr>
|
|
98
|
+
<td>Parámetro</td>
|
|
99
|
+
<td>Descripción</td>
|
|
100
|
+
</tr>
|
|
101
|
+
</thead>
|
|
102
|
+
<tbody>
|
|
103
|
+
<% operation.uri_elements.each do |element| %>
|
|
104
|
+
<tr>
|
|
105
|
+
<td><%= element.name %></td>
|
|
106
|
+
<td>
|
|
107
|
+
<%= element.description %>
|
|
108
|
+
</td>
|
|
109
|
+
</tr>
|
|
110
|
+
<% end %>
|
|
111
|
+
</tbody>
|
|
112
|
+
</table>
|
|
113
|
+
<% end %>
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
<% if !operation.request_elements.empty? %>
|
|
117
|
+
<h5>Elementos de Petición</h5>
|
|
118
|
+
<table>
|
|
119
|
+
<thead>
|
|
120
|
+
<tr>
|
|
121
|
+
<td>Nombre</td>
|
|
122
|
+
<td>Descripción</td>
|
|
123
|
+
<td>Requerido</td>
|
|
124
|
+
</tr>
|
|
125
|
+
</thead>
|
|
126
|
+
<tbody>
|
|
127
|
+
<% operation.request_elements.each do |element| %>
|
|
128
|
+
<tr>
|
|
129
|
+
<td><%= element.name %></td>
|
|
130
|
+
<td>
|
|
131
|
+
<%= element.description %><br />
|
|
132
|
+
Tipo: <%= h_type(element.type, @service) %><br />
|
|
133
|
+
Restricciones: <%= element.constraints %><br />
|
|
134
|
+
Valores Válidos: <%= element.valid_values %><br />
|
|
135
|
+
<% if glossary_terms_hash.include?(element.name)
|
|
136
|
+
glossary_term = glossary_terms_hash[element.name]
|
|
137
|
+
%>
|
|
138
|
+
Glosario:
|
|
139
|
+
<a href='#glossary-term-<%= glossary_term.short_name %>'>
|
|
140
|
+
<%= glossary_term.long_name %>
|
|
141
|
+
</a>
|
|
142
|
+
<br />
|
|
143
|
+
<% end %>
|
|
144
|
+
</td>
|
|
145
|
+
<td><%= element.required %></td>
|
|
146
|
+
</tr>
|
|
147
|
+
<% end %>
|
|
148
|
+
</tbody>
|
|
149
|
+
</table>
|
|
150
|
+
<% end %>
|
|
151
|
+
|
|
152
|
+
<% if !operation.response_elements.empty? %>
|
|
153
|
+
<h5>Elementos de Respuesta</h5>
|
|
154
|
+
<table>
|
|
155
|
+
<thead>
|
|
156
|
+
<tr>
|
|
157
|
+
<td>Nombre</td>
|
|
158
|
+
<td>Descripción</td>
|
|
159
|
+
<td>Requerido</td>
|
|
160
|
+
</tr>
|
|
161
|
+
</thead>
|
|
162
|
+
<tbody>
|
|
163
|
+
<% operation.response_elements.each do |element| %>
|
|
164
|
+
<tr>
|
|
165
|
+
<td><%= element.name %></td>
|
|
166
|
+
<td>
|
|
167
|
+
<%= element.description %><br />
|
|
168
|
+
<% if element.type %>
|
|
169
|
+
Tipo: <%= h_type(element.type, @service) %><br />
|
|
170
|
+
<% else %>
|
|
171
|
+
Contenedor: <%= h_type(element.elements_type, @service) %><br />
|
|
172
|
+
<% end %>
|
|
173
|
+
<% if element.default %>
|
|
174
|
+
Valor por defecto: <%= element.default %>
|
|
175
|
+
<% end %>
|
|
176
|
+
</td>
|
|
177
|
+
<td><%= element.required %></td>
|
|
178
|
+
</tr>
|
|
179
|
+
<% end %>
|
|
180
|
+
</tbody>
|
|
181
|
+
</table>
|
|
182
|
+
<% end %>
|
|
183
|
+
|
|
184
|
+
<% if !operation.messages.empty? %>
|
|
185
|
+
<h5>Mensajes</h5>
|
|
186
|
+
<table>
|
|
187
|
+
<thead>
|
|
188
|
+
<tr>
|
|
189
|
+
<td>Nivel</td>
|
|
190
|
+
<td>Código</td>
|
|
191
|
+
<td>Descripción</td>
|
|
192
|
+
<td>Código de Estado HTTP</td>
|
|
193
|
+
</tr>
|
|
194
|
+
</thead>
|
|
195
|
+
<tbody>
|
|
196
|
+
<% operation.messages.each do |message| %>
|
|
197
|
+
<tr>
|
|
198
|
+
<td><%= message.level %></td>
|
|
199
|
+
<td><%= message.key %></td>
|
|
200
|
+
<td><%= message.description %></td>
|
|
201
|
+
<td><%= message.status_code %></td>
|
|
202
|
+
</tr>
|
|
203
|
+
<% end %>
|
|
204
|
+
</tbody>
|
|
205
|
+
</table>
|
|
206
|
+
<% end %>
|
|
207
|
+
</div>
|
|
208
|
+
<% end %>
|
|
209
|
+
<% end %>
|
|
210
|
+
|
|
211
|
+
<h3>Representaciones</h3>
|
|
212
|
+
<% @service.representations.each do |representation| %>
|
|
213
|
+
<div class='representation' id='representation-<%= representation.name %>'>
|
|
214
|
+
<h4><%= representation.name %></h4>
|
|
215
|
+
<table>
|
|
216
|
+
<thead>
|
|
217
|
+
<tr>
|
|
218
|
+
<td>Nombre de Atributo</td>
|
|
219
|
+
<td>Descripción</td>
|
|
220
|
+
<td>Requerido</td>
|
|
221
|
+
</tr>
|
|
222
|
+
</thead>
|
|
223
|
+
<tbody>
|
|
224
|
+
<% representation.fields.each do |field| %>
|
|
225
|
+
<tr>
|
|
226
|
+
<td><%= field.name %></td>
|
|
227
|
+
<td>
|
|
228
|
+
<%= field.description %><br />
|
|
229
|
+
<% if field.type %>
|
|
230
|
+
Tipo: <%= h_type(field.type, @service) %><br />
|
|
231
|
+
<% else %>
|
|
232
|
+
Contenedor: <%= h_type(field.elements_type, @service) %><br />
|
|
233
|
+
<% end %>
|
|
234
|
+
</td>
|
|
235
|
+
<td><%= field.required %></td>
|
|
236
|
+
</tr>
|
|
237
|
+
<% end %>
|
|
238
|
+
</tbody>
|
|
239
|
+
</table>
|
|
240
|
+
</div>
|
|
241
|
+
<% end %>
|
|
242
|
+
|
|
243
|
+
<% if @service.proxy_operations.any? %>
|
|
244
|
+
<h3>Operaciones Proxy</h3>
|
|
245
|
+
<div id='proxy_operations' class='proxy_operations'>
|
|
246
|
+
<table>
|
|
247
|
+
<thead>
|
|
248
|
+
<tr>
|
|
249
|
+
<td>Nombre Interno</td>
|
|
250
|
+
<td>Método</td>
|
|
251
|
+
<td>URI</td>
|
|
252
|
+
<td>Servicio</td>
|
|
253
|
+
</tr>
|
|
254
|
+
</thead>
|
|
255
|
+
<tbody>
|
|
256
|
+
<% @service.proxy_operations.each do |operation| %>
|
|
257
|
+
<tr id='proxy-operation-<%= operation.code_name %>'>
|
|
258
|
+
<td>
|
|
259
|
+
<%= operation.code_name %>
|
|
260
|
+
</td>
|
|
261
|
+
<td><%= operation.http_method %></td>
|
|
262
|
+
<td><%= operation_path(operation) %></td>
|
|
263
|
+
<td><%= operation.service_name %></td>
|
|
264
|
+
</tr>
|
|
265
|
+
<% end %>
|
|
266
|
+
</tbody>
|
|
267
|
+
</table>
|
|
268
|
+
</div>
|
|
269
|
+
<% end %>
|
|
270
|
+
|
|
271
|
+
<% if @service.glossary.terms.any? %>
|
|
272
|
+
<h3>Glosario</h3>
|
|
273
|
+
<div class='glossary'>
|
|
274
|
+
<table>
|
|
275
|
+
<thead>
|
|
276
|
+
<tr>
|
|
277
|
+
<td>Nombre Corto</td>
|
|
278
|
+
<td>Nombre Largo</td>
|
|
279
|
+
<td>Descripción</td>
|
|
280
|
+
</tr>
|
|
281
|
+
</thead>
|
|
282
|
+
<tbody>
|
|
283
|
+
<% @service.glossary.terms.each do |term| %>
|
|
284
|
+
<tr id='glossary-term-<%= term.short_name %>'>
|
|
285
|
+
<td><%= term.short_name %></td>
|
|
286
|
+
<td><%= term.long_name %></td>
|
|
287
|
+
<td><%= term.description %></td>
|
|
288
|
+
</tr>
|
|
289
|
+
<% end %>
|
|
290
|
+
</tbody>
|
|
291
|
+
</table>
|
|
292
|
+
</div>
|
|
293
|
+
<% end %>
|
|
294
|
+
|
|
295
|
+
</body>
|
|
296
|
+
</html>
|
data/lib/angus/sdoc/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: angus-sdoc
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.0.
|
|
4
|
+
version: 0.0.5
|
|
5
5
|
prerelease:
|
|
6
6
|
platform: ruby
|
|
7
7
|
authors:
|
|
@@ -11,7 +11,7 @@ authors:
|
|
|
11
11
|
autorequire:
|
|
12
12
|
bindir: bin
|
|
13
13
|
cert_chain: []
|
|
14
|
-
date: 2013-11
|
|
14
|
+
date: 2013-12-11 00:00:00.000000000 Z
|
|
15
15
|
dependencies:
|
|
16
16
|
- !ruby/object:Gem::Dependency
|
|
17
17
|
name: rake
|
|
@@ -184,8 +184,9 @@ files:
|
|
|
184
184
|
- lib/angus/definitions/base.rb
|
|
185
185
|
- lib/angus/definitions/service.rb
|
|
186
186
|
- lib/angus/base.rb
|
|
187
|
+
- lib/angus/sdoc/templates/doc.en.erb
|
|
187
188
|
- lib/angus/sdoc/templates/styles.erb
|
|
188
|
-
- lib/angus/sdoc/templates/doc.erb
|
|
189
|
+
- lib/angus/sdoc/templates/doc.es.erb
|
|
189
190
|
- lib/angus/sdoc/version.rb
|
|
190
191
|
- lib/angus/sdoc/json_formatter.rb
|
|
191
192
|
- lib/angus/sdoc/html_formatter.rb
|