Skip to content

Commit 87575c7

Browse files
LukeGusLukeGus
committed
feat: add openapi json support
1 parent 01cd086 commit 87575c7

File tree

166 files changed

+25278
-3498
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

166 files changed

+25278
-3498
lines changed

‎docs/api/add-pinned-file.api.mdx‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
id: add-pinned-file
3+
title: "Add pinned file"
4+
description: "Adds a file to the list of pinned files for a host."
5+
sidebar_label: "Add pinned file"
6+
hide_title: true
7+
hide_table_of_contents: true
8+
api: eJydVO9v0zAQ/Ves+2zawDYQ+dYB04aEmNYhPlQVusbXxltiZ/ZlrIr6v6NzwhbWgibyIb/u+fn87t51YCgWwTZsvYMcZsZEhWptK1LsFZekKhtZ+bVqrHNkUiiqtQ8KVekjT0AD4yZCvoD5/ByWGgLdtRT51Jst5F36tIEM5Bxa0lB4x+RYQtg0lS1QNp/eRMmgg1iUVKO88bYhyMGvbqhg0NAE31BgS1GisvmFGeGsY9pQgJ2GBrkcRSIH6zYScFjTgUC6JPHYeBd7/jdZJo8/9TkTYXolJsJ3fAh04e6xskYZZBxQ7/9ChVUgNNsx5cnBfdFWZKQkjXWpBhOQjGvi0hvIofExSZQODtMYy6mgftTocENh2m8AGiKFewpSrg7aUEEOJXOTT6eVL7ASUfOjLMteg36Wwhe0Lh1phZEUOqOw5ZIcDwVUPTPs9D+Jj/aI5/Nzxa1zVKk+25ocv5Dt+CBbat/h5C8kOtknSutUZGQb2RYxnbn2zrKXrnkh8ds94o8Yy5XHYF7I8G6fwRe3FA6ptZQCF22wvE0VXhEGCrNWumKxHIfnYrO+08egR2tIKtIuCQb5AAI9vJz5UCNDDp+/X6dOFPtePRn/0wPWTUVjo2aP7TnY7rcdR/60bu1TEpZlMVxTqO2Dml1egAbp216AbJJNsj1ZBvApFrfkjCxSV7SmQK6gNBV85BrTkBk2nhkznmvPGbunWfW/k7EXk+mBp02F1kkeqdbdIMYCYixBw9itYuTer0ud5BNY14nxvoVqt5Pfdy0FqfFSwz0GiyvRa7HcaSgJDYVU/lvaQg4f+kO8upZkBF61ktTe8JX2eBwol1/n11LtYYjX3siagD9Bp3sOoMEnoVITpX8dVOg2LW4E23PK9Quedi15
9+
sidebar_class_name: "post api-method"
10+
info_path: api/termix-api
11+
custom_edit_url: null
12+
---
13+
14+
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
15+
import ParamsDetails from "@theme/ParamsDetails";
16+
import RequestSchema from "@theme/RequestSchema";
17+
import StatusCodes from "@theme/StatusCodes";
18+
import OperationTabs from "@theme/OperationTabs";
19+
import TabItem from "@theme/TabItem";
20+
import Heading from "@theme/Heading";
21+
22+
<Heading
23+
as={"h1"}
24+
className={"openapi__heading"}
25+
children={"Add pinned file"}
26+
>
27+
</Heading>
28+
29+
<MethodEndpoint
30+
method={"post"}
31+
path={"/ssh/file_manager/pinned"}
32+
context={"endpoint"}
33+
>
34+
35+
</MethodEndpoint>
36+
37+
38+
39+
Adds a file to the list of pinned files for a host.
40+
41+
<Heading
42+
id={"request"}
43+
as={"h2"}
44+
className={"openapi-tabs__heading"}
45+
children={"Request"}
46+
>
47+
</Heading>
48+
49+
<ParamsDetails
50+
parameters={undefined}
51+
>
52+
53+
</ParamsDetails>
54+
55+
<RequestSchema
56+
title={"Body"}
57+
body={{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"hostId":{"type":"integer"},"path":{"type":"string"},"name":{"type":"string"}}}}}}}
58+
>
59+
60+
</RequestSchema>
61+
62+
<StatusCodes
63+
id={undefined}
64+
label={undefined}
65+
responses={{"200":{"description":"File pinned."},"400":{"description":"Invalid data."},"409":{"description":"File already pinned."},"500":{"description":"Failed to pin file."}}}
66+
>
67+
68+
</StatusCodes>
69+
70+
71+

