Skip to content

Commit 11b752e

Browse files
committed
Regenerated documentation
1 parent b50ee85 commit 11b752e

File tree

5 files changed

+56
-15
lines changed

5 files changed

+56
-15
lines changed

docs/config.html

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,8 +172,20 @@
172172
<h1 class="title"> </h1>
173173
</header>
174174
<h1 id="lightspeed-core-stack">Lightspeed Core Stack</h1>
175+
<h2 id="base-url">🌍 Base URL</h2>
176+
<table>
177+
<thead>
178+
<tr class="header">
179+
<th>URL</th>
180+
<th>Description</th>
181+
</tr>
182+
</thead>
183+
<tbody>
184+
</tbody>
185+
</table>
186+
<h1 id="apis">🛠️ APIs</h1>
175187
<hr />
176-
<h1 id="configuration-options">📋 Configuration options</h1>
188+
<h1 id="components">📋 Components</h1>
177189
<h2 id="accessrule">AccessRule</h2>
178190
<p>Rule defining what actions a role can perform.</p>
179191
<table>
@@ -969,6 +981,8 @@ <h2 id="serviceconfiguration">ServiceConfiguration</h2>
969981
</table>
970982
<h2 id="tlsconfiguration">TLSConfiguration</h2>
971983
<p>TLS configuration.</p>
984+
<p>See also: - https://fastapi.tiangolo.com/deployment/https/ -
985+
https://en.wikipedia.org/wiki/Transport_Layer_Security</p>
972986
<table>
973987
<colgroup>
974988
<col style="width: 26%" />

docs/config.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,19 @@
11
# Lightspeed Core Stack
22

3+
4+
5+
## 🌍 Base URL
6+
7+
8+
| URL | Description |
9+
|-----|-------------|
10+
11+
12+
# 🛠️ APIs
13+
314
---
415

5-
# 📋 Configuration options
16+
# 📋 Components
617

718

819

@@ -362,6 +373,10 @@ Service configuration.
362373

363374
TLS configuration.
364375

376+
See also:
377+
- https://fastapi.tiangolo.com/deployment/https/
378+
- https://en.wikipedia.org/wiki/Transport_Layer_Security
379+
365380

366381
| Field | Type | Description |
367382
|-------|------|-------------|

docs/openapi.json

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7184,7 +7184,8 @@
71847184
"properties": {
71857185
"db_path": {
71867186
"type": "string",
7187-
"title": "Db Path"
7187+
"title": "DB path",
7188+
"description": "Path to file where SQLite database is stored"
71887189
}
71897190
},
71907191
"additionalProperties": false,
@@ -7350,7 +7351,8 @@
73507351
"type": "null"
73517352
}
73527353
],
7353-
"title": "Tls Certificate Path"
7354+
"title": "TLS certificate path",
7355+
"description": "SSL/TLS certificate file path for HTTPS support."
73547356
},
73557357
"tls_key_path": {
73567358
"anyOf": [
@@ -7362,7 +7364,8 @@
73627364
"type": "null"
73637365
}
73647366
],
7365-
"title": "Tls Key Path"
7367+
"title": "TLS key path",
7368+
"description": "SSL/TLS private key file path for HTTPS support."
73667369
},
73677370
"tls_key_password": {
73687371
"anyOf": [
@@ -7374,13 +7377,14 @@
73747377
"type": "null"
73757378
}
73767379
],
7377-
"title": "Tls Key Password"
7380+
"title": "SSL/TLS key password path",
7381+
"description": "Path to file containing the password to decrypt the SSL/TLS private key."
73787382
}
73797383
},
73807384
"additionalProperties": false,
73817385
"type": "object",
73827386
"title": "TLSConfiguration",
7383-
"description": "TLS configuration."
7387+
"description": "TLS configuration.\n\nSee also:\n- https://fastapi.tiangolo.com/deployment/https/\n- https://en.wikipedia.org/wiki/Transport_Layer_Security"
73847388
},
73857389
"ToolCall": {
73867390
"properties": {

docs/openapi.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4806,7 +4806,7 @@ SQLite database configuration.
48064806

48074807
| Field | Type | Description |
48084808
|-------|------|-------------|
4809-
| db_path | string | |
4809+
| db_path | string | Path to file where SQLite database is stored |
48104810

48114811

48124812
## ServiceConfiguration
@@ -4871,12 +4871,16 @@ Attributes:
48714871

48724872
TLS configuration.
48734873

4874+
See also:
4875+
- https://fastapi.tiangolo.com/deployment/https/
4876+
- https://en.wikipedia.org/wiki/Transport_Layer_Security
4877+
48744878

48754879
| Field | Type | Description |
48764880
|-------|------|-------------|
4877-
| tls_certificate_path | | |
4878-
| tls_key_path | | |
4879-
| tls_key_password | | |
4881+
| tls_certificate_path | | SSL/TLS certificate file path for HTTPS support. |
4882+
| tls_key_path | | SSL/TLS private key file path for HTTPS support. |
4883+
| tls_key_password | | Path to file containing the password to decrypt the SSL/TLS private key. |
48804884

48814885

48824886
## ToolCall

docs/output.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4806,7 +4806,7 @@ SQLite database configuration.
48064806

48074807
| Field | Type | Description |
48084808
|-------|------|-------------|
4809-
| db_path | string | |
4809+
| db_path | string | Path to file where SQLite database is stored |
48104810

48114811

48124812
## ServiceConfiguration
@@ -4871,12 +4871,16 @@ Attributes:
48714871

48724872
TLS configuration.
48734873

4874+
See also:
4875+
- https://fastapi.tiangolo.com/deployment/https/
4876+
- https://en.wikipedia.org/wiki/Transport_Layer_Security
4877+
48744878

48754879
| Field | Type | Description |
48764880
|-------|------|-------------|
4877-
| tls_certificate_path | | |
4878-
| tls_key_path | | |
4879-
| tls_key_password | | |
4881+
| tls_certificate_path | | SSL/TLS certificate file path for HTTPS support. |
4882+
| tls_key_path | | SSL/TLS private key file path for HTTPS support. |
4883+
| tls_key_password | | Path to file containing the password to decrypt the SSL/TLS private key. |
48804884

48814885

48824886
## ToolCall

0 commit comments

Comments
 (0)