Skip to content

Commit f081245

Browse files
committed
Add: UCI API Documentation
1 parent 759d686 commit f081245

File tree

6 files changed

+124
-1
lines changed

6 files changed

+124
-1
lines changed

docs/UCI API - Adapter.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
id: APIAdapter
3+
title:
4+
sidebar_label: Adapter API
5+
---
6+
7+
## /api/v1/adapter/create
8+
9+
#### `POST`
10+
11+
## /api/v1/adapter/get/`<adapter-id>`
12+
13+
#### `GET`
14+
15+
## /api/v1/adapter/udpate/`<adapter-id>`
16+
17+
#### `PUT`
18+
19+
## /api/v1/adapter/delete/`<adapter-id>`
20+
21+
#### `DELETE`
22+
23+
24+

docs/UCI API - Bot.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
id: APIBot
3+
title:
4+
sidebar_label: Bot API
5+
---
6+
7+
## /api/v1/bot/create
8+
9+
#### `POST`
10+
11+
## /api/v1/bot/get/`<bot-id>`
12+
13+
#### `GET`
14+
15+
## /api/v1/bot/udpate/`<bot-id>`
16+
17+
#### `PUT`
18+
19+
## /api/v1/bot/delete/`<bot-id>`
20+
21+
#### `DELETE`
22+
23+
24+
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
id: APIConversationLogic
3+
title: Conversation Logic
4+
sidebar_label: Conversation Logic API
5+
---
6+
7+
## /api/v1/conversationLogic/create
8+
9+
### `POST`
10+
11+
## /api/v1/conversationLogic/get/`<conversationLogic-id>`
12+
13+
### `GET`
14+
15+
## /api/v1/conversationLogic/udpate/`<conversationLogic-id>`
16+
17+
### `PUT`
18+
19+
## /api/v1/conversationLogic/delete/`<conversationLogic-id>`
20+
21+
### `DELETE`
22+
23+
24+

docs/UCI API - Transformer.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
id: APITransformer
3+
title:
4+
sidebar_label: Transformer API
5+
---
6+
7+
## /api/v1/transformer/create
8+
9+
#### `POST`
10+
11+
## /api/v1/transformer/get/`<transformer-id>`
12+
13+
#### `GET`
14+
15+
## /api/v1/transformer/udpate/`<transformer-id>`
16+
17+
#### `PUT`
18+
19+
## /api/v1/transformer/delete/`<transformer-id>`
20+
21+
#### `DELETE`
22+
23+
24+

docs/UCI API - User Segment.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
id: APIUserSegment
3+
title:
4+
sidebar_label: User Segment API
5+
---
6+
7+
## /api/v1/userSegment/`create`
8+
9+
#### `POST`
10+
11+
## /api/v1/userSegment/get/`<userSegment-id>`
12+
13+
#### `GET`
14+
15+
## /api/v1/userSegment/udpate/`<userSegment-id>`
16+
17+
#### `PUT`
18+
19+
## /api/v1/userSegment/delete/`<userSegment-id>`
20+
21+
#### `DELETE`
22+
23+
24+

sidebars.js

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88
*/
99

1010
module.exports = {
11+
uciSidebar: {
12+
'UCI API': ['APIAdapter', 'APITransformer', 'APIBot', 'APIUserSegment', 'APIConversationLogic' ],
13+
},
1114
someSidebar: {
1215
Products: [
1316
{
@@ -19,7 +22,7 @@ module.exports = {
1922
{
2023
Pariksha: ['ParikshaFuncSpecs', 'deploypariksha'],
2124
},
22-
],
25+
],
2326
Components: [
2427
'ComponentsOverview',
2528
{

0 commit comments

Comments
 (0)