Update to openapi-core 0.17 #206

zupo · 2023-03-24T11:10:35Z

This is quite a breaking change.

We are dropping support for all older versions of openapi-core and for OpenAPI 3.0 (upgraded to 3.1).

Refs #203
Refs python-openapi/openapi-core#542

pyproject.toml

zupo · 2023-03-24T11:12:42Z

pyramid_openapi3/__init__.py

-        validated = settings["request_validator"].validate(
-            settings["spec"], openapi_request
-        )
+        validated = settings["request_validator"].unmarshal(openapi_request)


The spec is now provided when settings["request_validator"] is instantiated during Pyramid bootup.

zupo · 2023-03-24T11:14:01Z

pyramid_openapi3/tests/test_app_construction.py

    info:
      version: "1.0.0"
      title: Foo API
    servers:
      - url: /api/v1
    paths:
      /foo:
-        $ref: "paths.yaml#/foo"
+        # $ref: "paths.yaml#/foo"


Can't get refs to work. Needs further investigation.

So it seems refs work for everything but for paths?

Details: 9b080c1

Is this good enough?

@damonhook: can you pls have a look if you can get examples/splitfile to work with paths being in a separate paths.yaml file? I can probably take it from there then, fix the rests of the tests and such.

So it is not just file references not working, but any reference at the paths level.
E.g: doing the following also breaks.

paths: /: $ref: "#/components/pathItems/todos" components: pathItems: todos: get: ... post: ...

However, this seems to be an issue with the openapi-spec-validator library. I checked and ref's are allowed here in the OpenAPI 3.1 spec, and if I disable validation of the spec, openapi-core handles it correctly (I can make requests and the parameters pull through correctly).

Going to dig into the openapi-spec-validator library a bit and either create an issue/PR on that side

python-openapi/openapi-spec-validator#207

I see that this openapi-spec-validator issue has been closed. The refs in the paths should hopefully work now

Example openapi.yaml

openapi: 3.1.0 info: title: Example API version: 1.0.0 paths: /: $ref: "#/components/pathItems/rootPath" components: pathItems: rootPath: get: responses: 200: description: Example Response⏎

openapi-spec-validator openapi.yaml OK

Previous version of openapi-spec-validator was raising an error

Will give it a test with the examples/splitfile

zupo · 2023-03-24T11:14:26Z

pyramid_openapi3/tests/test_extract_errors.py

                "message": "'not-a-valid-uuid' does not match '^[0-9]{2}-[A-F]{4}$'",
-                # TODO: ideally, this response would include "field"
-                # but I don't know how I can achieve this ATM ¯\_(ツ)_/¯  # noqa: ENC100


zupo · 2023-03-24T11:15:04Z

pyramid_openapi3/tests/test_extract_errors.py

-                    ]
-                )
-            return True
+    def validate(self, name: str) -> bool:


Same thing as before, just no longer needs to be wrapped in a class.

zupo · 2023-03-24T11:17:33Z

pyramid_openapi3/tween.py

@@ -41,8 +41,8 @@ def excview_tween(request: Request) -> Response:
            if "routes" in gsettings:
                settings_key = gsettings["routes"][request.matched_route.name]
                settings = request.registry.settings[settings_key]
