RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-02-09 02:59:27 +03:00
Code Issues Projects Releases Wiki Activity

Make parameters description conform to others

Browse Source
This commit is contained in:
marapper 2013-05-07 23:11:32 +04:00
parent 80b5162c83
commit a97c65da70
4 changed files with 20 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Parser/JmsMetadataParser.php
View File

@ -201,7 +201,7 @@ class JmsMetadataParser implements ParserInterface
$extracted = $this->commentExtractor->getDocCommentText($ref->getProperty($item->name)); $extracted = $this->commentExtractor->getDocCommentText($ref->getProperty($item->name));
} }
return !empty($extracted) ? $extracted : "No description."; return $extracted;
} }
} }

13
Tests/Formatter/MarkdownFormatterTest.php
View File

@ -200,31 +200,26 @@ foo:
* type: string * type: string
* required: false * required: false
* description: No description.
number: number:
* type: double * type: double
* required: false * required: false
* description: No description.
arr: arr:
* type: array * type: array
* required: false * required: false
* description: No description.
nested: nested:
* type: object (JmsNested) * type: object (JmsNested)
* required: false * required: false
* description: No description.
nested[bar]: nested[bar]:
* type: string * type: string
* required: false * required: false
* description: No description.
nested[baz][]: nested[baz][]:
@ -238,49 +233,41 @@ nested[circular]:
* type: object (JmsNested) * type: object (JmsNested)
* required: false * required: false
* description: No description.
nested[parent]: nested[parent]:
* type: object (JmsTest) * type: object (JmsTest)
* required: false * required: false
* description: No description.
nested[parent][foo]: nested[parent][foo]:
* type: string * type: string
* required: false * required: false
* description: No description.
nested[parent][number]: nested[parent][number]:
* type: double * type: double
* required: false * required: false
* description: No description.
nested[parent][arr]: nested[parent][arr]:
* type: array * type: array
* required: false * required: false
* description: No description.
nested[parent][nested]: nested[parent][nested]:
* type: object (JmsNested) * type: object (JmsNested)
* required: false * required: false
* description: No description.
nested[parent][nested_array][]: nested[parent][nested_array][]:
* type: array of objects (JmsNested) * type: array of objects (JmsNested)
* required: false * required: false
* description: No description.
nested_array[]: nested_array[]:
* type: array of objects (JmsNested) * type: array of objects (JmsNested)
* required: false * required: false
* description: No description.
### `GET` /jms-return-test ### ### `GET` /jms-return-test ###

32
Tests/Formatter/SimpleFormatterTest.php
View File

