docs/offeredapis/api_hub/swagger.yaml

   1 swagger: "2.0"
   2 info:
   3   description: "Provides the ability to subscribe to and unsubscribe from External\
   4     \ API notifications.\n\n**Main operation**\n\n```\nPOST /hub\n```\n\nrequest sample\
   5     \ 1\n\n```\n{\n  \"callback\": \"http://mydomain/notification\",\n  \"query\"\
   6     : \"eventType = ServiceOrderCreationNotification\"\n}\n```\n\nrequest sample 2\n\
   7     \n```\n{\n  \"callback\": \"http://mydomain/notification\",\n  \"query\": \"eventType=ServiceOrderCreationNotification,ServiceOrderStateChangeNotification\"\
   8     \n}\n```\n\n**EventType for serviceOrdering**\n\n- ServiceOrderCreationNotification\n\
   9     - ServiceOrderStateChangeNotification\n- ServiceOrderItemStateChangeNotification\n\
  10     \n**EventType for serviceInventory**\n\n- ServiceCreationNotification\n- ServiceAttributeValueChangeNotification\n\
  11     - ServiceRemoveNotification\n\n"
  12   version: "4.0.1"
  13   title: "API Hub"
  14   x-logo:
  15     url: "/redoc/logo.png"
  16     backgroundColor: "#FFFFFF"
  17 host: "api.orange.com"
  18 basePath: "/"
  19 schemes:
  20 - "http"
  21 produces:
  22 - "application/json;charset=utf-8"
  23 tags:
  24 - name: "Hub"
  25   description: "provided by NBI"
  26 paths:
  27   /hub:
  28     post:
  29       tags:
  30       - "Hub"
  31       consumes:
  32       - "application/json;charset=utf-8"
  33       produces:
  34       - "application/json;charset=utf-8"
  35       operationId: "hubCreate"
  36       summary: "create hub"
  37       description: ""
  38       deprecated: false
  39       parameters:
  40       - name: "Hub"
  41         required: true
  42         in: "body"
  43         description: ""
  44         schema:
  45           $ref: "#/definitions/HubIn"
  46       responses:
  47         201:
  48           description: "Created"
  49           schema:
  50             $ref: "#/definitions/Hub"
  51     get:
  52       tags:
  53       - "Hub"
  54       produces:
  55       - "application/json;charset=utf-8"
  56       operationId: "hubFind"
  57       summary: "find hub"
  58       description: ""
  59       deprecated: false
  60       responses:
  61         200:
  62           description: "Ok"
  63           schema:
  64             type: "array"
  65             items:
  66               $ref: "#/definitions/Hub"
  67   /hub/{hubId}:
  68     get:
  69       tags:
  70       - "Hub"
  71       produces:
  72       - "application/json;charset=utf-8"
  73       operationId: "hubGet"
  74       summary: "get hub"
  75       description: ""
  76       deprecated: false
  77       parameters:
  78       - name: "hubId"
  79         required: true
  80         in: "path"
  81         type: "string"
  82       responses:
  83         200:
  84           description: "Ok"
  85           schema:
  86             $ref: "#/definitions/Hub"
  87     delete:
  88       tags:
  89       - "Hub"
  90       operationId: "hubDelete"
  91       summary: "delete hub"
  92       description: ""
  93       deprecated: false
  94       parameters:
  95       - name: "hubId"
  96         required: true
  97         in: "path"
  98         type: "string"
  99       responses:
 100         204:
 101           description: "No Content"
 102 definitions:
 103   ErrorDetail:
 104     description: ""
 105     required:
 106     - "code"
 107     - "message"
 108     type: "object"
 109     properties:
 110       code:
 111         description: ""
 112         type: "integer"
 113         format: "int32"
 114       message:
 115         description: ""
 116         type: "string"
 117       description:
 118         description: ""
 119         type: "string"
 120       infoURL:
 121         description: ""
 122         type: "string"
 123   Error:
 124     description: ""
 125     required:
 126     - "code"
 127     - "message"
 128     type: "object"
 129     properties:
 130       code:
 131         description: ""
 132         type: "integer"
 133         format: "int32"
 134       message:
 135         description: ""
 136         type: "string"
 137       description:
 138         description: ""
 139         type: "string"
 140       infoURL:
 141         description: ""
 142         type: "string"
 143       details:
 144         type: "array"
 145         items:
 146           $ref: "#/definitions/ErrorDetail"
 147   HubIn:
 148     description: ""
 149     required:
 150     - "query"
 151     - "callback"
 152     type: "object"
 153     properties:
 154       query:
 155         description: "The query must have an eventType= information.\\nOptionally\
 156           \ a ? could be added to reduce hub.\\nquery”:”eventType = ServiceOrderStateChangeNotification”\
 157           &serviceOrder.state=COMPLETED"
 158         type: "string"
 159       callback:
 160         description: "URL where notification must be send"
 161         type: "string"
 162   Hub:
 163     description: ""
 164     required:
 165     - "id"
 166     - "query"
 167     - "callback"
 168     type: "object"
 169     properties:
 170       id:
 171         description: ""
 172         type: "string"
 173       query:
 174         description: "The query must have an eventType= information.\\nOptionally\
 175           \ a ? could be added to reduce hub.\\nquery”:”eventType = ServiceOrderStateChangeNotification”\
 176           &serviceOrder.state=COMPLETED"
 177         type: "string"
 178       callback:
 179         description: "URL where notification must be send"
 180         type: "string"