Skip to content

Make title and description config parameters optional #560

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 3, 2016
Merged

Make title and description config parameters optional #560

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ public function getConfigTreeBuilder()

$rootNode
->children()
->scalarNode('title')->cannotBeEmpty()->isRequired()->info('The title of the API.')->end()
->scalarNode('description')->cannotBeEmpty()->isRequired()->info('The description of the API.')->end()
->scalarNode('title')->defaultValue('')->info('The title of the API.')->end()
->scalarNode('description')->defaultValue('')->info('The description of the API.')->end()
->arrayNode('supported_formats')
->defaultValue(['jsonld' => ['mime_types' => ['application/ld+json']]])
->info('The list of enabled formats. The first one will be the default.')
Expand Down
63 changes: 15 additions & 48 deletions src/Hydra/ApiDocumentationBuilder.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,57 +29,18 @@
*/
final class ApiDocumentationBuilder implements ApiDocumentationBuilderInterface
{
/**
* @var ResourceNameCollectionFactoryInterface
*/
private $resourceNameCollectionFactory;

/**
* @var ResourceMetadataFactoryInterface
*/
private $resourceMetadataFactory;

/**
* @var PropertyNameCollectionFactoryInterface
*/
private $propertyNameCollectionFactory;

/**
* @var PropertyMetadataFactoryInterface
*/
private $propertyMetadataFactory;

/**
* @var ContextBuilderInterface
*/
private $contextBuilder;

/**
* @var ResourceClassResolverInterface
*/
private $resourceClassResolver;

/**
* @var OperationMethodResolverInterface
*/
private $operationMethodResolver;

/**
* @var UrlGeneratorInterface
*/
private $urlGenerator;

/**
* @var string
*/
private $title;

/**
* @var string
*/
private $description;

public function __construct(ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, ResourceMetadataFactoryInterface $resourceMetadataFactory, PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, ContextBuilderInterface $contextBuilder, ResourceClassResolverInterface $resourceClassResolver, OperationMethodResolverInterface $operationMethodResolver, UrlGeneratorInterface $urlGenerator, string $title, string $description)
public function __construct(ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, ResourceMetadataFactoryInterface $resourceMetadataFactory, PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, ContextBuilderInterface $contextBuilder, ResourceClassResolverInterface $resourceClassResolver, OperationMethodResolverInterface $operationMethodResolver, UrlGeneratorInterface $urlGenerator, string $title = '', string $description = '')
{
$this->resourceNameCollectionFactory = $resourceNameCollectionFactory;
$this->resourceMetadataFactory = $resourceMetadataFactory;
Expand Down Expand Up @@ -275,14 +236,20 @@ public function getApiDocumentation()
],
];

return [
'@context' => $this->getContext(),
'@id' => $this->urlGenerator->generate('api_hydra_vocab'),
'hydra:title' => $this->title,
'hydra:description' => $this->description,
'hydra:entrypoint' => $this->urlGenerator->generate('api_jsonld_entrypoint'),
'hydra:supportedClass' => $classes,
];
$doc = ['@context' => $this->getContext(), '@id' => $this->urlGenerator->generate('api_hydra_vocab')];

if ('' !== $this->title) {
$doc['hydra:title'] = $this->title;
}

if ('' !== $this->description) {
$doc['hydra:description'] = $this->description;
}

$doc['hydra:entrypoint'] = $this->urlGenerator->generate('api_jsonld_entrypoint');
$doc['hydra:supportedClass'] = $classes;

return $doc;
}

/**
Expand Down