‎docs/api/add-recent-file.api.mdx‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
id: add-recent-file
3+
title: "Add recent file"
4+
description: "Adds a file to the list of recent files for a host."
5+
sidebar_label: "Add recent file"
6+
hide_title: true
7+
hide_table_of_contents: true
8+
api: eJydVMFu2zAM/RWBZy/21nYDfEu3Fe2AYUWTYYcgGBiLidXakivRbQMj/z5Q9lq3CYZgvsQxyaenRz52oCkU3jRsnIUcploHhWptKlLsFJekKhNYubXyVJDlGApq7bxCVbrAE0iAcRMgX8BsdgnLBDzdtxT43Okt5F38azxpyNm3lEDhLJNlCWHTVKZAOTy9DcKgg1CUVKO88bYhyMGtbqlgSKDxriHPhoJE5fArPcozlmlDHnYJNMjlKBLYG7uRgMWaDgTiI8RD42zo8T9kmfy81ufmRQSFWpOeCOrpodQr+4CV0UojY8w6O5R1gaYiLVqj1mONJyCMauLSacihcSFKEC8GaQhlKlm/a7S4IZ/2lZBAIP9AXtrRQesryKFkbvI0rVyBlYiWn2RZ9h6SN0y+o7GR7AoDKbRaYcslWR4apHpk2CX/BD7ZA57NLhW31lKlera13PE4tNODaFH+4eZHAp3tA8U6FRjZBDZFiHeunTXsZCqOBP64B/wFQ7ly6PWRCJ/2EVxxR/6QWktpcNF6w9vY4RWhJz9tZSoWy3F4JjbqJ3mc9Dz6QkXGJaZBPiRBMrxcOF8jQw7ffs3jJIo9b16M/fUJ66aisRGz5/EcbPXXbiP/Gbt2kYRhKYY5+do8qen1FSQgc9sLkE2ySbYny5B8jsUdWS1F6obW5MkWFF3vAtcYl8hw8PS1p94idi+76H83Xy8m0xOnTYXGCo/Y624QYwEhlJDA2K0gqyb6dZlE+SSt68R4P32128nn+5a89HiZwAN6gyvRa7HcJVASavKx/Xe0hRw+95d4Nxcykl61Qmpvucp4PC+U6x+zuXR7WNK101Lj8VHI4SPkAAm4KFQcovitgwrtpsWN5PaY8vwBSowjLQ==
9+
sidebar_class_name: "post api-method"
10+
info_path: api/termix-api
11+
custom_edit_url: null
12+
---
13+
14+
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
15+
import ParamsDetails from "@theme/ParamsDetails";
16+
import RequestSchema from "@theme/RequestSchema";
17+
import StatusCodes from "@theme/StatusCodes";
18+
import OperationTabs from "@theme/OperationTabs";
19+
import TabItem from "@theme/TabItem";
20+
import Heading from "@theme/Heading";
21+
22+
<Heading
23+
as={"h1"}
24+
className={"openapi__heading"}
25+
children={"Add recent file"}
26+
>
27+
</Heading>
28+
29+
<MethodEndpoint
30+
method={"post"}
31+
path={"/ssh/file_manager/recent"}
32+
context={"endpoint"}
33+
>
34+
35+
</MethodEndpoint>
36+
37+
38+
39+
Adds a file to the list of recent files for a host.
40+
41+
<Heading
42+
id={"request"}
43+
as={"h2"}
44+
className={"openapi-tabs__heading"}
45+
children={"Request"}
46+
>
47+
</Heading>
48+
49+
<ParamsDetails
50+
parameters={undefined}
51+
>
52+
53+
</ParamsDetails>
54+
55+
<RequestSchema
56+
title={"Body"}
57+
body={{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"hostId":{"type":"integer"},"path":{"type":"string"},"name":{"type":"string"}}}}}}}
58+
>
59+
60+
</RequestSchema>
61+
62+
<StatusCodes
63+
id={undefined}
64+
label={undefined}
65+
responses={{"200":{"description":"Recent file added."},"400":{"description":"Invalid data."},"500":{"description":"Failed to add recent file."}}}
66+
>
67+
68+
</StatusCodes>
69+
70+
71+

