📝 Update docs, simplify usage of admonitions, only default ones (#15553)

docs/en/docs/_llm-test.md

@@ -124,10 +124,6 @@ See section `### Content of code blocks` in the general prompt in `scripts/trans
 
 //// tab | Test
 
-/// info
-Some text
-///
-
 /// note
 Some text
 ///
@@ -136,10 +132,6 @@ Some text
 Some text
 ///
 
-/// check
-Some text
-///
-
 /// tip
 Some text
 ///

docs/en/docs/advanced/additional-responses.md

@@ -34,7 +34,7 @@ Keep in mind that you have to return the `JSONResponse` directly.
 
 ///
 
-/// info
+/// note
 
 The `model` key is not part of OpenAPI.
 
@@ -183,7 +183,7 @@ Notice that you have to return the image using a `FileResponse` directly.
 
 ///
 
-/// info
+/// note
 
 Unless you specify a different media type explicitly in your `responses` parameter, FastAPI will assume the response has the same media type as the main response class (default `application/json`).
 

docs/en/docs/advanced/advanced-dependencies.md

@@ -98,7 +98,7 @@ For example, if you had a database session in a dependency with `yield`, the `St
 
 This behavior was reverted in 0.118.0, to make the exit code after `yield` be executed after the response is sent.
 
-/// info
+/// note
 
 As you will see below, this is very similar to the behavior before version 0.106.0, but with several improvements and bug fixes for corner cases.
 

docs/en/docs/advanced/custom-response.md

@@ -41,7 +41,7 @@ To return a response with HTML directly from **FastAPI**, use `HTMLResponse`.
 
 {* ../../docs_src/custom_response/tutorial002_py310.py hl[2,7] *}
 
-/// info
+/// note
 
 The parameter `response_class` will also be used to define the "media type" of the response.
 
@@ -65,7 +65,7 @@ A `Response` returned directly by your *path operation function* won't be docume
 
 ///
 
-/// info
+/// note
 
 Of course, the actual `Content-Type` header, status code, etc, will come from the `Response` object you returned.
 

docs/en/docs/advanced/dataclasses.md

@@ -18,7 +18,7 @@ And of course, it supports the same:
 
 This works the same way as with Pydantic models. And it is actually achieved in the same way underneath, using Pydantic.
 
-/// info
+/// note
 
 Keep in mind that dataclasses can't do everything Pydantic models can do.
 

docs/en/docs/advanced/events.md

@@ -120,7 +120,7 @@ To add a function that should be run when the application is shutting down, decl
 
 Here, the `shutdown` event handler function will write a text line `"Application shutdown"` to a file `log.txt`.
 
-/// info
+/// note
 
 In the `open()` function, the `mode="a"` means "append", so, the line will be added after whatever is on that file, without overwriting the previous contents.
 
@@ -152,7 +152,7 @@ Just a technical detail for the curious nerds. 🤓
 
 Underneath, in the ASGI technical specification, this is part of the [Lifespan Protocol](https://asgi.readthedocs.io/en/latest/specs/lifespan.html), and it defines events called `startup` and `shutdown`.
 
-/// info
+/// note
 
 You can read more about the Starlette `lifespan` handlers in [Starlette's  Lifespan' docs](https://www.starlette.dev/lifespan/).
 

docs/en/docs/advanced/openapi-webhooks.md

@@ -22,7 +22,7 @@ With **FastAPI**, using OpenAPI, you can define the names of these webhooks, the
 
 This can make it a lot easier for your users to **implement their APIs** to receive your **webhook** requests, they might even be able to autogenerate some of their own API code.
 
-/// info
+/// note
 
 Webhooks are available in OpenAPI 3.1.0 and above, supported by FastAPI `0.99.0` and above.
 
@@ -36,7 +36,7 @@ When you create a **FastAPI** application, there is a `webhooks` attribute that
 
 The webhooks that you define will end up in the **OpenAPI** schema and the automatic **docs UI**.
 
-/// info
+/// note
 
 The `app.webhooks` object is actually just an `APIRouter`, the same type you would use when structuring your app with multiple files.
 

docs/en/docs/advanced/response-directly.md

@@ -18,7 +18,7 @@ You will normally have much better performance using a [Response Model](../tutor
 
 You can return a `Response` or any sub-class of it.
 
-/// info
+/// note
 
 `JSONResponse` itself is a sub-class of `Response`.
 

docs/en/docs/advanced/security/oauth2-scopes.md

@@ -46,7 +46,7 @@ They are normally used to declare specific security permissions, for example:
 * `instagram_basic` is used by Facebook / Instagram.
 * `https://www.googleapis.com/auth/drive` is used by Google.
 
-/// info
+/// note
 
 In OAuth2 a "scope" is just a string that declares a specific permission required.
 
@@ -126,7 +126,7 @@ We are doing it here to demonstrate how **FastAPI** handles scopes declared at d
 
 {* ../../docs_src/security/tutorial005_an_py310.py hl[5,141,172] *}
 
-/// info | Technical Details
+/// note | Technical Details
 
 `Security` is actually a subclass of `Depends`, and it has just one extra parameter that we'll see later.
 

docs/en/docs/advanced/stream-data.md

@@ -4,7 +4,7 @@ If you want to stream data that can be structured as JSON, you should [Stream JS
 
 But if you want to **stream pure binary data** or strings, here's how you can do it.
 
-/// info
+/// note
 
 Added in FastAPI 0.134.0.
 
@@ -90,7 +90,7 @@ For example, they don't have an `await file.read()`, or `async for chunk in file
 
 And in many cases, reading them would be a blocking operation (that could block the event loop), because they are read from disk or from the network.
 
-/// info
+/// note
 
 The example above is actually an exception, because the `io.BytesIO` object is already in memory, so reading it won't block anything.
 

docs/en/docs/advanced/strict-content-type.md

@@ -81,7 +81,7 @@ If you need to support clients that don't send a `Content-Type` header, you can
 
 With this setting, requests without a `Content-Type` header will have their body parsed as JSON, which is the same behavior as older versions of FastAPI.
 
-/// info
+/// note
 
 This behavior and configuration was added in FastAPI 0.132.0.
 

docs/en/docs/advanced/websockets.md

@@ -111,7 +111,7 @@ They work the same way as for other FastAPI endpoints/*path operations*:
 
 {* ../../docs_src/websockets_/tutorial002_an_py310.py hl[68:69,82] *}
 
-/// info
+/// note
 
 As this is a WebSocket it doesn't really make sense to raise an `HTTPException`, instead we raise a `WebSocketException`.
 

docs/en/docs/advanced/wsgi.md

@@ -6,7 +6,7 @@ For that, you can use the `WSGIMiddleware` and use it to wrap your WSGI applicat
 
 ## Using `WSGIMiddleware` { #using-wsgimiddleware }
 
-/// info
+/// note
 
 This requires installing `a2wsgi` for example with `pip install a2wsgi`.
 

docs/en/docs/alternatives.md

@@ -36,7 +36,7 @@ Django REST Framework was created by Tom Christie. The same creator of Starlette
 
 ///
 
-/// check | Inspired **FastAPI** to
+/// tip | Inspired **FastAPI** to
 
 Have an automatic API documentation web user interface.
 
@@ -56,7 +56,7 @@ This decoupling of parts, and being a "microframework" that could be extended to
 
 Given the simplicity of Flask, it seemed like a good match for building APIs. The next thing to find was a "Django REST Framework" for Flask.
 
-/// check | Inspired **FastAPI** to
+/// tip | Inspired **FastAPI** to
 
 Be a micro-framework. Making it easy to mix and match the tools and parts needed.
 
@@ -98,7 +98,7 @@ def read_url():
 
 See the similarities in `requests.get(...)` and `@app.get(...)`.
 
-/// check | Inspired **FastAPI** to
+/// tip | Inspired **FastAPI** to
 
 * Have a simple and intuitive API.
 * Use HTTP method names (operations) directly, in a straightforward and intuitive way.
@@ -118,7 +118,7 @@ At some point, Swagger was given to the Linux Foundation, to be renamed OpenAPI.
 
 That's why when talking about version 2.0 it's common to say "Swagger", and for version 3+ "OpenAPI".
 
-/// check | Inspired **FastAPI** to
+/// tip | Inspired **FastAPI** to
 
 Adopt and use an open standard for API specifications, instead of a custom schema.
 
@@ -147,7 +147,7 @@ These features are what Marshmallow was built to provide. It is a great library,
 
 But it was created before there existed Python type hints. So, to define every <dfn title="the definition of how data should be formed">schema</dfn> you need to use specific utils and classes provided by Marshmallow.
 
-/// check | Inspired **FastAPI** to
+/// tip | Inspired **FastAPI** to
 
 Use code to define "schemas" that provide data types and validation, automatically.
 
@@ -163,13 +163,13 @@ It uses Marshmallow underneath to do the data validation. And it was created by
 
 It's a great tool and I have used it a lot too, before having **FastAPI**.
 
-/// info
+/// note
 
 Webargs was created by the same Marshmallow developers.
 
 ///
 
-/// check | Inspired **FastAPI** to
+/// tip | Inspired **FastAPI** to
 
 Have automatic validation of incoming request data.
 
@@ -193,13 +193,13 @@ But then, we have again the problem of having a micro-syntax, inside of a Python
 
 The editor can't help much with that. And if we modify parameters or Marshmallow schemas and forget to also modify that YAML docstring, the generated schema would be obsolete.
 
-/// info
+/// note
 
 APISpec was created by the same Marshmallow developers.
 
 ///
 
-/// check | Inspired **FastAPI** to
+/// tip | Inspired **FastAPI** to
 
 Support the open standard for APIs, OpenAPI.
 
@@ -225,13 +225,13 @@ Using it led to the creation of several Flask full-stack generators. These are t
 
 And these same full-stack generators were the base of the [**FastAPI** Project Generators](project-generation.md).
 
-/// info
+/// note
 
 Flask-apispec was created by the same Marshmallow developers.
 
 ///
 
-/// check | Inspired **FastAPI** to
+/// tip | Inspired **FastAPI** to
 
 Generate the OpenAPI schema automatically, from the same code that defines serialization and validation.
 
@@ -251,7 +251,7 @@ But as TypeScript data is not preserved after compilation to JavaScript, it cann
 
 It can't handle nested models very well. So, if the JSON body in the request is a JSON object that has inner fields that in turn are nested JSON objects, it cannot be properly documented and validated.
 
-/// check | Inspired **FastAPI** to
+/// tip | Inspired **FastAPI** to
 
 Use Python types to have great editor support.
 
@@ -271,7 +271,7 @@ It clearly inspired Uvicorn and Starlette, that are currently faster than Sanic
 
 ///
 
-/// check | Inspired **FastAPI** to
+/// tip | Inspired **FastAPI** to
 
 Find a way to have a crazy performance.
 
@@ -287,7 +287,7 @@ It is designed to have functions that receive two parameters, one "request" and
 
 So, data validation, serialization, and documentation, have to be done in code, not automatically. Or they have to be implemented as a framework on top of Falcon, like Hug. This same distinction happens in other frameworks that are inspired by Falcon's design, of having one request object and one response object as parameters.
 
-/// check | Inspired **FastAPI** to
+/// tip | Inspired **FastAPI** to
 
 Find ways to get great performance.
 
@@ -313,7 +313,7 @@ The dependency injection system requires pre-registration of the dependencies an
 
 Routes are declared in a single place, using functions declared in other places (instead of using decorators that can be placed right on top of the function that handles the endpoint). This is closer to how Django does it than to how Flask (and Starlette) does it. It separates in the code things that are relatively tightly coupled.
 
-/// check | Inspired **FastAPI** to
+/// tip | Inspired **FastAPI** to
 
 Define extra validations for data types using the "default" value of model attributes. This improves editor support, and it was not available in Pydantic before.
 
@@ -335,13 +335,13 @@ It has an interesting, uncommon feature: using the same framework, it's possible
 
 As it is based on the previous standard for synchronous Python web frameworks (WSGI), it can't handle Websockets and other things, although it still has high performance too.
 
-/// info
+/// note
 
 Hug was created by Timothy Crosley, the same creator of [`isort`](https://github.com/timothycrosley/isort), a great tool to automatically sort imports in Python files.
 
 ///
 
-/// check | Ideas inspiring **FastAPI**
+/// tip | Ideas inspiring **FastAPI**
 
 Hug inspired parts of APIStar, and was one of the tools I found most promising, alongside APIStar.
 
@@ -375,7 +375,7 @@ It was no longer an API web framework, as the creator needed to focus on Starlet
 
 Now APIStar is a set of tools to validate OpenAPI specifications, not a web framework.
 
-/// info
+/// note
 
 APIStar was created by Tom Christie. The same guy that created:
 
@@ -385,7 +385,7 @@ APIStar was created by Tom Christie. The same guy that created:
 
 ///
 
-/// check | Inspired **FastAPI** to
+/// tip | Inspired **FastAPI** to
 
 Exist.
 
@@ -409,7 +409,7 @@ That makes it extremely intuitive.
 
 It is comparable to Marshmallow. Although it's faster than Marshmallow in benchmarks. And as it is based on the same Python type hints, the editor support is great.
 
-/// check | **FastAPI** uses it to
+/// tip | **FastAPI** uses it to
 
 Handle all the data validation, data serialization and automatic model documentation (based on JSON Schema).
 
@@ -452,7 +452,7 @@ Nevertheless, it is already being used as a "standard" by several tools. This gr
 
 ///
 
-/// check | **FastAPI** uses it to
+/// tip | **FastAPI** uses it to
 
 Handle all the core web parts. Adding features on top.
 
@@ -470,7 +470,7 @@ It is not a web framework, but a server. For example, it doesn't provide tools f
 
 It is the recommended server for Starlette and **FastAPI**.
 
-/// check | **FastAPI** recommends it as
+/// tip | **FastAPI** recommends it as
 
 The main web server to run **FastAPI** applications.
 

docs/en/docs/async.md

@@ -139,7 +139,7 @@ You and your crush eat the burgers and have a nice time. ✨
 
 <img src="/img/async/concurrent-burgers/concurrent-burgers-07.png" class="illustration">
 
-/// info
+/// note
 
 Beautiful illustrations by [Ketrina Thompson](https://www.instagram.com/ketrinadrawsalot). 🎨
 
@@ -205,7 +205,7 @@ You just eat them, and you are done. ⏹
 
 There was not much talk or flirting as most of the time was spent waiting 🕙 in front of the counter. 😞
 
-/// info
+/// note
 
 Beautiful illustrations by [Ketrina Thompson](https://www.instagram.com/ketrinadrawsalot). 🎨
 

docs/en/docs/deployment/docker.md

@@ -132,7 +132,7 @@ Successfully installed fastapi pydantic
 
 </div>
 
-/// info
+/// note
 
 There are other formats and tools to define and install package dependencies.
 
@@ -556,7 +556,7 @@ If you are using containers (e.g. Docker, Kubernetes), then there are two main a
 
 If you have **multiple containers**, probably each one running a **single process** (for example, in a **Kubernetes** cluster), then you would probably want to have a **separate container** doing the work of the **previous steps** in a single container, running a single process, **before** running the replicated worker containers.
 
-/// info
+/// note
 
 If you are using Kubernetes, this would probably be an [Init Container](https://kubernetes.io/docs/concepts/workloads/pods/init-containers/).
 

docs/en/docs/deployment/server-workers.md

@@ -17,7 +17,7 @@ As you saw in the previous chapter about [Deployment Concepts](concepts.md), the
 
 Here I'll show you how to use **Uvicorn** with **worker processes** using the `fastapi` command or the `uvicorn` command directly.
 
-/// info
+/// note
 
 If you are using containers, for example with Docker or Kubernetes, I'll tell you more about that in the next chapter: [FastAPI in Containers - Docker](docker.md).
 

docs/en/docs/external-links.md

@@ -6,7 +6,7 @@ There are many posts, articles, tools, and projects, related to **FastAPI**.
 
 You could easily use a search engine or video platform to find many resources related to FastAPI.
 
-/// info
+/// note
 
 Before, this page used to list links to external articles.
 

docs/en/docs/features.md

@@ -63,7 +63,7 @@ second_user_data = {
 my_second_user: User = User(**second_user_data)
 ```
 
-/// info
+/// note
 
 `**second_user_data` means:
 

docs/en/docs/help-fastapi.md

@@ -170,7 +170,7 @@ And if there's any other style or consistency need, I'll ask directly for that,
 
 * Then **comment** saying that you did that, that's how I will know you really checked it.
 
-/// info
+/// note
 
 Unfortunately, I can't simply trust PRs that just have several approvals.
 

docs/en/docs/how-to/extending-openapi.md

@@ -27,7 +27,7 @@ And that function `get_openapi()` receives as parameters:
 * `description`: The description of your API, this can include markdown and will be shown in the docs.
 * `routes`: A list of routes, these are each of the registered *path operations*. They are taken from `app.routes`.
 
-/// info
+/// note
 
 The parameter `summary` is available in OpenAPI 3.1.0 and above, supported by FastAPI 0.99.0 and above.
 

docs/en/docs/how-to/separate-openapi-schemas.md

@@ -85,7 +85,7 @@ Probably the main use case for this is if you already have some autogenerated cl
 
 In that case, you can disable this feature in **FastAPI**, with the parameter `separate_input_output_schemas=False`.
 
-/// info
+/// note
 
 Support for `separate_input_output_schemas` was added in FastAPI `0.102.0`. 🤓
 

docs/en/docs/python-types.md

@@ -172,7 +172,7 @@ As the list is a type that contains some internal types, you put them in square
 
 {* ../../docs_src/python_types/tutorial006_py310.py hl[1] *}
 
-/// info
+/// note
 
 Those internal types in the square brackets are called "type parameters".
 
@@ -283,7 +283,7 @@ An example from the official Pydantic docs:
 
 {* ../../docs_src/python_types/tutorial011_py310.py *}
 
-/// info
+/// note
 
 To learn more about [Pydantic, check its docs](https://docs.pydantic.dev/).
 
@@ -341,7 +341,7 @@ This might all sound abstract. Don't worry. You'll see all this in action in the
 
 The important thing is that by using standard Python types, in a single place (instead of adding more classes, decorators, etc), **FastAPI** will do a lot of the work for you.
 
-/// info
+/// note
 
 If you already went through all the tutorial and came back to see more about types, a good resource is [the "cheat sheet" from `mypy`](https://mypy.readthedocs.io/en/latest/cheat_sheet_py3.html).
 

docs/en/docs/tutorial/bigger-applications.md

@@ -4,7 +4,7 @@ If you are building an application or a web API, it's rarely the case that you c
 
 **FastAPI** provides a convenience tool to structure your application while keeping all the flexibility.
 
-/// info
+/// note
 
 If you come from Flask, this would be the equivalent of Flask's Blueprints.
 
@@ -194,7 +194,7 @@ Having `dependencies` in the `APIRouter` can be used, for example, to require au
 
 ///
 
-/// check
+/// tip
 
 The `prefix`, `tags`, `responses`, and `dependencies` parameters are (as in many other cases) just a feature from **FastAPI** to help you avoid code duplication.
 
@@ -339,7 +339,7 @@ We could also import them like:
 from app.routers import items, users
 ```
 
-/// info
+/// note
 
 The first version is a "relative import":
 
@@ -382,7 +382,7 @@ Now, let's include the `router`s from the submodules `users` and `items`:
 
 {* ../../docs_src/bigger_applications/app_an_py310/main.py hl[10:11] title["app/main.py"] *}
 
-/// info
+/// note
 
 `users.router` contains the `APIRouter` inside of the file `app/routers/users.py`.
 
@@ -402,7 +402,7 @@ So, behind the scenes, it will actually work as if everything was the same singl
 
 ///
 
-/// check
+/// tip
 
 You don't have to worry about performance when including routers.
 
@@ -451,7 +451,7 @@ Here we do it... just to show that we can 🤷:
 
 and it will work correctly, together with all the other *path operations* added with `app.include_router()`.
 
-/// info | Very Technical Details
+/// note | Very Technical Details
 
 **Note**: this is a very technical detail that you probably can **just skip**.
 

docs/en/docs/tutorial/body-multiple-params.md

@@ -111,7 +111,7 @@ For example:
 {* ../../docs_src/body_multiple_params/tutorial004_an_py310.py hl[28] *}
 
 
-/// info
+/// note
 
 `Body` also has all the same extra validation and metadata parameters as `Query`, `Path` and others you will see later.
 

docs/en/docs/tutorial/body-nested-models.md

@@ -136,7 +136,7 @@ This will expect (convert, validate, document, etc.) a JSON body like:
 }
 ```
 
-/// info
+/// note
 
 Notice how the `images` key now has a list of image objects.
 
@@ -148,7 +148,7 @@ You can define arbitrarily deeply nested models:
 
 {* ../../docs_src/body_nested_models/tutorial007_py310.py hl[7,12,18,21,25] *}
 
-/// info
+/// note
 
 Notice how `Offer` has a list of `Item`s, which in turn have an optional list of `Image`s
 

docs/en/docs/tutorial/body.md

@@ -8,7 +8,7 @@ Your API almost always has to send a **response** body. But clients don't necess
 
 To declare a **request** body, you use [Pydantic](https://docs.pydantic.dev/) models with all their power and benefits.
 
-/// info
+/// note
 
 To send data, you should use one of: `POST` (the more common), `PUT`, `DELETE` or `PATCH`.
 

docs/en/docs/tutorial/cookie-param-models.md

@@ -32,7 +32,7 @@ You can see the defined cookies in the docs UI at `/docs`:
 <img src="/img/tutorial/cookie-param-models/image01.png">
 </div>
 
-/// info
+/// note
 
 Have in mind that, as **browsers handle cookies** in special ways and behind the scenes, they **don't** easily allow **JavaScript** to touch them.
 

docs/en/docs/tutorial/cookie-params.md

@@ -24,13 +24,13 @@ But remember that when you import `Query`, `Path`, `Cookie` and others from `fas
 
 ///
 
-/// info
+/// note
 
 To declare cookies, you need to use `Cookie`, because otherwise the parameters would be interpreted as query parameters.
 
 ///
 
-/// info
+/// note
 
 Have in mind that, as **browsers handle cookies** in special ways and behind the scenes, they **don't** easily allow **JavaScript** to touch them.
 

docs/en/docs/tutorial/debugging.md

@@ -72,7 +72,7 @@ So, the line:
 
 will not be executed.
 
-/// info
+/// note
 
 For more information, check [the official Python docs](https://docs.python.org/3/library/__main__.html).
 

docs/en/docs/tutorial/dependencies/dependencies-in-path-operation-decorators.md

@@ -28,7 +28,7 @@ It might also help avoid confusion for new developers that see an unused paramet
 
 ///
 
-/// info
+/// note
 
 In this example we use invented custom headers `X-Key` and `X-Token`.
 

docs/en/docs/tutorial/dependencies/dependencies-with-yield.md

@@ -170,7 +170,7 @@ participant tasks as Background tasks
     end
 ```
 
-/// info
+/// note
 
 Only **one response** will be sent to the client. It might be one of the error responses or it will be the response from the *path operation*.
 

docs/en/docs/tutorial/dependencies/index.md

@@ -51,7 +51,7 @@ In this case, this dependency expects:
 
 And then it just returns a `dict` containing those values.
 
-/// info
+/// note
 
 FastAPI added support for `Annotated` (and started recommending it) in version 0.95.0.
 
@@ -106,7 +106,7 @@ common_parameters --> read_users
 
 This way you write shared code once and **FastAPI** takes care of calling it for your *path operations*.
 
-/// check
+/// tip
 
 Notice that you don't have to create a special class and pass it somewhere to **FastAPI** to "register" it or anything similar.
 

docs/en/docs/tutorial/dependencies/sub-dependencies.md

@@ -35,7 +35,7 @@ Then we can use the dependency with:
 
 {* ../../docs_src/dependencies/tutorial005_an_py310.py hl[23] *}
 
-/// info
+/// note
 
 Notice that we are only declaring one dependency in the *path operation function*, the `query_or_cookie_extractor`.
 

docs/en/docs/tutorial/first-steps.md

@@ -270,7 +270,7 @@ https://example.com/items/foo
 /items/foo
 ```
 
-/// info
+/// note
 
 A "path" is also commonly called an "endpoint" or a "route".
 
@@ -322,7 +322,7 @@ The `@app.get("/")` tells **FastAPI** that the function right below is in charge
 * the path `/`
 * using a <dfn title="an HTTP GET method"><code>get</code> operation</dfn>
 
-/// info | `@decorator` Info
+/// note | `@decorator` Info
 
 That `@something` syntax in Python is called a "decorator".
 

docs/en/docs/tutorial/header-params.md

@@ -24,7 +24,7 @@ But remember that when you import `Query`, `Path`, `Header`, and others from `fa
 
 ///
 
-/// info
+/// note
 
 To declare headers, you need to use `Header`, because otherwise the parameters would be interpreted as query parameters.
 

docs/en/docs/tutorial/metadata.md

@@ -74,7 +74,7 @@ Use the `tags` parameter with your *path operations* (and `APIRouter`s) to assig
 
 {* ../../docs_src/metadata/tutorial004_py310.py hl[21,26] *}
 
-/// info
+/// note
 
 Read more about tags in [Path Operation Configuration](path-operation-configuration.md#tags).
 

docs/en/docs/tutorial/path-operation-configuration.md

@@ -72,13 +72,13 @@ You can specify the response description with the parameter `response_descriptio
 
 {* ../../docs_src/path_operation_configuration/tutorial005_py310.py hl[18] *}
 
-/// info
+/// note
 
 Notice that `response_description` refers specifically to the response, the `description` refers to the *path operation* in general.
 
 ///
 
-/// check
+/// tip
 
 OpenAPI specifies that each *path operation* requires a response description.
 

docs/en/docs/tutorial/path-params-numeric-validations.md

@@ -8,7 +8,7 @@ First, import `Path` from `fastapi`, and import `Annotated`:
 
 {* ../../docs_src/path_params_numeric_validations/tutorial001_an_py310.py hl[1,3] *}
 
-/// info
+/// note
 
 FastAPI added support for `Annotated` (and started recommending it) in version 0.95.0.
 
@@ -131,7 +131,7 @@ And you can also declare numeric validations:
 * `lt`: `l`ess `t`han
 * `le`: `l`ess than or `e`qual
 
-/// info
+/// note
 
 `Query`, `Path`, and other classes you will see later are subclasses of a common `Param` class.
 

docs/en/docs/tutorial/path-params.md

@@ -20,7 +20,7 @@ You can declare the type of a path parameter in the function, using standard Pyt
 
 In this case, `item_id` is declared to be an `int`.
 
-/// check
+/// tip
 
 This will give you editor support inside of your function, with error checks, completion, etc.
 
@@ -34,7 +34,7 @@ If you run this example and open your browser at [http://127.0.0.1:8000/items/3]
 {"item_id":3}
 ```
 
-/// check
+/// tip
 
 Notice that the value your function received (and returned) is `3`, as a Python `int`, not a string `"3"`.
 
@@ -66,7 +66,7 @@ because the path parameter `item_id` had a value of `"foo"`, which is not an `in
 
 The same error would appear if you provided a `float` instead of an `int`, as in: [http://127.0.0.1:8000/items/4.2](http://127.0.0.1:8000/items/4.2)
 
-/// check
+/// tip
 
 So, with the same Python type declaration, **FastAPI** gives you data validation.
 
@@ -82,7 +82,7 @@ And when you open your browser at [http://127.0.0.1:8000/docs](http://127.0.0.1:
 
 <img src="/img/tutorial/path-params/image01.png">
 
-/// check
+/// tip
 
 Again, just with that same Python type declaration, **FastAPI** gives you automatic, interactive documentation (integrating Swagger UI).
 

docs/en/docs/tutorial/query-params-str-validations.md

@@ -29,7 +29,7 @@ To achieve that, first import:
 
 {* ../../docs_src/query_params_str_validations/tutorial002_an_py310.py hl[1,3] *}
 
-/// info
+/// note
 
 FastAPI added support for `Annotated` (and started recommending it) in version 0.95.0.
 
@@ -382,7 +382,7 @@ For example, this custom validator checks that the item ID starts with `isbn-` f
 
 {* ../../docs_src/query_params_str_validations/tutorial015_an_py310.py hl[5,16:19,24] *}
 
-/// info
+/// note
 
 This is available with Pydantic version 2 or above. 😎
 

docs/en/docs/tutorial/query-params.md

@@ -65,7 +65,7 @@ The same way, you can declare optional query parameters, by setting their defaul
 
 In this case, the function parameter `q` will be optional, and will be `None` by default.
 
-/// check
+/// tip
 
 Also notice that **FastAPI** is smart enough to notice that the path parameter `item_id` is a path parameter and `q` is not, so, it's a query parameter.
 

docs/en/docs/tutorial/request-files.md

@@ -2,7 +2,7 @@
 
 You can define files to be uploaded by the client using `File`.
 
-/// info
+/// note
 
 To receive uploaded files, first install [`python-multipart`](https://github.com/Kludex/python-multipart).
 
@@ -28,7 +28,7 @@ Create file parameters the same way you would for `Body` or `Form`:
 
 {* ../../docs_src/request_files/tutorial001_an_py310.py hl[9] *}
 
-/// info
+/// note
 
 `File` is a class that inherits directly from `Form`.
 

docs/en/docs/tutorial/request-form-models.md

@@ -2,7 +2,7 @@
 
 You can use **Pydantic models** to declare **form fields** in FastAPI.
 
-/// info
+/// note
 
 To use forms, first install [`python-multipart`](https://github.com/Kludex/python-multipart).
 

docs/en/docs/tutorial/request-forms-and-files.md

@@ -2,7 +2,7 @@
 
 You can define files and form fields at the same time using `File` and `Form`.
 
-/// info
+/// note
 
 To receive uploaded files and/or form data, first install [`python-multipart`](https://github.com/Kludex/python-multipart).
 

docs/en/docs/tutorial/request-forms.md

@@ -2,7 +2,7 @@
 
 When you need to receive form fields instead of JSON, you can use `Form`.
 
-/// info
+/// note
 
 To use forms, first install [`python-multipart`](https://github.com/Kludex/python-multipart).
 
@@ -32,7 +32,7 @@ The <dfn title="specification">spec</dfn> requires the fields to be exactly name
 
 With `Form` you can declare the same configurations as with `Body` (and `Query`, `Path`, `Cookie`), including validation, examples, an alias (e.g. `user-name` instead of `username`), etc.
 
-/// info
+/// note
 
 `Form` is a class that inherits directly from `Body`.
 

docs/en/docs/tutorial/response-model.md

@@ -72,7 +72,7 @@ Here we are declaring a `UserIn` model, it will contain a plaintext password:
 
 {* ../../docs_src/response_model/tutorial002_py310.py hl[7,9] *}
 
-/// info
+/// note
 
 To use `EmailStr`, first install [`email-validator`](https://github.com/JoshData/python-email-validator).
 
@@ -251,7 +251,7 @@ So, if you send a request to that *path operation* for the item with ID `foo`, t
 }
 ```
 
-/// info
+/// note
 
 You can also use:
 

docs/en/docs/tutorial/response-status-code.md

@@ -18,7 +18,7 @@ Notice that `status_code` is a parameter of the "decorator" method (`get`, `post
 
 The `status_code` parameter receives a number with the HTTP status code.
 
-/// info
+/// note
 
 `status_code` can alternatively also receive an `IntEnum`, such as Python's [`http.HTTPStatus`](https://docs.python.org/3/library/http.html#http.HTTPStatus).
 

docs/en/docs/tutorial/schema-extra-example.md

@@ -24,7 +24,7 @@ For example you could use it to add metadata for a frontend user interface, etc.
 
 ///
 
-/// info
+/// note
 
 OpenAPI 3.1.0 (used since FastAPI 0.99.0) added support for `examples`, which is part of the **JSON Schema** standard.
 
@@ -155,7 +155,7 @@ OpenAPI also added `example` and `examples` fields to other parts of the specifi
     * `File()`
     * `Form()`
 
-/// info
+/// note
 
 This old OpenAPI-specific `examples` parameter is now `openapi_examples` since FastAPI `0.103.0`.
 
@@ -171,7 +171,7 @@ And now this new `examples` field takes precedence over the old single (and cust
 
 This new `examples` field in JSON Schema is **just a `list`** of examples, not a dict with extra metadata as in the other places in OpenAPI (described above).
 
-/// info
+/// note
 
 Even after OpenAPI 3.1.0 was released with this new simpler integration with JSON Schema, for a while, Swagger UI, the tool that provides the automatic docs, didn't support OpenAPI 3.1.0 (it does since version 5.0.0 🎉).
 

docs/en/docs/tutorial/security/first-steps.md

@@ -24,7 +24,7 @@ Copy the example in a file `main.py`:
 
 ## Run it { #run-it }
 
-/// info
+/// note
 
 The [`python-multipart`](https://github.com/Kludex/python-multipart) package is automatically installed with **FastAPI** when you run the `pip install "fastapi[standard]"` command.
 
@@ -60,7 +60,7 @@ You will see something like this:
 
 <img src="/img/tutorial/security/image01.png">
 
-/// check | Authorize button!
+/// tip | Authorize button!
 
 You already have a shiny new "Authorize" button.
 
@@ -118,7 +118,7 @@ So, let's review it from that simplified point of view:
 
 In this example we are going to use **OAuth2**, with the **Password** flow, using a **Bearer** token. We do that using the `OAuth2PasswordBearer` class.
 
-/// info
+/// note
 
 A "bearer" token is not the only option.
 
@@ -148,7 +148,7 @@ This parameter doesn't create that endpoint / *path operation*, but declares tha
 
 We will soon also create the actual path operation.
 
-/// info
+/// note
 
 If you are a very strict "Pythonista" you might dislike the style of the parameter name `tokenUrl` instead of `token_url`.
 
@@ -176,7 +176,7 @@ This dependency will provide a `str` that is assigned to the parameter `token` o
 
 **FastAPI** will know that it can use this dependency to define a "security scheme" in the OpenAPI schema (and the automatic API docs).
 
-/// info | Technical Details
+/// note | Technical Details
 
 **FastAPI** will know that it can use the class `OAuth2PasswordBearer` (declared in a dependency) to define the security scheme in OpenAPI because it inherits from `fastapi.security.oauth2.OAuth2`, which in turn inherits from `fastapi.security.base.SecurityBase`.
 

docs/en/docs/tutorial/security/get-current-user.md

@@ -52,7 +52,7 @@ Here **FastAPI** won't get confused because you are using `Depends`.
 
 ///
 
-/// check
+/// tip
 
 The way this dependency system is designed allows us to have different dependencies (different "dependables") that all return a `User` model.
 

docs/en/docs/tutorial/security/oauth2-jwt.md

@@ -42,7 +42,7 @@ $ pip install pyjwt
 
 </div>
 
-/// info
+/// note
 
 If you are planning to use digital signature algorithms like RSA or ECDSA, you should install the cryptography library dependency `pyjwt[crypto]`.
 
@@ -213,7 +213,7 @@ Using the credentials:
 Username: `johndoe`
 Password: `secret`
 
-/// check
+/// tip
 
 Notice that nowhere in the code is the plaintext password "`secret`", we only have the hashed version.
 

docs/en/docs/tutorial/security/simple-oauth2.md

@@ -32,7 +32,7 @@ They are normally used to declare specific security permissions, for example:
 * `instagram_basic` is used by Facebook / Instagram.
 * `https://www.googleapis.com/auth/drive` is used by Google.
 
-/// info
+/// note
 
 In OAuth2 a "scope" is just a string that declares a specific permission required.
 
@@ -72,7 +72,7 @@ If you need to enforce it, use `OAuth2PasswordRequestFormStrict` instead of `OAu
 * An optional `client_id` (we don't need it for our example).
 * An optional `client_secret` (we don't need it for our example).
 
-/// info
+/// note
 
 The `OAuth2PasswordRequestForm` is not a special class for **FastAPI** as is `OAuth2PasswordBearer`.
 
@@ -144,7 +144,7 @@ UserInDB(
 )
 ```
 
-/// info
+/// note
 
 For a more complete explanation of `**user_dict` check back in [the documentation for **Extra Models**](../extra-models.md#about-user-in-dict).
 
@@ -196,7 +196,7 @@ So, in our endpoint, we will only get a user if the user exists, was correctly a
 
 {* ../../docs_src/security/tutorial003_an_py310.py hl[58:66,69:74,94] *}
 
-/// info
+/// note
 
 The additional header `WWW-Authenticate` with value `Bearer` we are returning here is also part of the spec.
 

docs/en/docs/tutorial/server-sent-events.md

@@ -4,7 +4,7 @@ You can stream data to the client using **Server-Sent Events** (SSE).
 
 This is similar to [Stream JSON Lines](stream-json-lines.md), but uses the `text/event-stream` format, which is supported natively by browsers with the [`EventSource` API](https://developer.mozilla.org/en-US/docs/Web/API/EventSource).
 
-/// info
+/// note
 
 Added in FastAPI 0.135.0.
 

docs/en/docs/tutorial/stream-json-lines.md

@@ -2,7 +2,7 @@
 
 You could have a sequence of data that you would like to send in a "**stream**", you could do it with **JSON Lines**.
 
-/// info
+/// note
 
 Added in FastAPI 0.134.0.
 
@@ -48,7 +48,7 @@ A response would have a content type of `application/jsonl` (instead of `applica
 
 It's very similar to a JSON array (equivalent of a Python list), but instead of being wrapped in `[]` and having `,` between the items, it has **one JSON object per line**, they are separated by a new line character.
 
-/// info
+/// note
 
 The important point is that your app will be able to produce each line in turn, while the client consumes the previous lines.
 

docs/en/docs/tutorial/testing.md

@@ -8,7 +8,7 @@ With it, you can use [pytest](https://docs.pytest.org/) directly with **FastAPI*
 
 ## Using `TestClient` { #using-testclient }
 
-/// info
+/// note
 
 To use `TestClient`, first install [`httpx`](https://www.python-httpx.org).
 
@@ -144,7 +144,7 @@ E.g.:
 
 For more information about how to pass data to the backend (using `httpx` or the `TestClient`) check the [HTTPX documentation](https://www.python-httpx.org).
 
-/// info
+/// note
 
 Note that the `TestClient` receives data that can be converted to JSON, not Pydantic models.
 

docs/en/docs/virtual-environments.md

@@ -2,7 +2,7 @@
 
 When you work in Python projects you probably should use a **virtual environment** (or a similar mechanism) to isolate the packages you install for each project.
 
-/// info
+/// note
 
 If you already know about virtual environments, how to create them and use them, you might want to skip this section. 🤓
 
@@ -18,7 +18,7 @@ A **virtual environment** is a directory with some files in it.
 
 ///
 
-/// info
+/// note
 
 This page will teach you how to use **virtual environments** and how they work.
 

docs/en/mkdocs.yml

@@ -290,7 +290,10 @@ markdown_extensions:
       format: !!python/name:pymdownx.superfences.fence_code_format ''
   pymdownx.tilde: null
   pymdownx.blocks.admonition:
+    # TODO: remove types section (with custom types) once translations are migrated to
+    # not use custom types too
     types:
+    # Default types
     - note
     - attention
     - caution
@@ -299,6 +302,7 @@ markdown_extensions:
     - tip
     - hint
     - warning
+    # Custom types
     - info
     - check
   pymdownx.blocks.details: null