-
Notifications
You must be signed in to change notification settings - Fork 8
📡 API
Ringo Hoffmann edited this page Jan 19, 2022
·
2 revisions
The ranna main REST API.
Get Spec Map
Returns the available spec map.
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| payload | body | The execution payload | Yes | models.ExecutionRequest |
| Code | Description | Schema |
|---|---|---|
| 200 | OK | models.ExecutionResponse |
| 400 | Bad Request | models.ErrorModel |
| 500 | Internal Server Error | models.ErrorModel |
Get System Info
Returns general system and version information.
| Code | Description | Schema |
|---|---|---|
| 200 | OK | models.ExecutionResponse |
| 500 | Internal Server Error | models.ErrorModel |
Get Spec Map
Returns the available spec map.
| Code | Description | Schema |
|---|---|---|
| 200 | OK | models.SpecMap |
| Name | Type | Description | Required |
|---|---|---|---|
| code | integer | No | |
| context | string | No | |
| error | string | No |
| Name | Type | Description | Required |
|---|---|---|---|
| arguments | [ string ] | No | |
| code | string | No | |
| environment | object | No | |
| inline_expression | boolean | No | |
| language | string | No |
| Name | Type | Description | Required |
|---|---|---|---|
| exectimems | integer | No | |
| stderr | string | No | |
| stdout | string | No |
| Name | Type | Description | Required |
|---|---|---|---|
| import_regex | string | No | |
| template | string | No |
| Name | Type | Description | Required |
|---|---|---|---|
| cmd | string | No | |
| entrypoint | string | No | |
| example | string | No | |
| filename | string | No | |
| image | string | No | |
| inline | models.InlineSpec | No | |
| registry | string | No | |
| use | string | No |
| Name | Type | Description | Required |
|---|---|---|---|
| models.SpecMap | object |