51 Commits

Author	SHA1	Message	Date
Clément Lafont	83c81518c6	Fix methods in route annotation in documentation (#2028) ... Fix the bad typo.	2022-09-11 12:19:38 +02:00
LALLAHOM Hamdi	3d38bba7cd	Update index.rst (#2015) ... Replace "Symfony\Component\Serializer\Annotation\Group" by "Symfony\Component\Serializer\Annotation\Groups"	2022-08-04 11:58:28 +02:00
Cyril VERLOOP	205828d18d	Fix typo "expect" to "except" in documentation. (#2008)	2022-07-15 23:16:37 +02:00
Christopher Davis	235963df41	Merge pull request #1902 from chrisguitarguy/constraint_groups ... Respect Constraint Validation Groups When Describing Models	2022-06-10 16:15:42 -05:00
Guilhem Niot	7520ef407f	Clarify default policy on routes	2022-05-31 14:17:59 +02:00
Guilhem Niot	ed33ee8e4a	Fix the docs	2022-05-31 14:09:25 +02:00
Christopher Davis	a697792092	Merge remote-tracking branch 'origin/master' into constraint_groups	2022-05-12 18:45:41 -05:00
Guilhem Niot	7bc9462e7e	Fix DOCtor-RST errors	2022-05-12 23:59:36 +02:00
Christopher Davis	ccd3689faa	Expand the Documentation on Groups to Include Validation ... With some examples of objects and the use of model as well as some implications for generated code.	2022-05-11 08:52:48 -05:00
Christoph Wieseke	fdb2182834	fixed doc typo the broke the models section	2022-05-09 16:31:09 +02:00
Krystian Marcisz	6ac4f07872	[Docs] Add PHP Attributes examples (#1985) ... * [Docs] Add PHP Attributes examples * Fix namespaces	2022-04-30 20:25:41 +02:00
Guilhem Niot	05d16e6814	Add links to swagger php examples	2022-04-21 23:36:09 +02:00
Jack Cutting	4bc12f1034	Add link to Security documentation to the Learn More section	2022-01-26 17:39:42 +00:00
Guilhem Niot	a184cb8ef4	Fix deprecations (#1923)	2021-12-11 14:19:43 +01: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
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
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	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
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	6c6a04bba7	Various documentation enhancements (#1423)	2018-10-31 16:33:06 +01: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
Ondřej Machulda	83de823e77	Fix Model annotation example in docs (fixes #1318)	2018-05-09 17:12:17 +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