17 Commits

Author SHA1 Message Date
Luke Hagar
38e177de38 fix: uneven quotes 2024-04-03 19:23:15 -07:00
Robbe Sneyders
17fcad0c30 Update response handling documenation (#1742)
Contributes to #1531
2023-10-16 23:51:21 +02:00
Ruwann
3703a46d09 Add link to Flask JSONEncoder documentation (#1484) 2022-03-12 11:01:28 +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
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
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
Petr Horáček
e166d0fea5 add documentation for custom validators 2016-12-04 13:07:21 +01:00
Jason Estibeiro
e6ce534082 Made minor spelling and grammatical corrections 2016-10-27 12:30:03 +05:30
bobbyrullo
5d41045dcb Fix link 2016-08-10 17:39:23 -07:00
Rafael Caricio
7cd60a9510 Docs on JSONEncoder customization 2016-03-31 16:03:40 +02:00
João Santos
495e865eb0 #75 Fixes suggested in the Pull Request 2016-03-04 15:19:54 +01:00
João Santos
3bb0eee664 #78 Document response validation 2016-03-04 14:58:07 +01:00
João Santos
82ca280642 #78 Document how to return a status code and headers 2016-03-04 14:50:24 +01:00
João Santos
ba77fc3f7f #75 Document how arguments are passed to the functions 2016-03-04 14:26:08 +01:00
João Santos
7bd4851689 #75 document request validation 2016-03-04 14:12:47 +01:00
João Santos
ac95f912f8 #167 Split response and request documentation 2016-03-04 13:37:54 +01:00