Skip to content

Commit 9bea1bc

Browse files
committed
Regenerated doc
1 parent ce51490 commit 9bea1bc

File tree

8 files changed

+26
-44
lines changed

8 files changed

+26
-44
lines changed

src/app/endpoints/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Handler for REST API call to list available models.
4040
Handler for REST API calls to list and retrieve available providers.
4141

4242
## [query.py](query.py)
43-
Handler for REST API call to provide answer to query using Responses API.
43+
Handler for REST API call to provide answer to query using Response API.
4444

4545
## [rags.py](rags.py)
4646
Handler for REST API calls to list and retrieve available RAGs.
@@ -55,7 +55,7 @@ Handler for the / endpoint.
5555
Handler for REST API call to list available shields.
5656

5757
## [streaming_query.py](streaming_query.py)
58-
Handler for REST API call to provide answer to streaming query using Responses API.
58+
Streaming query handler using Responses API.
5959

6060
## [tools.py](tools.py)
6161
Handler for REST API call to list available tools from MCP servers.

src/utils/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Common utilities for the project.
1313
Decorator that makes sure the object is 'connected' according to it's connected predicate.
1414

1515
## [conversations.py](conversations.py)
16-
Utility functions for working with conversations.
16+
Utilities for conversations.
1717

1818
## [endpoints.py](endpoints.py)
1919
Utility functions for endpoint handlers.
@@ -28,7 +28,7 @@ Utilities for resolving MCP server authorization headers.
2828
MCP headers handling.
2929

3030
## [prompts.py](prompts.py)
31-
Utility functions for working with prompts.
31+
Utility functions for system prompts.
3232

3333
## [query.py](query.py)
3434
Utility functions for working with queries.

tests/e2e/configuration/README.md

Lines changed: 1 addition & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,2 @@
1-
# E2E Test Configuration Files
1+
# List of source files stored in `tests/e2e/configuration` directory
22

3-
This directory contains configuration files used for end-to-end testing of Lightspeed Core.
4-
5-
## Directory Structure
6-
7-
- `server-mode/` - Configurations for testing when LCore connects to a separate Llama Stack service
8-
- `library-mode/` - Configurations for testing when LCore embeds Llama Stack as a library
9-
10-
## Common Configuration Features
11-
12-
### Default Configurations (`lightspeed-stack.yaml`)
13-
14-
Both server-mode and library-mode default configurations include:
15-
16-
1. **MCP Servers** - Used for testing MCP-related endpoints:
17-
- `github-api` - Uses client-provided auth (Authorization header)
18-
- `gitlab-api` - Uses client-provided auth (X-API-Token header)
19-
- `k8s-service` - Uses kubernetes auth (not client-provided)
20-
- `public-api` - No authentication (not client-provided)
21-
22-
These servers test the `/v1/mcp-auth/client-options` endpoint, which should return only servers accepting client-provided authentication (`github-api` and `gitlab-api`).
23-
24-
2. **Authentication** - Set to `noop` for most tests
25-
26-
3. **User Data Collection** - Enabled for feedback and transcripts testing
27-
28-
### Special-Purpose Configurations
29-
30-
- `lightspeed-stack-auth-noop-token.yaml` - For authorization testing
31-
- `lightspeed-stack-invalid-feedback-storage.yaml` - For negative feedback testing
32-
- `lightspeed-stack-no-cache.yaml` - For cache-disabled scenarios

tests/e2e/features/steps/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,6 @@ LLM query and response steps.
3030
## [rbac.py](rbac.py)
3131
Step definitions for RBAC E2E tests.
3232

33+
## [token_counters.py](token_counters.py)
34+
Step definitions for token counter validation.
35+

tests/integration/endpoints/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Integration tests for the /health endpoint.
1212
## [test_info_integration.py](test_info_integration.py)
1313
Integration tests for the /info endpoint.
1414

15-
## [test_query_v1_integration.py](test_query_v1_integration.py)
15+
## [test_query_v2_integration.py](test_query_v2_integration.py)
1616
Integration tests for the /query endpoint (using Responses API).
1717

1818
## [test_rlsapi_v1_integration.py](test_rlsapi_v1_integration.py)

tests/unit/app/endpoints/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Unit tests for the /models REST API endpoint.
4040
Unit tests for the /providers REST API endpoints.
4141

4242
## [test_query.py](test_query.py)
43-
Unit tests for the /query REST API endpoint (includes utility function tests for get_rag_tools and get_mcp_tools).
43+
Unit tests for the /query REST API endpoint.
4444

4545
## [test_rags.py](test_rags.py)
4646
Unit tests for the /rags REST API endpoints.

tests/unit/models/responses/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,12 @@ Unit tests for QueryResponse model.
1515
## [test_rag_chunk.py](test_rag_chunk.py)
1616
Unit tests for RAGChunk model.
1717

18+
## [test_response_types.py](test_response_types.py)
19+
Unit tests for response-related type models defined in models/responses.py.
20+
1821
## [test_successful_responses.py](test_successful_responses.py)
1922
Unit tests for all successful response models.
2023

24+
## [test_types.py](test_types.py)
25+
Unit tests for response-related type models.
26+

tests/unit/utils/README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,12 @@ Test module for utils/common.py.
1515
## [test_connection_decorator.py](test_connection_decorator.py)
1616
Unit tests for the connection decorator.
1717

18+
## [test_conversations.py](test_conversations.py)
19+
Unit tests for conversation utility functions.
20+
1821
## [test_endpoints.py](test_endpoints.py)
1922
Unit tests for endpoints utility functions.
2023

21-
## [test_prompts.py](test_prompts.py)
22-
Unit tests for prompts utility functions (get_system_prompt, get_topic_summary_system_prompt).
23-
24-
## [test_query.py](test_query.py)
25-
Unit tests for query utility functions (store_conversation_into_cache, select_model_and_provider_id, validate_model_provider_override, etc.).
26-
2724
## [test_llama_stack_version.py](test_llama_stack_version.py)
2825
Unit tests for utility function to check Llama Stack version.
2926

@@ -33,6 +30,12 @@ Unit tests for MCP authorization headers utilities.
3330
## [test_mcp_headers.py](test_mcp_headers.py)
3431
Unit tests for MCP headers utility functions.
3532

33+
## [test_prompts.py](test_prompts.py)
34+
Unit tests for prompts utility functions.
35+
36+
## [test_query.py](test_query.py)
37+
Unit tests for utils/query.py functions.
38+
3639
## [test_responses.py](test_responses.py)
3740
Unit tests for utils/responses.py functions.
3841

@@ -46,5 +49,5 @@ Unit tests for functions defined in utils.suid module.
4649
Unit tests for functions defined in utils.transcripts module.
4750

4851
## [test_types.py](test_types.py)
49-
Unit tests for functions defined in utils/types.py.
52+
Unit tests for functions and types defined in utils/types.py.
5053

0 commit comments

Comments
 (0)