OpenApi v3 Spec

James Navin

There is, yes, but probably not for another month or so (its going to be hard for me to find the time before then).

2017-07-27T23:01:13+00:00

Marcel Overdijk reporter

OK thx for your response. This issue can be use to track the progress. With the new Link object in the v3 spec it will be easier to document HATEOAS api's, and of course test if the actual responses follow the spec :-)

2017-07-28T07:23:55+00:00

Robert Massaioli

It seems that OpenApi v3 now supports 'anyOf'. We are likely to need this support for the tool we are writing @jfnavin .

2017-08-15T23:36:51+00:00

Robert Massaioli

At this point in time there seems to only be a release candidate of the swagger validator library that would be required: https://github.com/swagger-api/swagger-parser/tree/feature/3.0.0-rc2

2017-08-16T02:49:55+00:00

James Navin

For basic support:

Evaluate maturity of the v3 parser lib
Bump to new version of parser lib
Fix broken API usage
Add tests for v3 specs
Do a major-version release

We would then need to identify new functionality in v3 and raise tickets to add coverage for those features (anyOf, Link etc)

2017-08-16T03:05:11+00:00

Brian Fox

Any update on this? This is critical functionality that my team is looking for.

2018-01-23T02:26:27+00:00

James Navin

@dexwest - is your team using OAI v3 in production yet? Ive been keeping an eye on the Java tooling and AFAIK its still not out of release candidate status. I haven't invested any time in supporting v3 as of yet as I assume most users are still on v2 (and there are enough bugs/feature requests in the current version of the SRV to keep me busy )

2018-02-05T04:13:32+00:00

John Thompson

@jfnavin - is there a timeline for OAI v3 support? I'm documenting some public facing Spring Boot services and need to decide between using v2 or v3.

2018-04-04T17:06:18+00:00

James Navin

@johnthompson - I don't have a timeline at the moment (unfortunately I only get time to work on this library a few days a month). I did see that a final 2.0.0 release of the v3 swagger-parser lib has been released so I might try and spike out a branch soon to get an idea of how much effort is required to add support.

2018-04-04T22:54:48+00:00

John Thompson

Cool - thanks @jfnavin !

2018-04-06T14:32:54+00:00

James Navin

I have started work on adding support for the OpenAPI v3 spec.

There is a new v2.0 branch that contains the initial work in anticipation of a major version release.

Current state is:

Existing test suite (based on v2 specs) passes (with some caveats...)
Validation of form data is not yet supported
No support of features above what exist in the v2 spec

I intend to add tests powered by v3 specs to confirm basic validation behavior, then look at adding support for new v3 features.

My likely plan of attack will be:

General refactoring and cleanup of existing codebase
'fill the gaps' where the v3 spec has enhanced what the v2 spec already supported (e.g. discriminator mappings etc)
Identify 'critical' new functionality to add validation for
Release 2.0
Add validation for 'non-critical' pieces as part of regular development/maintenance

Progress on the v2.0 release is tracked in ~~#113~~. Suggestions / comments welcomed there.