RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-02-02 15:51:48 +03:00
Code Issues Projects Releases Wiki Activity
810 Commits 9 Branches 28 Tags
Commit Graph

810 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Asmir Mustafic
883049a9e0 use the configured context factory to create the serialization context 2022-08-22 20:45:23 +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
Baptiste Lafontaine
1cf58fbae0
Allow symfony/flex composer plugin (#2013) 2022-07-18 17:58:10 +02:00
Cyril VERLOOP
205828d18d
Fix typo "expect" to "except" in documentation. (#2008) 2022-07-15 23:16:37 +02:00
Guilhem Niot
dcc1cd8964
Fix parameter sharing example (#2004) 2022-06-11 09:56:29 +02:00
Guilhem Niot
c1f4383fc0 Increase tests memory limit 2022-06-11 09:54:36 +02:00
Guilhem Niot
f33eee70fc
Catch a more precise exception in Swagger controller (#2005) 2022-06-10 23:17:15 +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
a6f25da106
Detect when a model is used for a form type (#1834) 
* Detect when a model is used for a form type

* typo

* Add a test + Fix implementation

* CS
 2022-06-10 22:41:24 +02:00
Guilhem Niot
b2b6d0f798
Merge pull request #1999 from chrisguitarguy/rm_inline_styles 
Remove Inline Styles in Favor of the Stylesheet
 2022-06-10 21:27:23 +02:00
Guilhem Niot
938b954a30
Merge pull request #1986 from WedgeSama/master 
Add previous exception to BadRequestHttpException on SwaggerUiController
 2022-06-10 20:55:12 +02:00
Guilhem Niot
be8499ffdc
Merge pull request #1988 from nelmio/ROOTCONTEXT 
Use the same root context everywhere
 2022-06-10 20:52:06 +02:00
Guilhem Niot
ee1fabe245
Merge pull request #2003 from nelmio/GuilhemN-patch-2 
Clarify default policy on routes
 2022-06-03 19:14:32 +02:00
Guilhem Niot
ba28741721
Merge pull request #2000 from stopfstedt/with_annotation 
corrects config option name in docs.
 2022-05-31 14:19:20 +02: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
Guilhem Niot
7803c7365e
Merge pull request #2002 from fluffycondor/fix-twig-suggestion 
Fix wrong package name in suggest section
 2022-05-31 14:03:36 +02:00
fluffycondor
075f4eec1c
Fix wrong package name 2022-05-27 17:44:13 +03:00
Stefan Topfstedt
89194219f9 corrects config option name in docs. 2022-05-18 11:55:35 -07:00
Christopher Davis
49bad6743c Remove Inline Styles in Favor of the Stylesheet 
Should fix https://github.com/nelmio/NelmioApiDocBundle/issues/1770
 2022-05-16 08:56:52 -05:00
Christopher Davis
a697792092 Merge remote-tracking branch 'origin/master' into constraint_groups 2022-05-12 18:45:41 -05:00
Guilhem Niot
0220f641ed
Merge pull request #1997 from nelmio/CIDOCS 
Add a Github Action to lint the docs
 2022-05-13 00:00:26 +02:00
Guilhem Niot
7bc9462e7e Fix DOCtor-RST errors 2022-05-12 23:59:36 +02:00
Guilhem Niot
5195058abb Add a Github Action to lint the docs 2022-05-12 23:59:12 +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
Christopher Davis
6b2ef45b24 Merge remote-tracking branch 'origin/master' into constraint_groups 2022-05-11 08:18:52 -05:00
Christopher Davis
d27cc8fc3b
Merge pull request #1994 from virtualize/master 
fixed doc typo that broke the models section
 2022-05-11 08:07:17 -05:00
Christoph Wieseke
fdb2182834
fixed doc typo the broke the models section 2022-05-09 16:31:09 +02:00
Tobias Sette
f66ab2a516
docs(commands.rst): fix command name (#1989) 2022-05-02 22:39:33 +02:00
Christopher Davis
da02f3ad33
Stop Model Property Description When a Schema Type or Ref is Already Defined (#1978) 
* Return a Result Object from AnnotationsReader::updateDefinition

This is so we can make a decision on whether or not a schema's type or
ref has been manually defined by a user via an `@OA\Schema` annotation
as something other than an object.

If it has been defined, this bundle should not read model properties any
further as it causes errors.

I put this in AnnotationReader as it seemed the most flexible in the
long run. It could have gone in `OpenApiAnnotationsReader`, but then any
additional things added to `updateDefinition` could be left out of the
decision down the road. This is also a convenient place to decide this
once for `ObjectModelDescriber` and `JMSModelDescriber`.

* Stop Model Describer if a Schema Type or Ref Has Been Defined

Via the result object added in the previous commit.

This lets user "short circuit" the model describers by manually defining
the schema type or ref on a plain PHP object or form. For example,
a collection class could be defined like this:

    /**
     * @OA\Schema(type="array", @OA\Items(ref=@Model(type=SomeEntity::class)))
     */
     class SomeCollection implements \IteratorAggregate { }

Previously the model describer would error as it tries to merge the
`array` schema with the already defiend `object` schema. Now it will
prefer the array schema and skip reading all the properties of the
object.

* Add a Documentation Bit on Stopping Property Description

* Mark UpdateClassDefinitionResult as Internal
 2022-04-30 20:28:05 +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
cb03d99c97 Remote Context::root() usage 2022-04-30 20:20:38 +02:00
Guilhem Niot
5d747aefc3 fix CS 2022-04-30 20:10:00 +02:00
Guilhem Niot
52e7fc4de1 Use the same root context everywhere 2022-04-30 20:07:44 +02:00
Benjamin Georgeault
42349cb4cf Add previous exception to BadRequestHttpException on SwaggerUiController. Improve debug. 2022-04-27 10:08:37 +02:00
Guilhem Niot
05d16e6814
Add links to swagger php examples 2022-04-21 23:36:09 +02:00
Valentin Salmeron
35ea6f2759
Update areas.rst (#1983) 
* Update areas.rst

'with_annotations' option is not mentioned in actual documentation

* Slight changes

* Rephrase
 2022-04-21 23:18:01 +02:00
Guilhem Niot
f8c030d096
Improve "no describer found" error message (#1979) 2022-04-13 19:54:31 +02:00
Guilhem Niot
fca94057d2 Merge remote-tracking branch 'origin/master' into constraint_groups 2022-04-13 19:43:23 +02:00
Baptiste Lafontaine
1302bc7568
Create an enum model describer (#1965) 
* Create an enum model describer

* Bump Api-Platform

Co-authored-by: Guilhem Niot <guilhem@gniot.fr>
 2022-04-04 11:42:44 +02:00
Guilhem Niot
2295f68b89
Add support of inline path parameters (#1973) 
* Add support of inline path parameters

* Fix CS
 2022-03-28 14:37:14 +02:00
Guilhem Niot
8111ce645b
Reproduce and fix duplicate operation id errors (#1972) 
* Replicate and fix duplicate operation id errors

* Fix CS
 2022-03-28 14:36:03 +02:00
Guilhem Niot
9cd417efb4
Merge pull request #1969 from nelmio/TESTS 
Fix the tests
 2022-03-24 15:14:49 +01:00
Guilhem Niot
a39317726a CS 2022-03-21 17:04:37 +01:00
Guilhem Niot
e722f642ad Fix the tests 2022-03-21 17:03:22 +01:00
Guilhem Niot
625aa151f0
Merge pull request #1966 from Flower7C3/patch-1 
correct indentation in configuration example
 2022-03-21 16:46:36 +01:00
Bartłomiej Jakub Kwiatek
a362f869ad
correct indentation in configuration example 2022-03-04 20:09:11 +01:00
Guilhem Niot
8fb8d90f24
Update link to zircote/swagger-php upgrade documentation 2022-02-28 11:54:53 +01:00
Guilhem Niot
7d827d5141
Merge pull request #1955 from thomaspicquet/master 
Fixed Areas attribute to work like the documentation specifies
 2022-02-28 11:52:28 +01:00
Thomas Picquet
405a5247e1 check $properties['value'] is not empty 2022-02-02 08:47:26 -08:00