Add support for WebHooks by WyriHaximus · Pull Request #115 · cebe/php-openapi

WyriHaximus · 2021-06-01T17:24:10Z

No description provided.

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

@WyriHaximus please rebase this on the openapi-31 branch. We'll add all 3.1 features to that branch and merge it into master when ready.

WyriHaximus · 2021-10-18T18:08:11Z

@cebe Will rebase and push later tonight 👍

WyriHaximus · 2021-10-18T20:10:29Z

@cebe Rebased it, is there any specific testing I should add reside from the existing change?

cebe · 2021-10-18T20:29:59Z

Webhook property check should depend in the openapi Version. Only require webhook in 3.1 and keep old behavior in 3.0.

Also would be good to have a WebHookTest which checks basic webhook example

WyriHaximus · 2021-10-18T22:14:59Z

Webhook property check should depend in the openapi Version. Only require webhook in 3.1 and keep old behavior in 3.0.

Done that just now

Also would be good to have a WebHookTest which checks basic webhook example

Doing this tomorrow 👍

marcelthole · 2021-10-20T12:48:25Z

src/spec/OpenApi.php

+        if ($this->getMajorVersion() === static::VERSION_3_0) {
+            $this->requireProperties(['openapi', 'info', 'paths']);
+        } else {
+            $this->requireProperties(['openapi', 'info'], ['paths', 'webhooks']);


I added the testcases for OpenAPI 3.1 here #129 and the OpenAPI Schema says, that only openapi and info is a required field in OpenAPI 3.1

// vendor/oai/openapi-specification-3.1/schemas/v3.1/schema.json "required": [ "openapi", "info" ]

// vendor/oai/openapi-specification-3.1/schemas/v3.0/schema.json "required": [ "openapi", "info", "paths" ],

Interesting, I was expecting to be a oneOf for paths and webhooks: https://github.com/OAI/OpenAPI-Specification/blob/main/schemas/v3.1/schema.json#L56-L72

yeah you are right. Thats my fault. Then components are also possible and missing in the atLeastOne argument.

Then should the examples with components, hooks and paths should work

Subscribed to #129 I'll rebase this PR and fix any errors coming up when it gets merged

here is the text representation of that from the specification:

https://spec.openapis.org/oas/latest.html#openapi-document
The OpenAPI document MUST contain at least one paths field, a components field or a webhooks field.

tests/spec/OpenApiTest.php

WyriHaximus · 2021-10-31T21:46:25Z

Rebased now that #129 has been merged.

Also would be good to have a WebHookTest which checks basic webhook example

Doing this tomorrow +1

@cebe Basic variant for this is in (been since nearly two weeks but details 😛 ), do you want me to expand it, or rely on the tests added from #129?

cebe · 2021-11-21T00:19:28Z

src/spec/OpenApi.php

            'info' => Info::class,
            'servers' => [Server::class],
            'paths' => Paths::class,
+            'webhooks' => WebHooks::class,


is there a specific reason why you introduce the "WebHooks" class and not implement this as a map of "string"->"PathItem" as described in the specification?

... ... ...

webhooks Map[string, Path Item Object | Reference Object] ] The incoming webhooks that MAY be received as part of this API and that the API consumer MAY choose to implement. Closely related to the callbacks feature, this section describes requests initiated other than by an API call, for example by an out of band registration. The key name is a unique string to refer to each webhook, while the (optionally referenced) Path Item Object describes a request that may be initiated by the API provider and the expected responses. An example is available.

https://spec.openapis.org/oas/v3.1.0#openapi-object

The WebHooks class is a copy, with some things changed, of the Paths class. Would the alternative just be wrapping a Path::class in an array, like servers?

src/spec/Schema.php

src/spec/Type.php

cebe · 2021-11-21T00:28:53Z

been since nearly two weeks but details

I'm not better in this, so not judging you ;-)

Tests are fine, I just wonder about implementation. I tried to follow the spec quite stricly in which Objects are described. There is a "Paths" object in the spec but no "Webhooks" object, which is not consistent. Need to decide if it's fine for the implementation to break with the strict dependence on the spec or not.

WyriHaximus · 2021-11-25T16:28:23Z

I tried to follow the spec quite stricly in which Objects are described. There is a "Paths" object in the spec but no "Webhooks" object, which is not consistent. Need to decide if it's fine for the implementation to break with the strict dependence on the spec or not.

Just dropped the WebHooks class of in a new commit so you can compare both.

cebe · 2021-11-29T16:54:07Z

Thanks, looks good.

cebe · 2021-11-29T17:12:19Z

