dmaap-mediator-producer/docs/swagger.json

   1 {
   2     "swagger": "2.0",
   3     "info": {
   4         "title": "DMaaP Mediator Producer",
   5         "contact": {},
   6         "license": {
   7             "name": "Apache 2.0",
   8             "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
   9         },
  10         "version": "1.1.0"
  11     },
  12     "paths": {
  13         "/admin/log": {
  14             "put": {
  15                 "description": "Set the log level of the producer.",
  16                 "tags": [
  17                     "Admin"
  18                 ],
  19                 "summary": "Set log level",
  20                 "parameters": [
  21                     {
  22                         "enum": [
  23                             "Error",
  24                             "Warn",
  25                             "Info",
  26                             "Debug"
  27                         ],
  28                         "type": "string",
  29                         "description": "string enums",
  30                         "name": "level",
  31                         "in": "query"
  32                     }
  33                 ],
  34                 "responses": {
  35                     "200": {
  36                         "description": ""
  37                     },
  38                     "400": {
  39                         "description": "Bad Request",
  40                         "schema": {
  41                             "type": "string"
  42                         }
  43                     }
  44                 }
  45             }
  46         },
  47         "/health_check": {
  48             "get": {
  49                 "description": "Get the status of the producer. Will show if the producer has registered in ICS.",
  50                 "tags": [
  51                     "Data producer (callbacks)"
  52                 ],
  53                 "summary": "Get status",
  54                 "responses": {
  55                     "200": {
  56                         "description": ""
  57                     }
  58                 }
  59             }
  60         },
  61         "/info_job": {
  62             "post": {
  63                 "description": "Callback for ICS to add an info job",
  64                 "consumes": [
  65                     "application/json"
  66                 ],
  67                 "tags": [
  68                     "Data producer (callbacks)"
  69                 ],
  70                 "summary": "Add info job",
  71                 "parameters": [
  72                     {
  73                         "description": "Info job data",
  74                         "name": "user",
  75                         "in": "body",
  76                         "required": true,
  77                         "schema": {
  78                             "$ref": "#/definitions/jobs.JobInfo"
  79                         }
  80                     }
  81                 ],
  82                 "responses": {
  83                     "200": {
  84                         "description": ""
  85                     },
  86                     "400": {
  87                         "description": "Bad Request",
  88                         "schema": {
  89                             "type": "string"
  90                         }
  91                     }
  92                 }
  93             }
  94         },
  95         "/info_job/{infoJobId}": {
  96             "delete": {
  97                 "description": "Callback for ICS to delete an info job",
  98                 "tags": [
  99                     "Data producer (callbacks)"
 100                 ],
 101                 "summary": "Delete info job",
 102                 "parameters": [
 103                     {
 104                         "type": "string",
 105                         "description": "Info job ID",
 106                         "name": "infoJobId",
 107                         "in": "path",
 108                         "required": true
 109                     }
 110                 ],
 111                 "responses": {
 112                     "200": {
 113                         "description": ""
 114                     }
 115                 }
 116             }
 117         },
 118         "/swagger": {
 119             "get": {
 120                 "description": "Get the Swagger API documentation for the producer.",
 121                 "tags": [
 122                     "Admin"
 123                 ],
 124                 "summary": "Get Swagger Documentation",
 125                 "responses": {
 126                     "200": {
 127                         "description": ""
 128                     }
 129                 }
 130             }
 131         }
 132     },
 133     "definitions": {
 134         "jobs.BufferTimeout": {
 135             "type": "object",
 136             "properties": {
 137                 "maxSize": {
 138                     "type": "integer"
 139                 },
 140                 "maxTimeMiliseconds": {
 141                     "type": "integer"
 142                 }
 143             }
 144         },
 145         "jobs.JobInfo": {
 146             "type": "object",
 147             "properties": {
 148                 "info_job_data": {
 149                     "$ref": "#/definitions/jobs.Parameters"
 150                 },
 151                 "info_job_identity": {
 152                     "type": "string"
 153                 },
 154                 "info_type_identity": {
 155                     "type": "string"
 156                 },
 157                 "last_updated": {
 158                     "type": "string"
 159                 },
 160                 "owner": {
 161                     "type": "string"
 162                 },
 163                 "target_uri": {
 164                     "type": "string"
 165                 }
 166             }
 167         },
 168         "jobs.Parameters": {
 169             "type": "object",
 170             "properties": {
 171                 "bufferTimeout": {
 172                     "$ref": "#/definitions/jobs.BufferTimeout"
 173                 }
 174             }
 175         }
 176     }
 177 }