Comments (6)
Case2: we need to get metadata from the serializer, no need to parse annotations, or to use reflection. You can define your serialization stuff in YAML or XML...
from nelmioapidocbundle.
Ah, good point, case 2 would try loading JMS metadata for the given class then.
from nelmioapidocbundle.
+1 for this important enhancement.
And what about describing functional exceptions? Should it also be added in the return property or should we add an exception property?
from nelmioapidocbundle.
@tonivdv There was some talk briefly in IRC of adding an errors
property as well to the ApiDoc
annotation. This could be filled in the beginning at least by scanning for @throws
docblock params.
But, yeah, I think it's needed, and I (or someone else) is going to have to add it anyway in order to support Swagger. I'm currently being held up by #61, so haven't been able to move onto this.
from nelmioapidocbundle.
@tonivdv The error thing is really contingent upon anything else, as far as I can tell, so I started separate issue for it: #65
from nelmioapidocbundle.
Closed by #70
from nelmioapidocbundle.
Related Issues (20)
- [Question]: Why I cant see in swagger properties from model? HOT 5
- [Bug]: Not nullable with default are required HOT 3
- [Feature]: Easy way to ignore properties from schema generation without relying on Symfony's `#[Ignore]` attribute HOT 1
- [Feature]: Define "tags" list via attributes HOT 1
- [Bug]: tags within api definition are not unique HOT 1
- [Bug]: Using #[NotNull] / #[NotBlank] doesn't influence nullable HOT 1
- [Feature]: PHPDoc with union of constant strings could/should be considered an enum HOT 1
- [Question]: Is there a way to hide route by method ?
- Duplication of query parameter if it's a reference HOT 2
- Components `property` is ignored for `@OA\Property` HOT 4
- [Bug]: Documentation is deprecated HOT 4
- [Bug]: problem with traversables HOT 2
- The "Nelmio\ApiDocBundle\Processor\MapRequestPayloadProcessor" class implements "OpenApi\Processors\ProcessorInterface" that is deprecated[Bug]: HOT 4
- [Bug]: Bad generated json (or clients?) since upgrade from 4.12 HOT 2
- [Bug]: enum_exists(): Argument #1 ($enum) must be of type string, array given HOT 3
- [Bug]: explicit setting of default value in Property causes error "Multiple definitions for [property]" HOT 1
- [Feature]: Create top level OpenApi Tag when processing Tag annotation
- [Bug]: Upgrading v4.29.1 -> v4.29.2 breaks documentation rendering HOT 4
- [Question]: How to add a 400 response to all endpoints HOT 1
- [Bug]: Setting property not nullable results in a nullable property
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from nelmioapidocbundle.