Draft: OpenAPI 3.1 #128

cebe · 2021-10-18T12:53:54Z

This branch will contain all changes made to support OpenAPI 3.1.

I added the following:

New method OpenApi::getMajorVersion() to return the current OpenAPI version, this should be used to make version dependent decisions when loading and validating the description.
OpenAPI 3.1 schema files for valdiation vai CLI

Possibly incomplete list of TODOs on this one:

Webhook support #114 ( solved by Add support for WebHooks #115 )
Support OpenAPI 3.1 #101 ( is this completely solved already? )
[RFC] Handle OpenAPI 3.1 BC Breaks #130

This replaces #117.

Co-authored-by: Cees-Jan Kiewiet <ceesjank@gmail.com>

Jean85 · 2021-10-19T07:13:07Z

This looks great, thank you @cebe!
Can we help in any way? Is there a "TODO" list to complete this?

Add Testcases for OpenAPI 3.1

schemas/openapi-v3.1.json

Add support for WebHooks

Signed-off-by: Aleksei Khudiakov <aleksey@xerkus.pro>

* master: (22 commits) Catch recursion when resolving inside included file Improve Responses resolving references Fixes default value for exclusiveMinimum and exclusiveMaximum more specific deprecation add hasPropertyValue() method add comments, optimize tests for #125 During serialization convert empty Map fields to empty Objects Add test to demonstrate OpenAPI v3.0 schema validation fails with empty Path properties yarn upgrade Added docker environment for local development Add symfony 6 support (#151) Bump node-fetch from 2.6.1 to 2.6.7 (#149) Fix CI badge in Readme (#150) Temporarily skip broken test (#145) Run speccy through yarn Add windows and macos cases Temporarily skip broken test Rework CI Run all tests (#136) Drop licence badge from readme (#137) ... Conflicts: README.md composer.json src/SpecBaseObject.php tests/ReaderTest.php

cebe · 2022-04-20T15:55:11Z

Is there a "TODO" list to complete this?

Added a TODO list to the main comment on this PR. not sure if this is all that needs to be done though.

colinmollenhour · 2022-06-23T21:40:49Z

Has anyone done much testing with this PR? Perhaps if you are using it successfully and share your experiences it will help push it closer to merge time.

I'm really looking forward to using this with the PHP League OpenAPI validator!

colinmollenhour · 2022-06-23T21:52:13Z

Is it actually possible to support OpenAPI 3.1 until the underlying justinrainbow/json-schema library support JSON Schema Draft 2020-12?

For example, one new feature of OpenAPI 3.1 not mentioned on #101 is the new unevaluatedProperties option, but this is really just a new feature of JSON Schema. I'm not sure if that needs to be implemented specifically in this library or not, but I would assume it at least needs to be supported by the JSON Schema parser?

philsturgeon · 2022-06-30T16:40:20Z

If you released a new version with OAS3.1 support and didn't support unevaluatedProperties properties straight away then I doubt anyone would even notice. I wouldn't let that hold you up.

