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": ["http"],
  10   "basePath": "/",
  11   "consumes": ["application/json"],
  12   "produces": ["application/json"],
  13   "securityDefinitions": {
  14     "Basic": {
  15       "type": "basic"
  16     }
  17   },
  18   "security": [{
  19     "Basic": []
  20   }],
  21   "paths": {
  22     "/URI-is-provided-by-the-client-when-creating-the-subscription-VnfPackageChangeNotification": {
  23       "get": {
  24         "operationId": "URI-is-provided-by-the-client-when-creating-the-subscription-VnfPackageChangeNotification_list",
  25         "description": "",
  26         "parameters": [],
  27         "responses": {
  28           "204": {
  29             "description": ""
  30           },
  31           "500": {
  32             "description": "error message",
  33             "schema": {
  34               "type": "string"
  35             }
  36           }
  37         },
  38         "tags": ["VNF Package Management interface"]
  39       },
  40       "post": {
  41         "operationId": "URI-is-provided-by-the-client-when-creating-the-subscription-VnfPackageChangeNotification_create",
  42         "description": "",
  43         "parameters": [{
  44           "name": "data",
  45           "in": "body",
  46           "required": true,
  47           "schema": {
  48             "$ref": "#/definitions/PkgChangeNotification"
  49           }
  50         }],
  51         "responses": {
  52           "204": {
  53             "description": ""
  54           }
  55         },
  56         "tags": ["VNF Package Management interface"]
  57       },
  58       "parameters": []
  59     },
  60     "/URI-is-provided-by-the-client-when-creating-the-subscription-VnfPackageOnboardingNotification": {
  61       "get": {
  62         "operationId": "URI-is-provided-by-the-client-when-creating-the-subscription-VnfPackageOnboardingNotification_list",
  63         "description": "",
  64         "parameters": [],
  65         "responses": {
  66           "204": {
  67             "description": ""
  68           },
  69           "500": {
  70             "description": "error message",
  71             "schema": {
  72               "type": "string"
  73             }
  74           }
  75         },
  76         "tags": ["VNF Package Management interface"]
  77       },
  78       "post": {
  79         "operationId": "URI-is-provided-by-the-client-when-creating-the-subscription-VnfPackageOnboardingNotification_create",
  80         "description": "",
  81         "parameters": [{
  82           "name": "data",
  83           "in": "body",
  84           "required": true,
  85           "schema": {
  86             "$ref": "#/definitions/PkgOnboardingNotification"
  87           }
  88         }],
  89         "responses": {
  90           "204": {
  91             "description": ""
  92           }
  93         },
  94         "tags": ["VNF Package Management interface"]
  95       },
  96       "parameters": []
  97     }
  98   },
  99   "definitions": {
 100     "NOTIFICATION_LINKSERIALIZER": {
 101       "title": "Vnfpackage",
 102       "description": "Link to the resource representing the VNF package to which the notified change applies.",
 103       "required": ["href"],
 104       "type": "object",
 105       "properties": {
 106         "href": {
 107           "title": "Href",
 108           "description": "URI of the referenced resource.",
 109           "type": "string",
 110           "minLength": 1
 111         }
 112       }
 113     },
 114     "PkgmLinks": {
 115       "title": " links",
 116       "description": "Links to resources related to this resource.",
 117       "type": "object",
 118       "properties": {
 119         "vnfPackage": {
 120           "$ref": "#/definitions/NOTIFICATION_LINKSERIALIZER"
 121         },
 122         "subscription": {
 123           "$ref": "#/definitions/NOTIFICATION_LINKSERIALIZER"
 124         }
 125       }
 126     },
 127     "PkgChangeNotification": {
 128       "required": ["id", "notificationType", "timeStamp", "subscriptionId", "vnfPkgId", "changeType", "vnfdId", "_links"],
 129       "type": "object",
 130       "properties": {
 131         "id": {
 132           "title": "Id",
 133           "description": "Identifier of this notification.",
 134           "type": "string",
 135           "minLength": 1
 136         },
 137         "notificationType": {
 138           "title": "Notificationtype",
 139           "description": "Discriminator for the different notification types.",
 140           "type": "string",
 141           "enum": ["VnfPackageChangeNotification"]
 142         },
 143         "timeStamp": {
 144           "title": "Timestamp",
 145           "description": "Date-time of the generation of the notification.",
 146           "type": "string",
 147           "format": "date-time"
 148         },
 149         "subscriptionId": {
 150           "title": "Subscriptionid",
 151           "description": "Identifier of the subscription that this notification relates to.",
 152           "type": "string",
 153           "minLength": 1
 154         },
 155         "vnfPkgId": {
 156           "title": "Vnfpkgid",
 157           "description": "Identifier of the VNF package.",
 158           "type": "string",
 159           "format": "uuid"
 160         },
 161         "changeType": {
 162           "title": "Changetype",
 163           "description": "The type of change of the VNF package.",
 164           "type": "string",
 165           "enum": ["OP_STATE_CHANGE", "PKG_DELETE"]
 166         },
 167         "operationalState": {
 168           "title": "Operationalstate",
 169           "description": "New operational state of the VNF package.",
 170           "type": "string",
 171           "enum": ["ENABLED", "DISABLED"]
 172         },
 173         "vnfdId": {
 174           "title": "Vnfdid",
 175           "description": "This identifier, which is managed by the VNF provider, identifies the VNF package and the VNFD in a globally unique way.",
 176           "type": "string",
 177           "minLength": 1
 178         },
 179         "_links": {
 180           "$ref": "#/definitions/PkgmLinks"
 181         }
 182       }
 183     },
 184     "PkgOnboardingNotification": {
 185       "required": ["id", "notificationType", "subscriptionId", "timeStamp", "vnfPkgId", "vnfdId", "_links"],
 186       "type": "object",
 187       "properties": {
 188         "id": {
 189           "title": "Id",
 190           "description": "Identifier of this notification.",
 191           "type": "string",
 192           "minLength": 1
 193         },
 194         "notificationType": {
 195           "title": "Notificationtype",
 196           "description": "Discriminator for the different notification types.",
 197           "type": "string",
 198           "enum": ["VnfPackageOnboardingNotification"]
 199         },
 200         "subscriptionId": {
 201           "title": "Subscriptionid",
 202           "description": "Identifier of the subscription that this notification relates to.",
 203           "type": "string",
 204           "minLength": 1
 205         },
 206         "timeStamp": {
 207           "title": "Timestamp",
 208           "description": "Date-time of the generation of the notification.",
 209           "type": "string",
 210           "format": "date-time"
 211         },
 212         "vnfPkgId": {
 213           "title": "Vnfpkgid",
 214           "description": "Identifier of the VNF package.",
 215           "type": "string",
 216           "format": "uuid"
 217         },
 218         "vnfdId": {
 219           "title": "Vnfdid",
 220           "description": "This identifier, which is managed by the VNF provider, identifies the VNF package and the VNFD in a globally unique way.",
 221           "type": "string",
 222           "format": "uuid"
 223         },
 224         "_links": {
 225           "$ref": "#/definitions/PkgmLinks"
 226         }
 227       }
 228     }
 229   }
 230 }