diff --git a/Resources/doc/areas.rst b/Resources/doc/areas.rst index e1f0f08..ca0696c 100644 --- a/Resources/doc/areas.rst +++ b/Resources/doc/areas.rst @@ -40,7 +40,7 @@ Then update your routing to be able to access your different documentations: .. code-block:: yaml - # app/config/routing.yml + # app/config/routing.yaml app.swagger_ui: path: /api/doc/{area} methods: GET diff --git a/Resources/doc/commands.rst b/Resources/doc/commands.rst index 67ab295..fb54519 100644 --- a/Resources/doc/commands.rst +++ b/Resources/doc/commands.rst @@ -5,7 +5,7 @@ A command is provided in order to dump the documentation in ``json``, ``yaml`` o .. code-block:: bash - $ php app/console nelmio:apidoc:dump [--format="..."] + $ php bin/console nelmio:apidoc:dump [--format="..."] The ``--format`` option allows to choose the format (default is: ``json``). @@ -14,20 +14,20 @@ without whitespace, use the ``--no-pretty`` option. .. code-block:: bash - $ php app/console nelmio:apidoc:dump --format=json > json-pretty-formatted.json - $ php app/console nelmio:apidoc:dump --format=json --no-pretty > json-no-pretty.json + $ php bin/console nelmio:apidoc:dump --format=json > json-pretty-formatted.json + $ php bin/console nelmio:apidoc:dump --format=json --no-pretty > json-no-pretty.json Every format can override API url. Useful if static documentation is not hosted on API url: .. code-block:: bash - $ php app/console nelmio:apidoc:dump --format=yaml --server-url "http://example.com/api" > api.yaml + $ php bin/console nelmio:apidoc:dump --format=yaml --server-url "http://example.com/api" > api.yaml For example to generate a static version of your documentation you can use: .. code-block:: bash - $ php app/console nelmio:apidoc:dump --format=html > api.html + $ php bin/console nelmio:apidoc:dump --format=html > api.html By default, the generated HTML will add the sandbox feature. If you want to generate a static version of your documentation without sandbox, @@ -40,6 +40,6 @@ or configure UI configuration, use the ``--html-config`` option. .. code-block:: bash - $ php app/console nelmio:apidoc:dump --format=html --html-config '{"assets_mode":"offline","server_url":"https://example.com","swagger_ui_config":{"supportedSubmitMethods":[]}}' > api.html + $ php bin/console nelmio:apidoc:dump --format=html --html-config '{"assets_mode":"offline","server_url":"https://example.com","swagger_ui_config":{"supportedSubmitMethods":[]}}' > api.html .. _`configure Swagger UI`: https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/ diff --git a/Resources/doc/faq.rst b/Resources/doc/faq.rst index 439dfb5..53c901c 100644 --- a/Resources/doc/faq.rst +++ b/Resources/doc/faq.rst @@ -10,7 +10,7 @@ A: You can configure ``schemas`` in the nelmio_api_doc configuration and then re .. code-block:: yaml - # config/nelmio_api_doc.yml + # config/nelmio_api_doc.yaml nelmio_api_doc: documentation: components: @@ -125,7 +125,7 @@ If you have not set up this script, you can manually execute this command: .. code-block:: bash - $ bin/console assets:install --symlink + $ php bin/console assets:install --symlink Re-add Google Fonts ------------------- @@ -194,7 +194,7 @@ A: Use ``@OA\Tag`` annotation. */ class BookmarkController extends AbstractFOSRestController implements ContextPresetInterface { - //... + // ... } Disable Default Section diff --git a/Resources/doc/index.rst b/Resources/doc/index.rst index 6bc43bd..69873b7 100644 --- a/Resources/doc/index.rst +++ b/Resources/doc/index.rst @@ -8,7 +8,7 @@ What's supported? ----------------- This bundle supports *Symfony* route requirements, PHP annotations, `Swagger-Php`_ annotations, -`FOSRestBundle`_ annotations and apps using `Api-Platform`_. +`FOSRestBundle`_ annotations and applications using `Api-Platform`_. .. _`Swagger-Php`: https://github.com/zircote/swagger-php .. _`FOSRestBundle`: https://github.com/FriendsOfSymfony/FOSRestBundle @@ -145,8 +145,8 @@ To document your routes, you can use the SwaggerPHP annotations and the namespace AppBundle\Controller; - use AppBundle\Entity\User; use AppBundle\Entity\Reward; + use AppBundle\Entity\User; use Nelmio\ApiDocBundle\Annotation\Model; use Nelmio\ApiDocBundle\Annotation\Security; use OpenApi\Annotations as OA; @@ -187,8 +187,8 @@ To document your routes, you can use the SwaggerPHP annotations and the namespace AppBundle\Controller; - use AppBundle\Entity\User; use AppBundle\Entity\Reward; + use AppBundle\Entity\User; use Nelmio\ApiDocBundle\Annotation\Model; use Nelmio\ApiDocBundle\Annotation\Security; use OpenApi\Attributes as OA; @@ -225,7 +225,7 @@ To document your routes, you can use the SwaggerPHP annotations and the } -The normal PHPdoc block on the controller method is used for the summary and description. +The normal PHPDoc block on the controller method is used for the summary and description. .. tip:: diff --git a/Resources/doc/security.rst b/Resources/doc/security.rst index a812e59..aa743ea 100644 --- a/Resources/doc/security.rst +++ b/Resources/doc/security.rst @@ -24,7 +24,7 @@ This will add the Bearer security policy to all registered paths. Overriding Specific Paths ------------------------- -The security policy can be overriden for a path using the ``@Security`` annotation. +The security policy can be overridden for a path using the ``@Security`` annotation. .. code-block:: php diff --git a/UPGRADE-3.0.md b/UPGRADE-3.0.md index a39c300..f720e27 100644 --- a/UPGRADE-3.0.md +++ b/UPGRADE-3.0.md @@ -230,7 +230,7 @@ class SwaggerDocblockConvertCommand extends ContainerAwareCommand Then open a command console, enter your project directory and run: ``` -bin/console api:doc:convert +php bin/console api:doc:convert ``` Your annotations should all be converted.