summaryrefslogtreecommitdiffstats
path: root/documentation/api
diff options
context:
space:
mode:
authorJannik Schönartz2020-04-15 20:02:26 +0200
committerJannik Schönartz2020-04-15 20:02:26 +0200
commitdc68a5f080f939b57834360504174385dd8be0b9 (patch)
treea870edba1bc048b3cb1714f88d12b483aac2bb1b /documentation/api
parent[permissionmanager] split permissions in one file per module (diff)
downloadbas-dc68a5f080f939b57834360504174385dd8be0b9.tar.gz
bas-dc68a5f080f939b57834360504174385dd8be0b9.tar.xz
bas-dc68a5f080f939b57834360504174385dd8be0b9.zip
[documentation] Add documentation for external backends.
Diffstat (limited to 'documentation/api')
-rw-r--r--documentation/api/collections.md65
1 files changed, 50 insertions, 15 deletions
diff --git a/documentation/api/collections.md b/documentation/api/collections.md
index b79dbed..e36fc0e 100644
--- a/documentation/api/collections.md
+++ b/documentation/api/collections.md
@@ -174,36 +174,71 @@ https://<domain_bas>/api/registration
body {
"client": {
"name": "<name>",
- "parents": [],
+ "parents": [<parentIds>],
"type": "<type>",
"uuid": "<uuid>",
- "purpose": "",
- "network": {
- "mac": "<mac>",
- "ip": "<ip>"
- },
+ "purpose": "<purpose>",
+ "contacts": [
+ {
+ "last_name": <lastName>,
+ "first_name": <firstName>
+ }
+ ],
"location": {
- "option": "<option>",
+ "bay": <bay>
"insertion": "<insertion>",
- "pos": 0
+ "option": "<option>",
+ "slot": <slot>
+ },
+ "networks": [
+ {
+ "ip": "<ip>",
+ "mac": "<mac>",
+ "primary": <primary>,
+ "hostname": "<hostname>",
+ "device": {
+ "speed": "<speeed>",
+ "name": "<networkDeviceName>",
+ "type": "<networkDeviceType>",
+ "vendor": "<networkDeviceVendor>"
+ }
+ }
+ ],
+ "runtime": {
+ "operating_system": {
+ "name": "<OSName>",
+ "version": "<OSVersion>"
+ },
+ "role": "<runtimeRole>"
},
"formfactor": {
"formfactor": "<formfactor>",
- "rackunits": 1
+ "rackunits": <rackunits>
}
},
"ipxe": false
}
```
-> **\<name\>** - Name of the client. Default: Client_uuid or Server_uuid\
-> **parentIds** - Ids of the groups the client gets added to\
-> **\<type\>** - CLIENT or SERVER\
-> **\<uuid\>** - UUID of the client\
+> **\<name\>** (STRING) - Name of the client. Default: Client_uuid or Server_uuid\
+> **\<parentIds\>** (List of INTs) - Ids of the groups the client gets added to\
+> **\<type\>** (STRING) - CLIENT or SERVER\
+> **\<uuid\>** (STRING) - UUID of the client\
+> **\<purpose\>** (STRING) - The purpose of the client
+
+> **contacts** - A list of the assigned administrators\
+> **\<lastName\>** (STRING) - First name of the contact\
+> **\<firstName\>** (STRING) - Last name of the contact
+
+> **location** (Server only) - Specific location information like rackslot and bay for servers\
+> **\<bay\>** (INT) - null, undefined or
+> **\<insertion\>** (STRING) - Front, Back, or Front and backside\
+> **\<option\>** - Horizontal or Vertical\
+> **\<slot\>** -
+
+> **\<networkd\>** -
> **\<mac\>** - Mac address of the client\
> **\<ip\>** - IP address of the client\
-> **\<option\>** (Server only) - Horizontal or Vertical\
-> **\<insertion\>** (Server only) - Front, Back, or Front and backside\
> **\<formfactor\>** (Server only) - 19\"\
> **\<rackunits\>** (Server only) - Amount of slots the server needs (int)\
> **\<ipxe\>** - Determines weather the return value is an ipxe script or not (true / false)