Tests are failing with Error: Class 'cebe\openapi\spec\WebHooks' not found

WyriHaximus · 2021-11-29T17:26:29Z

Tests are failing with Error: Class 'cebe\openapi\spec\WebHooks' not found

Whoops, want me to squash both commits into one?

WyriHaximus · 2021-11-30T07:18:28Z

Squashed both commits together

cebe · 2021-12-21T13:30:57Z

Thank you!

WyriHaximus · 2021-12-21T17:37:45Z

No problem, looking forward to having full support in

This was referenced Jun 1, 2021

Webhook support #114

Closed

[WIP] Add support for webhooks thephpleague/openapi-psr7-validator#129

Closed

WyriHaximus force-pushed the webhooks branch 4 times, most recently from 4ac9951 to a0ed996 Compare June 7, 2021 18:14

cebe added this to the 1.6.0 milestone Oct 13, 2021

cebe added the openapi 3.1 label Oct 13, 2021

WyriHaximus changed the base branch from master to openapi-31 October 18, 2021 18:04

WyriHaximus force-pushed the webhooks branch from a0ed996 to 3f41a71 Compare October 18, 2021 20:09

WyriHaximus changed the title ~~[WIP] Add support for WebHooks~~ Add support for WebHooks Oct 18, 2021

WyriHaximus marked this pull request as ready for review October 18, 2021 20:11

WyriHaximus force-pushed the webhooks branch from 3f41a71 to cc9c707 Compare October 18, 2021 22:14

WyriHaximus force-pushed the webhooks branch 2 times, most recently from 2176808 to 0df8b5e Compare October 20, 2021 07:09

marcelthole reviewed Oct 20, 2021

View reviewed changes

WyriHaximus force-pushed the webhooks branch 2 times, most recently from 48586f5 to f7ecbac Compare October 20, 2021 15:53

cebe reviewed Oct 20, 2021

View reviewed changes

tests/spec/OpenApiTest.php Outdated Show resolved Hide resolved

WyriHaximus force-pushed the webhooks branch from f7ecbac to 8142289 Compare October 20, 2021 19:43

WyriHaximus mentioned this pull request Oct 31, 2021

Add Testcases for OpenAPI 3.1 #129

Merged

WyriHaximus force-pushed the webhooks branch from 8142289 to 12da888 Compare October 31, 2021 21:19

cebe requested changes Nov 21, 2021

View reviewed changes

WyriHaximus force-pushed the webhooks branch from 12da888 to 4e30366 Compare November 25, 2021 16:22

WyriHaximus force-pushed the webhooks branch from 2a5d0c9 to 8c4f36a Compare November 29, 2021 17:26

Add support for WebHooks

0c10bea

WyriHaximus force-pushed the webhooks branch from 8c4f36a to 0c10bea Compare November 30, 2021 07:17

cebe merged commit 088af05 into cebe:openapi-31 Dec 21, 2021

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

cebe mentioned this pull request Apr 20, 2022

Draft: OpenAPI 3.1 #128

Open

3 tasks

WyriHaximus deleted the webhooks branch January 12, 2023 22:15

Conversation

WyriHaximus commented Jun 1, 2021

Uh oh!

cebe commented Oct 18, 2021

Uh oh!

WyriHaximus commented Oct 18, 2021

Uh oh!

WyriHaximus commented Oct 18, 2021

Uh oh!

cebe commented Oct 18, 2021

Uh oh!

WyriHaximus commented Oct 18, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

marcelthole Oct 20, 2021

Choose a reason for hiding this comment

Uh oh!

WyriHaximus Oct 20, 2021

Choose a reason for hiding this comment

Uh oh!

marcelthole Oct 20, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

WyriHaximus Oct 20, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cebe Oct 20, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

WyriHaximus commented Oct 31, 2021

Uh oh!

cebe Nov 21, 2021

Choose a reason for hiding this comment

Uh oh!

WyriHaximus Nov 25, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

cebe commented Nov 21, 2021

Uh oh!

WyriHaximus commented Nov 25, 2021

Uh oh!

cebe commented Nov 29, 2021

Uh oh!

cebe commented Nov 29, 2021

Uh oh!

WyriHaximus commented Nov 29, 2021

Uh oh!

WyriHaximus commented Nov 30, 2021

Uh oh!

cebe commented Dec 21, 2021

Uh oh!

WyriHaximus commented Dec 21, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

WyriHaximus commented Oct 18, 2021 •

edited

Loading

marcelthole Oct 20, 2021 •

edited

Loading

WyriHaximus Oct 20, 2021 •

edited

Loading