Skip to content

Commit e785d05

Browse files
committed
Add missing session cookie settings to doc
1 parent 79b22e0 commit e785d05

File tree

4 files changed

+10
-10
lines changed

4 files changed

+10
-10
lines changed

data_rentgen/server/settings/server.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,5 +66,5 @@ class ServerSettings(BaseModel):
6666
)
6767
session: SessionSettings = Field(
6868
default_factory=SessionSettings, # type: ignore[arg-type]
69-
description=":ref:`Session settings <backend-configuration-server-session>`",
69+
description=":ref:`Session settings <configuration-server-session>`",
7070
)

data_rentgen/server/settings/session.py

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,6 @@ class SessionSettings(BaseModel):
2020
Examples
2121
--------
2222
23-
For development environment:
24-
2523
.. code-block:: bash
2624
2725
DATA_RENTGEN__SERVER__SESSION__SECRET_KEY=secret
@@ -31,13 +29,6 @@ class SessionSettings(BaseModel):
3129
DATA_RENTGEN__SERVER__SESSION__HTTPS_ONLY=True
3230
DATA_RENTGEN__SERVER__SESSION__DOMAIN=example.com
3331
34-
For production environment:
35-
36-
.. code-block:: bash
37-
38-
DATA_RENTGEN__SERVER__SESSION__SECRET_KEY=secret
39-
DATA_RENTGEN__SERVER__SESSION__HTTPS_ONLY=True
40-
4132
"""
4233

4334
secret_key: str = Field(description="A random string for signing cookies.")

docs/reference/server/configuration/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ REST API server configuration
1111
logging
1212
monitoring
1313
cors
14+
session
1415
static_files
1516
openapi
1617
debug
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
.. _configuration-server-session:
2+
3+
Session cookie settings
4+
========================
5+
6+
These settings used to control cookie settings used for storing user session data.
7+
8+
.. autopydantic_model:: data_rentgen.server.settings.session.SessionSettings

0 commit comments

Comments
 (0)