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 Open API 3.0 #894

Closed
johngluckmdsol opened this issue Oct 13, 2017 · 24 comments
Closed

Add support for Open API 3.0 #894

johngluckmdsol opened this issue Oct 13, 2017 · 24 comments
Labels

Comments

@johngluckmdsol
Copy link

@johngluckmdsol johngluckmdsol commented Oct 13, 2017

It appears that version 3.0 is not yet supported. We're hoping to move to Open API 3.0 because we are better able to represent our JSON Schema with it. It would be great if your tool could suppor it.

@honzajavorek
Copy link
Contributor

@honzajavorek honzajavorek commented Oct 17, 2017

Regarding the Open API 3.0, we plan to support it, the question is when and the answer is yet to be determined. Of course anyone can come and contribute the support at any time, and we'll be there to help them - see #837 (comment)

Related issues: apiaryio/fury-adapter-swagger#131

@JurRutten
Copy link

@JurRutten JurRutten commented Oct 30, 2017

+1

1 similar comment
@veewee
Copy link

@veewee veewee commented Oct 30, 2017

+1

@XVincentX
Copy link
Contributor

@XVincentX XVincentX commented Oct 30, 2017

Same here. I'd love to put the express-gateway API under tests but our specs are written in Open API 3.0!

@tombevers
Copy link

@tombevers tombevers commented Oct 31, 2017

+1

@jonas-depop
Copy link

@jonas-depop jonas-depop commented Nov 24, 2017

+1

@honzajavorek
Copy link
Contributor

@honzajavorek honzajavorek commented Nov 30, 2017

@tombevers @jonas-depop @JurRutten @veewee We understand this is a wanted feature, but next time please use GitHub Reactions to express your feelings. Thanks!

By the way, one of the benefits is we can sort by the reactions:

image

@honzajavorek
Copy link
Contributor

@honzajavorek honzajavorek commented Jan 3, 2018

Just to reiterate, adding support for a new API description format goes like this...

Dredd consumes API Elements. It uses Fury.js to turn any API description format (currently API Blueprint and Swagger 2.0) into API Elements.

To produce API Elements for various formats, Fury.js uses adapters. So the first and the most important step to add support for OpenAPI 3.0 to Dredd would be to create an adapter for Fury, similar to the one for Swagger. The Fury.js maintainers (@apiaryio/adt) would definitely give a hand and advice to anyone who starts with this.


Note: A scheme of Dredd's parsing stack is in #820, I'd be happy to re-draw it and add it to docs if there's someone who actually needs it.

@honzajavorek honzajavorek mentioned this issue Jan 18, 2018
1 of 3 tasks complete
@altcatalin
Copy link

@altcatalin altcatalin commented Jan 18, 2018

+1

@YGeorge
Copy link

@YGeorge YGeorge commented Mar 30, 2018

Any update on this?

@michalholasek
Copy link
Contributor

@michalholasek michalholasek commented Apr 5, 2018

@YGeorge Implementation for initial OAS3 support is scheduled to start soon, but we don't have more accurate timeframe yet.

@joost
Copy link
Contributor

@joost joost commented Apr 26, 2018

+1

@nesl247
Copy link

@nesl247 nesl247 commented Jul 30, 2018

@michalholasek Is there a timeframe at this point? It's been a few months since the last update. Curious to see how it's going.

@michalholasek
Copy link
Contributor

@michalholasek michalholasek commented Jul 31, 2018

@nesl247 There's no update on the timeframe yet, unfortunately.

@Miouge1
Copy link

@Miouge1 Miouge1 commented Aug 21, 2018

Is there any alternatives to dredd to test OpenAPI 3.0?

@orontee
Copy link

@orontee orontee commented Aug 30, 2018

+1

1 similar comment
@jurgob
Copy link

@jurgob jurgob commented Sep 8, 2018

+1

@jcagarcia
Copy link

@jcagarcia jcagarcia commented Sep 26, 2018

+1

@honzajavorek
Copy link
Contributor

@honzajavorek honzajavorek commented Sep 26, 2018

