121 Commits

Author SHA1 Message Date
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
Saleh Saeed
774057a91a
Revert DocumentationController name 2021-02-08 22:54:21 +01:00
Saleh Saeed
46ef005787 Add Yaml Documentation
Fixes #1613
2021-02-01 23:29:53 +01:00
Guilhem Niot
bc2b3f7530 Merge branch '3.x' 2020-12-29 10:30:06 +01:00
Guilhem Niot
e57ede23ed Use annotations reader without cache 2020-12-29 10:27:09 +01:00
Baptiste Lafontaine
cc5bc47a0b Add documentation 2020-11-02 11:21:34 +01:00
Baptiste Lafontaine
cbab00939f Allow to pass options to the constructor of SwaggerUIBundle 2020-10-23 15:04:00 +02: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
Guilhem Niot
aa8dcf06d8
Update swagger-ui (#1672) 2020-07-04 16:26:54 +02:00
Filip Benčo
d932b06bbb
Add support for compound properties (#1651)
* Add support for compound properties

* Fix CS & Tests

* Another fixing :D

* Final CS fix

* Allow complex compound properties

* cs

* Update the Upgrading guide

* Update php doc

* Add Support for Nullable properties

* Fix CS

* Fix CS

* Add Support for Nullable Types & Schemas as in OA3

* Update Nullable Property handling

* CS

* Fix tests

* Accept also nullable config for Alternative model names

* Refactor nullable refs

* Fix CS & Tests

* Another CS

* Revert "Another CS"

This reverts commit 03ada32b3263f3537d2af63f0abe79bd4a9ac0b5.

* Revert "Fix CS & Tests"

This reverts commit 369f2ccd170aebeeb9d87e9e00cba5cea62d5529.

* Revert "Refactor nullable refs"

This reverts commit 91cdf6fd0130f3ebf415de99f8a91edbc764255e.

* Revert "Revert "Refactor nullable refs""

This reverts commit 0e50fc1938ce3e620fc655a7d1e9284a9f8c24f0.

* Revert "Revert "Fix CS & Tests""

This reverts commit 228d3ca994eb4622c4db81aaa5f32845862e5616.

* Revert "Revert "Another CS""

This reverts commit a5b08dedf5bca8fb711b816c62bed2de9f1c9521.

* Improve nullable refs description

Co-authored-by: Filip Benčo <filip.benco@websupport.sk>
Co-authored-by: Guilhem Niot <guilhem.niot@gmail.com>
2020-06-16 13:11:53 +02:00
Mantis Development
b3c53beead
Add dump command to print out swagger JSON. (#1537) (#1540)
* Add dump command to print out swagger JSON.

Command outputs to stdout, so can be redirected to a file.
Pretty prints output by default.
--no-pretty can be passed to remove whitespace from json output if it does not need to be human readable

* Update for styleci corrections

* Fix CS and add type hint

* REbase + Updates to documentation of dump command.

* Remove defaultName - config file specifies this
Add return value to dump command

* Update for OA3

* Add a test case

* update command name

* Fix the tests

Co-authored-by: Guilhem Niot <egetick@gmail.com>
Co-authored-by: Guilhem Niot <guilhem.niot@gmail.com>
2020-05-31 11:39:50 +02:00
Guilhem Niot
82d766bfe4 Merge branch 'v3' 2020-05-30 18:23:49 +02:00
Guilhem Niot
dfff2476d8
Add @SerializedName support (#1636)
* Add `@SerializedName` support

* Also test `@SerializedName` on properties

* Fix tests with sf < 4.2

* Fix the tests

* Update the CHANGELOG
2020-05-30 18:08:25 +02:00
Guilhem Niot
b2b0e60617 Merge branch 'v3' 2020-05-29 18:20:46 +02:00
Guilhem Niot
5e8f7290e8
Change arrow function to an IE11 compatible function
Imports https://github.com/api-platform/core/pull/2899 and fixes https://github.com/nelmio/NelmioApiDocBundle/issues/1517
2020-05-29 18:15:57 +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
Simon Podlipsky
75c9db256a Upgrade Swagger UI to 3.25.0 2020-03-22 21:33:04 +01:00
Guilhem Niot
1a9a5d7ce6
Merge pull request #1552 from cyberemissary/duplicate-param-cleanup
Added describer that removes duplicate parameters when using $ref.
2020-03-14 11:41:27 +01:00
Filip Benčo
90bae6738a Update after PR 2020-02-18 20:45:58 +01:00
Guilhem Niot
3710e95d26 Rework PR 2020-01-09 21:45:37 +01:00
cyberemissary
9b9dbe69dd Added describer that removes duplicate parameters when using $ref. 2020-01-09 14:29:52 -05:00
Filip Benčo
e9926b8025 Fix BC 2019-12-13 23:32:30 +01:00
Filip Benčo
f16ac2e785 Fix tests 2019-12-13 22:54:58 +01:00
Filip Benčo
2de03859c0 Fix some bugs and confings 2019-12-13 22:20:13 +01:00
Filip Benčo
f9eacee3fd Add exntensible Property Describers 2019-12-13 21:40:42 +01:00
Maxime Helias
1464865de1 Remove deprecated notice about controller_name_converter 2019-11-19 17:23:12 +01:00
Gripinskiy Sergey
57f8cf4634 Question about @SWG\Tag annotation added to FAQ (#1525) 2019-06-15 15:22:54 +02:00
Guilhem N
48c29474e0
Update swagger-ui (#1518) 2019-06-10 12:32:09 +02:00
Guilhem N
846e2e3ae4
Merge pull request #1456 from cyberemissary/cache-authorization
Cache authorization in local storage.
2019-05-18 09:56:51 +02:00
cyberemissary
31ef0bdc58 Cache authorization in local storage. 2019-05-17 16:50:49 -04:00
Serhii Kondratiuk
ccad10aae1 Added name_patterns filter option (#1504) 2019-04-16 17:22:50 +02:00
Asmir Mustafic
d6ea99420e Allow model describers on jms custom types (#1495)
* allow model describers on jms custom types

* add fallback describer

* test custom type def

* remove object_fallback describer from the container when jms is not active
2019-04-16 12:13:33 +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
Guilhem N
2cd7522d14
Add class attribute 2019-02-18 17:20:39 +01:00
Guilhem N
1db38a25b0
Do not autowire the form extension 2019-02-18 08:38:56 +01:00
Guilhem N
edb54a1551
Merge pull request #1463 from MyHammer/fix-api-platform-documentation-decoration
Fix documentation decoration with API Platform
2019-01-23 13:42:03 +01:00
Olivier Bacs
43c7c0db58
Update index.rst
To reflect Symfony 4's directory and file hierarchy
2019-01-21 23:50:02 +00:00
Alexander Wenzel
f1bb40c6e4 Fix #1462 by allowing all supported implementations of NormalizerInterface in ApiPlatformDescriber
> add test
2019-01-11 16:54:58 +01: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
Baptiste Lafontaine
70442dde60 Update swagger ui 2018-10-02 16:54:00 +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