Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for OpenAPI 3.0 #384

Closed
prodikl opened this issue Mar 21, 2017 · 15 comments
Closed

Add support for OpenAPI 3.0 #384

prodikl opened this issue Mar 21, 2017 · 15 comments

Comments

@prodikl
Copy link

prodikl commented Mar 21, 2017

Hey there,

I'm not sure if this is in the works already but after reading this post:
https://blog.readme.io/an-example-filled-guide-to-swagger-3-2/

I wanted to add an issue regarding support for OpenAPI / Swagger 3.0.

Specifically, the HATEOAS implementation would be very helpful for my team.

Please let me know if any work has started on this already, otherwise I'd be happy to fork and start contributing.

Thanks in advance

@bfanger
Copy link
Collaborator

bfanger commented Mar 24, 2017

I'm not working on this. community contributions are welcome.

@morsok
Copy link
Contributor

morsok commented Apr 10, 2017

Hello there,

We also use swagger-php and would really need the 3.0 support of anyOf and oneOf keywords, how could we help implement that ? Did you start working on it @prodikl ?

@bfanger
Copy link
Collaborator

bfanger commented May 19, 2017

I've not started working on this, but I've made a 3.x branch to make contributions easier, as a target for future pull-requests.

The branch includes the oneOf & anyOf patch from @morsok and I've done some basic find-and-replace-all stuff.

I think creating pull requests to 3.x and mentioning this issue is nice way to bundle the community efforts.

To try it out as-is: composer require zircote/swagger-php 3.x-dev

@prodikl
Copy link
Author

prodikl commented Jun 1, 2017

@morsok Hey so I just kept on using swagger-php 2.0.x with swagger-ui v3.0.x

I'm not attempting to use anyOf or oneOf, just using allOf for my composite models.

Sorry I can't be of more help!

@ricardovanlaarhoven
Copy link

My API works except the security schema.
when pressing execute its not sending the header autorizations with the request.

@swg\SecurityScheme( securityDefinition="Bearer", type="apiKey", name="Authorization", in="header" ),

or @bfanger am i doing something wrong in my annotation?

@bfanger
Copy link
Collaborator

bfanger commented Jun 15, 2017

@ricardovanlaarhoven In v3.0 it's securitySchemes while swagger-php hasn't been updated and still generates securityDefinitions.

Go make it work and create pull requests to projects where it doesn't work according to the (draft/proposed) specification. 😉

@danydev
Copy link

danydev commented Aug 3, 2017

Hey guys, is there a list of TODO items before we can have 3.0 released?

bfanger added a commit that referenced this issue Aug 12, 2017
… Components

- Minimum PHP version 7 (which was released dec 2015, it's time)
- Upgraded tests to use PHPUnit to v6.3
- Added strict_types
- Merged patches from master

Notify #384
bfanger added a commit that referenced this issue Aug 19, 2017
swagger-php 3.x is able to generate the link example: https://github.com/OAI/OpenAPI-Specification/blob/master/examples/v3.0/link-example.yaml

Updated annotations: Parameter & Response
Added annotations: Link & MediaType
Notify #384
@davidsoderberg
Copy link

Hey, when will 3.0 be released?

@bfanger
Copy link
Collaborator

bfanger commented Sep 29, 2017

It will be released when it can generate json files compatible with the 3.0 spec.

Work on swagger-php is not “planned”. Start contributing to the 3.x branch to make swagger-php 3.0 release a reality

@davidsoderberg
Copy link

👍 do you have a todo list for 3.x branch?

@bfanger
Copy link
Collaborator

bfanger commented Sep 30, 2017

Not a list, try to generate one of the v3 examples or start using v3 in a project and implement what is missing.

I’ve implemented and unittested the link-example.

@bfanger
Copy link
Collaborator

bfanger commented Feb 17, 2018

Thanks to great work done by @sonrac the 3.x branch is in good shape, try it out and report issues if you'll find any.

@ddanielroche
Copy link

ddanielroche commented Apr 4, 2018

Can you launch an alpha version to be able to test it in lichunqiang/yii2-swagger?
Thank you

@bambamboole
Copy link

Any news on the 3.0 release?

@bfanger
Copy link
Collaborator

bfanger commented Aug 12, 2018

It is ready, i think i've made all the breaking changes i wanted to make

I've changed a lot the last few days. So i'm keeping an eye on the PR/issues this week and then release v3

@bfanger bfanger closed this as completed Aug 19, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

8 participants