Thanks to visit codestin.com
Credit goes to github.com

Skip to content

📝 Update all docs to use Annotated as the main recommendation, with new examples and tests#9268

Merged
tiangolo merged 79 commits into
masterfrom
annotated-docs-tests
Mar 18, 2023
Merged

📝 Update all docs to use Annotated as the main recommendation, with new examples and tests#9268
tiangolo merged 79 commits into
masterfrom
annotated-docs-tests

Conversation

@tiangolo

@tiangolo tiangolo commented Mar 17, 2023

Copy link
Copy Markdown
Member

📝 Update all docs to use Annotated as the main recommendation, with new examples and tests

tiangolo added 30 commits March 17, 2023 21:44
@tiangolo
🍱 Add new source examples with Annotated for Query Params and String …
bd9c681 
…Validations
@tiangolo
📝 Add new docs with Annotated for Query Params and String Validations
b18ef10
@tiangolo
🚚 Rename incorrectly named tests for Query Params and str validations
2e9fe36
@tiangolo
✅ Add new tests with Annotated for Query Params and Sring Validations…
1f0e421 
… examples
@tiangolo
🍱 Add new examples with Annotated for Intro to Python Types
b109870
@tiangolo
📝 Update Python Types Intro, include Annotated
cf22b45
@tiangolo
🎨 Fix formatting in Query params and string validation, and highlight
9558c8b
@tiangolo
🍱 Add new Annotated source examples for Path Params and Numeric Valid…
b19b086 
…ations
@tiangolo
📝 Update docs for Path Params and Numeric Validations with Annotated
655dc8a
@tiangolo
🍱 Add new source examples with Annotated for Body - Multiple Params
4fee1e3
@tiangolo
📝 Update docs with Annotated for Body - Multiple Parameters
7b84f2a
@tiangolo
✅ Add test for new Annotated examples in Body - Multiple Parameters
5b2a52e
@tiangolo
🍱 Add new Annotated source examples for Body Fields
e83a64f
@tiangolo
📝 Update docs for Body Fields with new Annotated examples
fa5b79a
@tiangolo
✅ Add new tests for new Annotated examples for Body Fields
8885f73
@tiangolo
🍱 Add new Annotated source examples for Schema Extra (Example Data)
55beafd
@tiangolo
📝 Update docs for Schema Extra with Annotated
f15c5f2
@tiangolo
✅ Add tests for new Annotated examples for Schema Extra
ea65f0a
@tiangolo
🍱 Add new Annnotated source examples for Extra Data Types
2429492
@tiangolo
📝 Update docs with Annotated for Extra Data Types
f4e857b
@tiangolo
✅ Add tests for new Annotated examples for Extra Data Types
7d56e7f
@tiangolo
🍱 Add new Annotated source examples for Cookie Parameters
57a2733
@tiangolo
📝 Update docs for Cookie Parameters with Annotated examples
14746ed
@tiangolo
✅ Add tests for new Annotated source examples in Cookie Parameters
1b4f8cf
@tiangolo
🍱 Add new Annotated examples for Header Params
1ad111b
@tiangolo
📝 Update docs with Annotated examples for Header Parameters
540e630
@tiangolo
✅ Add tests for new Annotated examples for Header Params
d8094cf
@tiangolo
🍱 Add new Annotated examples for Form Data
3b09615
@tiangolo
📝 Update Annotated docs for Form Data
2ae1791
@tiangolo
✅ Add tests for new Annotated examples in Form Data
a026a67
tiangolo added 13 commits March 17, 2023 23:33
@tiangolo
📝 Update docs for Advanced Dependencies with Annotated
75c63e9
@tiangolo
📝 Update docs for OAuth2 scopes with Annotated
711b801
@tiangolo
📝 Update docs for HTTP Basic Auth with Annotated
9a58c49
@tiangolo
🍱 Add source examples with Annotated for WebSockets
b87c620
@tiangolo
✅ Add tests for new Annotated examples for WebSockets
4069f4f
@tiangolo
📝 Update docs for WebSockets with new Annotated examples
476f464
@tiangolo
🍱 Add source examples with Annotated for Settings and Environment Var…
b5ad411 
…iables
@tiangolo
📝 Update docs for Settings and Environment Variables with Annotated
c8e472a
@tiangolo
🍱 Add new source examples for testing dependencies with Annotated
db5b265
@tiangolo
✅ Add tests for new examples for testing dependencies
9ae49d0
@tiangolo
📝 Update docs for testing dependencies with new Annotated examples
d0fe373
@tiangolo
✅ Update and fix marker for Python 3.9 test
b0e7274
@tiangolo
Merge branch 'master' into annotated-docs-tests
742da53
@github-actions

github-actions Bot commented Mar 17, 2023 •
edited
Loading

Copy link
Copy Markdown
Contributor

🚀 Deployed on https://6414f3fb0831644eb51d43cf--fastapi.netlify.app

@github-actions github-actions Bot temporarily deployed to pull request March 17, 2023 22:51 Inactive
@github-actions

github-actions Bot commented Mar 17, 2023

Copy link
Copy Markdown
Contributor

📝 Docs preview for commit 742da53 at: https://6414ef1f43a77a4d73284d90--fastapi.netlify.app

@github-actions github-actions Bot temporarily deployed to pull request March 17, 2023 23:03 Inactive
@github-actions

github-actions Bot commented Mar 17, 2023

Copy link
Copy Markdown
Contributor

📝 Docs preview for commit 87d56fa at: https://6414f1f6cfc66b4b3c3b7d70--fastapi.netlify.app

@tiangolo
🔥 Remove source examples and tests for (non existent) docs section ab…
df130dd 
…out Annotated, as it's covered in all the rest of the docs
@github-actions github-actions Bot temporarily deployed to pull request March 17, 2023 23:13 Inactive
@github-actions

github-actions Bot commented Mar 17, 2023

Copy link
Copy Markdown
Contributor

📝 Docs preview for commit df130dd at: https://6414f42597a24a4fc8ec17af--fastapi.netlify.app

@tiangolo tiangolo mentioned this pull request Mar 17, 2023
Merged
@tiangolo tiangolo merged commit 9eaed2e into master Mar 18, 2023
@tiangolo tiangolo deleted the annotated-docs-tests branch March 18, 2023 12:30
@nzig

nzig commented Mar 18, 2023

Copy link
Copy Markdown
Contributor

Hey @tiangolo, I'm not sure what you meant by the sentence

Try to use the main, Annotated version better.

in all the examples. It sounds a bit weird to me. Maybe something like

Prefer to use the Annotated version if possible.

would be clearer?

@tiangolo tiangolo mentioned this pull request Mar 18, 2023
Merged
@tiangolo

tiangolo commented Mar 18, 2023

Copy link
Copy Markdown
Member Author

Sounds good! Just made another PR with that change here: #9270

@a-was

a-was commented Mar 19, 2023 •
edited
Loading

Copy link
Copy Markdown

@tiangolo
What about database docs?
https://fastapi.tiangolo.com/tutorial/sql-databases/#create-your-fastapi-path-operations
Everywhere I can see db: Session = Depends(get_db)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@tiangolo @nzig @a-was