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

ETA for OpenAPI 3 support? #72

Closed
moon0326 opened this issue Sep 22, 2017 · 21 comments
Closed

ETA for OpenAPI 3 support? #72

moon0326 opened this issue Sep 22, 2017 · 21 comments

Comments

@moon0326
Copy link

Hi!

Thank you for such a good package :) I've been using it for my projects.

Is there an ETA for OpenAPI 3 support? I know that it's coming, but just wanted to know if there is an ETA.

Thanks!
Moon

@JamesMessinger
Copy link
Member

Hi. Sorry for not having a solid ETA date. I had originally hoped to have it done by now, but then work got really hectic all of a sudden, so I haven't had any free time lately. I hope to resume work on Swagger Parser next week.

@moon0326
Copy link
Author

@BigstickCarpet thank you for the reply :) Have a good weekend!

@lcofre
Copy link

lcofre commented Oct 3, 2017

Great @BigstickCarpet !

Thanks very much for your work. I am in the process of migrating to 3.0.0 so your project update is invaluable!

@hugoduraes
Copy link

Can you make a beta release?

@andybarron
Copy link

any updates on this? anything specific that the community could throw together a PR for?

@JamesMessinger
Copy link
Member

Hi. Please see my comment here. I was unable to get any work done for a couple months because of work and family commitments, but I'm back on it now.

@andybarron
Copy link

All good, take your time! We all appreciate your work on this. Just let us know if we can help with anything specific :)

@gonenduk
Copy link

gonenduk commented Dec 5, 2017

Can't wait for an update :)

@sandorfr
Copy link

sandorfr commented Jan 7, 2018

Is there any way we can help move this forward so we could have an alpha soon?

@sandorfr
Copy link

sandorfr commented Feb 9, 2018

I don’t know about others, but I grow impatient on this one. I have the feeling the only way to move this forward would be through a PR but before doing duplicated work it would be great to know if it is started somewhere?

@gonenduk
Copy link

Any updates? ETA? Some news?

@gkoberger
Copy link

Is there any updates on this, or alternative packages we should be looking at?

We're happy to help fund development of this, since we rely on the package so much. Is that something that could help speed things up? We've looked into contributing ourselves, however we didn't want to duplicate work and wasn't sure how to make changes across multiple modules.

If there's a way we can help fund this, let me know! greg at readme dot io :)

(And thanks for building this... we love the package 💙)

@SomeoneRandom42
Copy link

Yeah I am with gkoberger. We really enjoy having the docs in line with the endpoints in comments and would love to keep using this package, but the new version of Open API adds many features we desperately want to upgrade.

If there is anything we can do please let me know.

@rssteffey
Copy link

I would also be up for helping expand to 3.0 support. The spec allows for a lot more flexibility in our APIs here and we're pretty dependent on this repo

@sandorfr
Copy link

I start to feel like the only way to progress this is to start a fork with the people motivated.

@gonenduk
Copy link

@gkoberger - maybe you should offer to fund it and some motivated people could take the project and work on it.

@ztheory
Copy link

ztheory commented May 8, 2018

@gonenduk - Pretty sure that's exactly what he did.

+1 for this.

@gkoberger
Copy link

gkoberger commented May 25, 2018

I reached out to @BigstickCarpet and offered to finance it, however unfortunately he wasn't able to commit to anything due to work commitments. I completely understand, but we really needed OAS3 support!

So, we created oas-normalize, which accepts both Swagger 2 and OAS 3 (YAML or JSON, via string or URL or blob or whatever), and validates them. It has a similar API to swagger-parser, and uses swagger-parser under the hood for Swagger 2. (It uses swagger2openapi for validating OAS 3). It also uses @BigstickCarpet's json-schema-ref-parser for all the resolving of $refs.

https://github.com/readmeio/oas-normalize

Here's how to use it:

const OAS = require('oas-normalize');

// Use a URL, string, pathname, JSON blob, whatever
const oas = new OAS('https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore-expanded.yaml');

oas.validate((err, spec) => {
  if (err) {
    console.log(err.errors);
    return;
  }
  console.log(spec); // spec will always be JSON, and valid
});

Currently it's backend-only, but we're going to try to fix that.

Let us know if you run into issues!

@gonenduk
Copy link

Great job!
Next step would be to use it in swagger-express-middleware.
If the interface is the same then it will be easy.

@MikeRalphson
Copy link

@gkoberger happy to help if swagger2openapi needs any work done (it being my baby).

@JamesMessinger
Copy link
Member

I just released Swagger Parser v5.0.0, which includes initial support for OpenAPI 3.0. 👏🎉🎆

A big "Thank You!" to Leo Long for doing the work and submitting PR #88. 👍 🥇 💯

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