Class: Aws::Api::Docs::Builder Private

Inherits:
Object
  • Object
show all
Defined in:
lib/aws-sdk-core/api/docs/builder.rb

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Defined Under Namespace

Classes: Tabulator

Constant Summary collapse

DOC_SRC =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

File.expand_path('../../../../../../doc-src/', __FILE__)

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(svc_module) ⇒ Builder

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Builder.


14
15
16
17
18
19
20
21
22
23
24
# File 'lib/aws-sdk-core/api/docs/builder.rb', line 14

def initialize(svc_module)
  @svc_module = svc_module
  @svc_name = svc_module.name.split('::').last
  @client_class = svc_module.const_get(:Client)
  @api = @client_class.api
  @full_name = @api.['serviceFullName']
  @uid = @api.['uid']
  @error_names = @api.operations.map {|_,o| o.errors.map(&:shape).map(&:name) }
  @error_names = @error_names.flatten.uniq.sort
  @namespace = YARD::Registry['Aws']
end

Class Method Details

.document(svc_module) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


10
11
12
# File 'lib/aws-sdk-core/api/docs/builder.rb', line 10

def self.document(svc_module)
  new(svc_module).document
end

Instance Method Details

#documentObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


26
27
28
29
30
31
# File 'lib/aws-sdk-core/api/docs/builder.rb', line 26

def document
  document_service
  document_types
  document_client
  document_errors
end