RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-02-02 15:51:48 +03:00
Code Issues Projects Releases Wiki Activity
NelmioApiDocBundle/Tests/Formatter/SimpleFormatterTest.php

2510 lines
168 KiB
PHP
Raw Normal View History

Add basic tests
2012-04-13 14:11:54 +02:00
<?php
/*
* This file is part of the NelmioApiDocBundle.
*
* (c) Nelmio <hello@nelm.io>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
Moved test classes to better locations
2012-04-13 14:22:07 +02:00
namespace Nelmio\ApiDocBundle\Tests\Formatter;
Unified data types [actualType and subType] This is the result of https://github.com/nelmio/NelmioApiDocBundle/issues/410. This PR aims to provide a uniform way of declaring data-types of parameters for parsers and handlers to follow. In turn, this would allow formatters to determine data-types in a cleaner and less volatile manner. (See use-case that can be improved with this PR: https://github.com/nelmio/NelmioApiDocBundle/blob/master/Formatter/AbstractFormatter.php#L103) This is possible by the addition two properties to each property item in `response`, and `parameters` fields in each API endpoint produced by the `ApiDocExtractor`: * `actualType` Contains a value from one of the `DataTypes` class constants. * `subType` Can contain either `null`, or any other `DataTypes` class constant. This is relevant when the `actualType` is a `DataTypes::COLLECTION`, wherein `subType` would specify the type of the collection items. It is also relevant when `actualType` is a `DataTypes::MODEL`, wherein `subType` would contain an identifier of the model (the FQCN or anything the parser would wish to specify) Examples: ```php array( 'id' => array( 'dataType' => 'integer', 'actualType' => DataTypes::INTEGER, 'subType' => null, ), 'profile' => array( 'dataType' => 'object (Profile)', 'actualType' => DataTypes::MODEL, 'subType' => 'Foo\Entity\Profile', 'children' => array( 'name' => array( 'dataType' => 'string', 'actualType' => DataTypes::STRING, 'subType' => null, ), 'birthDate' => array( 'dataType' => 'date', 'actualType' => DataTypes::DATE, 'subType' => null, ), ) ), 'languages' => array( 'dataType' => 'array of strings', 'actualType' => DataTypes::COLLECTION, 'subType' => DataTypes::STRING, ), 'roles' => array( 'dataType' => 'array of choices', 'actualType' => DataTypes::COLLECTION, 'subType' => DataTypes::ENUM, ), 'groups' => array( 'dataType' => 'array of objects (Group)', 'actualType' => DataTypes::COLLECTION, 'subType' => 'Foo\Entity\Group', ), 'profileRevisions' => array( 'dataType' => 'array of objects (Profile)', 'actualType' => DataTypes::COLLECTION, 'subType' => 'Foo\Entity\Profile', ), 'address' => array( 'dataType' => 'object (a_type_a_custom_JMS_serializer_handler_handles)', 'actualType' => DataTypes::MODEL, 'subType' => 'a_type_a_custom_JMS_serializer_handler_handles', ), ); ``` When a formatter omits the `dataType` property or leaves it blank, it is inferred within `ApiDocExtractor` before everything is passed to formatters.
2014-06-17 17:05:00 -07:00
use Nelmio\ApiDocBundle\DataTypes;
Moved test classes to better locations
2012-04-13 14:22:07 +02:00
use Nelmio\ApiDocBundle\Tests\WebTestCase;
Add basic tests
2012-04-13 14:11:54 +02:00
class SimpleFormatterTest extends WebTestCase
{
Revert "Fix test related to DungleApiBundle. Remove some of them." This reverts commit e66fb209b56e7937647fae39e64b6218efa62e1e.
2015-10-23 10:11:52 +02:00
public function testFormat()
{
$container = $this->getContainer();
$extractor = $container->get('nelmio_api_doc.extractor.api_doc_extractor');
set_error_handler(array($this, 'handleDeprecation'));
$data = $extractor->all();
restore_error_handler();
$result = $container->get('nelmio_api_doc.formatter.simple_formatter')->format($data);
if (class_exists('Dunglas\ApiBundle\DunglasApiBundle')) {
skip tests related to DunglasApiBundle
2015-10-23 10:53:47 +02:00
$this->markTestSkipped('There is an issue because of DunglasApiBundle');
Revert "Fix test related to DungleApiBundle. Remove some of them." This reverts commit e66fb209b56e7937647fae39e64b6218efa62e1e.
2015-10-23 10:11:52 +02:00
$expected = array (
'/api/other-resources' =>
array (
0 =>
array (
'method' => 'GET',
'uri' => '/api/other-resources.{_format}',
'description' => 'List another resource.',
'requirements' =>
array (
'_format' =>
array (
'requirement' => 'json|xml|html',
'dataType' => '',
'description' => '',
),
),
'response' =>
array (
'' =>
array (
'dataType' => 'array of objects (JmsTest)',
'subType' => 'Nelmio\\ApiDocBundle\\Tests\\Fixtures\\Model\\JmsTest',
'actualType' => 'collection',
'readonly' => true,
'required' => true,
'default' => true,
'description' => '',
'children' =>
array (
'foo' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'bar' =>
array (
'dataType' => 'DateTime',
'actualType' => 'datetime',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => true,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'number' =>
array (
'dataType' => 'double',
'actualType' => 'float',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'arr' =>
array (
'dataType' => 'array',
'actualType' => 'collection',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'nested' =>
array (
'dataType' => 'object (JmsNested)',
'actualType' => 'model',
'subType' => 'Nelmio\\ApiDocBundle\\Tests\\Fixtures\\Model\\JmsNested',
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
'children' =>
array (
'foo' =>
array (
'dataType' => 'DateTime',
'actualType' => 'datetime',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => true,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'bar' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'required' => false,
'default' => 'baz',
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'baz' =>
array (
'dataType' => 'array of integers',
'actualType' => 'collection',
'subType' => 'integer',
'required' => false,
'default' => NULL,
'description' => 'Epic description.
With multiple lines.',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'circular' =>
array (
'dataType' => 'object (JmsNested)',
'actualType' => 'model',
'subType' => 'Nelmio\\ApiDocBundle\\Tests\\Fixtures\\Model\\JmsNested',
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'parent' =>
array (
'dataType' => 'object (JmsTest)',
'actualType' => 'model',
'subType' => 'Nelmio\\ApiDocBundle\\Tests\\Fixtures\\Model\\JmsTest',
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
'children' =>
array (
'foo' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'bar' =>
array (
'dataType' => 'DateTime',
'actualType' => 'datetime',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => true,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'number' =>
array (
'dataType' => 'double',
'actualType' => 'float',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'arr' =>
array (
'dataType' => 'array',
'actualType' => 'collection',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'nested' =>
array (
'dataType' => 'object (JmsNested)',
'actualType' => 'model',
'subType' => 'Nelmio\\ApiDocBundle\\Tests\\Fixtures\\Model\\JmsNested',
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'nested_array' =>
array (
'dataType' => 'array of objects (JmsNested)',
'actualType' => 'collection',
'subType' => 'Nelmio\\ApiDocBundle\\Tests\\Fixtures\\Model\\JmsNested',
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
),
),
'since' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => '0.2',
'untilVersion' => NULL,
),
'until' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => '0.3',
),
'since_and_until' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => '0.4',
'untilVersion' => '0.5',
),
),
),
'nested_array' =>
array (
'dataType' => 'array of objects (JmsNested)',
'actualType' => 'collection',
'subType' => 'Nelmio\\ApiDocBundle\\Tests\\Fixtures\\Model\\JmsNested',
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
),
),
),
'resourceDescription' => 'Operations on another resource.',
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
'views' => array(
'default',
'premium',
),
),
1 =>
array (
'method' => 'PUT|PATCH',
'uri' => '/api/other-resources/{id}.{_format}',
'description' => 'Update a resource bu ID.',
'requirements' =>
array (
'_format' =>
array (
'requirement' => 'json|xml|html',
'dataType' => '',
'description' => '',
),
'id' =>
array (
'requirement' => '',
'dataType' => '',
'description' => '',
),
),
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
),
),
'/api/resources' =>
array (
0 =>
array (
'method' => 'GET',
'uri' => '/api/resources.{_format}',
'description' => 'List resources.',
'requirements' =>
array (
'_format' =>
array (
'requirement' => 'json|xml|html',
'dataType' => '',
'description' => '',
),
),
'response' =>
array (
'tests' =>
array (
'dataType' => 'array of objects (Test)',
'subType' => 'Nelmio\\ApiDocBundle\\Tests\\Fixtures\\Model\\Test',
'actualType' => 'collection',
'readonly' => true,
'required' => true,
'default' => true,
'description' => '',
'children' =>
array (
'a' =>
array (
'default' => 'nelmio',
'actualType' => 'string',
'subType' => NULL,
'format' => '{length: min: foo}, {not blank}',
'required' => true,
'dataType' => 'string',
'readonly' => NULL,
),
'b' =>
array (
'default' => NULL,
'actualType' => 'datetime',
'subType' => NULL,
'dataType' => 'DateTime',
'readonly' => NULL,
'required' => NULL,
),
),
),
),
'statusCodes' =>
array (
200 =>
array (
0 => 'Returned on success.',
),
404 =>
array (
0 => 'Returned if resource cannot be found.',
),
),
'resourceDescription' => 'Operations on resource.',
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
'views' => array(
'test',
'premium',
'default',
),
),
1 =>
array (
'method' => 'POST',
'uri' => '/api/resources.{_format}',
'description' => 'Create a new resource.',
'parameters' =>
array (
'a' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'default' => NULL,
'required' => true,
'description' => 'Something that describes A.',
'readonly' => false,
),
'b' =>
array (
'dataType' => 'float',
'actualType' => 'float',
'subType' => NULL,
'default' => NULL,
'required' => true,
'description' => NULL,
'readonly' => false,
),
'c' =>
array (
'dataType' => 'choice',
'actualType' => 'choice',
'subType' => NULL,
'default' => NULL,
'required' => true,
'description' => NULL,
'readonly' => false,
'format' => '{"x":"X","y":"Y","z":"Z"}',
),
'd' =>
array (
'dataType' => 'datetime',
'actualType' => 'datetime',
'subType' => NULL,
'default' => NULL,
'required' => true,
'description' => NULL,
'readonly' => false,
),
'e' =>
array (
'dataType' => 'date',
'actualType' => 'date',
'subType' => NULL,
'default' => NULL,
'required' => true,
'description' => NULL,
'readonly' => false,
),
'g' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'default' => NULL,
'required' => true,
'description' => NULL,
'readonly' => false,
),
),
'requirements' =>
array (
'_format' =>
array (
'requirement' => 'json|xml|html',
'dataType' => '',
'description' => '',
),
),
'response' =>
array (
'foo' =>
array (
'dataType' => 'DateTime',
'actualType' => 'datetime',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => true,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'bar' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'required' => false,
'default' => 'baz',
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'baz' =>
array (
'dataType' => 'array of integers',
'actualType' => 'collection',
'subType' => 'integer',
'required' => false,
'default' => NULL,
'description' => 'Epic description.
With multiple lines.',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'circular' =>
array (
'dataType' => 'object (JmsNested)',
'actualType' => 'model',
'subType' => 'Nelmio\\ApiDocBundle\\Tests\\Fixtures\\Model\\JmsNested',
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
'children' =>
array (
'foo' =>
array (
'dataType' => 'DateTime',
'actualType' => 'datetime',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => true,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'bar' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'required' => false,
'default' => 'baz',
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'baz' =>
array (
'dataType' => 'array of integers',
'actualType' => 'collection',
'subType' => 'integer',
'required' => false,
'default' => NULL,
'description' => 'Epic description.
With multiple lines.',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'circular' =>
array (
'dataType' => 'object (JmsNested)',
'actualType' => 'model',
'subType' => 'Nelmio\\ApiDocBundle\\Tests\\Fixtures\\Model\\JmsNested',
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'parent' =>
array (
'dataType' => 'object (JmsTest)',
'actualType' => 'model',
'subType' => 'Nelmio\\ApiDocBundle\\Tests\\Fixtures\\Model\\JmsTest',
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
'children' =>
array (
'foo' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'bar' =>
array (
'dataType' => 'DateTime',
'actualType' => 'datetime',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => true,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'number' =>
array (
'dataType' => 'double',
'actualType' => 'float',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'arr' =>
array (
'dataType' => 'array',
'actualType' => 'collection',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'nested' =>
array (
'dataType' => 'object (JmsNested)',
'actualType' => 'model',
'subType' => 'Nelmio\\ApiDocBundle\\Tests\\Fixtures\\Model\\JmsNested',
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'nested_array' =>
array (
'dataType' => 'array of objects (JmsNested)',
'actualType' => 'collection',
'subType' => 'Nelmio\\ApiDocBundle\\Tests\\Fixtures\\Model\\JmsNested',
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
),
),
'since' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => '0.2',
'untilVersion' => NULL,
),
'until' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => '0.3',
),
'since_and_until' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => '0.4',
'untilVersion' => '0.5',
),
),
),
'parent' =>
array (
'dataType' => 'object (JmsTest)',
'actualType' => 'model',
'subType' => 'Nelmio\\ApiDocBundle\\Tests\\Fixtures\\Model\\JmsTest',
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
'children' =>
array (
'foo' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'bar' =>
array (
'dataType' => 'DateTime',
'actualType' => 'datetime',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => true,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'number' =>
array (
'dataType' => 'double',
'actualType' => 'float',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'arr' =>
array (
'dataType' => 'array',
'actualType' => 'collection',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'nested' =>
array (
'dataType' => 'object (JmsNested)',
'actualType' => 'model',
'subType' => 'Nelmio\\ApiDocBundle\\Tests\\Fixtures\\Model\\JmsNested',
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'nested_array' =>
array (
'dataType' => 'array of objects (JmsNested)',
'actualType' => 'collection',
'subType' => 'Nelmio\\ApiDocBundle\\Tests\\Fixtures\\Model\\JmsNested',
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
),
),
'since' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => '0.2',
'untilVersion' => NULL,
),
'until' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => '0.3',
),
'since_and_until' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => '0.4',
'untilVersion' => '0.5',
),
),
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
'views' => array(
'default',
'premium',
),
),
2 =>
array (
'method' => 'DELETE',
'uri' => '/api/resources/{id}.{_format}',
'description' => 'Delete a resource by ID.',
'requirements' =>
array (
'_format' =>
array (
'requirement' => 'json|xml|html',
'dataType' => '',
'description' => '',
),
'id' =>
array (
'requirement' => '',
'dataType' => '',
'description' => '',
),
),
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
),
3 =>
array (
'method' => 'GET',
'uri' => '/api/resources/{id}.{_format}',
'description' => 'Retrieve a resource by ID.',
'requirements' =>
array (
'_format' =>
array (
'requirement' => 'json|xml|html',
'dataType' => '',
'description' => '',
),
'id' =>
array (
'requirement' => '',
'dataType' => '',
'description' => '',
),
),
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
),
),
'/tests' =>
array (
0 =>
array (
'method' => 'GET',
'uri' => '/tests.{_format}',
'description' => 'index action',
'filters' =>
array (
'a' =>
array (
'dataType' => 'integer',
),
'b' =>
array (
'dataType' => 'string',
'arbitrary' =>
array (
0 => 'arg1',
1 => 'arg2',
),
),
),
'requirements' =>
array (
'_format' =>
array (
'requirement' => '',
'dataType' => '',
'description' => '',
),
),
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
),
1 =>
array (
'method' => 'GET',
'uri' => '/tests.{_format}',
'description' => 'index action',
'filters' =>
array (
'a' =>
array (
'dataType' => 'integer',
),
'b' =>
array (
'dataType' => 'string',
'arbitrary' =>
array (
0 => 'arg1',
1 => 'arg2',
),
),
),
'requirements' =>
array (
'_format' =>
array (
'requirement' => '',
'dataType' => '',
'description' => '',
),
),
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
),
2 =>
array (
'method' => 'POST',
'uri' => '/tests.{_format}',
'host' => 'api.test.dev',
'description' => 'create test',
'parameters' =>
array (
'a' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'default' => NULL,
'required' => true,
'description' => 'A nice description',
'readonly' => false,
),
'b' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'default' => NULL,
'required' => false,
'description' => NULL,
'readonly' => false,
),
'c' =>
array (
'dataType' => 'boolean',
'actualType' => 'boolean',
'subType' => NULL,
'default' => false,
'required' => true,
'description' => NULL,
'readonly' => false,
),
'd' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'default' => 'DefaultTest',
'required' => true,
'description' => NULL,
'readonly' => false,
),
),
'requirements' =>
array (
'_format' =>
array (
'requirement' => '',
'dataType' => '',
'description' => '',
),
),
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
'views' => array(
'default',
'premium',
),
),
3 =>
array (
'method' => 'POST',
'uri' => '/tests.{_format}',
'host' => 'api.test.dev',
'description' => 'create test',
'parameters' =>
array (
'a' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'default' => NULL,
'required' => true,
'description' => 'A nice description',
'readonly' => false,
),
'b' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'default' => NULL,
'required' => false,
'description' => NULL,
'readonly' => false,
),
'c' =>
array (
'dataType' => 'boolean',
'actualType' => 'boolean',
'subType' => NULL,
'default' => false,
'required' => true,
'description' => NULL,
'readonly' => false,
),
'd' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'default' => 'DefaultTest',
'required' => true,
'description' => NULL,
'readonly' => false,
),
),
'requirements' =>
array (
'_format' =>
array (
'requirement' => '',
'dataType' => '',
'description' => '',
),
),
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
'views' => array(
'default',
'premium',
),
),
),
'/tests2' =>
array (
0 =>
array (
'method' => 'POST',
'uri' => '/tests2.{_format}',
'description' => 'post test 2',
'requirements' =>
array (
'_format' =>
array (
'requirement' => '',
'dataType' => '',
'description' => '',
),
),
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
'views' => array(
'default',
'premium',
),
),
),
'TestResource' =>
array (
0 =>
array (
'method' => 'ANY',
'uri' => '/named-resource',
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
'views' => array(
'default',
),
),
),
'others' =>
array (
0 =>
array (
'method' => 'POST',
'uri' => '/another-post',
'description' => 'create another test',
'parameters' =>
array (
'dependency_type' =>
array (
'required' => true,
'readonly' => false,
'description' => '',
'default' => NULL,
'dataType' => 'object (dependency_type)',
'actualType' => 'model',
'subType' => 'dependency_type',
'children' =>
array (
'a' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'default' => NULL,
'required' => true,
'description' => 'A nice description',
'readonly' => false,
),
),
),
),
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
'views' => array(
'default',
'test',
),
),
1 =>
array (
'method' => 'ANY',
'uri' => '/any',
'description' => 'Action without HTTP verb',
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
),
2 =>
array (
'method' => 'ANY',
'uri' => '/any/{foo}',
'description' => 'Action without HTTP verb',
'requirements' =>
array (
'foo' =>
array (
'requirement' => '',
'dataType' => '',
'description' => '',
),
),
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
),
3 =>
array (
'method' => 'ANY',
'uri' => '/authenticated',
'https' => false,
'authentication' => true,
'authenticationRoles' =>
array (
0 => 'ROLE_USER',
1 => 'ROLE_FOOBAR',
),
'deprecated' => false,
),
4 =>
array (
'method' => 'POST',
'uri' => '/jms-input-test',
'description' => 'Testing JMS',
'parameters' =>
array (
'foo' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'bar' =>
array (
'dataType' => 'DateTime',
'actualType' => 'datetime',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => true,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'number' =>
array (
'dataType' => 'double',
'actualType' => 'float',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'arr' =>
array (
'dataType' => 'array',
'actualType' => 'collection',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'nested' =>
array (
'dataType' => 'object (JmsNested)',
'actualType' => 'model',
'subType' => 'Nelmio\\ApiDocBundle\\Tests\\Fixtures\\Model\\JmsNested',
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
'children' =>
array (
'foo' =>
array (
'dataType' => 'DateTime',
'actualType' => 'datetime',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => true,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'bar' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'required' => false,
'default' => 'baz',
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'baz' =>
array (
'dataType' => 'array of integers',
'actualType' => 'collection',
'subType' => 'integer',
'required' => false,
'default' => NULL,
'description' => 'Epic description.
With multiple lines.',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'circular' =>
array (
'dataType' => 'object (JmsNested)',
'actualType' => 'model',
'subType' => 'Nelmio\\ApiDocBundle\\Tests\\Fixtures\\Model\\JmsNested',
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'parent' =>
array (
'dataType' => 'object (JmsTest)',
'actualType' => 'model',
'subType' => 'Nelmio\\ApiDocBundle\\Tests\\Fixtures\\Model\\JmsTest',
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
'children' =>
array (
'foo' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'bar' =>
array (
'dataType' => 'DateTime',
'actualType' => 'datetime',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => true,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'number' =>
array (
'dataType' => 'double',
'actualType' => 'float',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'arr' =>
array (
'dataType' => 'array',
'actualType' => 'collection',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'nested' =>
array (
'dataType' => 'object (JmsNested)',
'actualType' => 'model',
'subType' => 'Nelmio\\ApiDocBundle\\Tests\\Fixtures\\Model\\JmsNested',
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'nested_array' =>
array (
'dataType' => 'array of objects (JmsNested)',
'actualType' => 'collection',
'subType' => 'Nelmio\\ApiDocBundle\\Tests\\Fixtures\\Model\\JmsNested',
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
),
),
'since' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => '0.2',
'untilVersion' => NULL,
),
'until' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => '0.3',
),
'since_and_until' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => '0.4',
'untilVersion' => '0.5',
),
),
),
'nested_array' =>
array (
'dataType' => 'array of objects (JmsNested)',
'actualType' => 'collection',
'subType' => 'Nelmio\\ApiDocBundle\\Tests\\Fixtures\\Model\\JmsNested',
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
),
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
),
5 =>
array (
'method' => 'GET',
'uri' => '/jms-return-test',
'description' => 'Testing return',
'response' =>
array (
'dependency_type' =>
array (
'required' => true,
'readonly' => false,
'description' => '',
'default' => NULL,
'dataType' => 'object (dependency_type)',
'actualType' => 'model',
'subType' => 'dependency_type',
'children' =>
array (
'a' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'default' => NULL,
'required' => true,
'description' => 'A nice description',
'readonly' => false,
),
),
),
),
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
),
6 =>
array (
'method' => 'ANY',
'uri' => '/my-commented/{id}/{page}/{paramType}/{param}',
'description' => 'This method is useful to test if the getDocComment works.',
'documentation' => 'This method is useful to test if the getDocComment works.
And, it supports multilines until the first \'@\' char.',
'requirements' =>
array (
'id' =>
array (
'dataType' => 'int',
'description' => 'A nice comment',
'requirement' => '',
),
'page' =>
array (
'dataType' => 'int',
'description' => '',
'requirement' => '',
),
'paramType' =>
array (
'dataType' => 'int',
'description' => 'The param type',
'requirement' => '',
),
'param' =>
array (
'dataType' => 'int',
'description' => 'The param id',
'requirement' => '',
),
),
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
),
7 =>
array (
'method' => 'GET',
'uri' => '/popos',
'description' => 'Retrieves the collection of Popo resources.',
'documentation' => 'Gets the collection.',
'response' =>
array (
'foo' =>
array (
'required' => false,
'description' => '',
'readonly' => false,
'dataType' => 'string',
),
),
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
'resourceDescription' => 'Popo',
'section' => 'Popo',
),
8 =>
array (
'method' => 'POST',
'uri' => '/popos',
'description' => 'Creates a Popo resource.',
'documentation' => 'Adds an element to the collection.',
'parameters' =>
array (
'foo' =>
array (
'required' => false,
'description' => '',
'readonly' => false,
'dataType' => 'string',
),
),
'response' =>
array (
'foo' =>
array (
'required' => false,
'description' => '',
'readonly' => false,
'dataType' => 'string',
),
),
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
'resourceDescription' => 'Popo',
'section' => 'Popo',
),
9 =>
array (
'method' => 'DELETE',
'uri' => '/popos/{id}',
'description' => 'Deletes the Popo resource.',
'documentation' => 'Deletes an element of the collection.',
'requirements' =>
array (
'id' =>
array (
'dataType' => 'string',
'description' => '',
'requirement' => '',
),
),
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
'resourceDescription' => 'Popo',
'section' => 'Popo',
),
10 =>
array (
'method' => 'GET',
'uri' => '/popos/{id}',
'description' => 'Retrieves Popo resource.',
'documentation' => 'Gets an element of the collection.',
'requirements' =>
array (
'id' =>
array (
'dataType' => 'int',
'description' => '',
'requirement' => '',
),
),
'response' =>
array (
'foo' =>
array (
'required' => false,
'description' => '',
'readonly' => false,
'dataType' => 'string',
),
),
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
'resourceDescription' => 'Popo',
'section' => 'Popo',
),
11 =>
array (
'method' => 'PUT',
'uri' => '/popos/{id}',
'description' => 'Replaces the Popo resource.',
'documentation' => 'Replaces an element of the collection.',
'parameters' =>
array (
'foo' =>
array (
'required' => false,
'description' => '',
'readonly' => false,
'dataType' => 'string',
),
),
'requirements' =>
array (
'id' =>
array (
'dataType' => 'string',
'description' => '',
'requirement' => '',
),
),
'response' =>
array (
'foo' =>
array (
'required' => false,
'description' => '',
'readonly' => false,
'dataType' => 'string',
),
),
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
'resourceDescription' => 'Popo',
'section' => 'Popo',
),
12 =>
array (
'method' => 'ANY',
'uri' => '/return-nested-output',
'response' =>
array (
'foo' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'bar' =>
array (
'dataType' => 'DateTime',
'actualType' => 'datetime',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => true,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'number' =>
array (
'dataType' => 'double',
'actualType' => 'float',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'arr' =>
array (
'dataType' => 'array',
'actualType' => 'collection',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'nested' =>
array (
'dataType' => 'object (JmsNested)',
'actualType' => 'model',
'subType' => 'Nelmio\\ApiDocBundle\\Tests\\Fixtures\\Model\\JmsNested',
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
'children' =>
array (
'foo' =>
array (
'dataType' => 'DateTime',
'actualType' => 'datetime',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => true,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'bar' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'required' => false,
'default' => 'baz',
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'baz' =>
array (
'dataType' => 'array of integers',
'actualType' => 'collection',
'subType' => 'integer',
'required' => false,
'default' => NULL,
'description' => 'Epic description.
With multiple lines.',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'circular' =>
array (
'dataType' => 'object (JmsNested)',
'actualType' => 'model',
'subType' => 'Nelmio\\ApiDocBundle\\Tests\\Fixtures\\Model\\JmsNested',
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'parent' =>
array (
'dataType' => 'object (JmsTest)',
'actualType' => 'model',
'subType' => 'Nelmio\\ApiDocBundle\\Tests\\Fixtures\\Model\\JmsTest',
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
'children' =>
array (
'foo' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'bar' =>
array (
'dataType' => 'DateTime',
'actualType' => 'datetime',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => true,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'number' =>
array (
'dataType' => 'double',
'actualType' => 'float',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'arr' =>
array (
'dataType' => 'array',
'actualType' => 'collection',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'nested' =>
array (
'dataType' => 'object (JmsNested)',
'actualType' => 'model',
'subType' => 'Nelmio\\ApiDocBundle\\Tests\\Fixtures\\Model\\JmsNested',
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'nested_array' =>
array (
'dataType' => 'array of objects (JmsNested)',
'actualType' => 'collection',
'subType' => 'Nelmio\\ApiDocBundle\\Tests\\Fixtures\\Model\\JmsNested',
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
),
),
'since' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => '0.2',
'untilVersion' => NULL,
),
'until' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => '0.3',
),
'since_and_until' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => '0.4',
'untilVersion' => '0.5',
),
),
),
'nested_array' =>
array (
'dataType' => 'array of objects (JmsNested)',
'actualType' => 'collection',
'subType' => 'Nelmio\\ApiDocBundle\\Tests\\Fixtures\\Model\\JmsNested',
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
),
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
),
13 =>
array (
'method' => 'ANY',
'uri' => '/secure-route',
'https' => true,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
),
14 =>
array (
'method' => 'ANY',
'uri' => '/yet-another/{id}',
'requirements' =>
array (
'id' =>
array (
'requirement' => '\\d+',
'dataType' => '',
'description' => '',
),
),
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
),
15 =>
array (
'method' => 'GET',
'uri' => '/z-action-with-deprecated-indicator',
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => true,
),
16 =>
array (
'method' => 'POST',
'uri' => '/z-action-with-nullable-request-param',
'parameters' =>
array (
'param1' =>
array (
'required' => false,
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'description' => 'Param1 description.',
'readonly' => false,
),
),
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
),
17 =>
array (
'method' => 'GET',
'uri' => '/z-action-with-query-param',
'filters' =>
array (
'page' =>
array (
'requirement' => '\\d+',
'description' => 'Page of the overview.',
'default' => '1',
),
),
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
),
18 =>
array (
'method' => 'GET',
'uri' => '/z-action-with-query-param-no-default',
'filters' =>
array (
'page' =>
array (
'requirement' => '\\d+',
'description' => 'Page of the overview.',
),
),
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
),
19 =>
array (
'method' => 'GET',
'uri' => '/z-action-with-query-param-strict',
'requirements' =>
array (
'page' =>
array (
'requirement' => '\\d+',
'dataType' => '',
'description' => 'Page of the overview.',
),
),
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
),
20 =>
array (
'method' => 'POST',
'uri' => '/z-action-with-request-param',
'parameters' =>
array (
'param1' =>
array (
'required' => true,
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'description' => 'Param1 description.',
'readonly' => false,
),
),
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
),
21 =>
array (
'method' => 'ANY',
'uri' => '/z-return-jms-and-validator-output',
'response' =>
array (
'bar' =>
array (
'default' => NULL,
'actualType' => 'datetime',
'subType' => NULL,
'dataType' => 'DateTime',
'readonly' => NULL,
'required' => NULL,
),
'objects' =>
array (
'default' => NULL,
'actualType' => 'collection',
'subType' => 'Nelmio\\ApiDocBundle\\Tests\\Fixtures\\Model\\Test',
'dataType' => 'array of objects (Test)',
'children' =>
array (
'a' =>
array (
'default' => 'nelmio',
'actualType' => 'string',
'subType' => NULL,
'format' => '{length: min: foo}, {not blank}',
'required' => true,
'dataType' => 'string',
'readonly' => NULL,
),
'b' =>
array (
'default' => NULL,
'actualType' => 'datetime',
'subType' => NULL,
'dataType' => 'DateTime',
'readonly' => NULL,
'required' => NULL,
),
),
'readonly' => NULL,
'required' => NULL,
),
'number' =>
array (
'dataType' => 'DateTime',
'actualType' => 'datetime',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'related' =>
array (
'dataType' => 'object (Test)',
'actualType' => 'model',
'subType' => 'Nelmio\\ApiDocBundle\\Tests\\Fixtures\\Model\\Test',
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
'children' =>
array (
'a' =>
array (
'default' => 'nelmio',
'actualType' => 'string',
'subType' => NULL,
'format' => '{length: min: foo}, {not blank}',
'required' => true,
'dataType' => 'string',
'readonly' => NULL,
),
'b' =>
array (
'default' => NULL,
'actualType' => 'datetime',
'subType' => NULL,
'dataType' => 'DateTime',
'readonly' => NULL,
'required' => NULL,
),
),
),
),
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
),
22 =>
array (
'method' => 'ANY',
'uri' => '/z-return-selected-parsers-input',
'parameters' =>
array (
'a' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'default' => NULL,
'required' => true,
'description' => 'A nice description',
'readonly' => false,
),
'b' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'default' => NULL,
'required' => false,
'description' => NULL,
'readonly' => false,
),
'c' =>
array (
'dataType' => 'boolean',
'actualType' => 'boolean',
'subType' => NULL,
'default' => false,
'required' => true,
'description' => NULL,
'readonly' => false,
),
'd' =>
array (
'dataType' => 'string',
'actualType' => 'string',
'subType' => NULL,
'default' => 'DefaultTest',
'required' => true,
'description' => NULL,
'readonly' => false,
),
),
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
),
23 =>
array (
'method' => 'ANY',
'uri' => '/z-return-selected-parsers-output',
'response' =>
array (
'bar' =>
array (
'default' => NULL,
'actualType' => 'datetime',
'subType' => NULL,
'dataType' => 'DateTime',
'readonly' => NULL,
'required' => NULL,
),
'objects' =>
array (
'default' => NULL,
'actualType' => 'collection',
'subType' => 'Nelmio\\ApiDocBundle\\Tests\\Fixtures\\Model\\Test',
'dataType' => 'array of objects (Test)',
'children' =>
array (
'a' =>
array (
'default' => 'nelmio',
'actualType' => 'string',
'subType' => NULL,
'format' => '{length: min: foo}, {not blank}',
'required' => true,
'dataType' => 'string',
'readonly' => NULL,
),
'b' =>
array (
'default' => NULL,
'actualType' => 'datetime',
'subType' => NULL,
'dataType' => 'DateTime',
'readonly' => NULL,
'required' => NULL,
),
),
'readonly' => NULL,
'required' => NULL,
),
'number' =>
array (
'dataType' => 'DateTime',
'actualType' => 'datetime',
'subType' => NULL,
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
),
'related' =>
array (
'dataType' => 'object (Test)',
'actualType' => 'model',
'subType' => 'Nelmio\\ApiDocBundle\\Tests\\Fixtures\\Model\\Test',
'required' => false,
'default' => NULL,
'description' => '',
'readonly' => false,
'sinceVersion' => NULL,
'untilVersion' => NULL,
'children' =>
array (
'a' =>
array (
'default' => 'nelmio',
'actualType' => 'string',
'subType' => NULL,
'format' => '{length: min: foo}, {not blank}',
'required' => true,
'dataType' => 'string',
'readonly' => NULL,
),
'b' =>
array (
'default' => NULL,
'actualType' => 'datetime',
'subType' => NULL,
'dataType' => 'DateTime',
'readonly' => NULL,
'required' => NULL,
),
),
),
),
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
),
24 =>
array (
'method' => 'POST',
'uri' => '/zcached',
'cache' => 60,
'https' => false,
'authentication' => false,
'authenticationRoles' =>
array (
),
'deprecated' => false,
),
25 =>
array (
'method' => 'POST',
'uri' => '/zsecured',
'https' => false,
'authentication' => true,
'authenticationRoles' =>
array (
),
'deprecated' => false,
),
),
);
} else {
Fix tests (introduce result files to make things a bit more readable)
2015-10-23 10:36:53 +02:00
$expected = require __DIR__ . '/testFormat-result-no-dunglas.php';
Revert "Fix test related to DungleApiBundle. Remove some of them." This reverts commit e66fb209b56e7937647fae39e64b6218efa62e1e.
2015-10-23 10:11:52 +02:00
}
Fix tests (introduce result files to make things a bit more readable)
2015-10-23 10:36:53 +02:00
$this->assertEquals($expected, $result);
Revert "Fix test related to DungleApiBundle. Remove some of them." This reverts commit e66fb209b56e7937647fae39e64b6218efa62e1e.
2015-10-23 10:11:52 +02:00
}
Added more tests
2012-04-13 15:00:46 +02:00
public function testFormatOne()
{
$container = $this->getContainer();
Refactoring Move logic to extract data in the Extractor Remove logic in the AbstractFormatter Use ApiDoc class as data container Update tests Add test to prove the bug with FOSRestBundle annotations (\\d+ instead of \d+)
2012-07-20 00:58:58 +02:00
$extractor = $container->get('nelmio_api_doc.extractor.api_doc_extractor');
$annotation = $extractor->get('Nelmio\ApiDocBundle\Tests\Fixtures\Controller\TestController::indexAction', 'test_route_1');
$result = $container->get('nelmio_api_doc.formatter.simple_formatter')->formatOne($annotation);
Added more tests
2012-04-13 15:00:46 +02:00
$expected = array(
'method' => 'GET',
Remove .{_format} from routes used for resource grouping
2012-08-10 11:38:01 +02:00
'uri' => '/tests.{_format}',
Added more tests
2012-04-13 15:00:46 +02:00
'filters' => array(
'a' => array(
'dataType' => 'integer',
),
'b' => array(
'dataType' => 'string',
'arbitrary' => array(
'arg1',
'arg2',
),
),
),
Remove .{_format} from routes used for resource grouping
2012-08-10 11:38:01 +02:00
'description' => 'index action',
'requirements' => array(
Fix tests
2012-11-17 18:05:05 +01:00
'_format' => array('dataType' => '', 'description' => '', 'requirement' => ''),
Remove .{_format} from routes used for resource grouping
2012-08-10 11:38:01 +02:00
),
Added padlock icon for secure routes This fixes #115 - Added an https property to the annotation - Added glyphicon padlock icon - Updated Templates - Updated Unit tests
2012-12-10 10:21:04 -08:00
'https' => false,
adding 'authentication' attribute
2012-12-26 12:23:28 +01:00
'authentication' => false,
`authenticationRoles` can be set to appear in the tooltip of the key icon for API calls that require authentication.
2013-06-24 14:27:22 +02:00
'authenticationRoles' => array(),
'deprecated' => false,
Added more tests
2012-04-13 15:00:46 +02:00
);
$this->assertEquals($expected, $result);
}
Add basic tests
2012-04-13 14:11:54 +02:00
}
Reference in New Issue Copy Permalink