Skip to content

Commit 7ab3a59

Browse files
committed
Integrations compatibility info
1 parent 249ef16 commit 7ab3a59

File tree

8 files changed

+33
-6
lines changed

8 files changed

+33
-6
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 versions:
44+
45+
| Integration | Version(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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# aiohttp.web
22

3-
This section describes integration with [aiohttp.web](https://docs.aiohttp.org/en/stable/web.html) framework.
3+
This section describes integration with [aiohttp.web](https://docs.aiohttp.org/en/stable/web.html) framework. The integration supports aiohttp version 3.8+.
44

55
## Low level
66

docs/integrations/django.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Django
22

33
This section describes the integration with the [Django](https://www.djangoproject.com) web framework.
4-
The integration supports Django version 3.0 and above.
4+
The integration supports Django version 4 and 5.
55

66
## Middleware
77

docs/integrations/falcon.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Falcon
22

33
This section describes the integration with the [Falcon](https://falconframework.org) web framework.
4-
The integration supports Falcon version 3.0 and above.
4+
The integration supports Falcon version 4.
55

66
!!! warning
77

docs/integrations/fastapi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# FastAPI
22

3-
This section describes integration with [FastAPI](https://fastapi.tiangolo.com) ASGI framework.
3+
This section describes integration with [FastAPI](https://fastapi.tiangolo.com) ASGI framework. The integration supports FastAPI versions 0.11x and 0.12x.
44

55
!!! note
66

docs/integrations/flask.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Flask
22

3-
This section describes integration with the [Flask](https://flask.palletsprojects.com) web framework.
3+
This section describes integration with the [Flask](https://flask.palletsprojects.com) web framework. The integration supports Flask versions 2 and 3.
44

55
## View decorator
66

docs/integrations/starlette.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Starlette
22

3-
This section describes integration with the [Starlette](https://www.starlette.io) ASGI framework.
3+
This section describes integration with the [Starlette](https://www.starlette.io) ASGI framework. The integration supports Flask versions 0.4x and 0.5x.
44

55
## Middleware
66

0 commit comments

Comments
 (0)