Commit Graph

92 Commits

Author SHA1 Message Date
Eugene Fabrikant
6f600234fe Updated API Key example link to correct location (#1089)
* Updated API Key example link to correct location

* Fixed example href location per PR feedback
2019-12-03 22:03:01 +01:00
Christian Siegel
67f48ae24d Add swagger_ui_config option to pass config to the Swagger UI (#948)
* Add swagger_ui_config option to configure the Swagger UI

There was no possibility to configure the Swagger UI. Through
this new option a config object can be passed to the UI via
a `swagger-ui-config.json` file.

* Add tests for swagger_ui_config option
2019-11-05 10:12:59 +01:00
Tomasz Trębski
ec37d03902 Drop Python 2.7 support (#1058)
* Drop 2.7

* fixup! Drop 2.7

* fixup! Drop 2.7
2019-10-27 23:01:23 +01:00
rgmerk
c94fa6127a Instructions for deploying on modwsgi (#1018) 2019-10-18 12:41:39 +02:00
Asbjørn Apeland
485380d54f Document how to set Swagger UI path (#1051) 2019-10-09 18:28:14 +02:00
Albert Suarez
1a9db69583 Fixed [connextion] typo in documentation page (#1049) 2019-10-08 14:00:16 +02:00
Christian Siegel
d5699cc897 Mention pythonic_params in request docs (#947) 2019-07-11 13:12:33 +02:00
Tomasz Trębski
123c5c9fbd Remove Python 3.4 (#990)
* EOL Python 3.4

* fixup! EOL Python 3.4

* fixup! EOL Python 3.4

* fixup! EOL Python 3.4
2019-07-09 13:53:44 +02:00
Dan Walker
d24a8e2579 Update request.rst (#953)
Fix duplication
2019-06-07 12:01:51 +02:00
Spencer Herzberg
0989a93df5 fixes basic auth example doc; adds apikey example (#894)
* fixes basic auth example doc; adds apikey example

* remove required_scopes references that dont pertain to apikey
2019-03-11 08:22:37 +01:00
Simon
92867452a2 Added MethodViewResolver (#847)
* Added MethodViewResolver

By subclassing RestyResolver and modifying its `resolve_function_from_operation_id` method, it is now possible to use automatic routing functionality with Flask's MethodView together with MethodViewResolver.

* Add MethodView example

* Add tests for methodview

* add documentation on how to use MethodViewResolver
2019-02-04 08:25:27 +01:00
Daniel Grossmann-Kavanagh
d8cd116154 fix docs on adding error handler (#818) 2018-12-18 08:28:06 +01:00
Phil Sturgeon
fc8e018a8b Swagger -> OpenAPI (#813) 2018-12-11 08:30:15 +01:00
krise3k
2fc255f86d Fix link to example in JWT docs (#776)
Fix not working link to example in JWT docs.
2018-11-13 13:38:30 +01:00
The UNIX Man
b66aee3089 collectionFormat doesn't need the ' (#778)
It's plural.
2018-11-13 13:37:34 +01:00
The UNIX Man
6bf058f6b7 Use / instead of \ (#777)
URIs use forward slashes.
2018-11-13 13:36:49 +01:00
Daniel Grossmann-Kavanagh
343643428c update documentation (#771) 2018-11-12 09:40:42 +01:00
krise3k
6ec11825b8 Add support for JWT authentication (#732)
* Add support for JWT

* Add example for JWT

* Add minimal JWT documentation
2018-11-12 08:53:50 +01:00
Henning Jacobs
845d4255ab Update docs version to 2.0 (#744)
- Fixes #717 for now.
2018-11-07 08:15:37 +01:00
João Santos
44ea9336fe Connexion 2.0 (#619)
- App and Api options must be provided through the "options" argument (``old_style_options`` have been removed).
- You must specify a form content-type in 'consumes' in order to consume form data.
- The `Operation` interface has been formalized in the `AbstractOperation` class.
- The `Operation` class has been renamed to `Swagger2Operation`.
- Array parameter deserialization now follows the Swagger 2.0 spec more closely.
  In situations when a query parameter is passed multiple times, and the collectionFormat is either csv or pipes, the right-most value will be used.
  For example, `?q=1,2,3&q=4,5,6` will result in `q = [4, 5, 6]`.
  The old behavior is available by setting the collectionFormat to `multi`, or by importing `decorators.uri_parsing.AlwaysMultiURIParser` and passing `parser_class=AlwaysMultiURIParser` to your Api.
- The spec validator library has changed from `swagger-spec-validator` to `openapi-spec-validator`.
- Errors that previously raised `SwaggerValidationError` now raise the `InvalidSpecification` exception.
  All spec validation errors should be wrapped with `InvalidSpecification`.
- Support for nullable/x-nullable, readOnly and writeOnly/x-writeOnly has been added to the standard json schema validator.
- Custom validators can now be specified on api level (instead of app level).
- Added support for basic authentication and apikey authentication
- If unsupported security requirements are defined or ``x-tokenInfoFunc``/``x-tokenInfoUrl`` is missing, connexion now denies requests instead of allowing access without security-check.
- Accessing ``connexion.request.user`` / ``flask.request.user`` is no longer supported, use ``connexion.context['user']`` instead
2018-11-05 14:50:42 +01:00
Roberto Polli
1596f18b3d Fix: #582. Describe logging (#693)
- Show how to configure the logger
- Show how to access the logger
2018-10-04 08:41:21 +02:00
fdemello
cbca315326 Update routing.rst (#674)
Changes proposed in #596
2018-09-14 09:12:20 +02:00
Tomer Cohen
ccd62f897f fix link to odata (#661)
Link has markdown syntax in a reStructuredText document.
2018-08-08 20:29:30 +02:00
Zach Bloomquist
1fbb1ff941 Clarify the x-tokenInfoFunc interface (#609) 2018-06-28 07:37:53 +02:00
Henning Jacobs
b775d4de05 Merge branch 'aiohttp_support' of https://github.com/dutradda/connexion into dutradda-aiohttp_support 2018-04-09 21:22:55 +02:00
Ishaan Kumar
9f20c5ffb7 Minor typo (#567) 2018-02-13 10:55:20 +01:00
Diogo Dutra
34b4f941aa Added some documentation for aiohttp backend 2018-01-18 14:27:08 -02:00
Henning Jacobs
4486438e70 run tests against PyPI dependencies for release (#561)
* run tests against PyPI dependencies for release

* fix docs format
2018-01-13 19:57:28 +01:00
Maico Timmerman
546782a8d6 Updated docs and README 2018-01-10 23:05:44 +01:00
Jeremy
6af5dff3de Update CORS documentation (#524)
Resolved error since flask cors was moved to its own project: `ExtDeprecationWarning: Importing flask.ext.cors is deprecated, use flask_cors instead.`

Will also require installation `pip install -U flask-cors`
2017-10-10 23:22:42 +02:00
JulianLiu
bec650f638 path changes for JSONEncoder
After the refactor of uncouple all flask functions from base code, JSONEncoder should be `connexion.apps.flask_app.FlaskJSONEncoder` now.
2017-04-09 10:43:29 +08:00
Henning Jacobs
d9edc36647 Ignore context args (#429)
* #428 add unit test

* #428 ignore context param if not in function args

* #428 update OAuth2 example app

* #428 update security docs
2017-04-05 14:32:40 +02:00
Diogo
5857dd237f Uncouple all flask functions from base code.
removed test_decorators and test_parameter (this test is useless now);
removed the request/response containers and add new request response classes;
created a abstract api class and a api flask class;
derived classes will implements the get_response/get_request methods that will convert framework req/resp types to connexion req/resp types;
moved the jsonifier from produces to flask api;
created a abstract app class and a app flask class;
changed all validators to use the ConnexionRequest instead flask request;
changed the problem function to generate a ConnexionRequest;
created a new user variables container called context (this is a property of ConnexionRequest). this will be passed as kwargs to all operations functions;
this context is used on authentication;
fixed all tests to new API;
some changes that I did may not be documented in this commit.
2017-04-04 08:20:24 -03:00
Diogo Dutra
a7af62fbf0 Uncouple flask from App and Api. Created Abstract classes for theses modules. Fixed the tests 2017-04-04 08:20:23 -03:00
Patrick Williams
6eb5a6e969 Support the flask url variable converter "path" 2017-01-07 10:02:44 -05:00
Matthew Farrellee
5ce9083f20 correct doc for RestyResolver PUT requests 2017-01-03 06:22:08 -05:00
George Wilson
136b960fdc Fix issues raised by @hjacobs 2016-12-23 21:56:43 +00:00
George Wilson
f14791a2ca Add to index 2016-12-23 13:10:40 +00:00
George Wilson
936c6f1555 More code style 2016-12-23 13:09:05 +00:00
George Wilson
39cd7b7b87 File name 2016-12-23 13:06:36 +00:00
George Wilson
6117ae5ec5 Try and fix code style 2016-12-23 13:06:01 +00:00
George Wilson
7a9329fe6b Add docs on custom OAuth 2 Exceptions 2016-12-23 13:02:10 +00:00
Rafael Carício
138e231e7b Merge pull request #352 from phoracek/custom_validator
Validators refactoring
2016-12-05 19:14:28 +01:00
Petr Horáček
e166d0fea5 add documentation for custom validators 2016-12-04 13:07:21 +01:00
Henning Jacobs
29e11cefd4 how to enable CORS 2016-12-02 09:27:02 +01:00
Michael Wild
b638b1168e Adds parameter name sanitization in parameters_to_args()
Without sanitization e.g. OData query parameters, such as $skip, $top,
$filter cannot be passed to the controller (except by use of **kwargs).

Fixes: zalando/connexion#334
2016-10-31 15:16:03 +01:00
Jason Estibeiro
e6ce534082 Made minor spelling and grammatical corrections 2016-10-27 12:30:03 +05:30
Henning Jacobs
e8ffc95e17 #292 mention --mock in docs 2016-09-29 19:22:48 +02:00
Rafael Caricio
6076f96fd3 Fix typo 2016-09-15 00:51:53 +02:00
Rafael Caricio
fec010b2f8 Document connexion run command 2016-09-14 23:04:35 +02:00