@joost @jcagarcia @jurgob @orontee I'm sorry, but this is not helpful. See #894 (comment) I'm going to lock this issue now.

We, as the team behind the Apiary tools, would like to start with the adapter very soon.

It has two phases. First we need the Fury adapter mentioned earlier, which is the responsibility of @apiaryio/adt. When the adapter is ready, @apiaryio/sjs (currently me) can start working on bringing the very desired OAS3 support to Dredd. The adapter is going to be a parallel repository to https://github.com/apiaryio/fury-adapter-swagger, possibly something like https://github.com/apiaryio/fury-adapter-oas3, so watch out for that and when we kick it off, don't be afraid to give us a hand to make it all faster. See #894 (comment) to understand and do not hesitate to contact us in other issues for help and guidance.

This should stay as a tracking issue of OAS3 support in Dredd. We do track this as the most important thing to be worked on, so there's no need to add more 👍 . We hear you.

Thanks!

@apiaryio apiaryio locked and limited conversation to collaborators Sep 26, 2018
@honzajavorek
Copy link
Contributor

@honzajavorek honzajavorek commented Dec 6, 2018

The latest news about the adapter are under apiaryio/fury-adapter-swagger#131 (comment). I'll keep updating this issue regarding support of OpenAPI 3 in Dredd specifically.

honzajavorek added a commit that referenced this issue Jan 18, 2019
Please see https://github.com/apiaryio/api-elements.js/blob/master/packages/fury-adapter-oas3-parser/STATUS.md for the list of supported features. The support of OpenAPI 3 in Dredd is experimental, beta, early, you name it. It is everything but finished. However, it already works - see apiaryio/api-elements.js#71 The OAS3 adapter is now developed publicly at https://github.com/apiaryio/api-elements.js/tree/master/packages/fury-adapter-oas3-parser and accepts contributions.

Close #894
@honzajavorek honzajavorek mentioned this issue Jan 18, 2019
2 of 3 tasks complete
@honzajavorek
Copy link
Contributor

@honzajavorek honzajavorek commented Jan 18, 2019

With #1214 Dredd has an experimental support for OpenAPI 3 now!

party

Please see the status page for the list of supported features. The support of OpenAPI 3 in Dredd is experimental, beta, early, you name it. It is everything but finished. However, it already works - see apiaryio/api-elements.js#71 for examples. The OAS3 adapter is now developed publicly at the new api-elements.js monorepo and accepts contributions.

I'd like to thank you all very much for waiting for so long. I'm very happy today Dredd is one very significant step closer to be again a great tool for everyone using API description documents as a source of truth for their APIs.

@apiaryio apiaryio unlocked this conversation Jan 18, 2019
@ApiaryBot
Copy link
Collaborator

@ApiaryBot ApiaryBot commented Jan 18, 2019

🎉 This issue has been resolved in version 7.1.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@Teklie
Copy link

@Teklie Teklie commented Jun 5, 2020

Regarding the Open API 3.0, we plan to support it, the question is when and the answer is yet to be determined. Of course anyone can come and contribute the support at any time, and we'll be there to help them - see #837 (comment)

Related issues: apiaryio/fury-adapter-swagger#131

Hi @honzajavorek ,
is support for Open API 3.0 added?

Needed it :)

@priyanshuwustl
Copy link

@priyanshuwustl priyanshuwustl commented Aug 5, 2020

@Teklie

With #1214 Dredd has an experimental support for OpenAPI 3 now!

party

Please see the status page for the list of supported features. The support of OpenAPI 3 in Dredd is experimental, beta, early, you name it. It is everything but finished. However, it already works - see apiaryio/api-elements.js#71 for examples. The OAS3 adapter is now developed publicly at the new api-elements.js monorepo and accepts contributions.

I'd like to thank you all very much for waiting for so long. I'm very happy today Dredd is one very significant step closer to be again a great tool for everyone using API description documents as a source of truth for their APIs.

Updated status page link: https://github.com/apiaryio/api-elements.js/blob/master/packages/openapi3-parser/STATUS.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

You can’t perform that action at this time.