61 Commits

Author SHA1 Message Date
Jack Cutting
9545a0ce52 Allow security policies to be removed using the Security annotation by passing it a name of null. 2022-01-26 17:33:35 +00:00
Guilhem Niot
a184cb8ef4
Fix deprecations (#1923) 2021-12-11 14:19:43 +01:00
jeremy
0ed76d7d24
Add Location of Original Template (#1897)
This doc page advises that one can `have a look at the original template to see which blocks can be overridden`, but does not say where the original template can be found.  This edit adds that information so that users don't have to resort to searching for keywords (like I just had to).

Note that I haven't run any tests as this is a docs-only change.
2021-11-04 00:13:42 +01:00
Guilhem Niot
200ec0fdcb Merge branch '3.x' 2021-11-04 00:06:42 +01:00
Quentin Stoeckel
653a1f1776
Fix path to index.html.twig in documentation (#1883)
This fixes a minor typo in [*Re-add Google Fonts* part of the documentation](https://symfony.com/bundles/NelmioApiDocBundle/current/faq.html#re-add-google-fonts): using an uppercase `i` breaks template override.
2021-10-06 19:29:54 +02:00
Frederik Holz
aa18c6c83b
[3.x]: Hide the default section per area with new config parameter (#1868)
* Add new config node disable_default_routes to prevent registering RouteDescriber to specific areas which allowes disabling rendering of default routes, Adjust tests accordingly

* Add documentation for new config variable

* Change disable_default_routes to filter route collection instead of disabling route describer, Add test for new handling in FilteredRouteCollectionBuilder

* Change naming of matching method for disabling default routes

* Fix codestyle issue

* Fix codestyle issue

* Change naming of dataProvider to match testing name

Co-authored-by: Frederik Holz <team-orange@auxmoney.com>
2021-10-06 19:28:59 +02:00
Mathieu Ducrot
1306106931
Update templates comment path for bundle override (#1864)
## Changelog

Fix the comment path from SwaggerUI to SwaggerUi since case does matter for template override to work.
2021-08-23 12:06:14 +02:00
Zdeněk Drahoš
1a21f1855e Enable overriding server url for yaml and json export from console 2021-07-29 12:22:54 +02:00
Zdeněk Drahoš
1b9be28ad6 Enable dumping docs to yaml 2021-07-29 11:57:00 +02:00
Zdeněk Drahoš
5124f07ece Enable dumping html docs with cdn and offline assets 2021-06-27 09:24:35 +02:00
Javier Eguiluz
5232463cad
[Doc] Fix some minor RST issues 2021-07-16 17:39:22 +02:00
Javier Eguiluz
d107dc6dd6
[Doc] Fix a minor syntax issue (#1846) 2021-07-09 19:03:13 +02:00
Victor Passapera
730feba2d9 Updates documentation to show a side effect of design decision.
When using serializer context groups in JMS serializer, even if just using the Default group in one place explicitly and leaving it blank in another, they will be treated as different component schemas, even though to the serializer outcome they are the same.

Documenting behavior of decision with side effect.
2021-05-30 21:00:03 -07:00
Alexandru Năstase
9b258b10bb Add extra name_patterns example to areas docs
Add an extra `name_patterns` example to areas docs
2021-05-09 17:25:00 +02:00
Alexandru Năstase
791b0ce15d
Add extra name_patterns example to areas docs
Add an extra `name_patterns` example to areas docs
2021-05-07 16:56:52 +02:00
Guilhem Niot
a7573897fb Merge branch '3.x' 2021-04-23 15:18:59 +02:00
Javier Eguiluz
051fca9070
[Doc] Some minor fixes in index.rst 2021-03-23 20:13:05 +01:00
Baptiste Lafontaine
cc5bc47a0b Add documentation 2020-11-02 11:21:34 +01:00
Guilhem Niot
5b6f128bd0
Update @OA\Parameter usage example (#1706) 2020-08-26 22:30:16 +02:00
vadim2991
5dce5fe1bc
correction an invalid yaml in the documentation (#1703) 2020-08-21 22:39:40 +02:00
Guilhem Niot
0fd910b34a
Update the installation command 2020-07-24 16:57:39 +02:00
Guilhem Niot
35b84d1298
Fix @charliefancelli's report (https://github.com/nelmio/NelmioApiDocBundle/issues/1689) 2020-07-24 15:50:01 +02:00
Guilhem Niot
a82a1c1416
Fix @OA\JsonContent usage in the docs 2020-07-20 20:12:23 +02:00
Guilhem Niot
fa3158ce67 Document the support of OA annotations on methods 2020-07-12 15:21:14 +02:00
Filip Benčo
78664ef9ec
OpenApi 3 Support (#1623)
* Initial pass for OA3 upgrade

* Fix Util Tests

* Fix first batch of Unit Tests. Up to Model

* Another batch of fixed tests

* Update annotations

* Convert Model & Property Describers

* Update tests, Fix RouteDescribers, FIx additional bugs

* Another batch of updates

* Another batch of fixed Functional Tests

* Fix FunctionalTest tests

* Fix Bazinga Tests

* FIx FOS Rest

* Fix JMS TEsts & describers

* Fix all Tests

* Fix few stuff from own CR

* CS Fixes

* CS Fixes 2

* CS Fixes 3

* CS Fixes 4

* Remove collection bug

* Updates after first CRs

* CS

* Drop support for SF3

* Update the docs

* Add an upgrade guide

* misc doc fixes

* Configurable media types

* Code Style Fixes

* Don't use ::$ref for @Response and @RequestBody

* Fix upgrading guide

* Fix OA case

Co-authored-by: Filip Benčo <filip.benco@websupport.sk>
Co-authored-by: Guilhem Niot <guilhem.niot@gmail.com>
Co-authored-by: Mantis Development <mantis@users.noreply.github.com>
2020-05-28 13:19:11 +02:00
Gripinskiy Sergey
57f8cf4634 Question about @SWG\Tag annotation added to FAQ (#1525) 2019-06-15 15:22:54 +02:00
Serhii Kondratiuk
ccad10aae1 Added name_patterns filter option (#1504) 2019-04-16 17:22:50 +02:00
Aleksandar Dimitrov
f0bc1d3ff4
Fix for missing basePath
If it is used without `#/definitions/` the documentation gives an error: `Could not resolve reference because of: Tried to resolve a relative URL, without having a basePath..`
2019-02-27 16:54:49 +02:00
Olivier Bacs
43c7c0db58
Update index.rst
To reflect Symfony 4's directory and file hierarchy
2019-01-21 23:50:02 +00:00
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