From b9d49e579903bf60399c101a4c357c757f0f84fb Mon Sep 17 00:00:00 2001 From: Guilhem Niot Date: Fri, 24 Jul 2020 15:45:52 +0200 Subject: [PATCH 1/4] Update CHANGELOG.md --- CHANGELOG.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7552762..48962a7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,8 +5,9 @@ CHANGELOG ------------------ * Added `@SerializedName` annotation support and name converters when using Symfony >= 4.2. -* remove pattern added from the Expression Violation message. - +* Removed pattern added from the Expression Violation message. +* Added FOSRestBundle 3.x support +* Added `@SWG` annotations support at methods level in models 3.3.0 ----- From 0e7803888ae0798554653ae76552c4ddc80a36cd Mon Sep 17 00:00:00 2001 From: SAMUEL NELA Date: Fri, 24 Jul 2020 15:48:12 +0200 Subject: [PATCH 2/4] Excluded tests from classmap (#1521) --- composer.json | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/composer.json b/composer.json index 3a77a8c..f22eada 100644 --- a/composer.json +++ b/composer.json @@ -58,7 +58,10 @@ "autoload": { "psr-4": { "Nelmio\\ApiDocBundle\\": "" - } + }, + "exclude-from-classmap": [ + "/Tests/" + ] }, "extra": { "branch-alias": { From 0fd910b34aa2e9fad43a64e2e7c29abdc4e31088 Mon Sep 17 00:00:00 2001 From: Guilhem Niot Date: Fri, 24 Jul 2020 16:57:39 +0200 Subject: [PATCH 3/4] Update the installation command --- Resources/doc/index.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Resources/doc/index.rst b/Resources/doc/index.rst index 2c51dd5..b5d2af4 100644 --- a/Resources/doc/index.rst +++ b/Resources/doc/index.rst @@ -2,7 +2,7 @@ NelmioApiDocBundle ================== The **NelmioApiDocBundle** bundle allows you to generate documentation in the -OpenAPI (Swagger) format and provides a sandbox to interactively experiment with the API. +OpenAPI version 2 (Swagger) format and provides a sandbox to interactively experiment with the API. What's supported? ----------------- @@ -20,7 +20,7 @@ It does also support `Symfony form`_ types. Migrate from 2.x to 3.0 ----------------------- -`To migrate from 2.x to 3.0, just follow our guide.`__ +`To migrate from 2.x to 3.0, follow our guide.`__ __ https://github.com/nelmio/NelmioApiDocBundle/blob/master/UPGRADE-3.0.md @@ -31,7 +31,7 @@ Open a command console, enter your project directory and execute the following c .. code-block:: bash - $ composer require nelmio/api-doc-bundle + $ composer require nelmio/api-doc-bundle:^3.0 .. note:: From 0d2552edabecd0dafbf55f8b01fc4dbee075da36 Mon Sep 17 00:00:00 2001 From: Guilhem Niot Date: Fri, 24 Jul 2020 16:58:58 +0200 Subject: [PATCH 4/4] Update the links in the README --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d67ead1..b6c20e0 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ for your APIs. ## Migrate from 2.x to 3.0 -[To migrate from 2.x to 3.0, follow our guide.](https://github.com/nelmio/NelmioApiDocBundle/blob/master/UPGRADE-3.0.md) +[To migrate from 2.x to 3.0, follow our guide.](https://github.com/nelmio/NelmioApiDocBundle/blob/3.x/UPGRADE-3.0.md) ## Installation @@ -24,12 +24,12 @@ composer require nelmio/api-doc-bundle ## Documentation -[Read the documentation on symfony.com](https://symfony.com/doc/current/bundles/NelmioApiDocBundle/index.html) +[Read the documentation on symfony.com](https://symfony.com/doc/3.x/bundles/NelmioApiDocBundle/index.html) ## Contributing See -[CONTRIBUTING](https://github.com/nelmio/NelmioApiDocBundle/blob/master/CONTRIBUTING.md) +[CONTRIBUTING](https://github.com/nelmio/NelmioApiDocBundle/blob/3.x/CONTRIBUTING.md) file. ## Running the Tests @@ -38,6 +38,7 @@ Install the [Composer](http://getcomposer.org/) dependencies: git clone https://github.com/nelmio/NelmioApiDocBundle.git cd NelmioApiDocBundle + git checkout 3.x composer update Then run the test suite: