snow/minccino
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Update README.md for sea-orm

Browse source
This commit is contained in:
snow flurry 2022-09-24 20:01:33 -07:00
parent 32b584d7d9
commit 794c6a925b
1 changed files with 2 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
README.md
View file

@ -4,7 +4,7 @@ Server application that provides cloud-init metadata via the `nocloud-net` provi
## Requirements
Only sqlite3 dev libraries are required for Diesel.
Only sqlite3 dev libraries are required for sea-orm.
## Configuration
@ -20,33 +20,4 @@ This outputs the API key and the relevant config snippet you'll need to add to `
All API endpoints require an `X-API-Key` header with the key generated above, and for the API client to be connected via localhost. \todo Allow overriding the latter requirement, if needed
To create an instance (all requests sent to `http://[::1]`):
```
> POST /_yui/instances HTTP/1.1
> X-API-Key: Your_API_Key
> Content-type: application/json
> [...]
>
> {
> "name": "instance_hostname",
> "os_name": "netbsd|debian|invalid",
> "mac_address": "0a:42:01:23:45:67"
> }
>
< HTTP/1.1 201 Created
< Content-type: application/json
< [...]
<
< {
< "error": null,
< "instances": [
< {
< "id": 591750913,
< "name": "instance_hostname",
< "os_name": "netbsd|debian|invalid",
< "mac_address": "0a:42:01:23:45:67"
< }
< ]
< }
}
```
\todo HTTP API endpoints/usage