docs/pap/swagger/consolidated-healthcheck-pap.json

   1 {
   2   "swagger": "2.0",
   3   "basePath": "/",
   4   "tags": [
   5     {
   6       "name": "Consolidated Healthcheck"
   7     }
   8   ],
   9   "schemes": [
  10     "http",
  11     "https"
  12   ],
  13   "consumes": [
  14     "application/json",
  15     "application/yaml"
  16   ],
  17   "produces": [
  18     "application/json",
  19     "application/yaml"
  20   ],
  21   "paths": {
  22     "/policy/pap/v1/components/healthcheck": {
  23       "get": {
  24         "tags": [
  25           "Consolidated Healthcheck"
  26         ],
  27         "summary": "Returns health status of all policy components, including PAP, API, Distribution, and PDPs",
  28         "description": "Queries health status of all policy components, returning all policy components health status",
  29         "operationId": "policyComponentsHealthCheck",
  30         "produces": [
  31           "application/json",
  32           "application/yaml"
  33         ],
  34         "parameters": [
  35           {
  36             "name": "X-ONAP-RequestID",
  37             "in": "header",
  38             "description": "RequestID for http transaction",
  39             "required": false,
  40             "type": "string",
  41             "format": "uuid"
  42           }
  43         ],
  44         "responses": {
  45           "200": {
  46             "description": "successful operation",
  47             "headers": {
  48               "X-MinorVersion": {
  49                 "type": "string",
  50                 "description": "Used to request or communicate a MINOR version back from the client to the server, and from the server back to the client"
  51               },
  52               "X-PatchVersion": {
  53                 "type": "string",
  54                 "description": "Used only to communicate a PATCH version in a response for troubleshooting purposes only, and will not be provided by the client on request"
  55               },
  56               "X-LatestVersion": {
  57                 "type": "string",
  58                 "description": "Used only to communicate an API's latest version"
  59               },
  60               "X-ONAP-RequestID": {
  61                 "type": "string",
  62                 "format": "uuid",
  63                 "description": "Used to track REST transactions for logging purpose"
  64               }
  65             },
  66             "schema": {
  67               "type": "object",
  68               "additionalProperties": {
  69                 "type": "object"
  70               }
  71             }
  72           },
  73           "401": {
  74             "description": "Authentication Error"
  75           },
  76           "403": {
  77             "description": "Authorization Error"
  78           },
  79           "500": {
  80             "description": "Internal Server Error"
  81           }
  82         },
  83         "security": [
  84           {
  85             "basicAuth": []
  86           }
  87         ],
  88         "x-interface info": {
  89           "api-version": "1.0.0",
  90           "last-mod-release": "Frankfurt"
  91         }
  92       }
  93     }
  94   },
  95   "securityDefinitions": {
  96     "basicAuth": {
  97       "description": "",
  98       "type": "basic"
  99     }
 100   }
 101 }