Class: Aws::Resources::Documenter::OperationDocumenter

Inherits:
BaseOperationDocumenter show all
Defined in:
aws-sdk-resources/lib/aws-sdk-resources/documenter/operation_documenter.rb

Instance Attribute Summary

Attributes inherited from BaseOperationDocumenter

#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

Methods inherited from BaseOperationDocumenter

#initialize, #method_object

Constructor Details

This class inherits a constructor from Aws::Resources::Documenter::BaseOperationDocumenter

Instance Method Details

#docstringObject


6
7
8
# File 'aws-sdk-resources/lib/aws-sdk-resources/documenter/operation_documenter.rb', line 6

def docstring
  super + " #{return_base_message}"
end

#return_base_messageObject


22
23
24
25
26
# File 'aws-sdk-resources/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_messageObject


18
19
20
# File 'aws-sdk-resources/lib/aws-sdk-resources/documenter/operation_documenter.rb', line 18

def return_message
  "#{return_base_message} #{returns_data_members}"
end

#return_typeObject


10
11
12
13
14
15
16
# File 'aws-sdk-resources/lib/aws-sdk-resources/documenter/operation_documenter.rb', line 10

def return_type
  if returns_data_members
    ['Structure']
  else
    ['void']
  end
end

#returns_data_membersObject


28
29
30
31
32
33
34
35
36
37
38
# File 'aws-sdk-resources/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