82 Commits

Author SHA1 Message Date
Quentin Stoeckel
1e9585a415 faq.rst: enhance readability in symfony.com docs (#1420)
It may be a bit less readable on GitHub though.
2018-10-31 16:34:46 +01:00
Quentin Stoeckel
6c6a04bba7 Various documentation enhancements (#1423) 2018-10-31 16:33:06 +01:00
Quentin Stoeckel
48aaca92e3 Fix NelmioApiDocBundle view customization instructions (#1419)
* Fix NelmioApiDocBundle view customization instructions

"Just create a file..." was not OK (missing views/ subdirectory, wrong SwaggerUi case)
The path showcased as code-block's first row was OK

* View customization instructions: remove unnecessary /views/ subdirectory
2018-10-19 20:11:39 +02:00
Guilhem N
31ae375ab5
Make sure alternative names use the exact names specified (#1384)
* Make sure alternative names use the exact name specified

* Document the feature

* Cs
2018-08-26 22:15:44 +02:00
Aurélien Fontaine
c98f43164e
Fix path for template extension 2018-08-13 09:05:06 +02:00
David Buchmann
ca118c0fcc
complete example for template in faq 2018-07-16 14:15:27 +02:00
Markus Poerschke
c771c684a8 Customizable template and remove Google Fonts (#1357)
* Allow to override certain parts of the template

* Twig template can be defined via config
* Blocks can be used to override/extend only parts of the template

* Fix spelling in documentation

* Fix extension configuration tree

* Fix unit tests by making constructor argument optional

* Add fonts block and split swagger initialization into own block

* Fix code style

* Remove Google fonts, remove configuration and add changelog entry

* Remove template argument from service definition

* Add correct path for overriding template

* Move re-add of Google Fonts to FAQ section in documentation.

* Remove unused class import
2018-07-16 09:45:18 +02:00
Asmir Mustafic
ab005c4129 Implement alternative naming system via configuration (#1312)
* implement alternative naming system via configuration

* use strict comparison

* test di configs

* rever

* test naming aliases are applied

* set "default" as default area

* test names are passed to generators

* cs formatting

* added extra check for built-int types

* cs

* added documentation about alternative names

* allow to create the same alias in two different areas

* document and test better aliasing strategy

* specify that the last matching rule is used

* Make last matching rule wins

* Fix documentation
2018-06-10 09:56:38 +02:00
Guilhem N
9adca90e45
Merge pull request #1316 from dbu/faq
add more entries to the faq
2018-05-10 17:26:29 +02:00
Ondřej Machulda
83de823e77
Fix Model annotation example in docs (fixes #1318) 2018-05-09 17:12:17 +02:00
David Buchmann
d0e16d6001 adjust to feedback 2018-05-08 08:08:20 +02:00
David Buchmann
16fa7cf618 add more entries to the faq 2018-05-07 10:05:03 +02:00
Asmir Mustafic
4253ff6b67 Merge pull request #1277 from goetas/bazinga-hateoas
Add basic BazingaHateoasBundle support
2018-05-05 14:49:17 +02:00
Jean-Philippe Dépigny
6a039bfe62
Fix typo
Add backslash in `use Nelmio\ApiDocBundle\Annotation\Model;`
2018-04-10 11:17:11 +02:00
Guilhem N
0a946c5529
Typo 2018-04-04 22:10:42 +02:00
Guilhem N
c8a5fb0ecc
Merge pull request #1263 from nelmio/in-object-model
Support ``@Model`` in in-object annotations
2018-03-24 10:03:36 +01:00
Guilhem N
1c14bfeecb
Fix a link 2018-03-23 15:52:39 +01:00
Guilhem Niot
8026ff46eb Support `@Model` in in-object annotations 2018-03-22 19:14:01 +01:00
Guilhem N
61cda0161c
Merge pull request #1261 from nelmio/model
Support @Model through `ref`
2018-03-22 19:05:23 +01:00
Guilhem Niot
9bf00b5196 Support @Model through ref 2018-03-22 18:37:29 +01:00
Javier Spagnoletti
c8be7ebf15 [Documentation] Add some examples about undocumented properties and annotations 2018-03-19 14:44:15 -03:00
Javier Spagnoletti
ec851ca65c Allow to filter routes by host (#1121) 2018-03-17 10:37:54 -03:00
Guilhem N
37dfb8ef0d Document how to customize models documentation (#1237) 2018-02-20 09:59:00 +01:00
Roman Borysenko
c048adf7b7 Update index.rst (#1223)
* Update index.rst

* Create faq.rst

Frequently Asked Questions added

* Update faq.rst

* Update index.rst

Comment removed

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst

* Update index.rst
2018-02-13 17:13:09 +01:00
Guilhem N
4d95dde523
Make the docs clearer about models (#1185)
* Make the docs clearer about models

* Fixes
2018-01-13 13:21:23 +01:00
Guilhem N
c89ca38496
Several doc fixes 2018-01-10 14:45:02 +01:00
Guilhem N
605cc84a3f
Fix links 2018-01-09 13:22:28 +01:00
Guilhem N
43dbc10137
Fix links 2018-01-09 12:58:52 +01:00
David Buchmann
c30fb4c984
Provide example for action summary and description 2018-01-09 10:31:38 +01:00
Guilhem N
393a6c061e
Add areas support (#1169)
* Add areas support

* Document the Areas feature

* Allow to expose swagger area as JSON

* Fixes

* last fixes
2018-01-05 13:08:02 +01:00
Guilhem Niot
108687ec8e Fixes 2018-01-04 17:47:47 +01:00
Guilhem Niot
044935aff8 Rework the docs 2018-01-04 14:33:02 +01:00