Pablo Marti
1ed5aa23e6
✏️ Fix typo in oauth2-jwt.md ( #447 )
2019-08-30 17:35:52 -05:00
Chris Withers
bdd251a05b
📝 Tweak wording on OAuth2 scopes ( #371 )
2019-07-12 18:17:34 -05:00
Sebastián Ramírez
9a71672a95
📝 Update enum examples to use str, and improve Swagger UI in examples ( #351 )
2019-06-28 21:27:27 +02:00
Sebastián Ramírez
d3ea6f7514
📝 Add note to docs about including same router multiple times ( #348 )
2019-06-28 19:54:49 +02:00
Camila Gutierrez
ab77c069d4
📝 Update, simplify, and clarify the SQL tutorial ( #331 )
2019-06-27 13:25:16 +02:00
cyril
1c2cdb97e9
📝 Add online SQLite browsers to docs ( #330 )
2019-06-27 13:12:38 +02:00
Sebastián Ramírez
aa84ac8e3e
✨ Implement support for Pydantic's ORM mode ( #322 )
...
* ✨ Implement support for Pydantic's ORM mode
* 🏗️ Re-structure/augment SQL tutorial source using ORM mode
* 📝 Update SQL docs with SQLAlchemy, ORM mode, relationships
* 🔥 Remove unused util in tutorial
* 📝 Add tutorials for simple dict bodies and responses
* 🔥 Remove old SQL tutorial
* ✅ Add/update tests for SQL tutorial
* ✅ Add tests for simple dicts (body and response)
* 🐛 Fix cloning field from original field
2019-06-20 11:31:32 +02:00
dmontagu
120ab08360
📝 Update response-directly.md, fix link ( #306 )
2019-06-13 18:34:20 +02:00
Andrew Widdersheim
3f5521fdfb
📝 Fix default response model docs ( #288 )
...
Fix a discrepancy in the `tax` parameters default value between the docs
and the code example.
2019-06-13 18:31:48 +02:00
Sebastián Ramírez
5f7fe926ab
✨ Add support for Response parameters to set headers, cookies, and status codes ( #294 )
...
* ✨ Add support for declaring a Response parameter to set headers and cookies
* ✅ Add source for docs and tests
* 📝 Add docs for setting headers, cookies and status code
* 📝 Add attribution to Hug for inspiring response parameters
2019-06-06 14:29:40 +04:00
Sebastián Ramírez
bff5dbbf5d
✨ Implement dependency value cache per request ( #292 )
...
* ✨ Add dependency cache, with support for disabling it
* ✅ Add tests for dependency cache
* 📝 Add docs about dependency value caching
2019-06-05 21:00:54 +04:00
Sebastián Ramírez
09cd7c47a1
✨ Implement dependency overrides for testing ( #291 )
...
* ✨ Implement dependency overrides for testing
* ✅ Add docs source tests and extra tests for dependency overrides
* 📝 Add docs for testing dependencies with overrides
2019-06-05 15:43:18 +04:00
Sebastián Ramírez
c7db2ff858
🐛 Fix path and query parameters receiving dict as valid ( #287 )
...
* 🐛 Fix path and query parameters accepting dict
* ✅ Add several tests to ensure invalid types are not accepted
* 📝 Document (to include tested source) using query params with list
* 🐛 Fix OpenAPI schema in query with list tutorial
2019-06-03 21:59:40 +04:00
dmontagu
360a2797c1
🐛 Fix docs link in oauth2-scopes.md ( #275 )
...
#274
2019-05-30 17:43:18 +04:00
Sebastián Ramírez
bd407cc4ed
✨ Refactor param extraction using Pydantic Field ( #278 )
...
* ✨ Refactor parameter dependency using Pydantic Field
* ⬆️ Upgrade required Pydantic version with latest Shape values
* ✨ Add tutorials and code for using Enum and Optional
* ✅ Add tests for tutorials with new types and extra cases
* ♻️ Format, clean, and add annotations to dependencies.utils
* 📝 Update tutorial for query parameters with list defaults
* ✅ Add tests for query param with list default
2019-05-30 17:40:43 +04:00
Sebastián Ramírez
62af6e0eeb
✨ Separate Pydantic's ValidationError handler and improve docs for error handling ( #273 )
...
* ✨ Implement separated ValidationError handlers and custom exceptions
* ✅ Add tutorial source examples and tests
* 📝 Add docs for custom exception handlers
* 📝 Update docs section titles
2019-05-29 16:27:55 +04:00
William Hayes
d544bdf092
📝 Update docs for paths in path params ( #256 )
2019-05-29 13:43:41 +04:00
Sebastián Ramírez
24e9ea28d3
✅ Update testing docs, examples for testing POST, headers ( #271 )
2019-05-29 11:47:21 +04:00
Sebastián Ramírez
7b63bc5551
✨ Add include, exclude, and by_alias to path operation methods ( #264 )
...
* ✨ Make jsonable_encoder's include and exclude receive sequences
* ✨ Add include, exclude, and by_alias to app and router
* ✨ Add and update tutorial code with new parameters
* 📝 Update docs for new parameters and add docs for updating data
* ✅ Add tests for consistency in path operation methods
* ✅ Add tests for new parameters and update tests
2019-05-27 16:08:13 +04:00
William Hayes
d8716f94ae
✨ Add skip_defaults support for path operations (for #242 ) ( #248 )
2019-05-25 19:35:57 +04:00
James Kaplan
b087246f26
✨ Add support for WebSockets with dependencies, params, etc #166 ( #178 )
2019-05-24 20:41:41 +04:00
Sebastián Ramírez
e92b43b5c8
✨ Add parameter dependencies to path operation decorators and include_router ( #235 )
...
* ✨ Implement dependencies in decorator and .include_router
* 📝 Add docs for parameter dependencies
* ✅ Add tests for dependencies parameter
* 🔥 Remove debugging prints in tests
* 📝 Update release notes
2019-05-16 18:07:00 +04:00
Sebastián Ramírez
d240421378
📝 Add docs about params as functions for mypy ( #231 )
2019-05-15 22:01:23 +04:00
Christopher Dignam
866af5bca6
✏️ Fix typos in docs, from forms ( #176 )
2019-04-27 17:05:06 +04:00
Sebastián Ramírez
3797c04946
✨ Use 401 with WWW-Authenticate for OAuth2 and add scope_str ( #188 )
2019-04-27 17:00:56 +04:00
Sebastián Ramírez
c1df0f6b84
✨ Add docs and tests for Jinja2 templates ( #186 )
...
* ✨ Add docs and tests for Jinja2 templates
* 🎨 Fix format in test, remove unused import
2019-04-26 18:49:15 +04:00
Sebastián Ramírez
528ef7e079
✨ Docs and tests, responses with headers and cookies ( #185 )
2019-04-26 15:13:59 +04:00
Sebastián Ramírez
2b7f201a44
📝 Add docs about returning a response directly and encoder ( #184 )
2019-04-26 13:40:23 +04:00
Sebastián Ramírez
c705685394
✨ Add docs for HTTP Basic Auth and tests ( #177 )
2019-04-21 22:30:58 +04:00
Sebastián Ramírez
97adadd9e1
📝 Add docs for middleware ( #173 )
2019-04-21 19:56:20 +04:00
Sebastián Ramírez
596243f4a5
✨ Add docs about CORS ( #169 )
2019-04-20 21:13:01 +04:00
Sebastián Ramírez
61dd36a945
✨ Upgrade docstring Markdown parsing ( #163 )
...
* ✨ Upgrade docstring Markdown parsing
* 📝 Update release notes
2019-04-16 22:49:18 +04:00
Daniel Michaels
4ab349a2a8
✏️ fixed small typo /tutorial/extra-models.md ( #159 )
2019-04-16 22:20:03 +04:00
hayata-yamamoto
29a4f90bcd
📝 fix URL examples in Tutorial: Query Parameters ( #157 )
...
* modify tutorial
* modify item_id
2019-04-16 22:16:16 +04:00
Sebastián Ramírez
361fd00777
📝 Add note about Swagger UI and multi-part uploads
2019-04-14 22:24:31 +04:00
Sebastián Ramírez
aad6b123f7
✨ Add support for multi-file uploads ( #158 )
2019-04-14 22:12:14 +04:00
Sebastián Ramírez
84de980977
✨ Add docs about responses with additional status codes ( #156 )
...
* ✨ Add docs about responses with additional status codes
* 📝 Update docs, link to documenting additional responses
2019-04-12 22:43:21 +04:00
Sebastián Ramírez
ab6dd60997
📝 Add note on installing and running pytest
2019-04-12 21:45:19 +04:00
Sebastián Ramírez
46e3811f8d
✨ Add testing docs and tests ( #151 )
...
* ✏️ Fix typo in security intro
* ✨ Add testing docs and tests
* 🐛 Debug Travis coverage
* 🐛 Debug Travis coverage, report XML
* 💚 Make Travis/Flit use same code install
* ⏪ Revert Travis/Codecov debugging changes
2019-04-12 20:15:05 +04:00
Sebastián Ramírez
1e4f86db6d
📝 Update release notes and OAuth2 scopes docs
2019-04-09 23:36:18 +04:00
Sebastián Ramírez
7391056daf
✨ Add OAuth2 scopes with SecurityScopes, upgrade Security ( #141 )
...
* ✨ Upgrade OAuth2 Security with scopes handling
* 📝 Update Security tutorial with OAuth2 and JWT
* ✨ Add tutorial code for OAuth2 with scopes (and JWT)
* ✅ Add tests for tutorial/OAuth2 with scopes
* 🐛 Fix security_scopes type declaration
* ✨ Add docs and tests for SecurityScopes
2019-04-09 23:29:04 +04:00
Matthew McLeod
50653e205f
📝 Fix typo in SQL tutorial ( #138 )
2019-04-05 16:22:33 +04:00
Mostapha Sadeghipour Roudsari
c1da3b38a3
📝 fix typos in nested models and OAuth2 with JWT ( #127 )
2019-04-05 16:08:59 +04:00
Sebastián Ramírez
ad471307e2
✨ Additional Responses ( #97 )
...
Add additional responses to OpenAPI, including Pydantic models or schemas directly, custom status codes, media types, extending `response_model`, etc.
2019-04-05 14:18:28 +04:00
Sebastián Ramírez
2bd775988f
✨ Add/refactor addditional responses, tests, docs
2019-04-05 13:54:00 +04:00
Alex Iribarren
1426b6200a
🗃️ Close the DB even if exceptions are raised ( #89 )
...
* Close the DB even if exceptions are raised
* 📝 Add note about closing DB in finally
2019-03-31 22:01:32 +04:00
Sebastián Ramírez
dd6ab23b62
✨ Add docs/tests extending OpenAPI ( #126 )
2019-03-30 19:53:44 +04:00
James Saunders
714e68b5f0
📝 Add note in response model docs: why not return type annotations ( #109 )
...
* Update response model documentation to explain design choice
Closes #101
* 📝 Update note about return function type annotation
2019-03-29 19:02:53 +04:00
Sebastián Ramírez
a2c9f666b5
📝 Add note about Celery in background tasks
2019-03-25 23:47:25 +04:00
Sebastián Ramírez
dc1e94d05f
✨ Document and test union and list response models ( #108 )
2019-03-25 23:28:09 +04:00