‎docs/api/add-shortcut.api.mdx‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
id: add-shortcut
3+
title: "Add shortcut"
4+
description: "Adds a shortcut for a specific host."
5+
sidebar_label: "Add shortcut"
6+
hide_title: true
7+
hide_table_of_contents: true
8+
api: eJyNVE1v2zAM/SsGz1rire2G+ZZuK9oBw4omww5BMDAWE6u1JVeiuwRG/vtA2U29Jijig79IPlKPfGxBU8i9qdk4CxlMtA4JJqFwnvOGk5Xz8llTblYmTwoXeAQKGNcBsjlMp9ewUODpsaHAl05vIWvjp/GkIWPfkILcWSbLYsK6Lk2Okm18HyRlCyEvqEJ5421NkIFb3lPOoKD2ribPhoJYJfmNHvgZy7QmDzsFNXIxsAT2xq7FYLGiI4Z4SeGhdjZ0+B/SVB7/EzJ9ZgK1Jj0SyPNjfjf2CUujE42Mvdfnt9BKT6i3CW1M4BADLo7BXqEpSSfsJP++LSOQ4iviwmnIoHYhshU5gHEIxXhlSvpTocU1+fFzWAAFgfwTeWleC40vIYOCuc7G49LlWArF2Vmapu9BvarkBxobT7fEQAlanWDDBVnu25l0yLBTbwKfHQBPp9cJN9ZSmXQFV2T5RLTzo2hy+B7Lnwh0cQgU45LAyCawyUM8c+WsYSczdCLwxwPgrxiKpUOvT0T4dIjg8gfyx9haSIPzxhvexg4vCT35SSODMV8MzVMRXTf3Q6e9UKQUGZfoBlnvBKp/uXK+QoYMvv+exWEUMd+9rIFvG6zqkoayTfcT2ovwWZwDtRq7crEIwxIMM/KV2SST2xtQIHPbEZCO0lF6QEvvfIn5A1ktQckdrciTzSnuCBe4wrhy+sSTgaZew7Uva+vkrdhRx7ThcV2isZI1drbtjz6HEApQMJSnsLwX6EJFvsSzbUVpv3y528nvx4a8NHWh4Am9waUQNF/sFBSEmnzs9wNtIYMvXeHvZlKPuJeN1HWwe2Ue9kvk9ud0Ju3td3jltMR4/Asq3jMABS6SE6cm/muhRLtucC2+HaZc/wA9aSsd
9+
sidebar_class_name: "post api-method"
10+
info_path: api/termix-api
11+
custom_edit_url: null
12+
---
13+
14+
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
15+
import ParamsDetails from "@theme/ParamsDetails";
16+
import RequestSchema from "@theme/RequestSchema";
17+
import StatusCodes from "@theme/StatusCodes";
18+
import OperationTabs from "@theme/OperationTabs";
19+
import TabItem from "@theme/TabItem";
20+
import Heading from "@theme/Heading";
21+
22+
<Heading
23+
as={"h1"}
24+
className={"openapi__heading"}
25+
children={"Add shortcut"}
26+
>
27+
</Heading>
28+
29+
<MethodEndpoint
30+
method={"post"}
31+
path={"/ssh/file_manager/shortcuts"}
32+
context={"endpoint"}
33+
>
34+
35+
</MethodEndpoint>
36+
37+
38+
39+
Adds a shortcut for a specific host.
40+
41+
<Heading
42+
id={"request"}
43+
as={"h2"}
44+
className={"openapi-tabs__heading"}
45+
children={"Request"}
46+
>
47+
</Heading>
48+
49+
<ParamsDetails
50+
parameters={undefined}
51+
>
52+
53+
</ParamsDetails>
54+
55+
<RequestSchema
56+
title={"Body"}
57+
body={{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"hostId":{"type":"integer"},"path":{"type":"string"},"name":{"type":"string"}}}}}}}
58+
>
59+
60+
</RequestSchema>
61+
62+
<StatusCodes
63+
id={undefined}
64+
label={undefined}
65+
responses={{"200":{"description":"Shortcut added."},"400":{"description":"Invalid data."},"409":{"description":"Shortcut already exists."},"500":{"description":"Failed to add shortcut."}}}
66+
>
67+
68+
</StatusCodes>
69+
70+
71+

