Skip to content

Commit e36ed80

Browse files
authored
Merge pull request #2118 from tisnik/lcore-2861-up-to-date-packages-documentation
LCORE-2861: up to date packages documentation
2 parents 365f637 + 3b19169 commit e36ed80

11 files changed

Lines changed: 71 additions & 7 deletions

File tree

src/app/endpoints/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,9 @@ Handler for RHEL Lightspeed rlsapi v1 REST API endpoints.
6666
## [root.py](root.py)
6767
Handler for the / endpoint.
6868

69+
## [saved_prompts.py](saved_prompts.py)
70+
Handler for REST API calls to manage saved prompts.
71+
6972
## [shields.py](shields.py)
7073
Handler for REST API call to list available shields.
7174

src/models/api/responses/successful/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,9 @@ Successful response model for the OpenAI-compatible Responses API.
3636
## [rlsapi.py](rlsapi.py)
3737
Models for rlsapi v1 REST API responses.
3838

39+
## [saved_prompts.py](saved_prompts.py)
40+
Successful responses for saved prompts configuration.
41+
3942
## [vector_stores.py](vector_stores.py)
4043
Successful responses for vector stores and vector store files.
4144

src/models/database/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,4 @@ User conversation models.
1111

1212
## [saved_prompts.py](saved_prompts.py)
1313
User saved prompt models.
14+
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# List of source files stored in `src/pydantic_ai_lightspeed/capabilities/redaction` directory
2+
3+
## [__init__.py](__init__.py)
4+
PII redaction capability for Pydantic AI agents.
5+
6+
## [capability.py](capability.py)
7+
Pydantic AI capability for PII redaction of model messages.
8+
9+
## [core.py](core.py)
10+
Core redaction logic for PII detection and replacement.
11+

src/utils/README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ Common utilities for the project.
1212
## [compaction.py](compaction.py)
1313
Conversation compaction — partitioning, summarization, additive fold-up.
1414

15+
## [config_dumper.py](config_dumper.py)
16+
Function to dump the configuration schema into OpenAPI-compatible format.
17+
1518
## [connection_decorator.py](connection_decorator.py)
1619
Decorator that makes sure the object is 'connected' according to it's connected predicate.
1720

@@ -27,6 +30,9 @@ Degraded mode state tracking.
2730
## [endpoints.py](endpoints.py)
2831
Utility functions for endpoint handlers.
2932

33+
## [json_schema_updater.py](json_schema_updater.py)
34+
Function to transform a JSON Schema-like dictionary into an OpenAPI-compatible schema.
35+
3036
## [llama_stack_version.py](llama_stack_version.py)
3137
Check if the Llama Stack version is supported by the LCS.
3238

@@ -42,6 +48,12 @@ MCP headers handling.
4248
## [mcp_oauth_probe.py](mcp_oauth_probe.py)
4349
Probe MCP servers for OAuth and raise 401 with WWW-Authenticate when required.
4450

51+
## [models_dumper.py](models_dumper.py)
52+
Function to dump the schema of all data models into OpenAPI-compatible format.
53+
54+
## [openapi_schema_dumper.py](openapi_schema_dumper.py)
55+
Utility function to dump schema with list of models into OpenAPI-compatible JSON format.
56+
4557
## [prompts.py](prompts.py)
4658
Utility functions for system prompts.
4759

@@ -51,7 +63,7 @@ Helpers for running Pydantic AI agents against Llama Stack (Responses API compat
5163
## [query.py](query.py)
5264
Utility functions for working with queries.
5365

54-
## [quota.py](quota.py)
66+
## [quota_utils.py](quota_utils.py)
5567
Quota handling helper functions.
5668

5769
## [reranker.py](reranker.py)
@@ -63,9 +75,6 @@ Utility functions for processing Responses API output.
6375
## [rh_identity.py](rh_identity.py)
6476
Utility functions for extracting RH Identity context for telemetry.
6577

66-
## [schema_dumper.py](schema_dumper.py)
67-
Function to dump the configuration schema into OpenAPI-compatible format.
68-
6978
## [shields.py](shields.py)
7079
Utility functions for working with Llama Stack shields.
7180

tests/unit/app/endpoints/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,9 @@ Unit tests for the rlsapi v1 /infer REST API endpoint.
6666
## [test_root.py](test_root.py)
6767
Unit tests for the / endpoint handler.
6868

69+
## [test_saved_prompts.py](test_saved_prompts.py)
70+
Unit tests for the /saved-prompts/config REST API endpoint.
71+
6972
## [test_shields.py](test_shields.py)
7073
Unit tests for the /shields REST API endpoint.
7174

tests/unit/models/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,6 @@ Unit tests for models.
66
## [test_compaction.py](test_compaction.py)
77
Unit tests for the ConversationSummary model.
88

9+
## [test_saved_prompts_config.py](test_saved_prompts_config.py)
10+
Unit tests for SavedPromptsConfiguration.
11+
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# List of source files stored in `tests/unit/models/database` directory
2+
3+
## [__init__.py](__init__.py)
4+
Unit tests for database models.
5+
6+
## [test_saved_prompts.py](test_saved_prompts.py)
7+
Unit tests for SavedPrompt database model.
8+
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# List of source files stored in `tests/unit/pydantic_ai_lightspeed/capabilities/redaction` directory
2+
3+
## [__init__.py](__init__.py)
4+
Tests for pydantic_ai_lightspeed.capabilities.redaction package.
5+
6+
## [test_capability.py](test_capability.py)
7+
Unit tests for pydantic_ai_lightspeed.capabilities.redaction.capability module.
8+
9+
## [test_config.py](test_config.py)
10+
Unit tests for pydantic_ai_lightspeed.capabilities.redaction.config module.
11+
12+
## [test_core.py](test_core.py)
13+
Unit tests for pydantic_ai_lightspeed.capabilities.redaction.core module.
14+

tests/unit/pydantic_ai_lightspeed/llamastack/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
## [__init__.py](__init__.py)
44
Unit tests for pydantic_ai_lightspeed.llamastack sub-package.
55

6+
## [test_model.py](test_model.py)
7+
Unit tests for pydantic_ai_lightspeed.llamastack._model module.
8+
69
## [test_provider.py](test_provider.py)
710
Unit tests for pydantic_ai_lightspeed.llamastack._provider module.
811

0 commit comments

Comments
 (0)