python_method(route) ::= <<
<method_title(route)>
<route.operation.description>
<method_type_reference(route)>
<if(route.paramHelpers)><method_parameters(route)><endif>
<method_return(route)>
>>
method_title(route) ::= <<
[[python-<route.pythonClassReferenceId>-<route.pythonMethodReferenceId>]]
===== <route.pythonClassShortName>#<route.pythonMethodName>
>>
method_type_reference(route) ::= <<
.Method Signature
[source,python]
....
<route.successResponsePythonType> <route.pythonClassName>#<route.pythonMethodName>(<route.pythonParamSignatureList>)
....
>>
method_parameters(route) ::= <<
.Parameters
[cols="1,1,2a,1", options="header"]
|===
| Name
| Type
| Description
| Required
<route.pythonRequiredParamHelpers:method_parameter()>
<if(route.queryParamHelpers)><route.queryParamHelpers:optional_method_parameter()><endif>
|===
>>
method_parameter(paramHelper) ::= <<
| <paramHelper.name>
| <paramHelper.pythonType>
| <paramHelper.description>
| <paramHelper.required>
>>
optional_method_parameter(paramHelper) ::= <<
| `<paramHelper.name> = <paramHelper.pythonType>`
| <paramHelper.pythonType>
| <paramHelper.description>
| No, optional keyword argument
>>
method_return(route) ::= <<
.Returns
[cols="1,2a", options="header"]
|===
| Type
| Notes
| <route.successResponsePythonTypeRef>
| <route.successResponseDescription>
|===
>>
python_model(model) ::= <<
<model_title(model)>
<model.model.description>
<if(model.propertyHelpers)><model_properties(model)><endif>
>>
model_title(model) ::= <<
[[python-model-<model.idRef>]]
===== <model.id>
>>
model_properties(model) ::= <<f
.Attributes
[cols="1,1,1a", options="header"]
|===
| Name
| Type
| Description
<model.propertyHelpers:model_property()>
|===
>>
model_property(propertyHelper) ::= <<
| <propertyHelper.id>
| <propertyHelper.pythonTypeRef>
| <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/python.stg |
#1
|
19966 |
Paul Allen |
Refactor... |
|
|