‎docs/api/apply-a-credential-to-a-host.api.mdx‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
id: apply-a-credential-to-a-host
3+
title: "Apply a credential to a host"
4+
description: "Applies a credential to an SSH host for quick application."
5+
sidebar_label: "Apply a credential to a host"
6+
hide_title: true
7+
hide_table_of_contents: true
8+
api: eJy9VMFu2zAM/RWBpw1QE29tN8C3bEOxDhhWNC12CHJgLCYRIkuuRBcNDP/7QNtr0yYrMgzYybb8+EQ+8rEBQ6mItmIbPOQwqSpnKSlURSRDni06xUGhV9PpV7UOidUyRHVX22KjUNAFSuwINDCuEuQz+PwYmmCuocKIJTFF+dmAlXsq5DVo8FgS5GANaIh0V9tIBnKONWlIxZpKhLwB3lYdyjOtKELb6oMsktzlXzLNBZ2q4BMlAbzPMnk8F+Wpnr5iMiJJp0Wqi4JSWtbObUfQajg7RHDp79FZoyQxSjwAz169yQdRuvamQ58for1A6/pcJK3ti5ZJfiMRC0ridTCiV0gMupcth/ETPo0ba9pxR3PC4URix00vaAsaEsX73/2roxOxmat8PHahQCe4/DTLsnegX6T4Ha1XBhkXmEihNwprXsul/dionhmkpa8Qn+4RyzRy7T05VaLHFZXk+Ui2s4NsS+to4IpHEp3vE3VxKjGyTWyL1NVcBm85ROtXRxJ/2CP+gmm9CBjNkQwf9xlCsaF4SK25NLioo+Vt1+EFYaQ4qWVKZvPd31NxUu+UXdCjsSQVGAwn3z0I9PByEWKJDDl8+3nTTab1y9CFW3aCv6FY2gc1uboEDTJxferZKBtlewUN4E9YbMgbCVLXtKRIviDxjEx7iV74hw0x6Wyyt9s6q7ykb6AInsnzP2/FXhqmBx5XDq2X3LrONYMTZ7DjRNCQd/vwmRnldNhvc91tOglrGrHVbXRtK8d3NUXp4FzDPUaLC9F01oCxSd4N5Et0iV4p9M31sDrfqj9lPhyi30qL0NXyBRo2tO03uQzmf7xxUKWd7y66qx9TGbBfI5ZXZQ==
9+
sidebar_class_name: "post api-method"
10+
info_path: api/termix-api
11+
custom_edit_url: null
12+
---
13+
14+
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
15+
import ParamsDetails from "@theme/ParamsDetails";
16+
import RequestSchema from "@theme/RequestSchema";
17+
import StatusCodes from "@theme/StatusCodes";
18+
import OperationTabs from "@theme/OperationTabs";
19+
import TabItem from "@theme/TabItem";
20+
import Heading from "@theme/Heading";
21+
22+
<Heading
23+
as={"h1"}
24+
className={"openapi__heading"}
25+
children={"Apply a credential to a host"}
26+
>
27+
</Heading>
28+
29+
<MethodEndpoint
30+
method={"post"}
31+
path={"/credentials/{id}/apply-to-host/{hostId}"}
32+
context={"endpoint"}
33+
>
34+
35+
</MethodEndpoint>
36+
37+
38+
39+
Applies a credential to an SSH host for quick application.
40+
41+
<Heading
42+
id={"request"}
43+
as={"h2"}
44+
className={"openapi-tabs__heading"}
45+
children={"Request"}
46+
>
47+
</Heading>
48+
49+
<ParamsDetails
50+
parameters={[{"in":"path","name":"id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"hostId","required":true,"schema":{"type":"integer"}}]}
51+
>
52+
53+
</ParamsDetails>
54+
55+
<RequestSchema
56+
title={"Body"}
57+
body={undefined}
58+
>
59+
60+
</RequestSchema>
61+
62+
<StatusCodes
63+
id={undefined}
64+
label={undefined}
65+
responses={{"200":{"description":"Credential applied to host successfully."},"400":{"description":"Invalid request."},"404":{"description":"Credential not found."},"500":{"description":"Failed to apply credential to host."}}}
66+
>
67+
68+
</StatusCodes>
69+
70+
71+

‎docs/api/assign-a-role-to-a-user.api.mdx‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
id: assign-a-role-to-a-user
3+
title: "Assign a role to a user"
4+
description: "Assigns a role to a user."
5+
sidebar_label: "Assign a role to a user"
6+
hide_title: true
7+
hide_table_of_contents: true
8+
api: eJyNVU1v1DAQ/SvWnEAyu4EWELm1fIgiIdBuEYdqD7Px7K6pYwd7Al1F+e9onLRbmrZqLknsN8/z+dyBoVRF27ANHko4SclufVKoYnCkOChUbaI4Aw2M2wTlBSxOT97DSkODEWtiirLagRX7BnkHGjzWBCWI5ZkBDZF+tzaSgZJjSxpStaMaoeyA940gE0frt9D3qwFMiU+D2Qvirm0VPJNn2cKmcbZC8X3+K0kA3ZQ6rH9RxaChiaGhyJZSpg2OzswtnPVMW4rQ50fcSE3waUC/Kgp5/Z+shaQIc8bIqNRWFaW0aZ3bz6DXcPygzdkHZZO6DmwEH03By31iqnMpkqrQ+8BqTapG36Jz+5uzR4bjKcOPRFGFOFRTzDeh9df4dw+F5CKhuUP/+r5oPqF1ZHKbZGw+ZwaSvpp4F4y0REg5+9IZJczjGqu5NEaad0N/9PMcIGhIFP9ct1MbHZSwY27K+dyFCt0uJC6PiqJ4CfqOH1/RemWQcY2JFHqjsOUdeR67Qw3M0OtHiY8mxMvlZ8Wt9+Qk67ilmjw/ke34XraNdTRyxScSvZ4SZTuVGNkmtlXKMdfBWw4ySE8kfjMh/oBptw4YzRMZ3k4ZQnVJ8b5sraTAVRst73OF14SR4kkrfXGxur29lBkeBu826GZUxRUYVUT+BxDo8eNTiDUylPDl53nuRdGGxUFVPl5h3Ti6rQJFr8H6TciHWJZNOKdY2yt18v0MNEhfDgEWs2JWTMIewadYXZI3YqQWtKFIviIZH5mCGrNCjeI4SO1Eae8ydwfBe1ydh9QwXfG8cWi9nJor142zdwEye6CzLMu4lQd9zgO40iCFFWTXyST9iK7vZfl3S1GKttLwB6PFtSToogNjk3wbKDfoEj3i+rPFqHbP1UPOjovo95JvdK38gYZL2h/ukn7Va9gRGorZg2Hz/XDOi3OhOBhP7gdpshth+v5teS49M94zdTBiE/GvJAT/DoeHHMtwY8haBw79tsWtYAdOef4BJoN6iw==
9+
sidebar_class_name: "post api-method"
10+
info_path: api/termix-api
11+
custom_edit_url: null
12+
---
13+
14+
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
15+
import ParamsDetails from "@theme/ParamsDetails";
16+
import RequestSchema from "@theme/RequestSchema";
17+
import StatusCodes from "@theme/StatusCodes";
18+
import OperationTabs from "@theme/OperationTabs";
19+
import TabItem from "@theme/TabItem";
20+
import Heading from "@theme/Heading";
21+
22+
<Heading
23+
as={"h1"}
24+
className={"openapi__heading"}
25+
children={"Assign a role to a user"}
26+
>
27+
</Heading>
28+
29+
<MethodEndpoint
30+
method={"post"}
31+
path={"/rbac/users/{userId}/roles"}
32+
context={"endpoint"}
33+
>
34+
35+
</MethodEndpoint>
36+
37+
38+
39+
Assigns a role to a user.
40+
41+
<Heading
42+
id={"request"}
43+
as={"h2"}
44+
className={"openapi-tabs__heading"}
45+
children={"Request"}
46+
>
47+
</Heading>
48+
49+
<ParamsDetails
50+
parameters={[{"in":"path","name":"userId","required":true,"schema":{"type":"string"}}]}
51+
>
52+
53+
</ParamsDetails>
54+
55+
<RequestSchema
56+
title={"Body"}
57+
body={{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"roleId":{"type":"integer"}}}}}}}
58+
>
59+
60+
</RequestSchema>
61+
62+
<StatusCodes
63+
id={undefined}
64+
label={undefined}
65+
responses={{"200":{"description":"Role assigned successfully."},"400":{"description":"Role ID is required."},"403":{"description":"System roles cannot be manually assigned."},"404":{"description":"User or role not found."},"409":{"description":"Role already assigned."},"500":{"description":"Failed to assign role."}}}
66+
>
67+
68+
</StatusCodes>
69+
70+
71+

0 commit comments

Comments
 (0)