Skip to content
Snippets Groups Projects
Commit 2f5ecac1 authored by Reiter, Christoph's avatar Reiter, Christoph :snake:
Browse files

Document the bundle config and add it to the README

parent 9774b4c7
No related branches found
No related tags found
No related merge requests found
Pipeline #55046 passed
# DBP API-Core-Bundle
# DBP Relay Core Bundle
[GitLab](https://packagist.org/packages/dbp/api-core-bundle) | [Packagist](https://packagist.org/packages/dbp/api-core-bundle)
[GitLab](https://gitlab.tugraz.at/dbp/relay/dbp-relay-core-bundle) | [Packagist](https://packagist.org/packages/dbp/relay-core-bundle)
This Symfony bundle contains components required by all DBP bundles.
## Bundle Config
Created via `./bin/console config:dump-reference DbpRelayCoreBundle | sed '/^$/d'`
```yaml
# Default configuration for "DbpRelayCoreBundle"
dbp_relay_core:
# Some string identifying the current build (commit hash)
build_info: ~ # Example: deadbeef
# Some URL identifying the current build (URL to the commit on some git web interface)
build_info_url: ~ # Example: 'https://gitlab.example.com/project/-/commit/deadbeef'
# The title text of the API docs page
docs_title: 'Relay API Gateway'
# The description text of the API docs page (supports markdown)
docs_description: '*part of the [Digital Blueprint](https://gitlab.tugraz.at/dbp) project*'
```
\ No newline at end of file
......@@ -11,15 +11,23 @@ class Configuration implements ConfigurationInterface
{
public function getConfigTreeBuilder()
{
$treeBuilder = new TreeBuilder('dbp_core');
$treeBuilder = new TreeBuilder('dbp_relay_core');
$treeBuilder->getRootNode()
->children()
->scalarNode('build_info')->end()
->scalarNode('build_info_url')->end()
->scalarNode('build_info')
->info('Some string identifying the current build (commit hash)')
->example('deadbeef')
->end()
->scalarNode('build_info_url')
->info('Some URL identifying the current build (URL to the commit on some git web interface)')
->example('https://gitlab.example.com/project/-/commit/deadbeef')
->end()
->scalarNode('docs_title')
->info('The title text of the API docs page')
->defaultValue('Relay API Gateway')
->end()
->scalarNode('docs_description') // This supports markdown
->scalarNode('docs_description')
->info('The description text of the API docs page (supports markdown)')
->defaultValue('*part of the [Digital Blueprint](https://gitlab.tugraz.at/dbp) project*')
->end()
->end();
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment