13 Commits

Author SHA1 Message Date
Robbe Sneyders
b244d80908 Fix 'Edit on GitHub' link on docs (#1799)
Fixes #1797 

[Relevant
docs](https://docs.readthedocs.io/en/stable/guides/edit-source-links-sphinx.html#github).
2023-11-09 10:05:31 +01:00
Robbe Sneyders
cbeac6f2c1 Update security docs (#1764)
Contributes to #1531
2023-10-31 20:08:04 +01:00
Robbe Sneyders
655ea430ed Add validation documentation (#1743)
Contributes to #1531
2023-10-17 23:57:06 +02:00
Robbe Sneyders
abc1da750e Update routing documentation (#1738)
Works towards #1531 

Some parts of the old outing docs will need to be included on the
`parameters` and `swagger-ui` pages which we still need to add.
2023-10-12 01:37:45 +02:00
Robbe Sneyders
0c0c517cf6 Update quickstart documentation (#1701)
Contributes towards #1531

Updates the quickstart documentation for v3. I removed some more
detailed stuff that I don't think belongs on this page.
2023-05-09 22:22:52 +02:00
Robbe Sneyders
c257f04806 Fix ReadTheDocs config for Poetry (#1663) 2023-03-03 09:21:54 +01:00
Robbe Sneyders
edb0381af3 Implement user facing interface for ConnexionMiddleware (#1621)
This PR adds an interface for the ConnexionMiddleware, similar to the
interface of the Connexion Apps.

The Connexion Apps are now a simple wrapper around the
ConnexionMiddleware and framework app, delegating the work to the
middleware. This enables a similar interface and behavior for users when
using either the middleware or apps.

The arguments are repeated everywhere there is a user interface, but are
parsed in a central place. Repeating the arguments is not DRY, but
needed to provide users with IDE autocomplete, typing, etc. They are
parsed in a single `_Options` class, which also provides a mechanism to
set default options on an App level, and override them on the more
granular API level.

This makes the long list of provided parameters a lot more manageable,
so I would like to use it for the `Jsonifier` as well, and re-add the
`debug` and `extra_files` arguments which I have dropped in previous
PRs. I'll submit a separate PR for this.

I renamed the `options` parameter to `swagger_ui_options` since it only
contains swagger UI options. This is a breaking change though, and we'll
need to highlight this upon release.

We still have quite a lot of `App`, `MiddlewareApp`, and abstract
classes. It would be great if we could find a way to reduce those
further, or at least find better naming to make it more clear what each
one does 🙂 .

Finally, I added examples on how the middleware can be used with third
party frameworks under `examples/frameworks`. Currently there's an
example for Starlette and Quart, but this should be easy to extend. They
also show how the `ASGIDecorator` and `StarletteDecorator` from my
previous PR can be used.
2023-01-26 14:40:29 +01:00
Ruwann
a67baa5be0 Use both class docstring and init docstring for autoapi (#1451) 2022-02-05 14:39:02 +01:00
Robbe Sneyders
e3dd3c9273 Add API reference documentation (#1390)
* Add auto generated api documentation

* Fix rst formatting errors

* Add flake8 rst docstring check
2021-07-06 23:33:20 +02:00
Christian Clauss
6c4f99051d Upgrade syntax for Python >= 3.6 (#1383)
* pyupgrade --py36-plus **/*.py

* Fix indentation

* Fix indentation
2021-07-04 20:04:22 +02:00
Henning Jacobs
845d4255ab Update docs version to 2.0 (#744)
- Fixes #717 for now.
2018-11-07 08:15:37 +01:00
Rafael Caricio
2558a611f4 #104 typecasting in path parameters 2016-03-04 18:41:57 +01:00
João Santos
345ed84924 https://github.com/zalando/connexion/issues/11 Some documentation 2015-06-17 14:12:08 +02:00