Class: Aws::Resources::Documenter::OperationDocumenter
Instance Attribute Summary
#api_request, #api_request_name, #api_request_params, #builder, #called_operation, #operation_name, #resource_class, #resource_class_name, #source, #target_resource_class, #target_resource_class_name, #yard_class
Instance Method Summary
collapse
#initialize, #method_object
Instance Method Details
#docstring ⇒ Object
6
7
8
|
# File 'lib/aws-sdk-resources/documenter/operation_documenter.rb', line 6
def docstring
super + " #{return_base_message}"
end
|
#return_base_message ⇒ Object
22
23
24
25
26
|
# File 'lib/aws-sdk-resources/documenter/operation_documenter.rb', line 22
def return_base_message
if returns_data_members
"Calls {#{called_operation}}, returning its reponse."
end
end
|
#return_message ⇒ Object
18
19
20
|
# File 'lib/aws-sdk-resources/documenter/operation_documenter.rb', line 18
def return_message
"#{return_base_message} #{returns_data_members}"
end
|
#return_type ⇒ Object
10
11
12
13
14
15
16
|
# File 'lib/aws-sdk-resources/documenter/operation_documenter.rb', line 10
def return_type
if returns_data_members
['Structure']
else
['void']
end
end
|
#returns_data_members ⇒ Object
28
29
30
31
32
33
34
35
36
37
38
|
# File 'lib/aws-sdk-resources/documenter/operation_documenter.rb', line 28
def returns_data_members
if response_shape && response_shape.member_names.count > 0
msg = "The response data has following properties:\n"
response_shape.member_names.each do |name|
msg << "\n* `#{name}`"
end
msg
else
nil
end
end
|