Skip to content

Commit

Permalink
📝 Tweak wording in docs/tutorial/fastapi/multiple-models.md (#674)
Browse files Browse the repository at this point in the history
Co-authored-by: Luis Benitez <lbenitez000@gmail.com>
  • Loading branch information
tiangolo and lbenitez000 authored Oct 23, 2023
1 parent 6cd086f commit 9d3ca01
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/tutorial/fastapi/multiple-models.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,11 @@ Here's the weird thing, the `id` currently seems also "optional". 🤔

This is because in our **SQLModel** class we declare the `id` with `Optional[int]`, because it could be `None` in memory until we save it in the database and we finally get the actual ID.

But in the responses, we would always send a model from the database, and it would **always have an ID**. So the `id` in the responses could be declared as required too.
But in the responses, we always send a model from the database, so it **always has an ID**. So the `id` in the responses can be declared as required.

This would mean that our application is making the compromise with the clients that if it sends a hero, it would for sure have an `id` with a value, it would not be `None`.
This means that our application is making the promise to the clients that if it sends a hero, it will for sure have an `id` with a value, it will not be `None`.

### Why Is it Important to Compromise with the Responses
### Why Is it Important to Have a Contract for Responses

The ultimate goal of an API is for some **clients to use it**.

Expand Down

0 comments on commit 9d3ca01

Please sign in to comment.