summaryrefslogtreecommitdiffstats
path: root/swagger_inventory.yaml
diff options
context:
space:
mode:
authorShadi Haidar <sh1986@att.com>2019-02-15 20:28:32 -0500
committerShadi Haidar <sh1986@att.com>2019-03-05 14:57:45 -0500
commit13a84cadc80b9d1219ac04aa19cbde5352418760 (patch)
tree60b1a8bf6c8a4dbfe01823cd3cb9ea003ec44a43 /swagger_inventory.yaml
parent045758aee25a2421e76ddd16df2d22edc6cc69f2 (diff)
Add health and service endpoints
Added two new APIs to chcek internal health and to check dependencies/external interfaces, which is postgres like existing /dcae-service-types does Issue-ID: DCAEGEN2-1134 Change-Id: If0d3bf8ed0cfa7cb8870e91ef32060ffa844f93a Signed-off-by: Shadi Haidar <sh1986@att.com>
Diffstat (limited to 'swagger_inventory.yaml')
-rw-r--r--swagger_inventory.yaml27
1 files changed, 26 insertions, 1 deletions
diff --git a/swagger_inventory.yaml b/swagger_inventory.yaml
index c06368d..f8de1dd 100644
--- a/swagger_inventory.yaml
+++ b/swagger_inventory.yaml
@@ -17,7 +17,7 @@
# ECOMP is a trademark and service mark of AT&T Intellectual Property.
swagger: '2.0'
info:
- version: "3.1.1"
+ version: "3.2.0"
title: DCAE Inventory API
description: |
DCAE Inventory is a web service that provides the following:
@@ -356,6 +356,31 @@ paths:
description: "Unknown DCAE service"
schema:
$ref: "#/definitions/ApiResponseMessage"
+ /servicehealth:
+ get:
+ summary: "Check for external dependencies for inventory."
+ description: "Get a list of `DCAEServiceType` objects."
+ operationId: "dcaeServiceTypesGet"
+ consumes:
+ - "application/json"
+ - "application/vnd.dcae.inventory.v1+json"
+ produces:
+ - "application/json"
+ - "application/vnd.dcae.inventory.v1+json"
+ responses:
+ 200:
+ description: "List of `DCAEServiceType` objects"
+ schema:
+ $ref: "#/definitions/InlineResponse200"
+ /healthcheck:
+ get:
+ summary: ""
+ description: "Basic test to check inventory internals, that process and web api are running."
+ produces:
+ - "text/plain"
+ responses:
+ 200:
+ description: "OK response to indicate success"
definitions:
DCAEServiceTypeRequest:
type: "object"