Skip to content

LCORE-973: Updated TLS configuration #844

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 26, 2025
Merged

LCORE-973: Updated TLS configuration #844

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b50ee85
Updated TLS configuration
tisnik Nov 26, 2025
11b752e
Regenerated documentation
tisnik Nov 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion docs/config.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,8 +172,20 @@
<h1 class="title"> </h1>
</header>
<h1 id="lightspeed-core-stack">Lightspeed Core Stack</h1>
<h2 id="base-url">🌍 Base URL</h2>
<table>
<thead>
<tr class="header">
<th>URL</th>
<th>Description</th>
</tr>
</thead>
<tbody>
</tbody>
</table>
<h1 id="apis">🛠️ APIs</h1>
<hr />
<h1 id="configuration-options">📋 Configuration options</h1>
<h1 id="components">📋 Components</h1>
<h2 id="accessrule">AccessRule</h2>
<p>Rule defining what actions a role can perform.</p>
<table>
Expand Down Expand Up @@ -969,6 +981,8 @@ <h2 id="serviceconfiguration">ServiceConfiguration</h2>
</table>
<h2 id="tlsconfiguration">TLSConfiguration</h2>
<p>TLS configuration.</p>
<p>See also: - https://fastapi.tiangolo.com/deployment/https/ -
https://en.wikipedia.org/wiki/Transport_Layer_Security</p>
<table>
<colgroup>
<col style="width: 26%" />
Expand Down
17 changes: 16 additions & 1 deletion docs/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,19 @@
# Lightspeed Core Stack



## 🌍 Base URL


| URL | Description |
|-----|-------------|


# 🛠️ APIs

---

# 📋 Configuration options
# 📋 Components



Expand Down Expand Up @@ -362,6 +373,10 @@ Service configuration.

TLS configuration.

See also:
- https://fastapi.tiangolo.com/deployment/https/
- https://en.wikipedia.org/wiki/Transport_Layer_Security
Comment on lines +376 to +378
Copy link
Contributor

@coderabbitai coderabbitai bot Nov 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Wrap bare URLs in markdown link syntax.

The static analyzer flagged bare URLs (MD034). Wrap the links in markdown link syntax for proper formatting:

 See also:
