RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-03-12 18:46:10 +03:00
Code Issues Projects Releases Wiki Activity

Fix links

Browse Source
This commit is contained in:
Guilhem N 2018-01-09 13:22:28 +01:00 committed by GitHub
parent 43dbc10137
commit 605cc84a3f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Resources/doc/index.rst
View File

@ -95,7 +95,7 @@ Using the bundle
---------------- ----------------
You can configure global information in the bundle configuration ``documentation.info`` section (take a look at You can configure global information in the bundle configuration ``documentation.info`` section (take a look at
[the Swagger specification](http://swagger.io/specification/) to know the fields `the Swagger specification`_ to know the fields
available): available):
.. code-block:: yaml .. code-block:: yaml
@ -107,6 +107,8 @@ available):
description: This is an awesome app! description: This is an awesome app!
version: 1.0.0 version: 1.0.0
.. _`The Swagger specification`: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md
.. note:: .. note::
If you're using Flex, this config is there by default. Don't forget to adapt it to your app! If you're using Flex, this config is there by default. Don't forget to adapt it to your app!
@ -227,10 +229,8 @@ It has two options:
If you're not using the JMS Serializer If you're not using the JMS Serializer
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The [Symfony PropertyInfo component](https://symfony.com/doc/current/components/property_info.html) The `Symfony PropertyInfo component`_ is used to describe your models. It supports doctrine annotations, type hints,
is used to describe your models. It supports doctrine annotations, type hints, and even PHP doc blocks as long as you required the ``phpdocumentor/reflection-docblock`` library. It does also support
and even PHP doc blocks as long as you required the
``phpdocumentor/reflection-docblock`` library. It does also support
serialization groups when using the Symfony serializer. serialization groups when using the Symfony serializer.
If you're using the JMS Serializer If you're using the JMS Serializer
@ -240,7 +240,7 @@ The metadata of the JMS serializer are used by default to describe your
models. Additional information is extracted from the PHP doc block comment, models. Additional information is extracted from the PHP doc block comment,
but the property types must be specified in the JMS annotations. but the property types must be specified in the JMS annotations.
In case you prefer using the [Symfony PropertyInfo component](https://symfony.com/doc/current/components/property_info.html) (you In case you prefer using the `Symfony PropertyInfo component`_ (you
won't be able to use JMS serialization groups), you can disable JMS serializer won't be able to use JMS serialization groups), you can disable JMS serializer
support in your config: support in your config:
@ -258,3 +258,5 @@ If you need more complex features, take a look at:
:maxdepth: 1 :maxdepth: 1
areas areas
.. _`Symfony PropertyInfo component`: https://symfony.com/doc/current/components/property_info.html