Skip to content

Update OpenAPI schema #609

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 1 commit into from
Oct 2, 2025
Merged

Update OpenAPI schema #609

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions docs/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
"root"
],
"summary": "Root Endpoint Handler",
"description": "Handle request to the / endpoint.",
"description": "Handle GET requests to the root (\"/\") endpoint and returns the static HTML index page.\n\nReturns:\n HTMLResponse: The HTML content of the index page, including a heading,\n embedded image with the service icon, and links to the API documentation\n via Swagger UI and ReDoc.",
"operationId": "root_endpoint_handler__get",
"responses": {
"200": {
Expand Down Expand Up @@ -3159,4 +3159,4 @@
}
}
}
}
}
32 changes: 30 additions & 2 deletions docs/openapi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,12 @@ Lightspeed Core Service (LCS) service API specification.

> **Root Endpoint Handler**

Handle request to the / endpoint.
Handle GET requests to the root ("/") endpoint and returns the static HTML index page.

Returns:
HTMLResponse: The HTML content of the index page, including a heading,
embedded image with the service icon, and links to the API documentation
via Swagger UI and ReDoc.



Expand Down Expand Up @@ -642,6 +647,24 @@ Conversation cache configuration.
| postgres | | |


## ConversationData


Model representing conversation data returned by cache list operations.

Attributes:
conversation_id: The conversation ID
topic_summary: The topic summary for the conversation (can be None)
last_message_timestamp: The timestamp of the last message in the conversation


| Field | Type | Description |
|-------|------|-------------|
| conversation_id | string | |
| topic_summary | | |
| last_message_timestamp | number | |


## ConversationDeleteResponse


Expand Down Expand Up @@ -681,6 +704,7 @@ Attributes:
message_count: Number of user messages in the conversation.
last_used_model: The last model used for the conversation.
last_used_provider: The provider of the last used model.
topic_summary: The topic summary for the conversation.

Example:
```python
Expand All @@ -691,6 +715,7 @@ Example:
message_count=5,
last_used_model="gemini/gemini-2.0-flash",
last_used_provider="gemini",
topic_summary="Openshift Microservices Deployment Strategies",
)
```

Expand All @@ -703,6 +728,7 @@ Example:
| message_count | | Number of user messages in the conversation |
| last_used_model | | Identification of the last model used for the conversation |
| last_used_provider | | Identification of the last provider used for the conversation |
| topic_summary | | Topic summary for the conversation |


## ConversationResponse
Expand Down Expand Up @@ -757,13 +783,15 @@ Example:
message_count=5,
last_used_model="gemini/gemini-2.0-flash",
last_used_provider="gemini",
topic_summary="Openshift Microservices Deployment Strategies",
),
ConversationDetails(
conversation_id="456e7890-e12b-34d5-a678-901234567890"
created_at="2024-01-01T01:00:00Z",
message_count=2,
last_used_model="gemini/gemini-2.0-flash",
last_used_provider="gemini",
topic_summary="RHDH Purpose Summary",
)
]
)
Expand All @@ -781,7 +809,7 @@ Example:
Model representing a response for listing conversations of a user.

Attributes:
conversations: List of conversation IDs associated with the user.
conversations: List of conversation data associated with the user.


| Field | Type | Description |
Expand Down
32 changes: 30 additions & 2 deletions docs/output.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,12 @@ Lightspeed Core Service (LCS) service API specification.

> **Root Endpoint Handler**

Handle request to the / endpoint.
Handle GET requests to the root ("/") endpoint and returns the static HTML index page.

Returns:
HTMLResponse: The HTML content of the index page, including a heading,
embedded image with the service icon, and links to the API documentation
via Swagger UI and ReDoc.



Expand Down Expand Up @@ -642,6 +647,24 @@ Conversation cache configuration.
| postgres | | |


## ConversationData


Model representing conversation data returned by cache list operations.

Attributes:
conversation_id: The conversation ID
topic_summary: The topic summary for the conversation (can be None)
last_message_timestamp: The timestamp of the last message in the conversation


| Field | Type | Description |
|-------|------|-------------|
| conversation_id | string | |
| topic_summary | | |
| last_message_timestamp | number | |


## ConversationDeleteResponse


Expand Down Expand Up @@ -681,6 +704,7 @@ Attributes:
message_count: Number of user messages in the conversation.
last_used_model: The last model used for the conversation.
last_used_provider: The provider of the last used model.
topic_summary: The topic summary for the conversation.

Example:
```python
Expand All @@ -691,6 +715,7 @@ Example:
message_count=5,
last_used_model="gemini/gemini-2.0-flash",
last_used_provider="gemini",
topic_summary="Openshift Microservices Deployment Strategies",
)
```

Expand All @@ -703,6 +728,7 @@ Example:
| message_count | | Number of user messages in the conversation |
| last_used_model | | Identification of the last model used for the conversation |
| last_used_provider | | Identification of the last provider used for the conversation |
| topic_summary | | Topic summary for the conversation |


## ConversationResponse
Expand Down Expand Up @@ -757,13 +783,15 @@ Example:
message_count=5,
last_used_model="gemini/gemini-2.0-flash",
last_used_provider="gemini",
topic_summary="Openshift Microservices Deployment Strategies",
),
ConversationDetails(
conversation_id="456e7890-e12b-34d5-a678-901234567890"
created_at="2024-01-01T01:00:00Z",
message_count=2,
last_used_model="gemini/gemini-2.0-flash",
last_used_provider="gemini",
topic_summary="RHDH Purpose Summary",
)
]
)
Expand All @@ -781,7 +809,7 @@ Example:
Model representing a response for listing conversations of a user.

Attributes:
conversations: List of conversation IDs associated with the user.
conversations: List of conversation data associated with the user.


| Field | Type | Description |
Expand Down
Loading