@ -250,35 +250,35 @@ class SimpleFormatterTest extends WebTestCase
array( array(
'dataType' => 'string', 'dataType' => 'string',
'required' => false, 'required' => false,
'description' => 'No description.', 'description' => '',
'readonly' => false, 'readonly' => false,
), ),
'bar' => 'bar' =>
array( array(
'dataType' => 'DateTime', 'dataType' => 'DateTime',
'required' => false, 'required' => false,
'description' => 'No description.', 'description' => '',
'readonly' => true, 'readonly' => true,
), ),
'number' => 'number' =>
array( array(
'dataType' => 'double', 'dataType' => 'double',
'required' => false, 'required' => false,
'description' => 'No description.', 'description' => '',
'readonly' => false, 'readonly' => false,
), ),
'arr' => 'arr' =>
array( array(
'dataType' => 'array', 'dataType' => 'array',
'required' => false, 'required' => false,
'description' => 'No description.', 'description' => '',
'readonly' => false, 'readonly' => false,
), ),
'nested' => 'nested' =>
array( array(
'dataType' => 'object (JmsNested)', 'dataType' => 'object (JmsNested)',
'required' => false, 'required' => false,
'description' => 'No description.', 'description' => '',
'readonly' => false, 'readonly' => false,
'children' => 'children' =>
array( array(
@ -286,14 +286,14 @@ class SimpleFormatterTest extends WebTestCase
array( array(
'dataType' => 'DateTime', 'dataType' => 'DateTime',
'required' => false, 'required' => false,
'description' => 'No description.', 'description' => '',
'readonly' => true, 'readonly' => true,
), ),
'bar' => 'bar' =>
array( array(
'dataType' => 'string', 'dataType' => 'string',
'required' => false, 'required' => false,
'description' => 'No description.', 'description' => '',
'readonly' => false, 'readonly' => false,
), ),
'baz' => 'baz' =>
@ -309,14 +309,14 @@ With multiple lines.',
array( array(
'dataType' => 'object (JmsNested)', 'dataType' => 'object (JmsNested)',
'required' => false, 'required' => false,
'description' => 'No description.', 'description' => '',
'readonly' => false, 'readonly' => false,
), ),
'parent' => 'parent' =>
array( array(
'dataType' => 'object (JmsTest)', 'dataType' => 'object (JmsTest)',
'required' => false, 'required' => false,
'description' => 'No description.', 'description' => '',
'readonly' => false, 'readonly' => false,
'children' => 'children' =>
array( array(
@ -324,42 +324,42 @@ With multiple lines.',
array( array(
'dataType' => 'string', 'dataType' => 'string',
'required' => false, 'required' => false,
'description' => 'No description.', 'description' => '',
'readonly' => false, 'readonly' => false,
), ),
'bar' => 'bar' =>
array( array(
'dataType' => 'DateTime', 'dataType' => 'DateTime',
'required' => false, 'required' => false,
'description' => 'No description.', 'description' => '',
'readonly' => true, 'readonly' => true,
), ),
'number' => 'number' =>
array( array(
'dataType' => 'double', 'dataType' => 'double',
'required' => false, 'required' => false,
'description' => 'No description.', 'description' => '',
'readonly' => false, 'readonly' => false,
), ),
'arr' => 'arr' =>
array( array(
'dataType' => 'array', 'dataType' => 'array',
'required' => false, 'required' => false,
'description' => 'No description.', 'description' => '',
'readonly' => false, 'readonly' => false,
), ),
'nested' => 'nested' =>
array( array(
'dataType' => 'object (JmsNested)', 'dataType' => 'object (JmsNested)',
'required' => false, 'required' => false,
'description' => 'No description.', 'description' => '',
'readonly' => false, 'readonly' => false,
), ),
'nested_array' => 'nested_array' =>
array( array(
'dataType' => 'array of objects (JmsNested)', 'dataType' => 'array of objects (JmsNested)',
'required' => false, 'required' => false,
'description' => 'No description.', 'description' => '',
'readonly' => false, 'readonly' => false,
), ),
), ),
@ -370,7 +370,7 @@ With multiple lines.',
array( array(
'dataType' => 'array of objects (JmsNested)', 'dataType' => 'array of objects (JmsNested)',
'required' => false, 'required' => false,
'description' => 'No description.', 'description' => '',
'readonly' => false, 'readonly' => false,
), ),
), ),

6
Tests/Parser/JmsMetadataParserTest.php
View File

@ -76,19 +76,19 @@ class JmsMetadataParserTest extends \PHPUnit_Framework_TestCase
'foo' => array( 'foo' => array(
'dataType' => 'DateTime', 'dataType' => 'DateTime',
'required' => false, 'required' => false,
'description' => 'No description.', 'description' => '',
'readonly' => false 'readonly' => false
), ),
'bar' => array( 'bar' => array(
'dataType' => 'string', 'dataType' => 'string',
'required' => false, 'required' => false,
'description' => 'No description.', 'description' => '',
'readonly' => false 'readonly' => false
), ),
'baz' => array( 'baz' => array(
'dataType' => 'array of integers', 'dataType' => 'array of integers',
'required' => false, 'required' => false,
'description' => 'No description.', 'description' => '',
'readonly' => false 'readonly' => false
) )
), $output); ), $output);