]> git.ipfire.org Git - thirdparty/fastapi/fastapi.git/commitdiff
Add liks to related sections of docs from API reference pages
authorYurii Motov <yurii.motov.monte@gmail.com>
Mon, 26 Jan 2026 16:40:09 +0000 (17:40 +0100)
committerYurii Motov <yurii.motov.monte@gmail.com>
Mon, 26 Jan 2026 16:40:09 +0000 (17:40 +0100)
docs/en/docs/reference/request.md
docs/en/docs/reference/response.md
docs/en/docs/reference/responses.md
docs/en/docs/reference/security/index.md
docs/en/docs/reference/websockets.md

index f1de216424e66de03e5b485f00f46ddec9a32b75..7994bf8a88e0ab32debb72b0c6ae1e477f807913 100644 (file)
@@ -2,6 +2,8 @@
 
 You can declare a parameter in a *path operation function* or dependency to be of type `Request` and then you can access the raw request object directly, without any validation, etc.
 
+Read more about it in the [FastAPI docs about using Request directly](https://fastapi.tiangolo.com/advanced/using-request-directly/)
+
 You can import it directly from `fastapi`:
 
 ```python
index 00cf2c499cf7b4dacea029d48df7d4eefb2e4c50..c9085766c92c66fe1038c47665d6268f4667f679 100644 (file)
@@ -4,6 +4,8 @@ You can declare a parameter in a *path operation function* or dependency to be o
 
 You can also use it directly to create an instance of it and return it from your *path operations*.
 
+Read more about it in the [FastAPI docs about returning a custom Response](https://fastapi.tiangolo.com/advanced/response-directly/#returning-a-custom-response)
+
 You can import it directly from `fastapi`:
 
 ```python
index 46f014fcc830f708c836f8a1b6fcf6d43a3db8ca..bd578612945b5ab1595254003456d38c626c9047 100644 (file)
@@ -56,6 +56,8 @@ There are a couple of custom FastAPI response classes, you can use them to optim
 
 ## Starlette Responses
 
+You can read more about all of them in the [FastAPI docs for Custom Response](https://fastapi.tiangolo.com/advanced/custom-response/) and in the [Starlette docs about Responses](https://starlette.dev/responses/).
+
 ::: fastapi.responses.FileResponse
     options:
         members:
index 9a5c5e15fbf462309965edf200e82ad321e25252..8163aa2df28212363e4e66e5e5db8a65f4b01ab2 100644 (file)
@@ -28,6 +28,8 @@ from fastapi.security import (
 )
 ```
 
+Read more about them in the [FastAPI docs about Security](https://fastapi.tiangolo.com/tutorial/security/).
+
 ## API Key Security Schemes
 
 ::: fastapi.security.APIKeyCookie
index 4b7244e080e5e57f077e78bfbfe152fc5cd7ec59..24100834f08ac2c96cf6de612e00dd7e04697c9c 100644 (file)
@@ -2,6 +2,8 @@
 
 When defining WebSockets, you normally declare a parameter of type `WebSocket` and with it you can read data from the client and send data to it.
 
+Read more about it in the [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/)
+
 It is provided directly by Starlette, but you can import it from `fastapi`:
 
 ```python