Skip to content

Commit 96faa47

Browse files
committed
Integrations compatibility info
1 parent 249ef16 commit 96faa47

File tree

8 files changed

+51
-0
lines changed

8 files changed

+51
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,20 @@ and [OpenAPI v3.1](https://github.com/OAI/OpenAPI-Specification/blob/main/versio
3838

3939
Check documentation to see more details about the features. All documentation is in the "docs" directory and online at [openapi-core.readthedocs.io](https://openapi-core.readthedocs.io)
4040

41+
## Integrations compatibility matrix
42+
43+
Supported [Integrations](https://openapi-core.readthedocs.io/en/latest/integrations.html) and it's variants:
44+
45+
| Integration | Variant(s) |
46+
| --- | --- |
47+
| `aiohttp` | versions 3.8+ and 3.11+ tracks |
48+
| `django` | versions 4 and 5 |
49+
| `falcon` | version 4 |
50+
| `fastapi` | versions 0.11x and 0.12x |
51+
| `flask` | versions 2 and 3 |
52+
| `requests` | default dependency set |
53+
| `starlette` | versions 0.4x and 0.5x |
54+
| `werkzeug` | default dependency set |
4155

4256
## Installation
4357

docs/contributing.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,3 +71,16 @@ pre-commit run --all-files
7171
```
7272

7373
Pre-commit check results are also attached to your PR through integration with GitHub Actions.
74+
75+
### Integration compatibility matrix
76+
77+
Contrib integrations are tested in CI against framework version variants and
78+
Python versions. The matrix source of truth is:
79+
80+
- `.github/workflows/integration-tests.yml`
81+
82+
When changing integration compatibility, update both:
83+
84+
- dependency constraints in `pyproject.toml`
85+
- integration variants in `.github/workflows/integration-tests.yml`
86+
- information in `docs/integrations` and `README.md`

docs/integrations/aiohttp.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
This section describes integration with [aiohttp.web](https://docs.aiohttp.org/en/stable/web.html) framework.
44

5+
## Supported versions
6+
7+
- aiohttp versions 3.8+ and 3.11+ tracks
8+
59
## Low level
610

711
The integration defines classes useful for low level integration.

docs/integrations/django.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
This section describes the integration with the [Django](https://www.djangoproject.com) web framework.
44
The integration supports Django version 3.0 and above.
55

6+
## Supported versions
7+
8+
- Django versions 4 and 5
9+
610
## Middleware
711

812
Django can be integrated using [middleware](https://docs.djangoproject.com/en/5.0/topics/http/middleware/) to apply OpenAPI validation to your entire application.

docs/integrations/falcon.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
This section describes the integration with the [Falcon](https://falconframework.org) web framework.
44
The integration supports Falcon version 3.0 and above.
55

6+
## Supported versions
7+
8+
- Falcon version 4
9+
610
!!! warning
711

812
This integration does not support multipart form body requests.

docs/integrations/fastapi.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
This section describes integration with [FastAPI](https://fastapi.tiangolo.com) ASGI framework.
44

5+
## Supported versions
6+
7+
- FastAPI versions 0.11x and 0.12x
8+
59
!!! note
610

711
FastAPI also provides OpenAPI support. The main difference is that, unlike FastAPI's code-first approach, OpenAPI-core allows you to leverage your existing specification that aligns with the API-First approach. You can read more about API-first vs. code-first in the [Guide to API-first](https://www.postman.com/api-first/).

docs/integrations/flask.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
This section describes integration with the [Flask](https://flask.palletsprojects.com) web framework.
44

5+
## Supported versions
6+
7+
- Flask versions 2 and 3
8+
59
## View decorator
610

711
Flask can be integrated using a [view decorator](https://flask.palletsprojects.com/en/latest/patterns/viewdecorators/) to apply OpenAPI validation to your application's specific views.

docs/integrations/starlette.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
This section describes integration with the [Starlette](https://www.starlette.io) ASGI framework.
44

5+
## Supported versions
6+
7+
- Starlette versions 0.4x and 0.5x
8+
59
## Middleware
610

711
Starlette can be integrated using [middleware](https://www.starlette.io/middleware/) to apply OpenAPI validation to your entire application.

0 commit comments

Comments
 (0)