Skip to content
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

Jump to bottom

docs: update symfony_attributes.rst with info about required library #2289

Closed
wants to merge 1 commit into from
Closed

docs: update symfony_attributes.rst with info about required library #2289

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
11 changes: 11 additions & 0 deletions docs/symfony_attributes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,17 @@ NelmioApiDocBundle has the ability to automatically create documentation from **
MapQueryString
-------------------------------

Install required component

.. code-block:: terminal

$ composer require symfony/property-access
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you mean the property-info component instead of property-access. property-access isn't used anywhere in this project.

Also symfony/property-info should be installed together with this project because it's required in package.json https://github.com/nelmio/NelmioApiDocBundle/blob/9379c44da4b4e6ef36a81f3135d3d158838a7c16/composer.json#L29C10-L29C31


.. include:: /components/require_autoload.rst.inc

Usage
-----

Using the `Symfony MapQueryString`_ attribute allows NelmioApiDocBundle to automatically generate your query parameter documentation for your endpoint from your object.

.. versionadded:: 6.3
Expand Down
Loading