Skip to content

Commit 87b749c

Browse files
tisniktisnik
authored
Merge pull request #624 from tisnik/lcore-632-regenerated-openapi-doc
LCORE-632: regenerated OpenAPI doc
2 parents 65b3026 + 7318e77 commit 87b749c

File tree

3 files changed

+67
-23
lines changed

3 files changed

+67
-23
lines changed

‎docs/openapi.json‎

Lines changed: 51 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1597,15 +1597,36 @@
15971597
"properties": {
15981598
"conversation_id": {
15991599
"type": "string",
1600-
"title": "Conversation Id"
1600+
"title": "Conversation Id",
1601+
"description": "Conversation ID (UUID)",
1602+
"examples": [
1603+
"c5260aec-4d82-4370-9fdf-05cf908b3f16"
1604+
]
16011605
},
16021606
"chat_history": {
16031607
"items": {
16041608
"additionalProperties": true,
16051609
"type": "object"
16061610
},
16071611
"type": "array",
1608-
"title": "Chat History"
1612+
"title": "Chat History",
1613+
"description": "The simplified chat history as a list of conversation turns",
1614+
"examples": [
1615+
{
1616+
"completed_at": "2024-01-01T00:01:05Z",
1617+
"messages": [
1618+
{
1619+
"content": "Hello",
1620+
"type": "user"
1621+
},
1622+
{
1623+
"content": "Hi there!",
1624+
"type": "assistant"
1625+
}
1626+
],
1627+
"started_at": "2024-01-01T00:01:00Z"
1628+
}
1629+
]
16091630
}
16101631
},
16111632
"type": "object",
@@ -1979,7 +2000,11 @@
19792000
"properties": {
19802001
"response": {
19812002
"type": "string",
1982-
"title": "Response"
2003+
"title": "Response",
2004+
"description": "The response of the feedback request.",
2005+
"examples": [
2006+
"feedback received"
2007+
]
19832008
}
19842009
},
19852010
"type": "object",
@@ -2041,7 +2066,11 @@
20412066
"properties": {
20422067
"detail": {
20432068
"type": "string",
2044-
"title": "Detail"
2069+
"title": "Detail",
2070+
"description": "Details about the authorization issue",
2071+
"examples": [
2072+
"Missing or invalid credentials provided by client"
2073+
]
20452074
}
20462075
},
20472076
"type": "object",
@@ -2715,6 +2744,7 @@
27152744
},
27162745
"type": "array",
27172746
"title": "Rag Chunks",
2747+
"description": "List of RAG chunks used to generate the response",
27182748
"default": []
27192749
},
27202750
"tool_calls": {
@@ -2964,12 +2994,22 @@
29642994
"properties": {
29652995
"functionality": {
29662996
"type": "string",
2967-
"title": "Functionality"
2997+
"title": "Functionality",
2998+
"description": "The functionality of the service",
2999+
"examples": [
3000+
"feedback"
3001+
]
29683002
},
29693003
"status": {
29703004
"additionalProperties": true,
29713005
"type": "object",
2972-
"title": "Status"
3006+
"title": "Status",
3007+
"description": "The status of the service",
3008+
"examples": [
3009+
{
3010+
"enabled": true
3011+
}
3012+
]
29733013
}
29743014
},
29753015
"type": "object",
@@ -3071,7 +3111,11 @@
30713111
"properties": {
30723112
"detail": {
30733113
"type": "string",
3074-
"title": "Detail"
3114+
"title": "Detail",
3115+
"description": "Details about the authorization issue",
3116+
"examples": [
3117+
"Missing or invalid credentials provided by client"
3118+
]
30753119
}
30763120
},
30773121
"type": "object",

‎docs/openapi.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -760,8 +760,8 @@ Example:
760760

761761
| Field | Type | Description |
762762
|-------|------|-------------|
763-
| conversation_id | string | |
764-
| chat_history | array | |
763+
| conversation_id | string | Conversation ID (UUID) |
764+
| chat_history | array | The simplified chat history as a list of conversation turns |
765765

766766

767767
## ConversationsListResponse
@@ -931,7 +931,7 @@ Example:
931931

932932
| Field | Type | Description |
933933
|-------|------|-------------|
934-
| response | string | |
934+
| response | string | The response of the feedback request. |
935935

936936

937937
## FeedbackStatusUpdateRequest
@@ -989,7 +989,7 @@ Model representing response for forbidden access.
989989

990990
| Field | Type | Description |
991991
|-------|------|-------------|
992-
| detail | string | |
992+
| detail | string | Details about the authorization issue |
993993

994994

995995
## HTTPValidationError
@@ -1247,7 +1247,7 @@ Attributes:
12471247
|-------|------|-------------|
12481248
| conversation_id | | The optional conversation ID (UUID) |
12491249
| response | string | Response from LLM |
1250-
| rag_chunks | array | |
1250+
| rag_chunks | array | List of RAG chunks used to generate the response |
12511251
| tool_calls | | List of tool calls made during response generation |
12521252
| referenced_documents | array | List of documents referenced in generating the response |
12531253

@@ -1363,8 +1363,8 @@ Example:
13631363

13641364
| Field | Type | Description |
13651365
|-------|------|-------------|
1366-
| functionality | string | |
1367-
| status | object | |
1366+
| functionality | string | The functionality of the service |
1367+
| status | object | The status of the service |
13681368

13691369

13701370
## TLSConfiguration
@@ -1401,7 +1401,7 @@ Model representing response for missing or invalid credentials.
14011401

14021402
| Field | Type | Description |
14031403
|-------|------|-------------|
1404-
| detail | string | |
1404+
| detail | string | Details about the authorization issue |
14051405

14061406

14071407
## UserDataCollection

‎docs/output.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -760,8 +760,8 @@ Example:
760760

761761
| Field | Type | Description |
762762
|-------|------|-------------|
763-
| conversation_id | string | |
764-
| chat_history | array | |
763+
| conversation_id | string | Conversation ID (UUID) |
764+
| chat_history | array | The simplified chat history as a list of conversation turns |
765765

766766

767767
## ConversationsListResponse
@@ -931,7 +931,7 @@ Example:
931931

932932
| Field | Type | Description |
933933
|-------|------|-------------|
934-
| response | string | |
934+
| response | string | The response of the feedback request. |
935935

936936

937937
## FeedbackStatusUpdateRequest
@@ -989,7 +989,7 @@ Model representing response for forbidden access.
989989

990990
| Field | Type | Description |
991991
|-------|------|-------------|
992-
| detail | string | |
992+
| detail | string | Details about the authorization issue |
993993

994994

995995
## HTTPValidationError
@@ -1247,7 +1247,7 @@ Attributes:
12471247
|-------|------|-------------|
12481248
| conversation_id | | The optional conversation ID (UUID) |
12491249
| response | string | Response from LLM |
1250-
| rag_chunks | array | |
1250+
| rag_chunks | array | List of RAG chunks used to generate the response |
12511251
| tool_calls | | List of tool calls made during response generation |
12521252
| referenced_documents | array | List of documents referenced in generating the response |
12531253

@@ -1363,8 +1363,8 @@ Example:
13631363

13641364
| Field | Type | Description |
13651365
|-------|------|-------------|
1366-
| functionality | string | |
1367-
| status | object | |
1366+
| functionality | string | The functionality of the service |
1367+
| status | object | The status of the service |
13681368

13691369

13701370
## TLSConfiguration
@@ -1401,7 +1401,7 @@ Model representing response for missing or invalid credentials.
14011401

14021402
| Field | Type | Description |
14031403
|-------|------|-------------|
1404-
| detail | string | |
1404+
| detail | string | Details about the authorization issue |
14051405

14061406

14071407
## UserDataCollection

0 commit comments

Comments
 (0)