Switching away from hustinrainbow/json-schema might be on the cards. It seems like development has slowed down (jsonrainbow/json-schema#658) and its mostly just in maintenance now.

This was suggested as a supposedly drop-in replacement: https://opis.io/json-schema

It might be you can just swap packages and get a lot of the way there on the OAS3.1 schema differences.

shulard · 2022-10-08T09:19:21Z

Hello guys !

How can we help here ? Do you need more tests or is this PR miss some code ?

philsturgeon · 2022-10-19T16:54:08Z

@cebe I completely understand how busy you are, but if you ever want to chat about any of this I would be happy to hop on a Zoom call. Poke me on DMs somewhere and I'll send you a schedule link. No pressure, just want to unblock if I can.

WyriHaximus · 2023-01-12T22:35:21Z

@cebe Is there a way I can help move this forward? What mainly brought me here today is PHP 8.2 deprecations so I'll look into fixing those on the 3.1 and default branches. Aside from that, I've been using that branch for months now to generate an API client without any issue with a 3.1 spec so far. From my experience, it's pretty stable in its current state.

WyriHaximus · 2023-01-13T15:50:22Z

The 8.2 deprecations pr for OA 3.1: #178

WyriHaximus · 2023-01-17T07:59:48Z

Also just filed #179 with a small fix for webhooks

DEVizzent · 2023-01-19T22:55:39Z

@cebe I also was doing some test with this branch and really good results. If you need some help to finish some stuff before merge, I can help.
Thank for fixing the deprecations @WyriHaximus

acelaya · 2023-06-16T06:45:04Z

@DEVizzent I came across your fork when searching for OAS 3.1 support in this library.

Considering it's now even used by one of thephpleague packages, should we consider it now "the official" one? And if so, would you be open to enable issues on your fork? I would like to report something that works when using OAS 3.0 but not OAS 3.1

DEVizzent · 2023-06-16T08:34:30Z

@DEVizzent I came across your fork when searching for OAS 3.1 support in this library.

Considering it's now even used by one of thephpleague packages, should we consider it now "the official" one? And if so, would you be open to enable issues on your fork? I would like to report something that works when using OAS 3.0 but not OAS 3.1

I don't know if official one. But here we didn't find a way to contribute and we need keep evolving the library. So, feel free to create a ticket in the fork and contribute to the project. I will help if I can.

acelaya · 2023-06-16T08:37:16Z

I don't know if official one. But here we didn't find a way to contribute and we need keep evolving the library. So, feel free to create a ticket in the fork and contribute to the project. I will help if I can.

I would love to, but my point was that issues are disabled there 😅

To enable issues you need to go to https://github.com/DEVizzent/cebe-php-openapi/settings, and check this:

shulard · 2023-06-16T13:30:07Z

Maybe someone else already though about it but if @cebe can't maintain this package anymore, based on this MR discussion, it can be interesting to avoid using a personal namespace (a bit too late here because of thephpleague adoption 😄).

It might be a requirement to have at least two persons involved in the fork (I don't know @DEVizzent if you already gave access to some other people…) to avoid a blocked situation like this. Same for packagist "distribution channel", if we all decide to move from this current package, no-one can mark it "abandoned" to help user migrate.

Not sure it's relevant today but to prevent that kind of situation in the future, having "a team" behind the code seems important.

DEVizzent · 2023-06-16T14:04:29Z

I don't know if official one. But here we didn't find a way to contribute and we need keep evolving the library. So, feel free to create a ticket in the fork and contribute to the project. I will help if I can.

I would love to, but my point was that issues are disabled there 😅

To enable issues you need to go to https://github.com/DEVizzent/cebe-php-openapi/settings, and check this:

Sorry I thought it was a default option. Now it's enabled.

DEVizzent · 2023-06-16T14:09:16Z

Maybe someone else already though about it but if @cebe can't maintain this package anymore, based on this MR discussion, it can be interesting to avoid using a personal namespace (a bit too late here because of thephpleague adoption 😄).

It might be a requirement to have at least two persons involved in the fork (I don't know @DEVizzent if you already gave access to some other people…) to avoid a blocked situation like this. Same for packagist "distribution channel", if we all decide to move from this current package, no-one can mark it "abandoned" to help user migrate.

Not sure it's relevant today but to prevent that kind of situation in the future, having "a team" behind the code seems important.

I agree. WyriHaximus is also a collaborator in the project. And if there are other people who participate on it, I think it's healthy share this permissions.

cebe and others added 2 commits October 18, 2021 14:25

Added basic information about current OpenAPI version

69c07ef

OpenAPI v3.1: Add schema and validation to CLI

82b0db7

Co-authored-by: Cees-Jan Kiewiet <ceesjank@gmail.com>

cebe added this to the 1.6.0 milestone Oct 18, 2021

cebe added the openapi 3.1 label Oct 18, 2021

cebe mentioned this pull request Oct 18, 2021

Add v3.1 schema and validation based on it #117

Closed

cebe added 2 commits October 18, 2021 15:25

fix test paths

eb1108d

Update README.md

4fcc155

Add Testcases for OpenAPI 3.1

c4bba49

marcelthole mentioned this pull request Oct 21, 2021

[RFC] Handle OpenAPI 3.1 BC Breaks #130

Open

scaytrase mentioned this pull request Oct 27, 2021

nullable oneOf/anyOf value rejected thephpleague/openapi-psr7-validator#146

Closed

Update php.yml

2cb3b0d

marcelthole mentioned this pull request Oct 29, 2021

Add Testcases for OpenAPI 3.1 #129

Merged

Merge pull request #129 from marcelthole/add-openapi31-examples

551b05f

Add Testcases for OpenAPI 3.1

cebe added hacktoberfest-accepted and removed hacktoberfest-accepted labels Nov 20, 2021

Add support for WebHooks

0c10bea

Xerkus reviewed Nov 30, 2021

View reviewed changes

schemas/openapi-v3.1.json Outdated Show resolved Hide resolved

Xerkus mentioned this pull request Dec 7, 2021

Update pre-release openapi 3.1 schema to current in 31 branch #140

Merged

Merge pull request #115 from WyriHaximus-labs/webhooks

088af05

Add support for WebHooks

cebe modified the milestones: 1.6.0, 1.7.0 Feb 9, 2022

Xerkus and others added 2 commits February 9, 2022 12:31

Update pre-release openapi 3.1 schema to current (#140)

c88cb31

Signed-off-by: Aleksei Khudiakov <aleksey@xerkus.pro>

cebe modified the milestones: 1.7.0, 1.8.0 Apr 20, 2022

cebe mentioned this pull request Apr 20, 2022

OpenAPI v3.1 Support thephpleague/openapi-psr7-validator#163

Open

scaytrase mentioned this pull request Jan 27, 2023

Use devizzent/cebe-php-openapi to be compatible with OpenApi 3.1 thephpleague/openapi-psr7-validator#185

Merged

shulard mentioned this pull request Jun 16, 2023

Switch to devizzent/cebe-php-openapi over cebe/php-openapi ? CHStudio/Raven#25

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Draft: OpenAPI 3.1 #128

Draft: OpenAPI 3.1 #128

cebe commented Oct 18, 2021 •

edited

Jean85 commented Oct 19, 2021

cebe commented Apr 20, 2022

colinmollenhour commented Jun 23, 2022

colinmollenhour commented Jun 23, 2022

philsturgeon commented Jun 30, 2022

shulard commented Oct 8, 2022

philsturgeon commented Oct 19, 2022

WyriHaximus commented Jan 12, 2023

WyriHaximus commented Jan 13, 2023

WyriHaximus commented Jan 17, 2023

DEVizzent commented Jan 19, 2023

acelaya commented Jun 16, 2023

DEVizzent commented Jun 16, 2023

acelaya commented Jun 16, 2023 •

edited

shulard commented Jun 16, 2023

DEVizzent commented Jun 16, 2023

DEVizzent commented Jun 16, 2023

Draft: OpenAPI 3.1 #128

Are you sure you want to change the base?

Draft: OpenAPI 3.1 #128

Conversation

cebe commented Oct 18, 2021 • edited

Jean85 commented Oct 19, 2021

cebe commented Apr 20, 2022

colinmollenhour commented Jun 23, 2022

colinmollenhour commented Jun 23, 2022

philsturgeon commented Jun 30, 2022

shulard commented Oct 8, 2022

philsturgeon commented Oct 19, 2022

WyriHaximus commented Jan 12, 2023

WyriHaximus commented Jan 13, 2023

WyriHaximus commented Jan 17, 2023

DEVizzent commented Jan 19, 2023

acelaya commented Jun 16, 2023

DEVizzent commented Jun 16, 2023

acelaya commented Jun 16, 2023 • edited

shulard commented Jun 16, 2023

DEVizzent commented Jun 16, 2023

DEVizzent commented Jun 16, 2023

cebe commented Oct 18, 2021 •

edited

acelaya commented Jun 16, 2023 •

edited