gerrit.onap Code Review - so.git/blob

   1 {
   2   "swagger": "2.0",
   3   "info": {
   4     "title": "Modeling etsicatalog API",
   5     "description": "\n\nThe `swagger-ui` view can be found [here](/api/catalog/v1/swagger).\nThe `ReDoc` view can be found [here](/api/catalog/v1/redoc).\nThe swagger YAML document can be found [here](/api/catalog/v1/swagger.yaml).\nThe swagger JSON document can be found [here](/api/catalog/v1/swagger.json).",
   6     "version": "v1"
   7   },
   8   "host": "127.0.0.1:8000",
   9   "schemes": [
  10     "http"
  11   ],
  12   "basePath": "/",
  13   "consumes": [
  14     "application/json"
  15   ],
  16   "produces": [
  17     "application/json"
  18   ],
  19   "securityDefinitions": {
  20     "Basic": {
  21       "type": "basic"
  22     }
  23   },
  24   "security": [
  25     {
  26       "Basic": []
  27     }
  28   ],
  29   "paths": {
  30     "/URI-is-provided-by-the-client-when-creating-the-subscription-VnfPackageChangeNotification": {
  31       "get": {
  32         "operationId": "URI-is-provided-by-the-client-when-creating-the-subscription-VnfPackageChangeNotification_list",
  33         "description": "",
  34         "parameters": [],
  35         "responses": {
  36           "204": {
  37             "description": ""
  38           },
  39           "500": {
  40             "description": "error message",
  41             "schema": {
  42               "type": "string"
  43             }
  44           }
  45         },
  46         "tags": [
  47           "VNF Package Management interface"
  48         ]
  49       },
  50       "post": {
  51         "operationId": "URI-is-provided-by-the-client-when-creating-the-subscription-VnfPackageChangeNotification_create",
  52         "description": "",
  53         "parameters": [
  54           {
  55             "name": "data",
  56             "in": "body",
  57             "required": true,
  58             "schema": {
  59               "$ref": "#/definitions/PkgChangeNotification"
  60             }
  61           }
  62         ],
  63         "responses": {
  64           "204": {
  65             "description": ""
  66           }
  67         },
  68         "tags": [
  69           "VNF Package Management interface"
  70         ]
  71       },
  72       "parameters": []
  73     },
  74     "/URI-is-provided-by-the-client-when-creating-the-subscription-VnfPackageOnboardingNotification": {
  75       "get": {
  76         "operationId": "URI-is-provided-by-the-client-when-creating-the-subscription-VnfPackageOnboardingNotification_list",
  77         "description": "",
  78         "parameters": [],
  79         "responses": {
  80           "204": {
  81             "description": ""
  82           },
  83           "500": {
  84             "description": "error message",
  85             "schema": {
  86               "type": "string"
  87             }
  88           }
  89         },
  90         "tags": [
  91           "VNF Package Management interface"
  92         ]
  93       },
  94       "post": {
  95         "operationId": "URI-is-provided-by-the-client-when-creating-the-subscription-VnfPackageOnboardingNotification_create",
  96         "description": "",
  97         "parameters": [
  98           {
  99             "name": "data",
 100             "in": "body",
 101             "required": true,
 102             "schema": {
 103               "$ref": "#/definitions/PkgOnboardingNotification"
 104             }
 105           }
 106         ],
 107         "responses": {
 108           "204": {
 109             "description": ""
 110           }
 111         },
 112         "tags": [
 113           "VNF Package Management interface"
 114         ]
 115       },
 116       "parameters": []
 117     }
 118   },
 119   "definitions": {
 120     "NOTIFICATION_LINKSERIALIZER": {
 121       "title": "Vnfpackage",
 122       "description": "Link to the resource representing the VNF package to which the notified change applies.",
 123       "required": [
 124         "href"
 125       ],
 126       "type": "object",
 127       "properties": {
 128         "href": {
 129           "title": "Href",
 130           "description": "URI of the referenced resource.",
 131           "type": "string",
 132           "minLength": 1
 133         }
 134       }
 135     },
 136     "PkgmLinks": {
 137       "title": " links",
 138       "description": "Links to resources related to this resource.",
 139       "type": "object",
 140       "properties": {
 141         "vnfPackage": {
 142           "$ref": "#/definitions/NOTIFICATION_LINKSERIALIZER"
 143         },
 144         "subscription": {
 145           "$ref": "#/definitions/NOTIFICATION_LINKSERIALIZER"
 146         }
 147       }
 148     },
 149     "PkgChangeNotification": {
 150       "required": [
 151         "id",
 152         "notificationType",
 153         "timeStamp",
 154         "subscriptionId",
 155         "vnfPkgId",
 156         "changeType",
 157         "vnfdId",
 158         "_links"
 159       ],
 160       "type": "object",
 161       "properties": {
 162         "id": {
 163           "title": "Id",
 164           "description": "Identifier of this notification.",
 165           "type": "string",
 166           "minLength": 1
 167         },
 168         "notificationType": {
 169           "title": "Notificationtype",
 170           "description": "Discriminator for the different notification types.",
 171           "type": "string",
 172           "enum": [
 173             "VnfPackageChangeNotification"
 174           ]
 175         },
 176         "timeStamp": {
 177           "title": "Timestamp",
 178           "description": "Date-time of the generation of the notification.",
 179           "type": "string",
 180           "format": "date-time"
 181         },
 182         "subscriptionId": {
 183           "title": "Subscriptionid",
 184           "description": "Identifier of the subscription that this notification relates to.",
 185           "type": "string",
 186           "minLength": 1
 187         },
 188         "vnfPkgId": {
 189           "title": "Vnfpkgid",
 190           "description": "Identifier of the VNF package.",
 191           "type": "string",
 192           "minLength": 1
 193         },
 194         "changeType": {
 195           "title": "Changetype",
 196           "description": "The type of change of the VNF package.",
 197           "type": "string",
 198           "enum": [
 199             "OP_STATE_CHANGE",
 200             "PKG_DELETE"
 201           ]
 202         },
 203         "operationalState": {
 204           "title": "Operationalstate",
 205           "description": "New operational state of the VNF package.",
 206           "type": "string",
 207           "enum": [
 208             "ENABLED",
 209             "DISABLED"
 210           ]
 211         },
 212         "vnfdId": {
 213           "title": "Vnfdid",
 214           "description": "This identifier, which is managed by the VNF provider, identifies the VNF package and the VNFD in a globally unique way.",
 215           "type": "string",
 216           "minLength": 1
 217         },
 218         "_links": {
 219           "$ref": "#/definitions/PkgmLinks"
 220         }
 221       }
 222     },
 223     "PkgOnboardingNotification": {
 224       "required": [
 225         "id",
 226         "notificationType",
 227         "subscriptionId",
 228         "timeStamp",
 229         "vnfPkgId",
 230         "vnfdId",
 231         "_links"
 232       ],
 233       "type": "object",
 234       "properties": {
 235         "id": {
 236           "title": "Id",
 237           "description": "Identifier of this notification.",
 238           "type": "string",
 239           "minLength": 1
 240         },
 241         "notificationType": {
 242           "title": "Notificationtype",
 243           "description": "Discriminator for the different notification types.",
 244           "type": "string",
 245           "enum": [
 246             "VnfPackageOnboardingNotification"
 247           ]
 248         },
 249         "subscriptionId": {
 250           "title": "Subscriptionid",
 251           "description": "Identifier of the subscription that this notification relates to.",
 252           "type": "string",
 253           "minLength": 1
 254         },
 255         "timeStamp": {
 256           "title": "Timestamp",
 257           "description": "Date-time of the generation of the notification.",
 258           "type": "string",
 259           "format": "date-time"
 260         },
 261         "vnfPkgId": {
 262           "title": "Vnfpkgid",
 263           "description": "Identifier of the VNF package.",
 264           "type": "string",
 265           "minLength": 1
 266         },
 267         "vnfdId": {
 268           "title": "Vnfdid",
 269           "description": "This identifier, which is managed by the VNF provider, identifies the VNF package and the VNFD in a globally unique way.",
 270           "type": "string",
 271           "minLength": 1
 272         },
 273         "_links": {
 274           "$ref": "#/definitions/PkgmLinks"
 275         }
 276       }
 277     }
 278   }
 279 }