def test_document_service_resource_actions(self):
action_documenter = ActionDocumenter(self.resource)
action_documenter.document_actions(self.doc_structure)
self.assert_contains_lines_in_order([
'.. py:method:: sample_operation(**kwargs)',
' **Request Syntax**',
' ::',
' response = myservice.sample_operation(',
' Foo=\'string\',',
' Bar=\'string\'',
' )',
' :type Foo: string',
' :param Foo: Documents Foo',
' :type Bar: string',
' :param Bar: Documents Bar',
' :rtype: dict',
' :returns:',
' **Response Syntax**',
' ::',
' {',
' \'Foo\': \'string\',',
' \'Bar\': \'string\'',
' }',
' **Response Structure**',
' - *(dict) --*',
' - **Foo** *(string) --* Documents Foo',
' - **Bar** *(string) --* Documents Bar'
])
def _add_actions(self, section):
section = section.add_new_section('actions')
actions = self._resource.meta.resource_model.actions
if actions:
documenter = ActionDocumenter(self._resource)
documenter.member_map = self.member_map
documenter.document_actions(section)
def _add_actions(self, section):
section = section.add_new_section('actions')
actions = self._resource.meta.resource_model.actions
if actions:
documenter = ActionDocumenter(self._resource)
documenter.member_map = self.member_map
documenter.document_actions(section)
def test_document_service_resource_actions(self):
action_documenter = ActionDocumenter(self.resource)
action_documenter.document_actions(self.doc_structure)
self.assert_contains_lines_in_order([
'.. py:method:: sample_operation(**kwargs)',
' **Request Syntax**',
' ::',
' response = myservice.sample_operation(',
' Foo=\'string\',',
' Bar=\'string\'',
' )',
' :type Foo: string',
' :param Foo: Documents Foo',
' :type Bar: string',
' :param Bar: Documents Bar',
' :rtype: dict',
' :returns:',
' **Response Syntax**',
' ::',
' {',
' \'Foo\': \'string\',',
' \'Bar\': \'string\'',
' }',
' **Response Structure**',
' - *(dict) --*',
' - **Foo** *(string) --* Documents Foo',
' - **Bar** *(string) --* Documents Bar'
])
def test_document_nonservice_resource_actions(self):
subresource = self.resource.Sample('mysample')
action_documenter = ActionDocumenter(subresource)
action_documenter.document_actions(self.doc_structure)
self.assert_contains_lines_in_order([
'.. py:method:: load()',
(' Calls :py:meth:`MyService.Client.sample_operation` to update '
'the attributes of the Sample resource'),
' **Request Syntax** ',
' ::',
' sample.load()',
' :returns: None',
'.. py:method:: operate(**kwargs)',
' **Request Syntax** ',
' ::',
' response = sample.operate(',
" Bar='string'",
' )',
' :type Bar: string',
' :param Bar: Documents Bar',
' :rtype: dict',
' :returns: ',
' ',
' **Response Syntax** ',
' ::',
' {',
" 'Foo': 'string',",
" 'Bar': 'string'",
' }',
' **Response Structure** ',
' - *(dict) --* ',
' - **Foo** *(string) --* Documents Foo',
' - **Bar** *(string) --* Documents Bar',
'.. py:method:: reload()',
(' Calls :py:meth:`MyService.Client.sample_operation` to update '
'the attributes of the Sample resource'),
' **Request Syntax** ',
' ::',
' sample.reload()',
' :returns: None'
])
def test_document_nonservice_resource_actions(self):
subresource = self.resource.Sample('mysample')
action_documenter = ActionDocumenter(subresource)
action_documenter.document_actions(self.doc_structure)
self.assert_contains_lines_in_order([
'.. py:method:: load()',
(' Calls :py:meth:`MyService.Client.sample_operation` to update '
'the attributes of the Sample resource'),
' **Request Syntax** ',
' ::',
' sample.load()',
' :returns: None',
'.. py:method:: operate(**kwargs)',
' **Request Syntax** ',
' ::',
' response = sample.operate(',
" Bar='string'",
' )',
' :type Bar: string',
' :param Bar: Documents Bar',
' :rtype: dict',
' :returns: ',
' ',
' **Response Syntax** ',
' ::',
' {',
" 'Foo': 'string',",
" 'Bar': 'string'",
' }',
' **Response Structure** ',
' - *(dict) --* ',
' - **Foo** *(string) --* Documents Foo',
' - **Bar** *(string) --* Documents Bar',
'.. py:method:: reload()',
(' Calls :py:meth:`MyService.Client.sample_operation` to update '
'the attributes of the Sample resource'),
' **Request Syntax** ',
' ::',
' sample.reload()',
' :returns: None'
])