diff --git a/README.md b/README.md index dc2faf5ca4906236aefe16643c9361a7479baf18..96f09e2e5b5bb9d6bdb0df60506a499b6d2ccded 100644 --- a/README.md +++ b/README.md @@ -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`* This resource updates the inventory network data for @@ -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 sends it. - + The response will be an object containing the metadata, formatted according to the following schema: - + ```json { "$schema": "http://json-schema.org/draft-07/schema#", @@ -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 sends it. - + The response will be an object containing the metadata, formatted according to the following schema: - + ```json { "$schema": "http://json-schema.org/draft-07/schema#",