You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/server/settingsservice/board-soc-node-rest-api.md
-92Lines changed: 0 additions & 92 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,28 +27,13 @@ http://localhost:8080/api/v1
27
27
-**Response:**`NodeListResponse`
28
28
-**Status Codes:** 200, 500
29
29
30
-
### Create Node
31
-
32
-
-**Endpoint:**`POST /nodes`
33
-
-**Description:** Create a new node.
34
-
-**Request Body:**`CreateNodeRequest`
35
-
-**Response:**`NodeInfo`
36
-
-**Status Codes:** 200, 400, 500
37
-
38
30
### Get Node Details
39
31
40
32
-**Endpoint:**`GET /nodes/{name}`
41
33
-**Description:** Get specific node details including logs.
42
34
-**Response:**`NodeInfo` (with logs)
43
35
-**Status Codes:** 200, 404, 500
44
36
45
-
### Delete Node
46
-
47
-
-**Endpoint:**`DELETE /nodes/{name}`
48
-
-**Description:** Delete a specific node.
49
-
-**Response:** None
50
-
-**Status Codes:** 204, 500
51
-
52
37
### Get Pod Metrics for Node
53
38
54
39
-**Endpoint:**`GET /nodes/{name}/pods/metrics`
@@ -73,28 +58,13 @@ http://localhost:8080/api/v1
73
58
-**Response:**`SocListResponse`
74
59
-**Status Codes:** 200, 500
75
60
76
-
### Create SoC
77
-
78
-
-**Endpoint:**`POST /socs`
79
-
-**Description:** Create a new SoC.
80
-
-**Request Body:**`CreateSocRequest`
81
-
-**Response:**`SocInfo`
82
-
-**Status Codes:** 200, 400, 500
83
-
84
61
### Get SoC Details
85
62
86
63
-**Endpoint:**`GET /socs/{name}`
87
64
-**Description:** Get specific SoC details including logs.
88
65
-**Response:**`SocInfo` (with logs)
89
66
-**Status Codes:** 200, 404, 500
90
67
91
-
### Delete SoC
92
-
93
-
-**Endpoint:**`DELETE /socs/{name}`
94
-
-**Description:** Delete a specific SoC.
95
-
-**Response:** None
96
-
-**Status Codes:** 204, 500
97
-
98
68
---
99
69
100
70
## Board Management
@@ -110,28 +80,13 @@ http://localhost:8080/api/v1
110
80
-**Response:**`BoardListResponse`
111
81
-**Status Codes:** 200, 500
112
82
113
-
### Create Board
114
-
115
-
-**Endpoint:**`POST /boards`
116
-
-**Description:** Create a new board.
117
-
-**Request Body:**`CreateBoardRequest`
118
-
-**Response:**`BoardInfo`
119
-
-**Status Codes:** 200, 400, 500
120
-
121
83
### Get Board Details
122
84
123
85
-**Endpoint:**`GET /boards/{name}`
124
86
-**Description:** Get specific board details including logs.
125
87
-**Response:**`BoardInfo` (with logs)
126
88
-**Status Codes:** 200, 404, 500
127
89
128
-
### Delete Board
129
-
130
-
-**Endpoint:**`DELETE /boards/{name}`
131
-
-**Description:** Delete a specific board.
132
-
-**Response:** None
133
-
-**Status Codes:** 204, 500
134
-
135
90
---
136
91
137
92
## Monitoring Integration
@@ -145,53 +100,6 @@ http://localhost:8080/api/v1
145
100
146
101
---
147
102
148
-
## Request Body Schemas
149
-
150
-
### CreateNodeRequest
151
-
152
-
```json
153
-
{
154
-
"name": "string",
155
-
"ip": "string",
156
-
"image": "string",
157
-
"labels": {
158
-
"environment": "string",
159
-
"region": "string",
160
-
"type": "string"
161
-
}
162
-
}
163
-
```
164
-
165
-
### CreateSocRequest
166
-
167
-
```json
168
-
{
169
-
"name": "string",
170
-
"description": "string",
171
-
"labels": {
172
-
"architecture": "string",
173
-
"vendor": "string",
174
-
"generation": "string"
175
-
}
176
-
}
177
-
```
178
-
179
-
### CreateBoardRequest
180
-
181
-
```json
182
-
{
183
-
"name": "string",
184
-
"description": "string",
185
-
"labels": {
186
-
"function": "string",
187
-
"criticality": "string",
188
-
"location": "string"
189
-
}
190
-
}
191
-
```
192
-
193
-
---
194
-
195
103
## Response Schemas
196
104
197
105
- See the original documentation for `NodeInfo`, `SocInfo`, `BoardInfo`, `NodeListResponse`, `SocListResponse`, `BoardListResponse`, `SuccessResponse`, and `ErrorResponse` JSON structures.
0 commit comments