Skip to content
Snippets Groups Projects
Commit a4fb536a authored by Erik Reid's avatar Erik Reid
Browse files

added docs for /jobs/log

parent 04df3dcb
No related branches found
No related tags found
No related merge requests found
...@@ -331,6 +331,27 @@ Any non-empty responses are JSON formatted messages. ...@@ -331,6 +331,27 @@ Any non-empty responses are JSON formatted messages.
} }
``` ```
* /jobs/log
This resource returns the state of the previous (or current)
tasks associated with a call to `/jobs/update`. The response
contains error or warning messages, if any were generated.
```json
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"pending": {"type": "array", "items": {"type": "string"}},
"errors": {"type": "array", "items": {"type": "string"}},
"failed": {"type": "array", "items": {"type": "string"}},
"warnings": {"type": "array", "items": {"type": "string"}},
},
"required": ["pending", "errors", "failed", "warnings"],
"additionalProperties": False
}
```
* /jobs/reload-router-config/*`equipment-name`* * /jobs/reload-router-config/*`equipment-name`*
This resource updates the inventory network data for This resource updates the inventory network data for
...@@ -367,10 +388,10 @@ Any non-empty responses are JSON formatted messages. ...@@ -367,10 +388,10 @@ Any non-empty responses are JSON formatted messages.
The source-equipment is the equipment that causes the trap, not the NMS that The source-equipment is the equipment that causes the trap, not the NMS that
sends it. sends it.
The response will be an object containing the The response will be an object containing the
metadata, formatted according to the following schema: metadata, formatted according to the following schema:
```json ```json
{ {
"$schema": "http://json-schema.org/draft-07/schema#", "$schema": "http://json-schema.org/draft-07/schema#",
...@@ -679,10 +700,10 @@ Any non-empty responses are JSON formatted messages. ...@@ -679,10 +700,10 @@ Any non-empty responses are JSON formatted messages.
The source-equipment is the equipment that causes the trap, not the NMS that The source-equipment is the equipment that causes the trap, not the NMS that
sends it. sends it.
The response will be an object containing the The response will be an object containing the
metadata, formatted according to the following schema: metadata, formatted according to the following schema:
```json ```json
{ {
"$schema": "http://json-schema.org/draft-07/schema#", "$schema": "http://json-schema.org/draft-07/schema#",
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment