aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorJerry Flood <jflood@att.com>2019-05-30 10:36:24 -0400
committerJerry Flood <jflood@att.com>2019-05-30 10:36:39 -0400
commit6df50b96c77bd6402ea4bd7f1a84de6233549cdf (patch)
treed28862e0ae20bbf74fb8dcee9da56d6991c8fc04 /docs
parentcc67f224925c03f50ce47068cbde66799c65e3a0 (diff)
Initial docs update for Dublin
Issue-ID: OPTFRA-510 Change-Id: Ic2027fbd66de0f45f826282701c9979fc1599cb0 Signed-off-by: Jerry Flood <jflood@att.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst7
-rw-r--r--docs/sections/architecture.rst29
-rw-r--r--docs/sections/configuration.rst4
-rw-r--r--docs/sections/consumedapis.rst33
-rw-r--r--docs/sections/delivery.rst5
-rw-r--r--docs/sections/diagrams/ONAP_CMSO_FLOW.pngbin112095 -> 190829 bytes
-rw-r--r--docs/sections/installation.rst12
-rw-r--r--docs/sections/offeredapis.rst57
-rw-r--r--docs/sections/swaggerdoc/oof-cmso-optimizer-api.json538
-rw-r--r--docs/sections/swaggerdoc/oof-cmso-service-api.json (renamed from docs/sections/swaggerdoc/oof-cmso-api.json)353
-rw-r--r--docs/sections/swaggerdoc/oof-cmso-ticketmgt-api.json670
-rw-r--r--docs/sections/swaggerdoc/oof-cmso-topology.json516
12 files changed, 2038 insertions, 186 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 6448c1b..e185288 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -9,11 +9,10 @@ SO work flow requests for multiple VNFs to be executed within a provided change
optimizer is designed to determine a "conflict free" time within that change window that is suitable for
submitting the changes to SO.
-The initial release provides a skeletal implementation that runs in "standalone" mode, that is, the
-intended interfaces are stubbed out (i,e, "loop-back mode").
+The Dublin release provides a an schedule optimizer framework that provides an interface to a model driven schedule optimizer developed using MiniZinc technolgy to provide a best effort at a conflict free schedule. Inputs to the schedule optimizer require network topology and and scheduled change information on relevant network elements in order to do conflict avoidance. To this end, a Change Management Topology and Ticket Management interfaces were designed to abstract the vendor specific topology and availability data required for schedule optimization. Dublin provides skeletal implementations of these services.
- * SO interface for dispatching the work flow and checking status
- * Optimizer Interface for determining the "conflict free" change window (loop-back mode selects the start of change window provided the client)
+ * Dublin does not include an interface to SO for initiating the work flows and checking status. Rather, it has been suggested that a SO dispatcher service be provided to manage the runtime SO workload. While CMSO may take into account work scheduled for SO when creating a schedule. it is outside the domain of CMSO to manage the runtime actual workload on a target service such as SO.
+ * Dublin Topology and Ticket Management simulator services are skeletal interfaces. These services will be expanded in El Alto to provide data to support additional conflict avoidance test cases. Currently, only sunny day test cases are implemented in the CSIT test suite.
CMSO also models interfacing an external ticket/change management system to create, update, close/cancel tickets at relevant points in the CMSO flow.
diff --git a/docs/sections/architecture.rst b/docs/sections/architecture.rst
index 95b634f..5c8d554 100644
--- a/docs/sections/architecture.rst
+++ b/docs/sections/architecture.rst
@@ -6,16 +6,15 @@ Architecture
Introduction
------------------
OOF-CMSO is an optimizing service that allows for the scheduling of VNF change management
-work flows to be executed at a time in the future. It enables a 3rd party client to provide
-SO work flow requests for multiple VNFs to be executed within a provided change window. The schedule
-optimizer is designed to determine a "conflict free" time within that change window that is suitable for
-submitting the changes to SO.
+work flows to be executed at a time in the future. It enables a 3rd party client to provide
+SO work flow requests for multiple VNFs to be executed within a provided change window. The schedule
+optimizer is designed to determine a "conflict free" time within that change window that is suitable for
+submitting the changes to SO.
-The initial release provides a skeletal implementation that runs in "standalone" mode, that is, the
-intended interfaces are stubbed out (i,e, "loop-back mode").
+The Dublin release provides a an schedule optimizer framework that provides an interface to a model driven schedule optimizer developed using MiniZinc technolgy to provide a best effort at a conflict free schedule. Inputs to the schedule optimizer require network topology and and scheduled change information on relevant network elements in order to do conflict avoidance. To this end, a Change Management Topology and Ticket Management interfaces were designed to abstract the vendor specific topology and availability data required for schedule optimization. Dublin provides skeletal implementations of these services.
- * SO interface for dispatching the work flow and checking status
- * Optimizer Interface for determining the "conflict free" change window (loop-back mode selects the start of change window provided the client)
+ * Dublin does not include an interface to SO for initiating the work flows and checking status. Rather, it has been suggested that a SO dispatcher service be provided to manage the runtime SO workload. While CMSO may take into account work scheduled for SO when creating a schedule. it is outside the domain of CMSO to manage the runtime actual workload on a target service such as SO.
+ * Dublin Topology and Ticket Management simulator services are skeletal interfaces. These services will be expanded in El Alto to provide data to support additional conflict avoidance test cases. Currently, only sunny day test cases are implemented in the CSIT test suite.
CMSO also models interfacing an external ticket/change management system to create, update, close/cancel tickets at relevant points in the CMSO flow.
@@ -57,15 +56,14 @@ Architectural Flow Diagram
Scheduling Optimization and Confict Avoidance
-----------------------------------------------
-The Casablanca implementation of CMSO does not attempt any conflict avoidance. It will assume that no
-conflicts exist and creates a achedule based upon the earliest start time, expected duration of each work flow,
-the number of concurrent workflows to be executed and the number of VNFs. The optimized schedule
+The Dublin implementation of CMSO implements an Optimization service that provides conflict avoidance. The optimized schedule
provides a start time for each VNF in the schedule.
Conflict avoidance to achieve the goals of CMSO, successful completion of change requests without incurring network outages,
requires a system to track the availability (or rather unavailability) of assets required to determine an
-optimal time for exectution. No such system exists at this time within ONAP. CMSO itself can be used to track changes to VNFs and
-the initial optimization to be included in Dublin will be limited to ensuring that a VNF is not double booked within CMSO.
+optimal time for exectution. No such change management system exists at this time within ONAP, however, Dublin CMSO defines an interface that abstracts the Change Management Ticket information necessary for the schedule optimizer engine to determine element availability.
+
+
SO Change Request Dispatching
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -74,10 +72,7 @@ CMSO does not serve as a throttling dispatcher to SO. Rather, the dispatching of
the start time assigned to each VNF. CMSO will dispatch a VNF change to SO regardless of how many outstanding
change management requests there are to SO within CMSO.
-CMSO will expect that SO will throttle its own workload and reject requests that arrive when the system is busy.
-CMSO will not interpret these system busy rejections as "try again later" as the changes are assumed to be
-time sensitive based upon the conflict avoidance objectives of CMSO.
-
+It has been proposed that a dispatcher service be defined to enable applications such as SO to manage the runtime workload of the service. The dispatcher would respond to system busy indicators to determine the disatch disposition of a request. For example, time sensitive may be rejected if they cannot be serviced in a particular time window while others may be held based upon priority.
diff --git a/docs/sections/configuration.rst b/docs/sections/configuration.rst
index b394436..88048f8 100644
--- a/docs/sections/configuration.rst
+++ b/docs/sections/configuration.rst
@@ -5,13 +5,13 @@ Configuration
Executing CMSO in a standalone environment requires
- * MarisDB instance
+ * MariaDB instance
* Maven
* Java JDK 1.8
Executing the Robot testsuite requires
- * Pyhton 2.7
+ * Python 3.7
* Robot Framework
Running the example
diff --git a/docs/sections/consumedapis.rst b/docs/sections/consumedapis.rst
index d8d6c6c..f10d5ef 100644
--- a/docs/sections/consumedapis.rst
+++ b/docs/sections/consumedapis.rst
@@ -5,39 +5,42 @@ Consumed APIs
The following are the dependencies for CMSO project.
-SO (Dublin)
+SO (TBD)
--------------------------------------------
CMSO is designed to invoke SO API to
* Submit change management work flow requests
* Poll for status of submitted requests
+
+While the CMSO schedule optimizer considers concurrency when creating a scheduler, the actual SO workload at runtime remains outside the capabilities of CMSO. It has been proposed that CMSO interfaces to a dispatcher service which would manage the actual workload to SO at runtime.
-Schedule Optimizer with Conflict Avoidance (Dublin)
+Schedule Optimizer with Conflict Avoidance
-------------------------------------------------------
-There is currently no schedule optmizer that implements conflict avoidance.
-Conflict avoidance requires:
+CMSO in Dublin includes schedule optmizer that implements conflict avoidance. Services were added to CMSO in Dublin to support providing data to the scheduler optimizer which requires:
- * Vertical topology assets relevant the availability of the VNF(s) under consideration.
+ * Network Topology
+
+ * Vertical topology assets relevant the availability of the VNF(s) under consideration. These assets must be available in order to accomplish the change.
- * Within ONAP topology information is available in A&AI
+ * Horizontal topology assets. Horizontal topology represents assets that must be available in order to avoid a network outage during the change. As an example, the assets supporting the backup instance(s) of the VNF under change.
+
+ * Dublin provides a CMSO Topology Service which implements an API desinged to provide CMSO optimizer the network topology information that is required for conflict avoidance. This service currently only returns the VNF itself, however, El Alto will simulate vertical topology for the VNFs to expand the scope of the CMSO CSIT test cases.
- * Horizontal topology assets ???
-
- * Availability of the VNFs and of the assets identified in the previous items.
- Knowing the availability of related assests generally requires a change management
+ * Availability of the VNFs and related network elements identified by the Toplogy service.
+
+ * Determining the availability of related assests generally requires a change management
tracking/ticketing system system that identifies scheduled changes (unavailaibility) to all assets that contribute to the
functioning of the network.
- * There is no change management ticketing system within ONAP. CMSO itself may serve as such in a very limited capacity as it
- tracks scheduled changes to VNFs. It does not track changes the all network assets which is necessarilty required for full
- conflict avoidance. For ONAP Dublin, the conflict avoidance will necessarily be limited to VNF level conflict
- checking using CMSO as the source of asset (VNF) avaialability/unavailability.
+ * Dublin provides a CMSO Ticket Management service to simulate a change management ticketing system within ONAP. This service currently returns empty results, however, El Alto will simulate change tickets for the network elements to expand the scope of the CMSO CSIT test cases.
+CMSO Topology Service
+-----------------------------------------
-Change Management Ticketing System (TBD)
+CMSO Ticket Management Service
-----------------------------------------
diff --git a/docs/sections/delivery.rst b/docs/sections/delivery.rst
index 8b2c0d5..7d08934 100644
--- a/docs/sections/delivery.rst
+++ b/docs/sections/delivery.rst
@@ -1,11 +1,14 @@
OOF CMSO Delivery
======================
-OOF CMSO is made up of 3 docker containers depoloyed via OOM
+OOF CMSO is made up of 6 docker containers depoloyed via OOM
#. CMSO Service - Java server (Jersey)
#. CMSO Database Initialization - Java wrapper invoking Liquibase schema management scripts
#. MariaDB - OOM Common mariadb-galera server
+ #. CMSO Optimizer - Java server (Jersey)
+ #. CMSO Ticket Management - Java server (Jersey)
+ #. CMSO Topology - Java server (Jersey)
The OOM Helm Charts are located here:
diff --git a/docs/sections/diagrams/ONAP_CMSO_FLOW.png b/docs/sections/diagrams/ONAP_CMSO_FLOW.png
index 1b0b890..e85ff77 100644
--- a/docs/sections/diagrams/ONAP_CMSO_FLOW.png
+++ b/docs/sections/diagrams/ONAP_CMSO_FLOW.png
Binary files differ
diff --git a/docs/sections/installation.rst b/docs/sections/installation.rst
index 83167be..7bd824a 100644
--- a/docs/sections/installation.rst
+++ b/docs/sections/installation.rst
@@ -11,13 +11,17 @@ Get CMSO seed code from the Linux Foundation Projects page
$ git clone https://gerrit.onap.org/r/a/optf/cmso
-There are 3 folders in the project
+There are 5 folders in the project that represent the CMSO services
* cmso-service - Java Maven project (cmso-service/pom.xml)
* cmso-database - Java Maven project (cmso-database/pom.xml) for managing database schema and migrations
+ * cmso-optimizer - Java Maven project (cmso-optimizer/pom.xml)
+ * cmso-topology - Java Maven project (cmso-topology/pom.xml)
+ * cmso-ticketmgt - Java Maven project (cmso-ticketmgt/pom.xml)
- * Schema for the CMSO MariaDB database is in cmso-database/src/main/resources/cmso-dbchangelog/onap-cmso-v1-schema.sql
+There are 2 support folders
- * cmso-robot - Rabot framework project for used for unit and functional testing. See the project README for setup instructions.
+ * cmso-robot - Robot framework project for used for unit and functional testing. See the project README for setup instructions. This produces a docker container as well.
+ * cmso-sonar - This project executed the full robot test suites to generate the code coverage data for Sonar.
- * Note that CMSO was developed using Robot framework as the primary unit testing vehicle.
+Note that CMSO was developed using Robot framework as the primary unit testing vehicle so the cmso-sonar project was developed to generate the jacoco files for the 4 CMSO services to augment the limited Junit test cases. This same test suites are those executed in the CMSO CSIT job. Docker compose is used to create all of the required containers, including a Maria DB instance and the cmso-robot docker container.
diff --git a/docs/sections/offeredapis.rst b/docs/sections/offeredapis.rst
index 76165e9..b7b223b 100644
--- a/docs/sections/offeredapis.rst
+++ b/docs/sections/offeredapis.rst
@@ -4,15 +4,66 @@
Offered APIs
=============================================
-This document describes the CMSO API, provided by the Change Management Schedule Optimizer (CMSO)
+This document describes the CMSO APIs provided by the Change Management Schedule Optimizer (CMSO)
To view API documentation in the interactive swagger UI download the following and
paste into the swagger tool here: https://editor.swagger.io
-:download:`oof-cmso-api.json <./swaggerdoc/oof-cmso-api.json>`
+CMSO Service API
+====================
+:download:`oof-cmso-api.json <./swaggerdoc/oof-cmso-service-api.json>`
-.. swaggerv2doc:: ./swaggerdoc/oof-cmso-api.json
+.. swaggerv2doc:: ./swaggerdoc/oof-cmso-service-api.json
+
+.. code:: json
+
+ {
+ }
+
+.. code:: json
+
+ {
+ }
+
+CMSO Optimizer API
+====================
+:download:`oof-cmso-api.json <./swaggerdoc/oof-cmso-optimizer-api.json>`
+
+.. swaggerv2doc:: ./swaggerdoc/oof-cmso-optimizer-api.json
+
+.. code:: json
+
+ {
+ }
+
+.. code:: json
+
+ {
+ }
+
+CMSO Ticket Management API
+====================
+:download:`oof-cmso-api.json <./swaggerdoc/oof-cmso-ticketmgt-api.json>`
+
+.. swaggerv2doc:: ./swaggerdoc/oof-cmso-ticketmgt-api.json
+
+.. code:: json
+
+ {
+ }
+
+.. code:: json
+
+ {
+ }
+
+
+CMSO Topology API
+====================
+:download:`oof-cmso-api.json <./swaggerdoc/oof-cmso-topology-api.json>`
+
+.. swaggerv2doc:: ./swaggerdoc/oof-cmso-topology-api.json
.. code:: json
diff --git a/docs/sections/swaggerdoc/oof-cmso-optimizer-api.json b/docs/sections/swaggerdoc/oof-cmso-optimizer-api.json
new file mode 100644
index 0000000..d09fc87
--- /dev/null
+++ b/docs/sections/swaggerdoc/oof-cmso-optimizer-api.json
@@ -0,0 +1,538 @@
+{
+ "swagger" : "2.0",
+ "info" : {
+ "version" : "2.0.0-SNAPSHOT",
+ "title" : "cmso-optimizer"
+ },
+ "basePath" : "/optimizer",
+ "tags" : [ {
+ "name" : "Administration"
+ }, {
+ "name" : "Optimizer Interface"
+ } ],
+ "paths" : {
+ "/{apiVersion}/admin/{id}" : {
+ "get" : {
+ "tags" : [ "Administration" ],
+ "summary" : "",
+ "description" : "Returns encrypted value of id.",
+ "operationId" : "exec",
+ "produces" : [ "text/plain" ],
+ "parameters" : [ {
+ "name" : "apiVersion",
+ "in" : "path",
+ "description" : "v1|v2",
+ "required" : true,
+ "type" : "string",
+ "default" : "v1"
+ }, {
+ "name" : "id",
+ "in" : "path",
+ "description" : "Identifier",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "OK",
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ "400" : {
+ "description" : "Request failed"
+ }
+ }
+ }
+ },
+ "/{apiVersion}/health" : {
+ "get" : {
+ "tags" : [ "Administration" ],
+ "summary" : "",
+ "description" : "Returns health status of server.",
+ "operationId" : "healthCheck",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "apiVersion",
+ "in" : "path",
+ "description" : "v1",
+ "required" : true,
+ "type" : "string",
+ "default" : "v1"
+ }, {
+ "name" : "checkInterfaces",
+ "in" : "query",
+ "description" : "Check Interfaces",
+ "required" : false,
+ "type" : "boolean",
+ "default" : true
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "OK",
+ "schema" : {
+ "$ref" : "#/definitions/HealthCheckMessage"
+ }
+ },
+ "400" : {
+ "description" : "Not healthy",
+ "schema" : {
+ "$ref" : "#/definitions/HealthCheckMessage"
+ }
+ }
+ }
+ }
+ },
+ "/{apiVersion}/optimize/schedule" : {
+ "post" : {
+ "tags" : [ "Optimizer Interface" ],
+ "summary" : "",
+ "description" : "API to request schedule optimization for the passed elements.",
+ "operationId" : "optimizeSchedule",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "apiVersion",
+ "in" : "path",
+ "description" : "v1",
+ "required" : true,
+ "type" : "string",
+ "default" : "v1"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Optimization data.",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/definitions/Optimizer Request"
+ }
+ } ],
+ "responses" : {
+ "202" : {
+ "description" : "Accepted"
+ },
+ "400" : {
+ "description" : "Bad request",
+ "schema" : {
+ "$ref" : "#/definitions/CmsoRequestError"
+ }
+ },
+ "500" : {
+ "description" : "Unexpected Runtime error"
+ }
+ }
+ }
+ },
+ "/{apiVersion}/optimize/schedule/{id}" : {
+ "get" : {
+ "tags" : [ "Optimizer Interface" ],
+ "summary" : "",
+ "description" : "API to poll for optimized schedule.",
+ "operationId" : "getSchedule",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "apiVersion",
+ "in" : "path",
+ "description" : "v1",
+ "required" : true,
+ "type" : "string",
+ "default" : "v1"
+ }, {
+ "name" : "id",
+ "in" : "path",
+ "description" : "Request id",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "OK",
+ "schema" : {
+ "$ref" : "#/definitions/Optimizer Response"
+ }
+ },
+ "404" : {
+ "description" : "Not found.",
+ "schema" : {
+ "$ref" : "#/definitions/CmsoRequestError"
+ }
+ },
+ "500" : {
+ "description" : "Unexpected Runtime error"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "Optimizer Interface" ],
+ "summary" : "",
+ "description" : "API to acknowledge and delete optimized schedule request. Acknowledgesthat optimization has results have been retrieved an are safe to delete",
+ "operationId" : "deleteSchedule",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "apiVersion",
+ "in" : "path",
+ "description" : "v1",
+ "required" : true,
+ "type" : "string",
+ "default" : "v1"
+ }, {
+ "name" : "id",
+ "in" : "path",
+ "description" : "Request id",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "204" : {
+ "description" : "Deleted"
+ },
+ "404" : {
+ "description" : "Not found.",
+ "schema" : {
+ "$ref" : "#/definitions/CmsoRequestError"
+ }
+ },
+ "500" : {
+ "description" : "Unexpected Runtime error"
+ }
+ }
+ }
+ },
+ "/{apiVersion}/policies" : {
+ "get" : {
+ "tags" : [ "Optimizer Interface" ],
+ "summary" : "",
+ "description" : "API to retrieve supported change management policies.",
+ "operationId" : "getPolicies",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "apiVersion",
+ "in" : "path",
+ "description" : "v1",
+ "required" : true,
+ "type" : "string",
+ "default" : "v1"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "OK",
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/Supported Policy Information"
+ }
+ }
+ },
+ "400" : {
+ "description" : "Bad request",
+ "schema" : {
+ "$ref" : "#/definitions/CmsoRequestError"
+ }
+ },
+ "500" : {
+ "description" : "Unexpected Runtime error"
+ }
+ }
+ }
+ }
+ },
+ "definitions" : {
+ "Change Window" : {
+ "type" : "object",
+ "properties" : {
+ "startTime" : {
+ "type" : "string",
+ "format" : "date-time",
+ "description" : "Earliest time for which changes may begin."
+ },
+ "endTime" : {
+ "type" : "string",
+ "format" : "date-time",
+ "description" : "Latest time by which all changes must be completed."
+ }
+ },
+ "description" : "Time window for which tickets are to returned"
+ },
+ "CmsoRequestError" : {
+ "type" : "object",
+ "properties" : {
+ "requestError" : {
+ "$ref" : "#/definitions/RequestError"
+ }
+ }
+ },
+ "HealthCheckComponent" : {
+ "type" : "object",
+ "properties" : {
+ "name" : {
+ "type" : "string"
+ },
+ "url" : {
+ "type" : "string"
+ },
+ "status" : {
+ "type" : "string"
+ },
+ "healthy" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "HealthCheckMessage" : {
+ "type" : "object",
+ "properties" : {
+ "healthy" : {
+ "type" : "boolean"
+ },
+ "buildInfo" : {
+ "type" : "string"
+ },
+ "currentTime" : {
+ "type" : "string"
+ },
+ "hostname" : {
+ "type" : "string"
+ },
+ "components" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/HealthCheckComponent"
+ }
+ }
+ }
+ },
+ "Name Value Data" : {
+ "type" : "object",
+ "properties" : {
+ "name" : {
+ "type" : "string",
+ "description" : "Name."
+ },
+ "value" : {
+ "type" : "object",
+ "description" : "Value."
+ }
+ },
+ "description" : "Instance of a name/value"
+ },
+ "Optimizer Element" : {
+ "type" : "object",
+ "properties" : {
+ "elementId" : {
+ "type" : "string",
+ "description" : "Element identifier"
+ },
+ "elementData" : {
+ "type" : "array",
+ "description" : "Implementation specific element data.",
+ "items" : {
+ "$ref" : "#/definitions/Name Value Data"
+ }
+ },
+ "groupId" : {
+ "type" : "string",
+ "description" : "VNF group identifier."
+ }
+ },
+ "description" : "Element to be scheduled."
+ },
+ "Optimizer Request" : {
+ "type" : "object",
+ "properties" : {
+ "requestId" : {
+ "type" : "string",
+ "description" : "Unique Id of the request"
+ },
+ "concurrencyLimit" : {
+ "type" : "integer",
+ "format" : "int32",
+ "description" : "Concurrency limit for this request"
+ },
+ "normalDuration" : {
+ "type" : "integer",
+ "format" : "int32",
+ "description" : "Expected duration of normal change"
+ },
+ "additionalDuration" : {
+ "type" : "integer",
+ "format" : "int32",
+ "description" : "Additional duration for failed change"
+ },
+ "commonData" : {
+ "type" : "array",
+ "description" : "Implementation specific name value pairs.",
+ "items" : {
+ "$ref" : "#/definitions/Name Value Data"
+ }
+ },
+ "changeWindows" : {
+ "type" : "array",
+ "description" : "Lists of desired change windows to schedule the elements.",
+ "items" : {
+ "$ref" : "#/definitions/Change Window"
+ }
+ },
+ "elements" : {
+ "type" : "array",
+ "description" : "List of the elements to schedule.",
+ "items" : {
+ "$ref" : "#/definitions/Optimizer Element"
+ }
+ },
+ "policies" : {
+ "type" : "array",
+ "description" : "List of the policies to control optimization.",
+ "items" : {
+ "$ref" : "#/definitions/Supported Policy Information"
+ }
+ }
+ },
+ "description" : "Request to provide an \"conflict free\" schedule for passed elements."
+ },
+ "Optimizer Response" : {
+ "type" : "object",
+ "properties" : {
+ "requestId" : {
+ "type" : "string",
+ "description" : "Unique Id of the request"
+ },
+ "status" : {
+ "type" : "string",
+ "description" : "Status of the optimization",
+ "enum" : [ "CREATED", "PENDING_TOPOLOGY", "TOPOLOGY_IN_PROGRESS", "PENDING_TICKETS", "TICKETS_IN_PROGRESS", "PENDING_OPTIMIZER", "OPTIMIZER_IN_PROGRESS", "COMPLETED", "FAILED", "DELETED" ]
+ },
+ "errorMessage" : {
+ "type" : "string",
+ "description" : "Message for failed optimization"
+ },
+ "schedules" : {
+ "type" : "array",
+ "description" : "List of schedules returned by the optimizer.",
+ "items" : {
+ "$ref" : "#/definitions/Optimizer Schedule Info"
+ }
+ }
+ },
+ "description" : "Response to optimizer request for the requested elements."
+ },
+ "Optimizer Schedule Info" : {
+ "type" : "object",
+ "properties" : {
+ "scheduledElements" : {
+ "type" : "array",
+ "description" : "Lists of elements with start times.",
+ "items" : {
+ "$ref" : "#/definitions/Scheduled Element"
+ }
+ },
+ "unScheduledElements" : {
+ "type" : "array",
+ "description" : "Lists of elements that were not able to be scheduled.",
+ "items" : {
+ "$ref" : "#/definitions/Unscheduled Element"
+ }
+ }
+ },
+ "description" : "Schedule Information returned from optimizer request."
+ },
+ "RequestError" : {
+ "type" : "object",
+ "properties" : {
+ "messageId" : {
+ "type" : "string"
+ },
+ "text" : {
+ "type" : "string"
+ },
+ "variables" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ }
+ },
+ "Scheduled Element" : {
+ "type" : "object",
+ "properties" : {
+ "elementId" : {
+ "type" : "string",
+ "description" : "Element identifier"
+ },
+ "groupId" : {
+ "type" : "string",
+ "description" : "Group identifier"
+ },
+ "scheduleType" : {
+ "type" : "string",
+ "enum" : [ "UNKNOWN", "GROUP_DISPATCH", "INDIVIDUAL" ]
+ },
+ "startTime" : {
+ "type" : "string",
+ "format" : "date-time",
+ "description" : "Earliest time for which changes may begin."
+ },
+ "endTime" : {
+ "type" : "string",
+ "format" : "date-time",
+ "description" : "Latest time by which all changes must be completed."
+ },
+ "durationSeconds" : {
+ "type" : "integer",
+ "format" : "int64",
+ "description" : "Expected duration of change in seconds."
+ }
+ },
+ "description" : "Scheduled element returned by the optimizer."
+ },
+ "Supported Policy Information" : {
+ "type" : "object",
+ "properties" : {
+ "policyName" : {
+ "type" : "string",
+ "description" : "Policy name"
+ },
+ "policyDescription" : {
+ "type" : "string",
+ "description" : "Policy description"
+ },
+ "policyModifiers" : {
+ "type" : "array",
+ "description" : "Named values to modify/override policy attributes.",
+ "items" : {
+ "$ref" : "#/definitions/Name Value Data"
+ }
+ }
+ },
+ "description" : "Policy Information returned from get policies API."
+ },
+ "Unscheduled Element" : {
+ "type" : "object",
+ "properties" : {
+ "elementId" : {
+ "type" : "string",
+ "description" : "Element identifier"
+ },
+ "groupId" : {
+ "type" : "string",
+ "description" : "Group identifier"
+ },
+ "notScheduledReaons" : {
+ "type" : "array",
+ "description" : "List of reasons not able to schedule this element.",
+ "items" : {
+ "type" : "string",
+ "enum" : [ "ConcurrencyConstraint", "AvailabilityConstraint", "Other" ]
+ }
+ },
+ "notScheduledMessages" : {
+ "type" : "array",
+ "description" : "List of messages not able to schedule this element.",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ },
+ "description" : "Scheduled element returned by the optimizer."
+ }
+ }
+} \ No newline at end of file
diff --git a/docs/sections/swaggerdoc/oof-cmso-api.json b/docs/sections/swaggerdoc/oof-cmso-service-api.json
index 751b276..3168ecc 100644
--- a/docs/sections/swaggerdoc/oof-cmso-api.json
+++ b/docs/sections/swaggerdoc/oof-cmso-service-api.json
@@ -1,13 +1,21 @@
{
"swagger" : "2.0",
"info" : {
- "version" : "1.0.0-SNAPSHOT",
+ "version" : "2.0.0-SNAPSHOT",
"title" : "cmso-service"
},
"basePath" : "/cmso",
+ "tags" : [ {
+ "name" : "CMSO Administration"
+ }, {
+ "name" : "CMSO Optimized Schedule API"
+ }, {
+ "name" : "CMSO Schedule API"
+ } ],
"paths" : {
"/{apiVersion}/admin/{id}" : {
"get" : {
+ "tags" : [ "CMSO Administration" ],
"summary" : "",
"description" : "Returns encrypted value of id.",
"operationId" : "exec",
@@ -45,6 +53,7 @@
},
"/{apiVersion}/health" : {
"get" : {
+ "tags" : [ "CMSO Administration" ],
"summary" : "",
"description" : "Returns health status of server.",
"operationId" : "healthCheck",
@@ -84,40 +93,9 @@
}
}
},
- "/{apiVersion}/optimizerCallback" : {
- "post" : {
- "summary" : "",
- "description" : "Processes optimizer results callback to a Pending Optimization schedule.",
- "operationId" : "sniroCallback",
- "produces" : [ "application/json" ],
- "parameters" : [ {
- "name" : "apiVersion",
- "in" : "path",
- "description" : "v1",
- "required" : true,
- "type" : "string",
- "default" : "v1"
- }, {
- "in" : "body",
- "name" : "body",
- "description" : "Return schedules > lastScheduleId",
- "required" : false,
- "schema" : {
- "$ref" : "#/definitions/Response from schedule optimizer"
- }
- } ],
- "responses" : {
- "200" : {
- "description" : "OK"
- },
- "500" : {
- "description" : "Unexpected Runtime error"
- }
- }
- }
- },
"/{apiVersion}/schedules" : {
"get" : {
+ "tags" : [ "CMSO Schedule API" ],
"summary" : "",
"description" : "Returns a list of Scheduler Requests based upon the filter criteria.",
"operationId" : "searchScheduleRequests",
@@ -220,7 +198,52 @@
"404" : {
"description" : "No records found",
"schema" : {
- "$ref" : "#/definitions/CMSRequestError"
+ "$ref" : "#/definitions/CmsoRequestError"
+ }
+ },
+ "500" : {
+ "description" : "Unexpected Runtime error"
+ }
+ }
+ }
+ },
+ "/{apiVersion}/schedules/optimized/{scheduleId}" : {
+ "post" : {
+ "tags" : [ "CMSO Optimized Schedule API" ],
+ "summary" : "",
+ "description" : "Creates a request for an optimized schedule",
+ "operationId" : "createScheduleRequest",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "apiVersion",
+ "in" : "path",
+ "description" : "v1",
+ "required" : true,
+ "type" : "string",
+ "default" : "v1"
+ }, {
+ "name" : "scheduleId",
+ "in" : "path",
+ "description" : "Schedule id to uniquely identify the schedule request being created.",
+ "required" : true,
+ "type" : "string"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Data for creating a schedule request for the given schedule id",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/definitions/Optimized Schedule Request"
+ }
+ } ],
+ "responses" : {
+ "202" : {
+ "description" : "Schedule request accepted for optimization."
+ },
+ "409" : {
+ "description" : "Schedule request already exists for this schedule id.",
+ "schema" : {
+ "$ref" : "#/definitions/CmsoRequestError"
}
},
"500" : {
@@ -231,6 +254,7 @@
},
"/{apiVersion}/schedules/scheduleDetails" : {
"get" : {
+ "tags" : [ "CMSO Schedule API" ],
"summary" : "",
"description" : "Returns a list of Schedule request details based upon the filter criteria.",
"operationId" : "searchScheduleRequestDetails",
@@ -446,7 +470,7 @@
"404" : {
"description" : "No records found",
"schema" : {
- "$ref" : "#/definitions/CMSRequestError"
+ "$ref" : "#/definitions/CmsoRequestError"
}
},
"500" : {
@@ -457,6 +481,7 @@
},
"/{apiVersion}/schedules/{scheduleId}" : {
"get" : {
+ "tags" : [ "CMSO Schedule API" ],
"summary" : "",
"description" : "Retrieve the schedule request for scheduleId",
"operationId" : "getScheduleRequestInfo",
@@ -491,6 +516,7 @@
}
},
"post" : {
+ "tags" : [ "CMSO Schedule API" ],
"summary" : "",
"description" : "Creates a schedule request for scheduleId",
"operationId" : "createScheduleRequest",
@@ -514,7 +540,7 @@
"description" : "Data for creating a schedule request for the given schedule id",
"required" : false,
"schema" : {
- "$ref" : "#/definitions/CMSMessage"
+ "$ref" : "#/definitions/CmsoMessage"
}
} ],
"responses" : {
@@ -524,7 +550,7 @@
"409" : {
"description" : "Schedule request already exists for this schedule id.",
"schema" : {
- "$ref" : "#/definitions/CMSRequestError"
+ "$ref" : "#/definitions/CmsoRequestError"
}
},
"500" : {
@@ -533,6 +559,7 @@
}
},
"delete" : {
+ "tags" : [ "CMSO Schedule API" ],
"summary" : "",
"description" : "Cancels the schedule request for scheduleId",
"operationId" : "deleteScheduleRequest",
@@ -558,7 +585,7 @@
"404" : {
"description" : "No record found",
"schema" : {
- "$ref" : "#/definitions/CMSRequestError"
+ "$ref" : "#/definitions/CmsoRequestError"
}
},
"500" : {
@@ -569,6 +596,7 @@
},
"/{apiVersion}/schedules/{scheduleId}/approvals" : {
"post" : {
+ "tags" : [ "CMSO Schedule API" ],
"summary" : "",
"description" : "Adds an accept/reject approval status to the schedule request identified by scheduleId",
"operationId" : "approveScheduleRequest",
@@ -610,71 +638,6 @@
}
},
"definitions" : {
- "CMSMessage" : {
- "type" : "object",
- "properties" : {
- "domain" : {
- "type" : "string",
- "description" : "Schedule domain : ChangeManagement"
- },
- "scheduleId" : {
- "type" : "string",
- "description" : "Schedule id that must be unique within the domain. Use of UUID is highly recommended."
- },
- "scheduleName" : {
- "type" : "string",
- "description" : "User provided name of the schedule (deaults to scheduleId"
- },
- "userId" : {
- "type" : "string",
- "description" : "ATTUID of the user requesting the schedule."
- },
- "domainData" : {
- "type" : "array",
- "description" : "Domain data as name value/pairs. (i.e. CallbackUrl, CallbackData, WorkflowName)",
- "items" : {
- "type" : "object",
- "additionalProperties" : {
- "type" : "string"
- }
- }
- },
- "schedulingInfo" : {
- "$ref" : "#/definitions/Change Management Scheduling Info"
- }
- }
- },
- "CMSRequestError" : {
- "type" : "object",
- "properties" : {
- "requestError" : {
- "$ref" : "#/definitions/RequestError"
- }
- }
- },
- "CMSchedule" : {
- "type" : "object",
- "properties" : {
- "groupId" : {
- "type" : "string"
- },
- "startTime" : {
- "type" : "string"
- },
- "finishTime" : {
- "type" : "string"
- },
- "latestInstanceStartTime" : {
- "type" : "string"
- },
- "node" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
- }
- }
- },
"Change Management Group" : {
"type" : "object",
"properties" : {
@@ -785,6 +748,10 @@
"msoTime" : {
"type" : "string",
"description" : "Time of last poll for MSO status."
+ },
+ "request" : {
+ "type" : "string",
+ "description" : "Change equest."
}
},
"description" : "VNF details for Change Management Schedule"
@@ -807,15 +774,25 @@
"format" : "int32",
"description" : "Maximum number of VNF changes to schedule concurrently"
},
- "policyId" : {
- "type" : "string",
- "description" : "Name of schedule optimization policy used by the change management cmso optimizer to determine available time slot"
+ "changeWindows" : {
+ "type" : "array",
+ "description" : "Lists of desired change windows to schedule the elements.",
+ "items" : {
+ "$ref" : "#/definitions/Change Window"
+ }
},
- "vnfDetails" : {
+ "policies" : {
+ "type" : "array",
+ "description" : "List of the policies to control optimization.",
+ "items" : {
+ "$ref" : "#/definitions/Supported Policy Information"
+ }
+ },
+ "elements" : {
"type" : "array",
"description" : "Lists of the VNFs to be changed and the desired change windows",
"items" : {
- "$ref" : "#/definitions/VNF Details"
+ "$ref" : "#/definitions/Optimizer Element"
}
}
},
@@ -826,14 +803,16 @@
"properties" : {
"startTime" : {
"type" : "string",
- "description" : "Earliest time that a set of changes may begin."
+ "format" : "date-time",
+ "description" : "Earliest time for which changes may begin."
},
"endTime" : {
"type" : "string",
- "description" : "Latest time by which all changes must be completed"
+ "format" : "date-time",
+ "description" : "Latest time by which all changes must be completed."
}
},
- "description" : "Time window within which the scheduler optimizer can schedule the changes for the group of NVFs"
+ "description" : "Time window for which tickets are to returned"
},
"CmDetailsMessage" : {
"type" : "object",
@@ -918,10 +897,48 @@
"items" : {
"$ref" : "#/definitions/Schedule Approval Request"
}
+ }
+ }
+ },
+ "CmsoMessage" : {
+ "type" : "object",
+ "properties" : {
+ "domain" : {
+ "type" : "string",
+ "description" : "Schedule domain : ChangeManagement"
},
- "schedulesId" : {
- "type" : "integer",
- "format" : "int32"
+ "scheduleId" : {
+ "type" : "string",
+ "description" : "Schedule id that must be unique within the domain. Use of UUID is highly recommended."
+ },
+ "scheduleName" : {
+ "type" : "string",
+ "description" : "User provided name of the schedule (deaults to scheduleId"
+ },
+ "userId" : {
+ "type" : "string",
+ "description" : "ATTUID of the user requesting the schedule."
+ },
+ "domainData" : {
+ "type" : "array",
+ "description" : "Domain data as name value/pairs. (i.e. CallbackUrl, CallbackData, WorkflowName)",
+ "items" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ }
+ },
+ "schedulingInfo" : {
+ "$ref" : "#/definitions/Change Management Scheduling Info"
+ }
+ }
+ },
+ "CmsoRequestError" : {
+ "type" : "object",
+ "properties" : {
+ "requestError" : {
+ "$ref" : "#/definitions/RequestError"
}
}
},
@@ -977,55 +994,94 @@
}
}
},
- "RequestError" : {
+ "Name Value Data" : {
"type" : "object",
"properties" : {
- "messageId" : {
- "type" : "string"
- },
- "text" : {
- "type" : "string"
+ "name" : {
+ "type" : "string",
+ "description" : "Name."
},
- "variables" : {
- "type" : "array",
- "items" : {
- "type" : "string"
- }
+ "value" : {
+ "type" : "object",
+ "description" : "Value."
}
- }
+ },
+ "description" : "Instance of a name/value"
},
- "Response from schedule optimizer" : {
+ "Optimized Schedule Request" : {
"type" : "object",
"properties" : {
- "transactionId" : {
+ "domain" : {
"type" : "string",
- "description" : "Unique id of optimization request."
+ "description" : "Schedule domain : ChangeManagement"
},
"scheduleId" : {
"type" : "string",
- "description" : "Schedule id for which the optimization request was executed."
+ "description" : "Schedule id that must be unique within the domain. Use of UUID is highly recommended."
},
- "requestState" : {
+ "scheduleName" : {
"type" : "string",
- "description" : "State of the request as reported by the optimizer."
+ "description" : "User provided name of the schedule (deaults to scheduleId"
},
- "status" : {
+ "userId" : {
"type" : "string",
- "description" : "Status of the request."
+ "description" : "ATTUID of the user requesting the schedule."
+ },
+ "commonData" : {
+ "type" : "array",
+ "description" : "Implementation specific name value pairs.",
+ "items" : {
+ "$ref" : "#/definitions/Name Value Data"
+ }
},
- "description" : {
+ "schedulingData" : {
+ "description" : "Scheduling data.",
+ "$ref" : "#/definitions/Change Management Scheduling Info"
+ }
+ },
+ "description" : "Request to schedule VNF change management workflow(s)."
+ },
+ "Optimizer Element" : {
+ "type" : "object",
+ "properties" : {
+ "elementId" : {
"type" : "string",
- "description" : "Description of the request status."
+ "description" : "Element identifier"
},
- "schedule" : {
+ "elementData" : {
"type" : "array",
- "description" : "List of schedules returned, one per group. Only 1 group supported at this time.",
+ "description" : "Implementation specific element data.",
"items" : {
- "$ref" : "#/definitions/CMSchedule"
+ "$ref" : "#/definitions/Name Value Data"
}
+ },
+ "request" : {
+ "type" : "object",
+ "description" : "Request for be scheduled."
+ },
+ "groupId" : {
+ "type" : "string",
+ "description" : "VNF group identifier."
}
},
- "description" : "Asynchronous response to schedule oprimizer request."
+ "description" : "Element to be scheduled."
+ },
+ "RequestError" : {
+ "type" : "object",
+ "properties" : {
+ "messageId" : {
+ "type" : "string"
+ },
+ "text" : {
+ "type" : "string"
+ },
+ "variables" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ }
},
"Schedule" : {
"type" : "object",
@@ -1133,6 +1189,23 @@
},
"description" : "Request to accept or reject an optimized time slot."
},
+ "Supported Policy Information" : {
+ "type" : "object",
+ "properties" : {
+ "policyName" : {
+ "type" : "string",
+ "description" : "Policy name"
+ },
+ "policyModifiers" : {
+ "type" : "array",
+ "description" : "Named values to modify/override policy attributes.",
+ "items" : {
+ "$ref" : "#/definitions/Name Value Data"
+ }
+ }
+ },
+ "description" : "Policy Information returned from get policies API."
+ },
"VNF Details" : {
"type" : "object",
"properties" : {
diff --git a/docs/sections/swaggerdoc/oof-cmso-ticketmgt-api.json b/docs/sections/swaggerdoc/oof-cmso-ticketmgt-api.json
new file mode 100644
index 0000000..24dc2f2
--- /dev/null
+++ b/docs/sections/swaggerdoc/oof-cmso-ticketmgt-api.json
@@ -0,0 +1,670 @@
+{
+ "swagger" : "2.0",
+ "info" : {
+ "version" : "2.0.0-SNAPSHOT",
+ "title" : "cmso-ticketmgt"
+ },
+ "basePath" : "/ticketmgt",
+ "tags" : [ {
+ "name" : "Administration"
+ }, {
+ "name" : "Availability Interface"
+ }, {
+ "name" : "Ticket Management"
+ } ],
+ "paths" : {
+ "/{apiVersion}/activetickets" : {
+ "post" : {
+ "tags" : [ "Availability Interface" ],
+ "summary" : "Request Active Tickets",
+ "description" : "API to support conflict avoidance. Retrieves the active ticket data for the passed criteria to detemine availability of passed elements within the passed time window.\nIf the request results in asynchronous processging, IN_PROGRESS status will be returned and the optimizer will begin to poll the request until COMPLETED.",
+ "operationId" : "getActiveTickets",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "apiVersion",
+ "in" : "path",
+ "description" : "v1",
+ "required" : true,
+ "type" : "string",
+ "default" : "v1"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Active ticket criteria (elements and change windows).",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/definitions/Ticket Management Request"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "OK",
+ "schema" : {
+ "$ref" : "#/definitions/Ticket Management Response"
+ }
+ },
+ "400" : {
+ "description" : "Bad request",
+ "schema" : {
+ "$ref" : "#/definitions/CmsoRequestError"
+ }
+ },
+ "500" : {
+ "description" : "Unexpected Runtime error"
+ }
+ }
+ }
+ },
+ "/{apiVersion}/activetickets/{id}" : {
+ "get" : {
+ "tags" : [ "Availability Interface" ],
+ "summary" : "Poll Active Tickets Request",
+ "description" : "Poll for the status of the request id. Optimizser will poll until status is COMPLETED and issue acknowledge (DELETE) API to acknowledge the receipt of the response.",
+ "operationId" : "pollActiveTickets",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "apiVersion",
+ "in" : "path",
+ "description" : "v1",
+ "required" : true,
+ "type" : "string",
+ "default" : "v1"
+ }, {
+ "name" : "id",
+ "in" : "path",
+ "description" : "Active tickets request id.",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "OK",
+ "schema" : {
+ "$ref" : "#/definitions/Ticket Management Response"
+ }
+ },
+ "404" : {
+ "description" : "Not found.",
+ "schema" : {
+ "$ref" : "#/definitions/CmsoRequestError"
+ }
+ },
+ "500" : {
+ "description" : "Unexpected Runtime error"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "Availability Interface" ],
+ "summary" : "Acknowledge Active Tickets Response",
+ "description" : "API call used to acknowledge the receipt of a COMPLETED asynchronous request to enable the Ticket Management service to remove it from their cache. The service may remove from the cache on the poll request. The optimizer will treat Not found reponse on as normal.",
+ "operationId" : "deleteActiveTicketsRequest",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "apiVersion",
+ "in" : "path",
+ "description" : "v1",
+ "required" : true,
+ "type" : "string",
+ "default" : "v1"
+ }, {
+ "name" : "id",
+ "in" : "path",
+ "description" : "Active tickets request id.",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "successful operation",
+ "schema" : {
+ "$ref" : "#/definitions/Ticket Management Response"
+ }
+ },
+ "204" : {
+ "description" : "OK"
+ },
+ "404" : {
+ "description" : "Not found",
+ "schema" : {
+ "$ref" : "#/definitions/CmsoRequestError"
+ }
+ },
+ "500" : {
+ "description" : "Unexpected Runtime error"
+ }
+ }
+ }
+ },
+ "/{apiVersion}/admin/{id}" : {
+ "get" : {
+ "tags" : [ "Administration" ],
+ "summary" : "",
+ "description" : "Returns encrypted value of id.",
+ "operationId" : "exec",
+ "produces" : [ "text/plain" ],
+ "parameters" : [ {
+ "name" : "apiVersion",
+ "in" : "path",
+ "description" : "v1|v2",
+ "required" : true,
+ "type" : "string",
+ "default" : "v1"
+ }, {
+ "name" : "id",
+ "in" : "path",
+ "description" : "Identifier",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "OK",
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ "400" : {
+ "description" : "Request failed"
+ }
+ }
+ }
+ },
+ "/{apiVersion}/health" : {
+ "get" : {
+ "tags" : [ "Administration" ],
+ "summary" : "",
+ "description" : "Returns health status of server.",
+ "operationId" : "healthCheck",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "apiVersion",
+ "in" : "path",
+ "description" : "v1",
+ "required" : true,
+ "type" : "string",
+ "default" : "v1"
+ }, {
+ "name" : "checkInterfaces",
+ "in" : "query",
+ "description" : "Check Interfaces",
+ "required" : false,
+ "type" : "boolean",
+ "default" : true
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "OK",
+ "schema" : {
+ "$ref" : "#/definitions/HealthCheckMessage"
+ }
+ },
+ "400" : {
+ "description" : "Not healthy",
+ "schema" : {
+ "$ref" : "#/definitions/HealthCheckMessage"
+ }
+ }
+ }
+ }
+ },
+ "/{apiVersion}/ticket" : {
+ "post" : {
+ "tags" : [ "Ticket Management" ],
+ "summary" : "Create Ticket",
+ "description" : "Creates a ticket for the passed data",
+ "operationId" : "createTicket",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "apiVersion",
+ "in" : "path",
+ "description" : "v1",
+ "required" : true,
+ "type" : "string",
+ "default" : "v1"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Data for creating a ticket",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/definitions/Ticket Data"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "Ticket Created. Ticket Id returned.",
+ "schema" : {
+ "$ref" : "#/definitions/Ticket Data"
+ }
+ },
+ "400" : {
+ "description" : "Bad request.",
+ "schema" : {
+ "$ref" : "#/definitions/CmsoRequestError"
+ }
+ },
+ "500" : {
+ "description" : "Unexpected Runtime error"
+ }
+ }
+ },
+ "put" : {
+ "tags" : [ "Ticket Management" ],
+ "summary" : "Update Ticket",
+ "description" : "Updates a ticket to the passed data",
+ "operationId" : "updateTicket",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "apiVersion",
+ "in" : "path",
+ "description" : "v1",
+ "required" : true,
+ "type" : "string",
+ "default" : "v1"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Data for updating a ticket",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/definitions/Ticket Data"
+ }
+ } ],
+ "responses" : {
+ "204" : {
+ "description" : "Ticket Updated."
+ },
+ "400" : {
+ "description" : "Bad request.",
+ "schema" : {
+ "$ref" : "#/definitions/CmsoRequestError"
+ }
+ },
+ "500" : {
+ "description" : "Unexpected Runtime error"
+ }
+ }
+ }
+ },
+ "/{apiVersion}/ticket/{id}" : {
+ "get" : {
+ "tags" : [ "Ticket Management" ],
+ "summary" : "Fetch Ticket",
+ "description" : "Returns ticket information for the provided ticket id.",
+ "operationId" : "fetchTicket",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "apiVersion",
+ "in" : "path",
+ "description" : "v1",
+ "required" : true,
+ "type" : "string",
+ "default" : "v1"
+ }, {
+ "name" : "id",
+ "in" : "path",
+ "description" : "Unique ticket identifier",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "OK",
+ "schema" : {
+ "$ref" : "#/definitions/Ticket Data"
+ }
+ },
+ "404" : {
+ "description" : "No record found",
+ "schema" : {
+ "$ref" : "#/definitions/CmsoRequestError"
+ }
+ },
+ "500" : {
+ "description" : "Unexpected Runtime error"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "Ticket Management" ],
+ "summary" : "Cancel the ticket",
+ "description" : "Cancels the ticket.",
+ "operationId" : "deleteScheduleRequest",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "apiVersion",
+ "in" : "path",
+ "description" : "v1",
+ "required" : true,
+ "type" : "string",
+ "default" : "v1"
+ }, {
+ "name" : "id",
+ "in" : "path",
+ "description" : "Ticket id to uniquely identify the ticket being deleted.",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "204" : {
+ "description" : "Delete successful"
+ },
+ "400" : {
+ "description" : "Bad request",
+ "schema" : {
+ "$ref" : "#/definitions/CmsoRequestError"
+ }
+ },
+ "404" : {
+ "description" : "No record found",
+ "schema" : {
+ "$ref" : "#/definitions/CmsoRequestError"
+ }
+ },
+ "500" : {
+ "description" : "Unexpected Runtime error"
+ }
+ }
+ }
+ },
+ "/{apiVersion}/tickets" : {
+ "get" : {
+ "tags" : [ "Ticket Management" ],
+ "summary" : "Search Tickets",
+ "description" : "Returns a list of based upon the filter criteria.",
+ "operationId" : "searchTcikets",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "apiVersion",
+ "in" : "path",
+ "description" : "v1",
+ "required" : true,
+ "type" : "string",
+ "default" : "v1"
+ }, {
+ "name" : "id",
+ "in" : "query",
+ "description" : "Ticket identifier",
+ "required" : false,
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "collectionFormat" : "multi"
+ }, {
+ "name" : "elementId",
+ "in" : "query",
+ "description" : "Element Id",
+ "required" : false,
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "collectionFormat" : "multi"
+ }, {
+ "name" : "startTime",
+ "in" : "query",
+ "description" : "Start time <low>,<high>",
+ "required" : false,
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "collectionFormat" : "multi"
+ }, {
+ "name" : "finishTime",
+ "in" : "query",
+ "description" : "Finish time <low>,<high>",
+ "required" : false,
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ },
+ "collectionFormat" : "multi"
+ }, {
+ "name" : "maxTickets",
+ "in" : "query",
+ "description" : "Maximum number of tickets to return",
+ "required" : false,
+ "type" : "integer",
+ "format" : "int32"
+ }, {
+ "name" : "lastId",
+ "in" : "query",
+ "description" : "Return tickets > last id",
+ "required" : false,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "OK",
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/Ticket Data"
+ }
+ }
+ },
+ "400" : {
+ "description" : "Bad request",
+ "schema" : {
+ "$ref" : "#/definitions/CmsoRequestError"
+ }
+ },
+ "500" : {
+ "description" : "Unexpected Runtime error"
+ }
+ }
+ }
+ }
+ },
+ "definitions" : {
+ "Change Window" : {
+ "type" : "object",
+ "properties" : {
+ "startTime" : {
+ "type" : "string",
+ "format" : "date-time",
+ "description" : "Earliest time for which changes may begin."
+ },
+ "endTime" : {
+ "type" : "string",
+ "format" : "date-time",
+ "description" : "Latest time by which all changes must be completed."
+ }
+ },
+ "description" : "Time window for which tickets are to returned"
+ },
+ "CmsoRequestError" : {
+ "type" : "object",
+ "properties" : {
+ "requestError" : {
+ "$ref" : "#/definitions/RequestError"
+ }
+ }
+ },
+ "Element Critera" : {
+ "type" : "object",
+ "properties" : {
+ "elementId" : {
+ "type" : "string",
+ "description" : "Element id unique to the request."
+ },
+ "elementData" : {
+ "type" : "array",
+ "description" : "Implementation specific element data.",
+ "items" : {
+ "$ref" : "#/definitions/Name Value Data"
+ }
+ }
+ },
+ "description" : "Element criteria for retrieving active tickets."
+ },
+ "HealthCheckComponent" : {
+ "type" : "object",
+ "properties" : {
+ "name" : {
+ "type" : "string"
+ },
+ "url" : {
+ "type" : "string"
+ },
+ "status" : {
+ "type" : "string"
+ },
+ "healthy" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "HealthCheckMessage" : {
+ "type" : "object",
+ "properties" : {
+ "healthy" : {
+ "type" : "boolean"
+ },
+ "buildInfo" : {
+ "type" : "string"
+ },
+ "currentTime" : {
+ "type" : "string"
+ },
+ "hostname" : {
+ "type" : "string"
+ },
+ "components" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/HealthCheckComponent"
+ }
+ }
+ }
+ },
+ "Name Value Data" : {
+ "type" : "object",
+ "properties" : {
+ "name" : {
+ "type" : "string",
+ "description" : "Name."
+ },
+ "value" : {
+ "type" : "object",
+ "description" : "Value."
+ }
+ },
+ "description" : "Instance of a name/value"
+ },
+ "RequestError" : {
+ "type" : "object",
+ "properties" : {
+ "messageId" : {
+ "type" : "string"
+ },
+ "text" : {
+ "type" : "string"
+ },
+ "variables" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ }
+ },
+ "Ticket Data" : {
+ "type" : "object",
+ "properties" : {
+ "id" : {
+ "type" : "string",
+ "description" : "Unique ticket identifier"
+ },
+ "startTime" : {
+ "type" : "string",
+ "format" : "date-time",
+ "description" : "Scheduled start time of change."
+ },
+ "endTime" : {
+ "type" : "string",
+ "format" : "date-time",
+ "description" : "Scheduled end time of change."
+ },
+ "availability" : {
+ "type" : "string",
+ "description" : "Availability of element(s) during change window",
+ "enum" : [ "full", "partial", "unavailable" ]
+ },
+ "elementIds" : {
+ "type" : "array",
+ "description" : "List elementIds of elements being changed. At least one maps to elementId in the request",
+ "items" : {
+ "type" : "string"
+ }
+ },
+ "changeDetails" : {
+ "type" : "string",
+ "description" : "Details of the change."
+ }
+ },
+ "description" : "Change Management Ticket Information."
+ },
+ "Ticket Management Request" : {
+ "type" : "object",
+ "properties" : {
+ "requestId" : {
+ "type" : "string",
+ "description" : "Unique Id of the request"
+ },
+ "commonData" : {
+ "type" : "array",
+ "description" : "Implementation specific name value pairs provided to be passed to Ticket Management query .",
+ "items" : {
+ "$ref" : "#/definitions/Name Value Data"
+ }
+ },
+ "changeWindows" : {
+ "type" : "array",
+ "description" : "Lists of desired change windows for which TicketData will be returned.",
+ "items" : {
+ "$ref" : "#/definitions/Change Window"
+ }
+ },
+ "elements" : {
+ "type" : "array",
+ "description" : "List of the elements for which TicketData will be returned.",
+ "items" : {
+ "$ref" : "#/definitions/Element Critera"
+ }
+ }
+ },
+ "description" : "Request to retrieve active tickets for the provided elements."
+ },
+ "Ticket Management Response" : {
+ "type" : "object",
+ "properties" : {
+ "requestId" : {
+ "type" : "string",
+ "description" : "Unique Id of the request"
+ },
+ "elements" : {
+ "type" : "array",
+ "description" : "List of TicketData for the requested elements. A single ticket may apply to more than 1 passed elementId.",
+ "items" : {
+ "$ref" : "#/definitions/Ticket Data"
+ }
+ },
+ "status" : {
+ "type" : "string",
+ "description" : "Status of ticket request. IN_PROGRESS will indicate asynchronous processing is required.",
+ "enum" : [ "IN_PROGESS", "COMPLETED", "FAILED" ]
+ },
+ "pollingSeconds" : {
+ "type" : "integer",
+ "format" : "int32",
+ "description" : "If request is asynchronous (IN_PROGRESS), suggested interval to the next poll."
+ }
+ },
+ "description" : "Response to active ticket query for the requested elements."
+ }
+ }
+} \ No newline at end of file
diff --git a/docs/sections/swaggerdoc/oof-cmso-topology.json b/docs/sections/swaggerdoc/oof-cmso-topology.json
new file mode 100644
index 0000000..c99ec67
--- /dev/null
+++ b/docs/sections/swaggerdoc/oof-cmso-topology.json
@@ -0,0 +1,516 @@
+{
+ "swagger" : "2.0",
+ "info" : {
+ "version" : "2.0.0-SNAPSHOT",
+ "title" : "cmso-topology"
+ },
+ "basePath" : "/topology",
+ "tags" : [ {
+ "name" : "Administration"
+ }, {
+ "name" : "Topology Interface"
+ } ],
+ "paths" : {
+ "/{apiVersion}/admin/{id}" : {
+ "get" : {
+ "tags" : [ "Administration" ],
+ "summary" : "",
+ "description" : "Returns encrypted value of id.",
+ "operationId" : "exec",
+ "produces" : [ "text/plain" ],
+ "parameters" : [ {
+ "name" : "apiVersion",
+ "in" : "path",
+ "description" : "v1|v2",
+ "required" : true,
+ "type" : "string",
+ "default" : "v1"
+ }, {
+ "name" : "id",
+ "in" : "path",
+ "description" : "Identifier",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "OK",
+ "schema" : {
+ "type" : "string"
+ }
+ },
+ "400" : {
+ "description" : "Request failed"
+ }
+ }
+ }
+ },
+ "/{apiVersion}/current" : {
+ "post" : {
+ "tags" : [ "Topology Interface" ],
+ "summary" : "Request Topology",
+ "description" : "API to retrieve toplogy for scheduling 'conflict free' mainentance. Retrieves the element information related to the list of elements targeted for mainenance activity. Scope of related elements to be returned are defined in the passed ToplogogyRequest. Elements returned must include in the elementData, the identifier that the element is known as in the ticket management system.\nThe Topology Service may implement asynchronous requests by returning IN_PROGRESS status. If IN_PROGRESS, the optimizer will begin polling until COMPLETED is returned with the response. ",
+ "operationId" : "retrieveCurrentTopology",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "apiVersion",
+ "in" : "path",
+ "description" : "v1",
+ "required" : true,
+ "type" : "string",
+ "default" : "v1"
+ }, {
+ "in" : "body",
+ "name" : "body",
+ "description" : "Topology criteria.",
+ "required" : false,
+ "schema" : {
+ "$ref" : "#/definitions/Topology Request"
+ }
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "OK",
+ "schema" : {
+ "$ref" : "#/definitions/Topology Response"
+ }
+ },
+ "400" : {
+ "description" : "Bad request",
+ "schema" : {
+ "$ref" : "#/definitions/CmsoRequestError"
+ }
+ },
+ "500" : {
+ "description" : "Unexpected Runtime error"
+ }
+ }
+ }
+ },
+ "/{apiVersion}/current/request/{id}" : {
+ "get" : {
+ "tags" : [ "Topology Interface" ],
+ "summary" : "Poll Asynchronous Topology Request",
+ "description" : "If a topology request results in asynchronous request (IN_PROGRESS) this GET is used to retrieve status until COMPLETED. At which time, the optimizer will issue a DELETE to acknowledge receipt.\nThe Topology Service implementation may delete the cache when returning completed. The optimizer will treat subsequent not found on delete as normal.",
+ "operationId" : "getTopologyRequest",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "apiVersion",
+ "in" : "path",
+ "description" : "v1",
+ "required" : true,
+ "type" : "string",
+ "default" : "v1"
+ }, {
+ "name" : "id",
+ "in" : "path",
+ "description" : "Request Id",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "OK",
+ "schema" : {
+ "$ref" : "#/definitions/Topology Response"
+ }
+ },
+ "404" : {
+ "description" : "Not Found",
+ "schema" : {
+ "$ref" : "#/definitions/CmsoRequestError"
+ }
+ },
+ "500" : {
+ "description" : "Unexpected Runtime error"
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "Topology Interface" ],
+ "summary" : "Acknowledge Topology Response",
+ "description" : "API to acknowledge COMPLETED toplogy request.",
+ "operationId" : "deleteTopologyRequest",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "apiVersion",
+ "in" : "path",
+ "description" : "v1",
+ "required" : true,
+ "type" : "string",
+ "default" : "v1"
+ }, {
+ "name" : "id",
+ "in" : "path",
+ "description" : "Request Id",
+ "required" : true,
+ "type" : "string"
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "OK",
+ "schema" : {
+ "$ref" : "#/definitions/Topology Response"
+ }
+ },
+ "404" : {
+ "description" : "Not Found",
+ "schema" : {
+ "$ref" : "#/definitions/CmsoRequestError"
+ }
+ },
+ "500" : {
+ "description" : "Unexpected Runtime error"
+ }
+ }
+ }
+ },
+ "/{apiVersion}/health" : {
+ "get" : {
+ "tags" : [ "Administration" ],
+ "summary" : "",
+ "description" : "Returns health status of server.",
+ "operationId" : "healthCheck",
+ "produces" : [ "application/json" ],
+ "parameters" : [ {
+ "name" : "apiVersion",
+ "in" : "path",
+ "description" : "v1",
+ "required" : true,
+ "type" : "string",
+ "default" : "v1"
+ }, {
+ "name" : "checkInterfaces",
+ "in" : "query",
+ "description" : "Check Interfaces",
+ "required" : false,
+ "type" : "boolean",
+ "default" : true
+ } ],
+ "responses" : {
+ "200" : {
+ "description" : "OK",
+ "schema" : {
+ "$ref" : "#/definitions/HealthCheckMessage"
+ }
+ },
+ "400" : {
+ "description" : "Not healthy",
+ "schema" : {
+ "$ref" : "#/definitions/HealthCheckMessage"
+ }
+ }
+ }
+ }
+ }
+ },
+ "definitions" : {
+ "CmsoRequestError" : {
+ "type" : "object",
+ "properties" : {
+ "requestError" : {
+ "$ref" : "#/definitions/RequestError"
+ }
+ }
+ },
+ "Element Critera" : {
+ "type" : "object",
+ "properties" : {
+ "elementId" : {
+ "type" : "string",
+ "description" : "Element id unique to the request."
+ },
+ "elementData" : {
+ "type" : "array",
+ "description" : "Implementation specific element data.",
+ "items" : {
+ "$ref" : "#/definitions/Name Value Data"
+ }
+ }
+ },
+ "description" : "Element criteria for retrieving topology."
+ },
+ "Element Location" : {
+ "type" : "object",
+ "properties" : {
+ "lat" : {
+ "type" : "number",
+ "format" : "float",
+ "description" : "Geographic latitude of element."
+ },
+ "lon" : {
+ "type" : "number",
+ "format" : "float",
+ "description" : "Geographic longitude of element."
+ },
+ "timezone" : {
+ "type" : "string",
+ "description" : "Timezone."
+ }
+ },
+ "description" : "Location information necessary to determine timezone. lat/lon and/or timezone must be provided"
+ },
+ "HealthCheckComponent" : {
+ "type" : "object",
+ "properties" : {
+ "name" : {
+ "type" : "string"
+ },
+ "url" : {
+ "type" : "string"
+ },
+ "status" : {
+ "type" : "string"
+ },
+ "healthy" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "HealthCheckMessage" : {
+ "type" : "object",
+ "properties" : {
+ "healthy" : {
+ "type" : "boolean"
+ },
+ "buildInfo" : {
+ "type" : "string"
+ },
+ "currentTime" : {
+ "type" : "string"
+ },
+ "hostname" : {
+ "type" : "string"
+ },
+ "components" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/definitions/HealthCheckComponent"
+ }
+ }
+ }
+ },
+ "Name Value Data" : {
+ "type" : "object",
+ "properties" : {
+ "name" : {
+ "type" : "string",
+ "description" : "Name."
+ },
+ "value" : {
+ "type" : "object",
+ "description" : "Value."
+ }
+ },
+ "description" : "Instance of a name/value"
+ },
+ "RequestError" : {
+ "type" : "object",
+ "properties" : {
+ "messageId" : {
+ "type" : "string"
+ },
+ "text" : {
+ "type" : "string"
+ },
+ "variables" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ }
+ },
+ "Supported Policy Information" : {
+ "type" : "object",
+ "properties" : {
+ "policyName" : {
+ "type" : "string",
+ "description" : "Policy name"
+ },
+ "policyDescription" : {
+ "type" : "string",
+ "description" : "Policy description"
+ },
+ "policyModifiers" : {
+ "type" : "array",
+ "description" : "Named values to modify/override policy attributes.",
+ "items" : {
+ "$ref" : "#/definitions/Name Value Data"
+ }
+ }
+ },
+ "description" : "Policy Information returned from get policies API."
+ },
+ "Topology Constraint ELements" : {
+ "type" : "object",
+ "properties" : {
+ "elementId" : {
+ "type" : "string",
+ "description" : "Element identifier"
+ },
+ "constraintType" : {
+ "type" : "string",
+ "description" : "Type of constraint."
+ },
+ "constraintTypeMinimum" : {
+ "type" : "integer",
+ "format" : "int32",
+ "description" : "If more than one instance of constraintType, minimum number of available instances required. Useful for identifying availableBackup elements, service paths."
+ },
+ "optimizerAvailabilityMatrixName" : {
+ "type" : "string",
+ "description" : "Availability matrix name. Availability matrix will not be passed to optimizer engine. Generally useful for global concurrency type constraints."
+ },
+ "availabilityMatrixScope" : {
+ "type" : "string",
+ "description" : "Availability matrix scope global or scoped per elementId.",
+ "enum" : [ "NONE", "GLOBAL", "ELEMENT" ]
+ },
+ "elementAvailabilityAggreagation" : {
+ "type" : "boolean",
+ "description" : "Availability matrix is aggregated into element availability marrix."
+ },
+ "elements" : {
+ "type" : "array",
+ "description" : "Elements ",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ },
+ "description" : "Constraining Element Information returned from TopologyRequuest."
+ },
+ "Topology Element" : {
+ "type" : "object",
+ "properties" : {
+ "elementId" : {
+ "type" : "string",
+ "description" : "Element identifier"
+ },
+ "elementLocation" : {
+ "description" : "Location information for the element.",
+ "$ref" : "#/definitions/Element Location"
+ },
+ "requiredElements" : {
+ "type" : "array",
+ "description" : "List of related elements required to be available to execute the chenge.",
+ "items" : {
+ "type" : "string"
+ }
+ },
+ "constraintElements" : {
+ "type" : "array",
+ "description" : "Lists of related elements that must be available to avoid network outage while executing the change. Each set constraint elements",
+ "items" : {
+ "$ref" : "#/definitions/Topology Constraint ELements"
+ }
+ },
+ "elementData" : {
+ "type" : "array",
+ "description" : "Implementation specific element data.",
+ "items" : {
+ "$ref" : "#/definitions/Name Value Data"
+ }
+ }
+ },
+ "description" : "Element Information returned from TopologyRequuest."
+ },
+ "Topology Related Element" : {
+ "type" : "object",
+ "properties" : {
+ "elementId" : {
+ "type" : "string",
+ "description" : "Element identifier"
+ },
+ "elementLocation" : {
+ "description" : "Location information for the element.",
+ "$ref" : "#/definitions/Element Location"
+ },
+ "elementData" : {
+ "type" : "array",
+ "description" : "Implementation specific element data.",
+ "items" : {
+ "$ref" : "#/definitions/Name Value Data"
+ }
+ },
+ "relatedElements" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ },
+ "description" : "Element Information returned from TopologyRequuest."
+ },
+ "Topology Request" : {
+ "type" : "object",
+ "properties" : {
+ "requestId" : {
+ "type" : "string",
+ "description" : "Unique Id of the request"
+ },
+ "commonData" : {
+ "type" : "array",
+ "description" : "Implementation specific name value pairs.",
+ "items" : {
+ "$ref" : "#/definitions/Name Value Data"
+ }
+ },
+ "elements" : {
+ "type" : "array",
+ "description" : "List of the elements for which topology information is requested.",
+ "items" : {
+ "$ref" : "#/definitions/Element Critera"
+ }
+ },
+ "policies" : {
+ "type" : "array",
+ "description" : "List of the policies to control topology retrieve.",
+ "items" : {
+ "$ref" : "#/definitions/Supported Policy Information"
+ }
+ }
+ },
+ "description" : "Request to retrieve topology information for the provided elements."
+ },
+ "Topology Response" : {
+ "type" : "object",
+ "properties" : {
+ "requestId" : {
+ "type" : "string",
+ "description" : "Unique Id of the request"
+ },
+ "elements" : {
+ "type" : "array",
+ "description" : "List of elements for for which topology has been requested.",
+ "items" : {
+ "$ref" : "#/definitions/Topology Element"
+ }
+ },
+ "referencedElements" : {
+ "type" : "array",
+ "description" : "List of referenced elements representing the topology that has been requested.",
+ "items" : {
+ "$ref" : "#/definitions/Topology Related Element"
+ }
+ },
+ "status" : {
+ "type" : "string",
+ "description" : "Status of asynchronous request. COMPLETED is returned on initial synchonous request. If IN_PROGRESS is returned, the optimizer will enter asynchronous polling mode.",
+ "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ]
+ },
+ "errorMessage" : {
+ "type" : "string",
+ "description" : "FAILED request error message."
+ },
+ "pollingSeconds" : {
+ "type" : "integer",
+ "format" : "int32",
+ "description" : "If request is asynchronous (IN_PROGRESS), suggested interval to the next poll."
+ }
+ },
+ "description" : "Response to topology query for the requested elements."
+ }
+ }
+} \ No newline at end of file