mirror of
https://github.com/opencloud-eu/opencloud.git
synced 2026-05-24 16:41:35 -04:00
docs: add docs on new APIs
This commit is contained in:
@@ -17,10 +17,13 @@ When run, **ociswrapper** starts an API server that exposes some endpoints to re
|
||||
```bash
|
||||
./bin/ociswrapper serve --bin=<path-to-ocis-binary>
|
||||
```
|
||||
|
||||
To check other available options:
|
||||
|
||||
```bash
|
||||
./bin/ociswrapper serve --help
|
||||
```
|
||||
|
||||
```bash
|
||||
--url string oCIS server url (default "https://localhost:9200")
|
||||
--retry string Number of retries to start oCIS server (default "5")
|
||||
@@ -51,9 +54,9 @@ Also, see `./bin/ociswrapper help` for more information.
|
||||
|
||||
Returns:
|
||||
|
||||
* `200 OK` - oCIS is successfully reconfigured
|
||||
* `400 Bad Request` - request body is not a valid JSON object
|
||||
* `500 Internal Server Error` - oCIS server is not running
|
||||
- `200 OK` - oCIS is successfully reconfigured
|
||||
- `400 Bad Request` - request body is not a valid JSON object
|
||||
- `500 Internal Server Error` - oCIS server is not running
|
||||
|
||||
2. `DELETE /rollback`
|
||||
|
||||
@@ -61,5 +64,63 @@ Also, see `./bin/ociswrapper help` for more information.
|
||||
|
||||
Returns:
|
||||
|
||||
* `200 OK` - rollback is successful
|
||||
* `500 Internal Server Error` - oCIS server is not running
|
||||
- `200 OK` - rollback is successful
|
||||
- `500 Internal Server Error` - oCIS server is not running
|
||||
|
||||
3. `POST /command`
|
||||
|
||||
Executes the provided command on the oCIS server. The body of the request should be a JSON object with the following structure:
|
||||
|
||||
```yml
|
||||
{
|
||||
"command": "<ocis-command>", # without the ocis binary. e.g. "list"
|
||||
}
|
||||
```
|
||||
|
||||
If the command requires user input, the body of the request should be a JSON object with the following structure:
|
||||
|
||||
```json
|
||||
{
|
||||
"command": "<ocis-command>",
|
||||
"inputs": ["value1"]
|
||||
}
|
||||
```
|
||||
|
||||
Returns:
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "OK",
|
||||
"exitCode": 0,
|
||||
"message": "<command output>"
|
||||
}
|
||||
OR
|
||||
{
|
||||
"status": "ERROR",
|
||||
"exitCode": <error-exit-code>,
|
||||
"message": "<command output>"
|
||||
}
|
||||
```
|
||||
|
||||
- `200 OK` - command is successfully executed
|
||||
- `400 Bad Request` - request body is not a valid JSON object
|
||||
- `500 Internal Server Error`
|
||||
|
||||
4. `POST /start`
|
||||
|
||||
Starts the oCIS server.
|
||||
|
||||
Returns:
|
||||
|
||||
- `200 OK` - oCIS server is started
|
||||
- `409 Conflict` - oCIS server is already running
|
||||
- `500 Internal Server Error` - Unable to start oCIS server
|
||||
|
||||
5. `POST /stop`
|
||||
|
||||
Stops the oCIS server.
|
||||
|
||||
Returns:
|
||||
|
||||
- `200 OK` - oCIS server is stopped
|
||||
- `500 Internal Server Error` - Unable to stop oCIS server
|
||||
|
||||
Reference in New Issue
Block a user