Skip to content

Commit e4472fe

Browse files
tisniktisnik
authored
Merge pull request #535 from tisnik/lcore-287-fixed-field-descriptions
LCORE-287: fixed field descriptions
2 parents 7662753 + 29d4e76 commit e4472fe

File tree

4 files changed

+35
-56
lines changed

4 files changed

+35
-56
lines changed

‎docs/openapi.json‎

Lines changed: 23 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@
267267
},
268268
"llama_stack": {
269269
"url": "http://localhost:8321",
270-
"api_key": "xyzzy",
270+
"api_key": "*****",
271271
"use_as_library_client": false
272272
},
273273
"user_data_collection": {
@@ -935,9 +935,12 @@
935935
},
936936
"skip_userid_check": {
937937
"type": "boolean",
938-
"title": "Skip User Id Check",
938+
"title": "Skip Userid Check",
939939
"description": "Whether to skip the user ID check",
940-
"examples": [true, false]
940+
"examples": [
941+
true,
942+
false
943+
]
941944
}
942945
},
943946
"type": "object",
@@ -947,12 +950,12 @@
947950
"skip_userid_check"
948951
],
949952
"title": "AuthorizedResponse",
950-
"description": "Model representing a response to an authorization request.\n\nAttributes:\n user_id: The ID of the logged in user.\n username: The name of the logged in user.",
953+
"description": "Model representing a response to an authorization request.\n\nAttributes:\n user_id: The ID of the logged in user.\n username: The name of the logged in user.\n skip_userid_check: Whether to skip the user ID check.",
951954
"examples": [
952955
{
956+
"skip_userid_check": false,
953957
"user_id": "123e4567-e89b-12d3-a456-426614174000",
954-
"username": "user1",
955-
"skip_userid_check": false
958+
"username": "user1"
956959
}
957960
]
958961
},
@@ -1015,27 +1018,17 @@
10151018
"$ref": "#/components/schemas/UserDataCollection"
10161019
},
10171020
"database": {
1018-
"$ref": "#/components/schemas/DatabaseConfiguration",
1019-
"default": {
1020-
"sqlite": {
1021-
"db_path": "/tmp/lightspeed-stack.db"
1022-
}
1023-
}
1021+
"$ref": "#/components/schemas/DatabaseConfiguration"
10241022
},
10251023
"mcp_servers": {
10261024
"items": {
10271025
"$ref": "#/components/schemas/ModelContextProtocolServer"
10281026
},
10291027
"type": "array",
1030-
"title": "Mcp Servers",
1031-
"default": []
1028+
"title": "Mcp Servers"
10321029
},
10331030
"authentication": {
1034-
"$ref": "#/components/schemas/AuthenticationConfiguration",
1035-
"default": {
1036-
"module": "noop",
1037-
"skip_tls_verification": false
1038-
}
1031+
"$ref": "#/components/schemas/AuthenticationConfiguration"
10391032
},
10401033
"authorization": {
10411034
"anyOf": [
@@ -1058,8 +1051,7 @@
10581051
]
10591052
},
10601053
"inference": {
1061-
"$ref": "#/components/schemas/InferenceConfiguration",
1062-
"default": {}
1054+
"$ref": "#/components/schemas/InferenceConfiguration"
10631055
}
10641056
},
10651057
"additionalProperties": false,
@@ -1655,7 +1647,7 @@
16551647
"llama_stack_version"
16561648
],
16571649
"title": "InfoResponse",
1658-
"description": "Model representing a response to an info request.\n\nAttributes:\n name: Service name.\n service_version: Service version.\n llama_stack_version: Llama Stack version.\n\nExample:\n ```python\n info_response = InfoResponse(\n name=\"Lightspeed Stack\",\n service_version=\"1.0.0\",\n llama_stack_version=\"0.2.18\",\n )\n ```",
1650+
"description": "Model representing a response to an info request.\n\nAttributes:\n name: Service name.\n service_version: Service version.\n llama_stack_version: Llama Stack version.\n\nExample:\n ```python\n info_response = InfoResponse(\n name=\"Lightspeed Stack\",\n service_version=\"1.0.0\",\n llama_stack_version=\"0.2.19\",\n )\n ```",
16591651
"examples": [
16601652
{
16611653
"llama_stack_version": "1.0.0",
@@ -1684,12 +1676,7 @@
16841676
"title": "Url"
16851677
},
16861678
"jwt_configuration": {
1687-
"$ref": "#/components/schemas/JwtConfiguration",
1688-
"default": {
1689-
"user_id_claim": "user_id",
1690-
"username_claim": "username",
1691-
"role_rules": []
1692-
}
1679+
"$ref": "#/components/schemas/JwtConfiguration"
16931680
}
16941681
},
16951682
"additionalProperties": false,
@@ -1796,7 +1783,9 @@
17961783
"api_key": {
17971784
"anyOf": [
17981785
{
1799-
"type": "string"
1786+
"type": "string",
1787+
"format": "password",
1788+
"writeOnly": true
18001789
},
18011790
{
18021791
"type": "null"
@@ -1919,7 +1908,9 @@
19191908
},
19201909
"password": {
19211910
"type": "string",
1922-
"title": "Password"
1911+
"format": "password",
1912+
"title": "Password",
1913+
"writeOnly": true
19231914
},
19241915
"namespace": {
19251916
"anyOf": [
@@ -2303,23 +2294,10 @@
23032294
"default": true
23042295
},
23052296
"tls_config": {
2306-
"$ref": "#/components/schemas/TLSConfiguration",
2307-
"default": {}
2297+
"$ref": "#/components/schemas/TLSConfiguration"
23082298
},
23092299
"cors": {
2310-
"$ref": "#/components/schemas/CORSConfiguration",
2311-
"default": {
2312-
"allow_origins": [
2313-
"*"
2314-
],
2315-
"allow_credentials": false,
2316-
"allow_methods": [
2317-
"*"
2318-
],
2319-
"allow_headers": [
2320-
"*"
2321-
]
2322-
}
2300+
"$ref": "#/components/schemas/CORSConfiguration"
23232301
}
23242302
},
23252303
"additionalProperties": false,

‎docs/openapi.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -397,8 +397,8 @@ Returns:
397397
| Status Code | Description | Component |
398398
|-------------|-------------|-----------|
399399
| 200 | The user is logged-in and authorized to access OLS | [AuthorizedResponse](#authorizedresponse) |
400-
| 400 | Missing or invalid credentials provided by client for noop and noop-with-token | [UnauthorizedResponse](#unauthorizedresponse) |
401-
| 401 | Missing or invalid credentials provided by client for k8s | [UnauthorizedResponse](#unauthorizedresponse) |
400+
| 400 | Missing or invalid credentials provided by client for the noop and noop-with-token authentication modules | [UnauthorizedResponse](#unauthorizedresponse) |
401+
| 401 | Missing or invalid credentials provided by client for the k8s authentication module | [UnauthorizedResponse](#unauthorizedresponse) |
402402
| 403 | User is not authorized | [ForbiddenResponse](#forbiddenresponse) |
403403
## GET `/metrics`
404404

@@ -510,13 +510,14 @@ Model representing a response to an authorization request.
510510
Attributes:
511511
user_id: The ID of the logged in user.
512512
username: The name of the logged in user.
513+
skip_userid_check: Whether to skip the user ID check.
513514

514515

515516
| Field | Type | Description |
516517
|-------|------|-------------|
517518
| user_id | string | User ID, for example UUID |
518519
| username | string | User name |
519-
| skip_userid_check | bool | Whether to skip user_id check |
520+
| skip_userid_check | boolean | Whether to skip the user ID check |
520521

521522

522523
## CORSConfiguration
@@ -893,7 +894,7 @@ Example:
893894
info_response = InfoResponse(
894895
name="Lightspeed Stack",
895896
service_version="1.0.0",
896-
llama_stack_version="0.2.18",
897+
llama_stack_version="0.2.19",
897898
)
898899
```
899900

‎docs/output.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -397,8 +397,8 @@ Returns:
397397
| Status Code | Description | Component |
398398
|-------------|-------------|-----------|
399399
| 200 | The user is logged-in and authorized to access OLS | [AuthorizedResponse](#authorizedresponse) |
400-
| 400 | Missing or invalid credentials provided by client for noop and noop-with-token | [UnauthorizedResponse](#unauthorizedresponse) |
401-
| 401 | Missing or invalid credentials provided by client for k8s | [UnauthorizedResponse](#unauthorizedresponse) |
400+
| 400 | Missing or invalid credentials provided by client for the noop and noop-with-token authentication modules | [UnauthorizedResponse](#unauthorizedresponse) |
401+
| 401 | Missing or invalid credentials provided by client for the k8s authentication module | [UnauthorizedResponse](#unauthorizedresponse) |
402402
| 403 | User is not authorized | [ForbiddenResponse](#forbiddenresponse) |
403403
## GET `/metrics`
404404

@@ -510,14 +510,14 @@ Model representing a response to an authorization request.
510510
Attributes:
511511
user_id: The ID of the logged in user.
512512
username: The name of the logged in user.
513-
skip_userid_check: Whether to skip user_id check
513+
skip_userid_check: Whether to skip the user ID check.
514514

515515

516516
| Field | Type | Description |
517517
|-------|------|-------------|
518518
| user_id | string | User ID, for example UUID |
519519
| username | string | User name |
520-
| skip_userid_check | bool | skip user_id check |
520+
| skip_userid_check | boolean | Whether to skip the user ID check |
521521

522522

523523
## CORSConfiguration
@@ -884,7 +884,7 @@ Example:
884884
info_response = InfoResponse(
885885
name="Lightspeed Stack",
886886
service_version="1.0.0",
887-
llama_stack_version="0.2.18",
887+
llama_stack_version="0.2.19",
888888
)
889889
```
890890

‎src/app/endpoints/authorized.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@
2020
"model": AuthorizedResponse,
2121
},
2222
400: {
23-
"description": "Missing or invalid credentials provided by client for the noop and"
23+
"description": "Missing or invalid credentials provided by client for the noop and "
2424
"noop-with-token authentication modules",
2525
"model": UnauthorizedResponse,
2626
},
2727
401: {
28-
"description": "Missing or invalid credentials provided by client for the"
28+
"description": "Missing or invalid credentials provided by client for the "
2929
"k8s authentication module",
3030
"model": UnauthorizedResponse,
3131
},

0 commit comments

Comments
 (0)