ruby_method(route) ::= <<
<method_title(route)>
<route.operation.description>
<if(route.paramHelpers)><method_parameters(route)><endif>
<method_return(route)>
>>
method_title(route) ::= <<
[[ruby-<route.rubyClassReferenceId>-<route.rubyMethodReferenceId>]]
===== <route.rubyClassShortName>#<route.rubyMethodName>
.Method Signature
[source, ruby]
....
<route.successResponseRubyType> <route.rubyClassName>#<route.rubyMethodName>(<route.rubyParamSignatureList>)
....
>>
method_parameters(route) ::= <<
.Parameters
[cols="1,1,2a,1", options="header"]
|===
| Name
| Type
| Description
| Required
<route.rubyRequiredParamHelpers:format_parameter()>
<if(route.queryParamHelpers)><format_optional_parameters(route)><endif>
|===
>>
format_parameter(paramHelper) ::= <<
| <paramHelper.name>
| <paramHelper.rubyType>
| <paramHelper.description>
| <paramHelper.required>
>>
format_parameter_declaration(paramHelper) ::= "<paramHelper.name>"
format_optional_parameters(route) ::= <<
| opts
| Hash
|
One of the following values:
<route.queryParamHelpers:format_optional_parameter()>
| false
>>
format_optional_parameter(paramHelper) ::= "* `<paramHelper.name>`: <paramHelper.description><\n>"
method_return(route) ::= <<
.Returns
[cols="1,2a", options="header"]
|===
| Type
| Notes
| <route.successResponseRubyTypeRef>
| <route.successResponseDescription>
|===
>>
ruby_model(model) ::= <<
<model_title(model)>
<model.model.description>
<if(model.propertyHelpers)><model_properties(model)><endif>
>>
model_title(model) ::= <<
[[ruby-model-<model.idRef>]]
===== <model.id>
>>
model_properties(model) ::= <<
.Attributes
[cols="1,1,1a", options="header"]
|===
| Name
| Type
| Description
<model.propertyHelpers:model_property()>
|===
>>
model_property(propertyHelper) ::= <<
| <propertyHelper.id>
| <propertyHelper.rubyTypeRef>
| <propertyHelper.property.description>
>>
# |
Change |
User |
Description |
Committed |
|
#1
|
20014 |
Paul Allen |
Moved swagger gneration inside project. |
|
|
//guest/paul_allen/hws/dev/swagger/src/main/resources/asciidoc/ruby.stg |
#1
|
19966 |
Paul Allen |
Refactor... |
|
|