-- https://fastapi.tiangolo.com/deployment/https/
-- https://en.wikipedia.org/wiki/Transport_Layer_Security
+- [FastAPI HTTPS Deployment](https://fastapi.tiangolo.com/deployment/https/)
+- [Transport Layer Security Overview](https://en.wikipedia.org/wiki/Transport_Layer_Security)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
See also:
- https://fastapi.tiangolo.com/deployment/https/
- https://en.wikipedia.org/wiki/Transport_Layer_Security
See also:
- [FastAPI HTTPS Deployment](https://fastapi.tiangolo.com/deployment/https/)
- [Transport Layer Security Overview](https://en.wikipedia.org/wiki/Transport_Layer_Security)
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

377-377: Bare URL used

(MD034, no-bare-urls)

378-378: Bare URL used

(MD034, no-bare-urls)

🤖 Prompt for AI Agents 
In docs/config.md around lines 376 to 378, there are bare URLs listed which
trigger MD034; replace each bare URL with proper Markdown link syntax (e.g.
[FastAPI HTTPS docs](https://fastapi.tiangolo.com/deployment/https/) and
[Transport Layer Security -
Wikipedia](https://en.wikipedia.org/wiki/Transport_Layer_Security)) so the links
are wrapped in []() with a brief descriptive label.



| Field | Type | Description |
|-------|------|-------------|
Expand Down
14 changes: 9 additions & 5 deletions docs/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7184,7 +7184,8 @@
"properties": {
"db_path": {
"type": "string",
"title": "Db Path"
"title": "DB path",
"description": "Path to file where SQLite database is stored"
}
},
"additionalProperties": false,
Expand Down Expand Up @@ -7350,7 +7351,8 @@
"type": "null"
}
],
"title": "Tls Certificate Path"
"title": "TLS certificate path",
"description": "SSL/TLS certificate file path for HTTPS support."
},
"tls_key_path": {
"anyOf": [
Expand All @@ -7362,7 +7364,8 @@
"type": "null"
}
],
"title": "Tls Key Path"
"title": "TLS key path",
"description": "SSL/TLS private key file path for HTTPS support."
},
"tls_key_password": {
"anyOf": [
Expand All @@ -7374,13 +7377,14 @@
"type": "null"
}
],
"title": "Tls Key Password"
"title": "SSL/TLS key password path",
"description": "Path to file containing the password to decrypt the SSL/TLS private key."
}
},
"additionalProperties": false,
"type": "object",
"title": "TLSConfiguration",
"description": "TLS configuration."
"description": "TLS configuration.\n\nSee also:\n- https://fastapi.tiangolo.com/deployment/https/\n- https://en.wikipedia.org/wiki/Transport_Layer_Security"
},
"ToolCall": {
"properties": {
Expand Down
12 changes: 8 additions & 4 deletions docs/openapi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4806,7 +4806,7 @@ SQLite database configuration.

| Field | Type | Description |
|-------|------|-------------|
| db_path | string | |
| db_path | string | Path to file where SQLite database is stored |


## ServiceConfiguration
Expand Down Expand Up @@ -4871,12 +4871,16 @@ Attributes:

TLS configuration.

See also:
- https://fastapi.tiangolo.com/deployment/https/
- https://en.wikipedia.org/wiki/Transport_Layer_Security


| Field | Type | Description |
|-------|------|-------------|
| tls_certificate_path | | |
| tls_key_path | | |
| tls_key_password | | |
| tls_certificate_path | | SSL/TLS certificate file path for HTTPS support. |
| tls_key_path | | SSL/TLS private key file path for HTTPS support. |
| tls_key_password | | Path to file containing the password to decrypt the SSL/TLS private key. |


## ToolCall
Expand Down
12 changes: 8 additions & 4 deletions docs/output.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4806,7 +4806,7 @@ SQLite database configuration.

| Field | Type | Description |
|-------|------|-------------|
| db_path | string | |
| db_path | string | Path to file where SQLite database is stored |


## ServiceConfiguration
Expand Down Expand Up @@ -4871,12 +4871,16 @@ Attributes:

TLS configuration.

See also:
- https://fastapi.tiangolo.com/deployment/https/
- https://en.wikipedia.org/wiki/Transport_Layer_Security
Comment on lines +4874 to +4876
Copy link
Contributor

@coderabbitai coderabbitai bot Nov 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Wrap bare URLs in markdown link syntax (consistent with docs/config.md).

The See also links for TLSConfiguration should use markdown link syntax:

 See also:
-- https://fastapi.tiangolo.com/deployment/https/
-- https://en.wikipedia.org/wiki/Transport_Layer_Security
+- [FastAPI HTTPS Deployment](https://fastapi.tiangolo.com/deployment/https/)
+- [Transport Layer Security Overview](https://en.wikipedia.org/wiki/Transport_Layer_Security)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
See also:
- https://fastapi.tiangolo.com/deployment/https/
- https://en.wikipedia.org/wiki/Transport_Layer_Security
See also:
- [FastAPI HTTPS Deployment](https://fastapi.tiangolo.com/deployment/https/)
- [Transport Layer Security Overview](https://en.wikipedia.org/wiki/Transport_Layer_Security)
🤖 Prompt for AI Agents 
In docs/output.md around lines 4874 to 4876, the "See also" section contains
bare URLs; update them to use Markdown link syntax (consistent with
docs/config.md) by replacing each bare URL with a bracketed link label and the
URL in parentheses (e.g., [FastAPI HTTPS docs](https://...) and [Transport Layer
Security - Wikipedia](https://...)), preserving order and punctuation.



| Field | Type | Description |
|-------|------|-------------|
| tls_certificate_path | | |
| tls_key_path | | |
| tls_key_password | | |
| tls_certificate_path | | SSL/TLS certificate file path for HTTPS support. |
| tls_key_path | | SSL/TLS private key file path for HTTPS support. |
| tls_key_password | | Path to file containing the password to decrypt the SSL/TLS private key. |


## ToolCall
Expand Down
7 changes: 6 additions & 1 deletion src/models/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,12 @@ class ConfigurationBase(BaseModel):


class TLSConfiguration(ConfigurationBase):
"""TLS configuration."""
"""TLS configuration.

See also:
- https://fastapi.tiangolo.com/deployment/https/
- https://en.wikipedia.org/wiki/Transport_Layer_Security
"""

tls_certificate_path: Optional[FilePath] = Field(
None,
Expand Down
Loading