-            result = settings["response_validator"].validate(
-                settings["spec"], request=openapi_request, response=openapi_response
+            result = settings["response_validator"].unmarshal(


We now have to use unmarshal to get the deserialized values, validate doesn't return anything.

In this light the request.openapi_validated should maybe be renamed to request.openapi_unmarshalled but that's such a mouthful.

zupo · 2023-03-24T11:19:09Z

@am-on, @damonhook, @dz0ny, @miohtama: if you can spare some brain cycles, I'd love a review of the changes.

blueracer-io · 2023-03-24T12:01:44Z

Unit tests performance report: ❌

Whoa, hold your horses! This pull request is really slowing down your tests! Are you sure you want to merge it?

Branch	Number of tests	Suite duration	Mean test duration
`main`	87	1.7s¹	18.7ms¹
`update/openapi-core_0.17`²	87 (0%)	2.6s (53%) ❌	30.1ms (61%) ❌

Found 1 new test, this is how it compares to existing tests:

Name	Duration	Percentile Score	Status
BadRequestsTests.test_missing_JWT_token	43ms	slower than 77% of existing tests	👀

The median/mean of the previous 15 runs. ↩ ↩²
More specifically from commit 4b7879aa80f4d9a3595428b4f21f3253c895b780 in run #1. ↩

pyramid_openapi3/__init__.py

Older versions don't support OpenApi v3.1.

damonhook

I noticed that with a later release of openapi-core, running the Spec.create(...) seems to run the validator https://github.com/python-openapi/openapi-core/blob/59996250c5f316c8fc64512115bfd18f587b78ee/openapi_core/spec/paths.py#L29

So we can likely remove the validate_spec() calls we make
here and here. Right now we are validating the spec twice

zupo · 2023-06-19T20:50:07Z

Swagger UI 5 is released! https://github.com/swagger-api/swagger-ui/releases

kskarthik · 2023-06-21T07:55:38Z

Swagger UI 5 is released! https://github.com/swagger-api/swagger-ui/releases

do hey have multiple supported versions? I have observed 4.x series & 5.x series

Edit: previous were beta releases of 5.x didn't observe previously

damonhook

I see from the 0.17 release notes that Spec.create is deprecated.
https://github.com/python-openapi/openapi-core/releases/tag/0.17.0

While it will still work on 0.17, It does have a deprecation warning (and it has been removed in 0.18)

In `add_spec_view`

pyramid_openapi3/pyramid_openapi3/__init__.py

Line 227 in 389356b

spec = Spec.create(spec_dict)

Should change to

spec = Spec.from_dict(spec_dict)

In `add_spec_view_directory`

pyramid_openapi3/pyramid_openapi3/__init__.py

Line 279 in 389356b

spec = Spec.create(spec_dict, url=spec_url)

Should change to

spec = Spec.from_dict(spec_dict, spec_url=spec_url)

Note

In 0.18, spec_url will be changing to base_uri, but for 0.17 we need to still use spec_url

zupo · 2024-03-07T21:02:10Z

The upgrade to openapi-core was done in #220.

This PR then remains a good basis to work on bringing in OpenAPI v3.1 support, but I imagine a new PR should be opened.

zupo added 5 commits March 23, 2023 23:46

wip

8b3967f

all but custom formatters and

1acd6a6

fix custom formatters

96f5bf3

add custom deserializer test for response too

5bf9b2c

refactor InvalidSecurity -> SecurityValidationError

cdcec95

zupo commented Mar 24, 2023

View reviewed changes

pyproject.toml Outdated Show resolved Hide resolved

zupo commented Mar 24, 2023

View reviewed changes

fix splitfile example

9b080c1

damonhook reviewed Mar 27, 2023

View reviewed changes

pyramid_openapi3/__init__.py Show resolved Hide resolved

zupo added 2 commits April 13, 2023 12:45

my fix was merged, we can now go back to using upstream

32f9942

We have to use an alpha release of the upcoming Swagger UI version 5.

389356b

Older versions don't support OpenApi v3.1.

damonhook reviewed Apr 20, 2023

View reviewed changes

zupo mentioned this pull request Jun 20, 2023

Cannot import name 'InvalidSchemaFormatValue', need support for openapi-core 0.17.0 #203

Closed

zupo mentioned this pull request Sep 22, 2023

$ref overwrites nullable property #159

Open

Wim-De-Clercq mentioned this pull request Nov 20, 2023

ImportError: cannot import name 'default_handlers' from 'openapi_spec_validator' OnroerendErfgoed/atramhasis#733

Closed

damonhook reviewed Jan 22, 2024

View reviewed changes

This was referenced Feb 27, 2024

Update to supported versions? #219

Closed

Update to use openapi-core 0.19.0 #220

Merged

zupo closed this Mar 7, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update to openapi-core 0.17 #206

Update to openapi-core 0.17 #206

zupo commented Mar 24, 2023 •

edited

Loading

zupo Mar 24, 2023

zupo Mar 24, 2023

zupo Mar 24, 2023

zupo Mar 24, 2023

zupo Mar 24, 2023

damonhook Apr 20, 2023

damonhook Apr 21, 2023

damonhook Jun 20, 2023

zupo Mar 24, 2023

zupo Mar 24, 2023

zupo Mar 24, 2023

zupo commented Mar 24, 2023

blueracer-io bot commented Mar 24, 2023 •

edited

Loading

damonhook left a comment •

edited

Loading

zupo commented Jun 19, 2023

kskarthik commented Jun 21, 2023 •

edited

Loading

damonhook left a comment

zupo commented Mar 7, 2024 •

edited

Loading

Update to openapi-core 0.17 #206

Update to openapi-core 0.17 #206

Conversation

zupo commented Mar 24, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zupo commented Mar 24, 2023

blueracer-io bot commented Mar 24, 2023 • edited Loading

Unit tests performance report: ❌

Footnotes

damonhook left a comment • edited Loading

Choose a reason for hiding this comment

zupo commented Jun 19, 2023

kskarthik commented Jun 21, 2023 • edited Loading

damonhook left a comment

Choose a reason for hiding this comment

In add_spec_view

In add_spec_view_directory

zupo commented Mar 7, 2024 • edited Loading

zupo commented Mar 24, 2023 •

edited

Loading

blueracer-io bot commented Mar 24, 2023 •

edited

Loading

damonhook left a comment •

edited

Loading

kskarthik commented Jun 21, 2023 •

edited

Loading

In `add_spec_view`

In `add_spec_view_directory`

zupo commented Mar 7, 2024 •

edited

Loading