@itentialopensource/adapter-tmf638_service_inventory_management 1.0.0 → 1.1.0

package/report/adapter-openapi.json

@@ -0,0 +1,3065 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "title": "Service Inventory Management",
+    "description": "## TMF API Reference : TMF 638 - Service Inventory Management\n\n Version 4.0 \n\nThe intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Service inventory.\n\nThe Service Inventory API can be used to query the service instances for a customer via Self Service Portal or the Call Centre operator can query the service instances on behalf of the customer while a customer may have a complaint or a query.\nNote: Only the CustomerFacingServices instances will be presented to the customer.\n\nThe Service Inventory API can be called by the Service Order Management to create a new service instance/ update an existing service instance in the Service Inventory.\n\n### Service resource\nService is an abstract base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. This gives rise to the two subclasses of  Service: CustomerFacingService and ResourceFacingService.\n\n### Service Inventory API performs the following operations on service  :\n- Retrieve  a service or a collection of services depending on filter criteria\n- Partial update of a service (including updating rules)\n- Create a service (including default values and creation rules and for administration users only)\n- Delete a service (for administration users only)\n- Notification of events on service\n\nCopyright (c)TM Forum 2019. All Rights Reserved.",
+    "contact": {},
+    "version": "4.0.0"
+  },
+  "servers": [
+    {
+      "url": "https://serverRoot/tmf-api/serviceInventory/v4",
+      "variables": {}
+    }
+  ],
+  "paths": {
+    "/service": {
+      "get": {
+        "tags": [
+          "service"
+        ],
+        "summary": "listService",
+        "description": "This operation list or find Service entities",
+        "operationId": "listService",
+        "parameters": [
+          {
+            "name": "fields",
+            "in": "query",
+            "description": "Comma-separated properties to be provided in response",
+            "style": "form",
+            "explode": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "offset",
+            "in": "query",
+            "description": "Requested index for start of resources to be provided in response",
+            "style": "form",
+            "explode": true,
+            "schema": {
+              "type": "integer",
+              "format": "int32"
+            }
+          },
+          {
+            "name": "limit",
+            "in": "query",
+            "description": "Requested number of resources to be provided in response",
+            "style": "form",
+            "explode": true,
+            "schema": {
+              "type": "integer",
+              "format": "int32"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Success",
+            "headers": {
+              "X-Result-Count": {
+                "description": "Actual number of items returned in the response body",
+                "content": {
+                  "text/plain": {
+                    "schema": {
+                      "type": "string",
+                      "description": "Actual number of items returned in the response body"
+                    }
+                  }
+                }
+              },
+              "X-Total-Count": {
+                "description": "Total number of items matching criteria",
+                "content": {
+                  "text/plain": {
+                    "schema": {
+                      "type": "string",
+                      "description": "Total number of items matching criteria"
+                    }
+                  }
+                }
+              }
+            },
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/Service"
+                  },
+                  "description": ""
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Bad Request",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "Forbidden",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Not Found",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "405": {
+            "description": "Method Not allowed",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "409": {
+            "description": "Conflict",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal Server Error",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "post": {
+        "tags": [
+          "service"
+        ],
+        "summary": "createService",
+        "description": "This operation creates a Service entity.",
+        "operationId": "createService",
+        "parameters": [],
+        "requestBody": {
+          "description": "The Service to be created",
+          "content": {
+            "application/json": {
+              "schema": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/Service_Create"
+                  },
+                  {
+                    "description": "The Service to be created"
+                  }
+                ]
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "201": {
+            "description": "Created",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Service"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Bad Request",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "Forbidden",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "405": {
+            "description": "Method Not allowed",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "409": {
+            "description": "Conflict",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal Server Error",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/service/{id}": {
+      "get": {
+        "tags": [
+          "service"
+        ],
+        "summary": "retrieveService",
+        "description": "This operation retrieves a Service entity. Attribute selection is enabled for all first level attributes.",
+        "operationId": "retrieveService",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "description": "Identifier of the Service",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "fields",
+            "in": "query",
+            "description": "Comma-separated properties to provide in response",
+            "style": "form",
+            "explode": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Success",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Service"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Bad Request",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "Forbidden",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Not Found",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "405": {
+            "description": "Method Not allowed",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "409": {
+            "description": "Conflict",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal Server Error",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "patch": {
+        "tags": [
+          "service"
+        ],
+        "summary": "patchService",
+        "description": "This operation updates partially a Service entity.",
+        "operationId": "patchService",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "description": "Identifier of the Service",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "description": "The Service to be updated",
+          "content": {
+            "application/json": {
+              "schema": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/Service_Update"
+                  },
+                  {
+                    "description": "The Service to be updated"
+                  }
+                ]
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "Updated",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Service"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Bad Request",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "Forbidden",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Not Found",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "405": {
+            "description": "Method Not allowed",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "409": {
+            "description": "Conflict",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal Server Error",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "delete": {
+        "tags": [
+          "service"
+        ],
+        "summary": "deleteService",
+        "description": "This operation deletes a Service entity.",
+        "operationId": "deleteService",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "description": "Identifier of the Service",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "Deleted",
+            "headers": {},
+            "content": {}
+          },
+          "400": {
+            "description": "Bad Request",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "Forbidden",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Not Found",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "405": {
+            "description": "Method Not allowed",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "409": {
+            "description": "Conflict",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal Server Error",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/listener/serviceCreateEvent": {
+      "post": {
+        "tags": [
+          "notification listeners (client side)"
+        ],
+        "summary": "listenToServiceCreateEvent",
+        "description": "Example of a client listener for receiving the notification ServiceCreateEvent",
+        "operationId": "listenToServiceCreateEvent",
+        "parameters": [],
+        "requestBody": {
+          "description": "The event data",
+          "content": {
+            "application/json": {
+              "schema": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/ServiceCreateEvent"
+                  },
+                  {
+                    "description": "The event data"
+                  }
+                ]
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "201": {
+            "description": "Notified",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/EventSubscription"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Bad Request",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "Forbidden",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Not Found",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "405": {
+            "description": "Method Not allowed",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "409": {
+            "description": "Conflict",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal Server Error",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/listener/serviceAttributeValueChangeEvent": {
+      "post": {
+        "tags": [
+          "notification listeners (client side)"
+        ],
+        "summary": "listenToServiceAttributeValueChangeEvent",
+        "description": "Example of a client listener for receiving the notification ServiceAttributeValueChangeEvent",
+        "operationId": "listenToServiceAttributeValueChangeEvent",
+        "parameters": [],
+        "requestBody": {
+          "description": "The event data",
+          "content": {
+            "application/json": {
+              "schema": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/ServiceAttributeValueChangeEvent"
+                  },
+                  {
+                    "description": "The event data"
+                  }
+                ]
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "201": {
+            "description": "Notified",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/EventSubscription"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Bad Request",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "Forbidden",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Not Found",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "405": {
+            "description": "Method Not allowed",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "409": {
+            "description": "Conflict",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal Server Error",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/listener/serviceStateChangeEvent": {
+      "post": {
+        "tags": [
+          "notification listeners (client side)"
+        ],
+        "summary": "listenToServiceStateChangeEvent",
+        "description": "Example of a client listener for receiving the notification ServiceStateChangeEvent",
+        "operationId": "listenToServiceStateChangeEvent",
+        "parameters": [],
+        "requestBody": {
+          "description": "The event data",
+          "content": {
+            "application/json": {
+              "schema": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/ServiceStateChangeEvent"
+                  },
+                  {
+                    "description": "The event data"
+                  }
+                ]
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "201": {
+            "description": "Notified",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/EventSubscription"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Bad Request",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "Forbidden",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Not Found",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "405": {
+            "description": "Method Not allowed",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "409": {
+            "description": "Conflict",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal Server Error",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/listener/serviceDeleteEvent": {
+      "post": {
+        "tags": [
+          "notification listeners (client side)"
+        ],
+        "summary": "listenToServiceDeleteEvent",
+        "description": "Example of a client listener for receiving the notification ServiceDeleteEvent",
+        "operationId": "listenToServiceDeleteEvent",
+        "parameters": [],
+        "requestBody": {
+          "description": "The event data",
+          "content": {
+            "application/json": {
+              "schema": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/ServiceDeleteEvent"
+                  },
+                  {
+                    "description": "The event data"
+                  }
+                ]
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "201": {
+            "description": "Notified",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/EventSubscription"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Bad Request",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "Forbidden",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Not Found",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "405": {
+            "description": "Method Not allowed",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "409": {
+            "description": "Conflict",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal Server Error",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/hub": {
+      "post": {
+        "tags": [
+          "events subscription"
+        ],
+        "summary": "registerListener",
+        "description": "Sets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics.",
+        "operationId": "registerListener",
+        "parameters": [],
+        "requestBody": {
+          "description": "Data containing the callback endpoint to deliver the information",
+          "content": {
+            "application/json": {
+              "schema": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/EventSubscriptionInput"
+                  },
+                  {
+                    "description": "Data containing the callback endpoint to deliver the information"
+                  }
+                ]
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "201": {
+            "description": "Subscribed",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/EventSubscription"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Bad Request",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "Forbidden",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Not Found",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "405": {
+            "description": "Method Not allowed",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "409": {
+            "description": "Conflict",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal Server Error",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/hub/{id}": {
+      "delete": {
+        "tags": [
+          "events subscription"
+        ],
+        "summary": "unregisterListener",
+        "description": "Resets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics.",
+        "operationId": "unregisterListener",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "description": "The id of the registered listener",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "Deleted",
+            "headers": {},
+            "content": {}
+          },
+          "400": {
+            "description": "Bad request",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "Forbidden",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Not Found",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "405": {
+            "description": "Method not allowed",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal Server Error",
+            "headers": {},
+            "content": {
+              "application/json;charset=utf-8": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "Addressable": {
+        "title": "Addressable",
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "unique identifier"
+          },
+          "href": {
+            "type": "string",
+            "description": "Hyperlink reference"
+          }
+        },
+        "description": "Base schema for adressable entities"
+      },
+      "Characteristic": {
+        "title": "Characteristic",
+        "required": [
+          "name",
+          "value"
+        ],
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Unique identifier of the characteristic"
+          },
+          "name": {
+            "type": "string",
+            "description": "Name of the characteristic"
+          },
+          "valueType": {
+            "type": "string",
+            "description": "Data type of the value of the characteristic"
+          },
+          "characteristicRelationship": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/CharacteristicRelationship"
+            },
+            "description": ""
+          },
+          "value": {},
+          "@baseType": {
+            "type": "string",
+            "description": "When sub-classing, this defines the super-class"
+          },
+          "@schemaLocation": {
+            "type": "string",
+            "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
+          },
+          "@type": {
+            "type": "string",
+            "description": "When sub-classing, this defines the sub-class Extensible name"
+          }
+        },
+        "description": "Describes a given characteristic of an object or entity through a name/value pair."
+      },
+      "CharacteristicRelationship": {
+        "title": "CharacteristicRelationship",
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Unique identifier of the characteristic"
+          },
+          "relationshipType": {
+            "type": "string",
+            "description": "The type of relationship"
+          }
+        },
+        "description": "Another Characteristic that is related to the current Characteristic;"
+      },
+      "ConstraintRef": {
+        "title": "ConstraintRef",
+        "required": [
+          "id"
+        ],
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "reference id to the target constraint"
+          },
+          "href": {
+            "type": "string",
+            "description": "Hyperlink reference to the target constraint"
+          },
+          "name": {
+            "type": "string",
+            "description": "Name given to the constraint"
+          },
+          "version": {
+            "type": "string",
+            "description": "constraint version"
+          },
+          "@baseType": {
+            "type": "string",
+            "description": "When sub-classing, this defines the super-class"
+          },
+          "@schemaLocation": {
+            "type": "string",
+            "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
+          },
+          "@type": {
+            "type": "string",
+            "description": "When sub-classing, this defines the sub-class Extensible name"
+          },
+          "@referredType": {
+            "type": "string",
+            "description": "The (class) type of the referred constraint"
+          }
+        },
+        "description": "Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec."
+      },
+      "EntityRef": {
+        "title": "EntityRef",
+        "required": [
+          "id"
+        ],
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "unique identifier"
+          },
+          "href": {
+            "type": "string",
+            "description": "Hyperlink reference"
+          },
+          "name": {
+            "type": "string",
+            "description": "Name of the related entity."
+          },
+          "@baseType": {
+            "type": "string",
+            "description": "When sub-classing, this defines the super-class"
+          },
+          "@schemaLocation": {
+            "type": "string",
+            "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
+          },
+          "@type": {
+            "type": "string",
+            "description": "When sub-classing, this defines the sub-class Extensible name"
+          },
+          "@referredType": {
+            "type": "string",
+            "description": "The actual type of the target instance when needed for disambiguation."
+          }
+        },
+        "description": "Entity reference schema to be use for all entityRef class."
+      },
+      "EntityValue": {
+        "title": "EntityValue",
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Unique identifier of a related entity."
+          },
+          "href": {
+            "type": "string",
+            "description": "Reference of the related entity."
+          }
+        },
+        "description": "Base entity value  schema for use in TMForum Open-APIs"
+      },
+      "Extensible": {
+        "title": "Extensible",
+        "type": "object",
+        "properties": {
+          "@baseType": {
+            "type": "string",
+            "description": "When sub-classing, this defines the super-class"
+          },
+          "@schemaLocation": {
+            "type": "string",
+            "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
+          },
+          "@type": {
+            "type": "string",
+            "description": "When sub-classing, this defines the sub-class Extensible name"
+          }
+        },
+        "description": "Base Extensible schema for use in TMForum Open-APIs"
+      },
+      "Feature": {
+        "title": "Feature",
+        "required": [
+          "id",
+          "name",
+          "featureCharacteristic"
+        ],
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Unique identifier of the feature."
+          },
+          "isBundle": {
+            "type": "boolean",
+            "description": "True if this is a feature group. Default is false."
+          },
+          "isEnabled": {
+            "type": "boolean",
+            "description": "True if this feature is enabled. Default is true."
+          },
+          "name": {
+            "type": "string",
+            "description": "This is the name for the feature."
+          },
+          "constraint": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ConstraintRef"
+            },
+            "description": "This is a list of feature constraints."
+          },
+          "featureCharacteristic": {
+            "minItems": 1,
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Characteristic"
+            },
+            "description": "This is a list of Characteristics for a particular feature."
+          },
+          "featureRelationship": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/FeatureRelationship"
+            },
+            "description": ""
+          }
+        },
+        "description": "Configuration feature."
+      },
+      "FeatureRelationship": {
+        "title": "FeatureRelationship",
+        "required": [
+          "name",
+          "relationshipType"
+        ],
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Unique identifier of the target feature."
+          },
+          "name": {
+            "type": "string",
+            "description": "This is the name of the target feature."
+          },
+          "relationshipType": {
+            "type": "string",
+            "description": "This is the type of the feature relationship."
+          },
+          "validFor": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/TimePeriod"
+              },
+              {
+                "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both"
+              }
+            ]
+          }
+        },
+        "description": "Configuration feature"
+      },
+      "Note": {
+        "title": "Note",
+        "required": [
+          "author",
+          "date",
+          "text"
+        ],
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Identifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation)"
+          },
+          "author": {
+            "type": "string",
+            "description": "Author of the note"
+          },
+          "date": {
+            "type": "string",
+            "description": "Date of the note",
+            "format": "date-time"
+          },
+          "text": {
+            "type": "string",
+            "description": "Text of the note"
+          }
+        },
+        "description": "Extra information about a given entity"
+      },
+      "OrderItemActionType": {
+        "title": "OrderItemActionType",
+        "enum": [
+          "add",
+          "modify",
+          "delete",
+          "noChange"
+        ],
+        "type": "string",
+        "description": "action to be performed on the product"
+      },
+      "Place": {
+        "title": "Place",
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Unique identifier of the place"
+          },
+          "href": {
+            "type": "string",
+            "description": "Unique reference of the place"
+          },
+          "name": {
+            "type": "string",
+            "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]"
+          }
+        },
+        "description": "Place reference. Place defines the places where the products are sold or delivered."
+      },
+      "PlaceRef": {
+        "title": "PlaceRef",
+        "required": [
+          "id"
+        ],
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "unique identifier"
+          },
+          "href": {
+            "type": "string",
+            "description": "Hyperlink reference"
+          },
+          "name": {
+            "type": "string",
+            "description": "Name of the related entity."
+          },
+          "@baseType": {
+            "type": "string",
+            "description": "When sub-classing, this defines the super-class"
+          },
+          "@schemaLocation": {
+            "type": "string",
+            "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
+          },
+          "@type": {
+            "type": "string",
+            "description": "When sub-classing, this defines the sub-class Extensible name"
+          },
+          "@referredType": {
+            "type": "string",
+            "description": "The actual type of the target instance when needed for disambiguation."
+          }
+        },
+        "description": "Place reference. PlaceRef defines the placeRefs where the products are sold or delivered."
+      },
+      "RelatedEntityRefOrValue": {
+        "title": "RelatedEntityRefOrValue",
+        "required": [
+          "role"
+        ],
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Unique identifier of a related entity."
+          },
+          "href": {
+            "type": "string",
+            "description": "Reference of the related entity."
+          },
+          "name": {
+            "type": "string",
+            "description": "Name of the related entity."
+          },
+          "role": {
+            "type": "string"
+          },
+          "@baseType": {
+            "type": "string",
+            "description": "When sub-classing, this defines the super-class"
+          },
+          "@schemaLocation": {
+            "type": "string",
+            "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
+          },
+          "@type": {
+            "type": "string",
+            "description": "When sub-classing, this defines the sub-class Extensible name"
+          },
+          "@referredType": {
+            "type": "string",
+            "description": "The actual type of the target instance when needed for disambiguation."
+          }
+        },
+        "description": "A reference to an entity, where the type of the entity is not known in advance. A related entity defines a entity described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the Entity and not the RelatedEntityRefOrValue class itself"
+      },
+      "RelatedParty": {
+        "title": "RelatedParty",
+        "required": [
+          "id",
+          "@referredType"
+        ],
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "unique identifier"
+          },
+          "href": {
+            "type": "string",
+            "description": "Hyperlink reference"
+          },
+          "name": {
+            "type": "string",
+            "description": "Name of the related entity."
+          },
+          "role": {
+            "type": "string",
+            "description": "Role played by the related party"
+          },
+          "@baseType": {
+            "type": "string",
+            "description": "When sub-classing, this defines the super-class"
+          },
+          "@schemaLocation": {
+            "type": "string",
+            "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
+          },
+          "@type": {
+            "type": "string",
+            "description": "When sub-classing, this defines the sub-class Extensible name"
+          },
+          "@referredType": {
+            "type": "string",
+            "description": "The actual type of the target instance when needed for disambiguation."
+          }
+        },
+        "description": "Related Entity reference. A related party defines party or party role linked to a specific entity."
+      },
+      "RelatedPlaceRefOrValue": {
+        "title": "RelatedPlaceRefOrValue",
+        "required": [
+          "role"
+        ],
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Unique identifier of the place"
+          },
+          "href": {
+            "type": "string",
+            "description": "Unique reference of the place"
+          },
+          "name": {
+            "type": "string",
+            "description": "A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]"
+          },
+          "role": {
+            "type": "string"
+          },
+          "@baseType": {
+            "type": "string",
+            "description": "When sub-classing, this defines the super-class"
+          },
+          "@schemaLocation": {
+            "type": "string",
+            "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
+          },
+          "@type": {
+            "type": "string",
+            "description": "When sub-classing, this defines the sub-class Extensible name"
+          },
+          "@referredType": {
+            "type": "string",
+            "description": "The actual type of the target instance when needed for disambiguation."
+          }
+        },
+        "description": "Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself"
+      },
+      "RelatedServiceOrderItem": {
+        "title": "RelatedServiceOrderItem",
+        "required": [
+          "itemId",
+          "serviceOrderId"
+        ],
+        "type": "object",
+        "properties": {
+          "itemId": {
+            "type": "string",
+            "description": "Identifier of the order item where the service was managed"
+          },
+          "role": {
+            "type": "string",
+            "description": "role of the service order item for this service"
+          },
+          "serviceOrderHref": {
+            "type": "string",
+            "description": "Reference of the related entity."
+          },
+          "serviceOrderId": {
+            "type": "string",
+            "description": "Unique identifier of a related entity."
+          },
+          "itemAction": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/OrderItemActionType"
+              },
+              {
+                "description": "action to be performed on the product"
+              }
+            ]
+          },
+          "@referredType": {
+            "type": "string",
+            "description": "The actual type of the target instance when needed for disambiguation."
+          }
+        },
+        "description": "RelatedServiceOrderItem (a ServiceOrder item) .The service order item which triggered service creation/change/termination."
+      },
+      "ResourceRef": {
+        "title": "ResourceRef",
+        "required": [
+          "id"
+        ],
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "unique identifier"
+          },
+          "href": {
+            "type": "string",
+            "description": "Hyperlink reference"
+          },
+          "name": {
+            "type": "string",
+            "description": "Name of the related entity."
+          },
+          "@baseType": {
+            "type": "string",
+            "description": "When sub-classing, this defines the super-class"
+          },
+          "@schemaLocation": {
+            "type": "string",
+            "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
+          },
+          "@type": {
+            "type": "string",
+            "description": "When sub-classing, this defines the sub-class Extensible name"
+          },
+          "@referredType": {
+            "type": "string",
+            "description": "The actual type of the target instance when needed for disambiguation."
+          }
+        }
+      },
+      "Service": {
+        "title": "Service",
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Unique identifier of the service"
+          },
+          "href": {
+            "type": "string",
+            "description": "Reference of the service"
+          },
+          "category": {
+            "type": "string",
+            "description": "Is it a customer facing or resource facing service"
+          },
+          "description": {
+            "type": "string",
+            "description": "Free-text description of the service"
+          },
+          "endDate": {
+            "type": "string",
+            "description": "Date when the service ends",
+            "format": "date-time"
+          },
+          "hasStarted": {
+            "type": "boolean",
+            "description": "If TRUE, this Service has already been started"
+          },
+          "isBundle": {
+            "type": "boolean",
+            "description": "If true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a 'atomic' service (hierachy leaf)."
+          },
+          "isServiceEnabled": {
+            "type": "boolean",
+            "description": "If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed"
+          },
+          "isStateful": {
+            "type": "boolean",
+            "description": "If TRUE, this Service can be changed without affecting any other services"
+          },
+          "name": {
+            "type": "string",
+            "description": "Name of the service"
+          },
+          "serviceDate": {
+            "type": "string",
+            "description": "Date when the service was created (whatever its status)."
+          },
+          "serviceType": {
+            "type": "string",
+            "description": "Business type of the service"
+          },
+          "startDate": {
+            "type": "string",
+            "description": "Date when the service starts",
+            "format": "date-time"
+          },
+          "startMode": {
+            "type": "string",
+            "description": "This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above"
+          },
+          "feature": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Feature"
+            },
+            "description": "A list of feature associated with this service"
+          },
+          "note": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Note"
+            },
+            "description": "A list of notes made on this service"
+          },
+          "place": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/RelatedPlaceRefOrValue"
+            },
+            "description": "A list of places (Place [*]). Used to define a place useful for the service (for example a geographical place whre the service is installed)"
+          },
+          "relatedEntity": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/RelatedEntityRefOrValue"
+            },
+            "description": "A list of related  entity in relationship with this service"
+          },
+          "relatedParty": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/RelatedParty"
+            },
+            "description": "A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity"
+          },
+          "serviceCharacteristic": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Characteristic"
+            },
+            "description": "A list of characteristics that characterize this service (ServiceCharacteristic [*])"
+          },
+          "serviceOrderItem": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/RelatedServiceOrderItem"
+            },
+            "description": "A list of service order items related to this service"
+          },
+          "serviceRelationship": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ServiceRelationship"
+            },
+            "description": "A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory."
+          },
+          "serviceSpecification": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/ServiceSpecificationRef"
+              },
+              {
+                "description": "Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification."
+              }
+            ]
+          },
+          "state": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/ServiceStateType"
+              },
+              {
+                "description": "Valid values for the lifecycle state of the service"
+              }
+            ]
+          },
+          "supportingResource": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ResourceRef"
+            },
+            "description": "A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources"
+          },
+          "supportingService": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ServiceRefOrValue"
+            },
+            "description": "A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)"
+          }
+        },
+        "description": "Service is a base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. This gives rise to the two subclasses of Service: CustomerFacingService and ResourceFacingService."
+      },
+      "Service_Create": {
+        "title": "Service_Create",
+        "required": [
+          "serviceSpecification",
+          "state"
+        ],
+        "type": "object",
+        "properties": {
+          "category": {
+            "type": "string",
+            "description": "Is it a customer facing or resource facing service"
+          },
+          "description": {
+            "type": "string",
+            "description": "Free-text description of the service"
+          },
+          "endDate": {
+            "type": "string",
+            "description": "Date when the service ends",
+            "format": "date-time"
+          },
+          "hasStarted": {
+            "type": "boolean",
+            "description": "If TRUE, this Service has already been started"
+          },
+          "isBundle": {
+            "type": "boolean",
+            "description": "If true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a 'atomic' service (hierachy leaf)."
+          },
+          "isServiceEnabled": {
+            "type": "boolean",
+            "description": "If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed"
+          },
+          "isStateful": {
+            "type": "boolean",
+            "description": "If TRUE, this Service can be changed without affecting any other services"
+          },
+          "name": {
+            "type": "string",
+            "description": "Name of the service"
+          },
+          "serviceDate": {
+            "type": "string",
+            "description": "Date when the service was created (whatever its status)."
+          },
+          "serviceType": {
+            "type": "string",
+            "description": "Business type of the service"
+          },
+          "startDate": {
+            "type": "string",
+            "description": "Date when the service starts",
+            "format": "date-time"
+          },
+          "startMode": {
+            "type": "string",
+            "description": "This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above"
+          },
+          "feature": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Feature"
+            },
+            "description": "A list of feature associated with this service"
+          },
+          "note": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Note"
+            },
+            "description": "A list of notes made on this service"
+          },
+          "place": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/RelatedPlaceRefOrValue"
+            },
+            "description": "A list of places (Place [*]). Used to define a place useful for the service (for example a geographical place whre the service is installed)"
+          },
+          "relatedEntity": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/RelatedEntityRefOrValue"
+            },
+            "description": "A list of related  entity in relationship with this service"
+          },
+          "relatedParty": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/RelatedParty"
+            },
+            "description": "A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity"
+          },
+          "serviceCharacteristic": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Characteristic"
+            },
+            "description": "A list of characteristics that characterize this service (ServiceCharacteristic [*])"
+          },
+          "serviceOrderItem": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/RelatedServiceOrderItem"
+            },
+            "description": "A list of service order items related to this service"
+          },
+          "serviceRelationship": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ServiceRelationship"
+            },
+            "description": "A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory."
+          },
+          "serviceSpecification": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/ServiceSpecificationRef"
+              },
+              {
+                "description": "Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification."
+              }
+            ]
+          },
+          "state": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/ServiceStateType"
+              },
+              {
+                "description": "Valid values for the lifecycle state of the service"
+              }
+            ]
+          },
+          "supportingResource": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ResourceRef"
+            },
+            "description": "A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources"
+          },
+          "supportingService": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ServiceRefOrValue"
+            },
+            "description": "A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)"
+          }
+        },
+        "description": "Service is a base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. This gives rise to the two subclasses of Service: CustomerFacingService and ResourceFacingService.\nSkipped properties: id,href"
+      },
+      "Service_Update": {
+        "title": "Service_Update",
+        "type": "object",
+        "properties": {
+          "category": {
+            "type": "string",
+            "description": "Is it a customer facing or resource facing service"
+          },
+          "description": {
+            "type": "string",
+            "description": "Free-text description of the service"
+          },
+          "endDate": {
+            "type": "string",
+            "description": "Date when the service ends",
+            "format": "date-time"
+          },
+          "hasStarted": {
+            "type": "boolean",
+            "description": "If TRUE, this Service has already been started"
+          },
+          "isBundle": {
+            "type": "boolean",
+            "description": "If true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a 'atomic' service (hierachy leaf)."
+          },
+          "isServiceEnabled": {
+            "type": "boolean",
+            "description": "If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed"
+          },
+          "isStateful": {
+            "type": "boolean",
+            "description": "If TRUE, this Service can be changed without affecting any other services"
+          },
+          "name": {
+            "type": "string",
+            "description": "Name of the service"
+          },
+          "serviceType": {
+            "type": "string",
+            "description": "Business type of the service"
+          },
+          "startDate": {
+            "type": "string",
+            "description": "Date when the service starts",
+            "format": "date-time"
+          },
+          "startMode": {
+            "type": "string",
+            "description": "This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above"
+          },
+          "feature": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Feature"
+            },
+            "description": "A list of feature associated with this service"
+          },
+          "note": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Note"
+            },
+            "description": "A list of notes made on this service"
+          },
+          "place": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/RelatedPlaceRefOrValue"
+            },
+            "description": "A list of places (Place [*]). Used to define a place useful for the service (for example a geographical place whre the service is installed)"
+          },
+          "relatedEntity": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/RelatedEntityRefOrValue"
+            },
+            "description": "A list of related  entity in relationship with this service"
+          },
+          "relatedParty": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/RelatedParty"
+            },
+            "description": "A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity"
+          },
+          "serviceCharacteristic": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Characteristic"
+            },
+            "description": "A list of characteristics that characterize this service (ServiceCharacteristic [*])"
+          },
+          "serviceOrderItem": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/RelatedServiceOrderItem"
+            },
+            "description": "A list of service order items related to this service"
+          },
+          "serviceRelationship": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ServiceRelationship"
+            },
+            "description": "A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory."
+          },
+          "serviceSpecification": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/ServiceSpecificationRef"
+              },
+              {
+                "description": "Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification."
+              }
+            ]
+          },
+          "state": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/ServiceStateType"
+              },
+              {
+                "description": "Valid values for the lifecycle state of the service"
+              }
+            ]
+          },
+          "supportingResource": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ResourceRef"
+            },
+            "description": "A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources"
+          },
+          "supportingService": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ServiceRefOrValue"
+            },
+            "description": "A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)"
+          }
+        },
+        "description": "Service is a base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. This gives rise to the two subclasses of Service: CustomerFacingService and ResourceFacingService.\nSkipped properties: id,href,serviceDate"
+      },
+      "ServiceRef": {
+        "title": "ServiceRef",
+        "required": [
+          "id"
+        ],
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "unique identifier"
+          },
+          "href": {
+            "type": "string",
+            "description": "Hyperlink reference"
+          },
+          "name": {
+            "type": "string",
+            "description": "Name of the related entity."
+          },
+          "@baseType": {
+            "type": "string",
+            "description": "When sub-classing, this defines the super-class"
+          },
+          "@schemaLocation": {
+            "type": "string",
+            "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
+          },
+          "@type": {
+            "type": "string",
+            "description": "When sub-classing, this defines the sub-class Extensible name"
+          },
+          "@referredType": {
+            "type": "string",
+            "description": "The actual type of the target instance when needed for disambiguation."
+          }
+        },
+        "description": "Service reference, for when Service is used by other entities"
+      },
+      "ServiceRefOrValue": {
+        "title": "ServiceRefOrValue",
+        "required": [
+          "id"
+        ],
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Unique identifier of the service"
+          },
+          "href": {
+            "type": "string",
+            "description": "Reference of the service"
+          },
+          "category": {
+            "type": "string",
+            "description": "Is it a customer facing or resource facing service"
+          },
+          "description": {
+            "type": "string",
+            "description": "Free-text description of the service"
+          },
+          "endDate": {
+            "type": "string",
+            "description": "Date when the service ends",
+            "format": "date-time"
+          },
+          "hasStarted": {
+            "type": "boolean",
+            "description": "If TRUE, this Service has already been started"
+          },
+          "isBundle": {
+            "type": "boolean",
+            "description": "If true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a 'atomic' service (hierachy leaf)."
+          },
+          "isServiceEnabled": {
+            "type": "boolean",
+            "description": "If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed"
+          },
+          "isStateful": {
+            "type": "boolean",
+            "description": "If TRUE, this Service can be changed without affecting any other services"
+          },
+          "name": {
+            "type": "string",
+            "description": "Name of the service"
+          },
+          "serviceDate": {
+            "type": "string",
+            "description": "Date when the service was created (whatever its status)."
+          },
+          "serviceType": {
+            "type": "string",
+            "description": "Business type of the service"
+          },
+          "startDate": {
+            "type": "string",
+            "description": "Date when the service starts",
+            "format": "date-time"
+          },
+          "startMode": {
+            "type": "string",
+            "description": "This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above"
+          },
+          "feature": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Feature"
+            },
+            "description": "A list of feature associated with this service"
+          },
+          "note": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Note"
+            },
+            "description": "A list of notes made on this service"
+          },
+          "place": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/RelatedPlaceRefOrValue"
+            },
+            "description": "A list of places (Place [*]). Used to define a place useful for the service (for example a geographical place whre the service is installed)"
+          },
+          "relatedEntity": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/RelatedEntityRefOrValue"
+            },
+            "description": "A list of related  entity in relationship with this service"
+          },
+          "relatedParty": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/RelatedParty"
+            },
+            "description": "A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity"
+          },
+          "serviceCharacteristic": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Characteristic"
+            },
+            "description": "A list of characteristics that characterize this service (ServiceCharacteristic [*])"
+          },
+          "serviceOrderItem": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/RelatedServiceOrderItem"
+            },
+            "description": "A list of service order items related to this service"
+          },
+          "serviceRelationship": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ServiceRelationship"
+            },
+            "description": "A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory."
+          },
+          "serviceSpecification": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/ServiceSpecificationRef"
+              },
+              {
+                "description": "Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification."
+              }
+            ]
+          },
+          "state": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/ServiceStateType"
+              },
+              {
+                "description": "Valid values for the lifecycle state of the service"
+              }
+            ]
+          },
+          "supportingResource": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ResourceRef"
+            },
+            "description": "A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources"
+          },
+          "supportingService": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ServiceRefOrValue"
+            },
+            "description": "A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)"
+          },
+          "@baseType": {
+            "type": "string",
+            "description": "When sub-classing, this defines the super-class"
+          },
+          "@schemaLocation": {
+            "type": "string",
+            "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
+          },
+          "@type": {
+            "type": "string",
+            "description": "When sub-classing, this defines the sub-class Extensible name"
+          },
+          "@referredType": {
+            "type": "string",
+            "description": "The actual type of the target instance when needed for disambiguation."
+          }
+        },
+        "description": "A Service to be created defined by value or existing defined by reference. The polymorphic attributes @type, @schemaLocation & @referredType are related to the Service entity and not the RelatedServiceRefOrValue class itself"
+      },
+      "ServiceRelationship": {
+        "title": "ServiceRelationship",
+        "required": [
+          "relationshipType",
+          "service"
+        ],
+        "type": "object",
+        "properties": {
+          "relationshipType": {
+            "type": "string"
+          },
+          "service": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/ServiceRefOrValue"
+              },
+              {
+                "description": "A Service to be created defined by value or existing defined by reference. The polymorphic attributes @type, @schemaLocation & @referredType are related to the Service entity and not the RelatedServiceRefOrValue class itself"
+              }
+            ]
+          },
+          "serviceRelationshipCharacteristic": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Characteristic"
+            },
+            "description": ""
+          }
+        }
+      },
+      "ServiceSpecificationRef": {
+        "title": "ServiceSpecificationRef",
+        "required": [
+          "id"
+        ],
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "unique identifier"
+          },
+          "href": {
+            "type": "string",
+            "description": "Hyperlink reference"
+          },
+          "name": {
+            "type": "string",
+            "description": "Name of the related entity."
+          },
+          "version": {
+            "type": "string",
+            "description": "Service specification version"
+          },
+          "@baseType": {
+            "type": "string",
+            "description": "When sub-classing, this defines the super-class"
+          },
+          "@schemaLocation": {
+            "type": "string",
+            "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
+          },
+          "@type": {
+            "type": "string",
+            "description": "When sub-classing, this defines the sub-class Extensible name"
+          },
+          "@referredType": {
+            "type": "string",
+            "description": "The actual type of the target instance when needed for disambiguation."
+          }
+        },
+        "description": "Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification."
+      },
+      "ServiceStateType": {
+        "title": "ServiceStateType",
+        "enum": [
+          "feasibilityChecked",
+          "designed",
+          "reserved",
+          "inactive",
+          "active",
+          "terminated"
+        ],
+        "type": "string",
+        "description": "Valid values for the lifecycle state of the service"
+      },
+      "TimePeriod": {
+        "title": "TimePeriod",
+        "type": "object",
+        "properties": {
+          "endDateTime": {
+            "type": "string",
+            "description": "End of the time period, using IETC-RFC-3339 format",
+            "format": "date-time",
+            "example": "1985-04-12T23:20:50.52Z"
+          },
+          "startDateTime": {
+            "type": "string",
+            "description": "Start of the time period, using IETC-RFC-3339 format",
+            "format": "date-time",
+            "example": "1985-04-12T23:20:50.52Z"
+          }
+        },
+        "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both"
+      },
+      "EventSubscription": {
+        "title": "EventSubscription",
+        "required": [
+          "id",
+          "callback"
+        ],
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Id of the listener"
+          },
+          "callback": {
+            "type": "string",
+            "description": "The callback being registered."
+          },
+          "query": {
+            "type": "string",
+            "description": "additional data to be passed"
+          }
+        },
+        "description": "Sets the communication endpoint address the service instance must use to deliver notification information"
+      },
+      "EventSubscriptionInput": {
+        "title": "EventSubscriptionInput",
+        "required": [
+          "callback"
+        ],
+        "type": "object",
+        "properties": {
+          "callback": {
+            "type": "string",
+            "description": "The callback being registered."
+          },
+          "query": {
+            "type": "string",
+            "description": "additional data to be passed"
+          }
+        },
+        "description": "Sets the communication endpoint address the service instance must use to deliver notification information"
+      },
+      "ServiceCreateEvent": {
+        "title": "ServiceCreateEvent",
+        "type": "object",
+        "properties": {
+          "event": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/ServiceCreateEventPayload"
+              },
+              {
+                "description": "The event data structure"
+              }
+            ]
+          },
+          "eventId": {
+            "type": "string",
+            "description": "The identifier of the notification."
+          },
+          "eventTime": {
+            "type": "string",
+            "description": "Time of the event occurrence.",
+            "format": "date-time"
+          },
+          "eventType": {
+            "type": "string",
+            "description": "The type of the notification."
+          },
+          "correlationId": {
+            "type": "string",
+            "description": "The correlation id for this event."
+          },
+          "domain": {
+            "type": "string",
+            "description": "The domain of the event."
+          },
+          "title": {
+            "type": "string",
+            "description": "The title of the event."
+          },
+          "description": {
+            "type": "string",
+            "description": "An explnatory of the event."
+          },
+          "priority": {
+            "type": "string",
+            "description": "A priority."
+          },
+          "timeOcurred": {
+            "type": "string",
+            "description": "The time the event occured.",
+            "format": "date-time"
+          }
+        },
+        "description": "The notification data structure"
+      },
+      "ServiceCreateEventPayload": {
+        "title": "ServiceCreateEventPayload",
+        "type": "object",
+        "properties": {
+          "service": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/Service"
+              },
+              {
+                "description": "Service is a base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. This gives rise to the two subclasses of Service: CustomerFacingService and ResourceFacingService."
+              }
+            ]
+          }
+        },
+        "description": "The event data structure"
+      },
+      "ServiceAttributeValueChangeEvent": {
+        "title": "ServiceAttributeValueChangeEvent",
+        "type": "object",
+        "properties": {
+          "eventId": {
+            "type": "string",
+            "description": "The identifier of the notification."
+          },
+          "eventTime": {
+            "type": "string",
+            "description": "Time of the event occurrence.",
+            "format": "date-time"
+          },
+          "eventType": {
+            "type": "string",
+            "description": "The type of the notification."
+          },
+          "correlationId": {
+            "type": "string",
+            "description": "The correlation id for this event."
+          },
+          "domain": {
+            "type": "string",
+            "description": "The domain of the event."
+          },
+          "title": {
+            "type": "string",
+            "description": "The title of the event."
+          },
+          "description": {
+            "type": "string",
+            "description": "An explnatory of the event."
+          },
+          "priority": {
+            "type": "string",
+            "description": "A priority."
+          },
+          "timeOcurred": {
+            "type": "string",
+            "description": "The time the event occured.",
+            "format": "date-time"
+          },
+          "fieldPath": {
+            "type": "string",
+            "description": "The path identifying the object field concerned by this notification."
+          },
+          "event": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/ServiceAttributeValueChangeEventPayload"
+              },
+              {
+                "description": "The event data structure"
+              }
+            ]
+          }
+        },
+        "description": "The notification data structure"
+      },
+      "ServiceAttributeValueChangeEventPayload": {
+        "title": "ServiceAttributeValueChangeEventPayload",
+        "type": "object",
+        "properties": {
+          "service": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/Service"
+              },
+              {
+                "description": "Service is a base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. This gives rise to the two subclasses of Service: CustomerFacingService and ResourceFacingService."
+              }
+            ]
+          }
+        },
+        "description": "The event data structure"
+      },
+      "ServiceStateChangeEvent": {
+        "title": "ServiceStateChangeEvent",
+        "type": "object",
+        "properties": {
+          "event": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/ServiceStateChangeEventPayload"
+              },
+              {
+                "description": "The event data structure"
+              }
+            ]
+          },
+          "eventId": {
+            "type": "string",
+            "description": "The identifier of the notification."
+          },
+          "eventTime": {
+            "type": "string",
+            "description": "Time of the event occurrence.",
+            "format": "date-time"
+          },
+          "eventType": {
+            "type": "string",
+            "description": "The type of the notification."
+          },
+          "correlationId": {
+            "type": "string",
+            "description": "The correlation id for this event."
+          },
+          "domain": {
+            "type": "string",
+            "description": "The domain of the event."
+          },
+          "title": {
+            "type": "string",
+            "description": "The title of the event."
+          },
+          "description": {
+            "type": "string",
+            "description": "An explnatory of the event."
+          },
+          "priority": {
+            "type": "string",
+            "description": "A priority."
+          },
+          "timeOcurred": {
+            "type": "string",
+            "description": "The time the event occured.",
+            "format": "date-time"
+          }
+        },
+        "description": "The notification data structure"
+      },
+      "ServiceStateChangeEventPayload": {
+        "title": "ServiceStateChangeEventPayload",
+        "type": "object",
+        "properties": {
+          "service": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/Service"
+              },
+              {
+                "description": "Service is a base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. This gives rise to the two subclasses of Service: CustomerFacingService and ResourceFacingService."
+              }
+            ]
+          }
+        },
+        "description": "The event data structure"
+      },
+      "ServiceDeleteEvent": {
+        "title": "ServiceDeleteEvent",
+        "type": "object",
+        "properties": {
+          "event": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/ServiceDeleteEventPayload"
+              },
+              {
+                "description": "The event data structure"
+              }
+            ]
+          },
+          "eventId": {
+            "type": "string",
+            "description": "The identifier of the notification."
+          },
+          "eventTime": {
+            "type": "string",
+            "description": "Time of the event occurrence.",
+            "format": "date-time"
+          },
+          "eventType": {
+            "type": "string",
+            "description": "The type of the notification."
+          },
+          "correlationId": {
+            "type": "string",
+            "description": "The correlation id for this event."
+          },
+          "domain": {
+            "type": "string",
+            "description": "The domain of the event."
+          },
+          "title": {
+            "type": "string",
+            "description": "The title of the event."
+          },
+          "description": {
+            "type": "string",
+            "description": "An explnatory of the event."
+          },
+          "priority": {
+            "type": "string",
+            "description": "A priority."
+          },
+          "timeOcurred": {
+            "type": "string",
+            "description": "The time the event occured.",
+            "format": "date-time"
+          }
+        },
+        "description": "The notification data structure"
+      },
+      "ServiceDeleteEventPayload": {
+        "title": "ServiceDeleteEventPayload",
+        "type": "object",
+        "properties": {
+          "service": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/Service"
+              },
+              {
+                "description": "Service is a base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. This gives rise to the two subclasses of Service: CustomerFacingService and ResourceFacingService."
+              }
+            ]
+          }
+        },
+        "description": "The event data structure"
+      },
+      "Error": {
+        "title": "Error",
+        "required": [
+          "code",
+          "reason"
+        ],
+        "type": "object",
+        "properties": {
+          "code": {
+            "type": "string",
+            "description": "Application relevant detail, defined in the API or a common list."
+          },
+          "reason": {
+            "type": "string",
+            "description": "Explanation of the reason for the error which can be shown to a client user."
+          },
+          "message": {
+            "type": "string",
+            "description": "More details and corrective actions related to the error which can be shown to a client user."
+          },
+          "status": {
+            "type": "string",
+            "description": "HTTP Error code extension"
+          },
+          "referenceError": {
+            "type": "string",
+            "description": "URI of documentation describing the error."
+          },
+          "@baseType": {
+            "type": "string",
+            "description": "When sub-classing, this defines the super-class."
+          },
+          "@schemaLocation": {
+            "type": "string",
+            "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
+          },
+          "@type": {
+            "type": "string",
+            "description": "When sub-classing, this defines the sub-class entity name."
+          }
+        },
+        "description": "Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)"
+      }
+    }
+  },
+  "tags": [
+    {
+      "name": "service"
+    },
+    {
+      "name": "notification listeners (client side)"
+    },
+    {
+      "name": "events subscription"
+    }
+  ]
+}