openapi 3.1: swagger-parser won't parse a 3.1 spec

[gscott]

openapi 3.1 is released -- but the openapi-glue dependency https://github.com/APIDevTools/swagger-parser won't parse that spec . The repo over there appears slightly dormant. Any plans here for handling that dependency? Or should we try to do PRs on swagger-parser?

[seriousme]

Hi,

I was already waiting for swagger-parser to support 3.1
However swagger-parser indeed looks rather dormant :-(
If you can get it to wake up again that would be rather awesome !
If not we will need to come up with an alternative.

Kind regards,
Hans

[seriousme]

FYI:
Just noticed that the openAPI team is still busy producing the 3.1 JSON schema
OAI/OpenAPI-Specification#2474

This might wake up APIdevtools as its schema defs seem to rely on the official spec
See https://github.com/APIDevTools/openapi-schemas

[philsturgeon]

Give it a minute, we're on it. We need to get the OASv3.1 schema done so that other tools, like swagger-parser, can use it to get up to 3.1 support. It'll take a while before the tools you like are on 3.1, so please be patient, and send PRs whenever you can to help! 🥳

[seriousme]

@philsturgeon No rush, I'd rather see a solid schema than a rush job that needs to be patched 5 times over ;-)

[github-actions]

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days'

[philsturgeon]

Progress on the schemas is going rather well. Maybe you could give it a try and report any problems over there. OAI/OpenAPI-Specification#2489

[seriousme]

@philsturgeon : thanks for reporting your progress !
Fastify-openapi-glue does not use the spec directly but through a dependency called APIDevTools/swagger-parser that in turn depends on APIDevTools/openapi-schemas and that one depends on your schema.

From the looks of it APIDevTools/openapi-schemas will automatically pick your schema up once its published.

Kind regards,
Hans

[github-actions]

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days'

[seriousme]

Small update:

I have submitted a PR to APIDevTools/openapi-schemas 5 days ago. However no response yet :-(

If it turns out APIDevTools/* has been abandoned then we need to go for plan B.
I have been playing around a bit and it should not be too hard to remove the dependency on APIDevTools/swagger-parser.

Kind regards,
Hans

[philsturgeon]

I don't get the emails about it but I do have enough permissions to merge. Let me look into how to tag releases.

[seriousme]

Small update:

Plan A is moving very slowly. Phil has merged the 3.1 PR to APIdevTools/openapi-schemas (thanks for that !), but it has not been published yet on NPM.
My plan B was to do schema validation myself using Ajv however it looks like AJV has an issue with $dynamicRef in the OAS 3.1 specification. The issue is under investigation with the author of Ajv.

Kind regards,
Hans