diff options
Diffstat (limited to 'vid-app-common/src/main/resources')
15 files changed, 413 insertions, 0 deletions
diff --git a/vid-app-common/src/main/resources/json/mso/asyncRequestStatus b/vid-app-common/src/main/resources/json/mso/asyncRequestStatus new file mode 100755 index 00000000..23d2c288 --- /dev/null +++ b/vid-app-common/src/main/resources/json/mso/asyncRequestStatus @@ -0,0 +1,54 @@ +{
+ "$schema": "http://json-schema.org/draft-04/schema#",
+ "description": "request structure",
+ "properties": {
+ "correlator": {
+ "description": "Optional correlation Id originally provided with the request in requestInfo",
+ "type": "string"
+ },
+ "finishTime": {
+ "description": "Date and time the request was finished in GMT with the following sample format: Wed, 15 Oct 2014 13:01:52 GMT",
+ "type": "string"
+ },
+ "instanceIds": {},
+ "requestId": {
+ "description": "UUID for the request generated by the instantiation service",
+ "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
+ "type": "string"
+ },
+ "requestScope": {
+ "description": "short description of the entity being operated on",
+ "enum": [
+ "network",
+ "service",
+ "vfModule",
+ "vnf",
+ "volumeGroup"
+ ],
+ "type": "string"
+ },
+ "requestStatus": {},
+ "requestType": {
+ "description": "short description of the action being performed on the requestScope",
+ "enum": [
+ "createInstance",
+ "deleteInstance",
+ "replaceInstance",
+ "updateInstance"
+ ],
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Date and time the request was created in GMT with the following sample format: Wed, 15 Oct 2014 13:01:52 GMT",
+ "type": "string"
+ }
+ },
+ "required": [
+ "requestId",
+ "requestScope",
+ "requestStatus",
+ "requestType",
+ "startTime"
+ ],
+ "type": "object"
+}
diff --git a/vid-app-common/src/main/resources/json/mso/cloudConfiguration b/vid-app-common/src/main/resources/json/mso/cloudConfiguration new file mode 100755 index 00000000..eb627798 --- /dev/null +++ b/vid-app-common/src/main/resources/json/mso/cloudConfiguration @@ -0,0 +1,19 @@ +{
+ "$schema": "http://json-schema.org/draft-04/schema#",
+ "description": "fields communicating the cloud configuration in a standard way",
+ "type": "object",
+ "properties": {
+ "nodeLocation": {
+ "description": "Location identifier for the node",
+ "type": "string"
+ },
+ "lcpCloudRegionId": {
+ "description": "LCP Node Location identifier",
+ "type": "string"
+ },
+ "tenantId": {
+ "description": "Openstack tenant id",
+ "type": "string"
+ }
+ }
+}
\ No newline at end of file diff --git a/vid-app-common/src/main/resources/json/mso/instanceIds b/vid-app-common/src/main/resources/json/mso/instanceIds new file mode 100755 index 00000000..c20ea9ad --- /dev/null +++ b/vid-app-common/src/main/resources/json/mso/instanceIds @@ -0,0 +1,29 @@ +{
+ "$schema": "http://json-schema.org/draft-04/schema#",
+ "description": "instanceIds that may be associated with a particular request",
+ "type": "object",
+ "properties": {
+ "networkInstanceId": {
+ "description": "UUID for the network instance (if any)",
+ "type": "string"
+ },
+ "serviceInstanceId": {
+ "description": "UUID for the service instance",
+ "type": "string"
+ },
+ "vfModuleInstanceId": {
+ "description": "UUID for the vfModule instance (if any)",
+ "type": "string"
+ },
+ "vnfInstanceId": {
+ "description": "UUID for the vnf instance (if any)",
+ "type": "string"
+ },
+ "volumeGroupInstanceId": {
+ "description": "UUID for the volume group instance (if any)",
+ "type": "string"
+ }
+ }
+}
+
+
\ No newline at end of file diff --git a/vid-app-common/src/main/resources/json/mso/modelInfo b/vid-app-common/src/main/resources/json/mso/modelInfo new file mode 100755 index 00000000..2504d517 --- /dev/null +++ b/vid-app-common/src/main/resources/json/mso/modelInfo @@ -0,0 +1,41 @@ +{
+ "$schema": "http://json-schema.org/draft-04/schema#",
+ "description": "fields describing the SDC entity being operated on by the request",
+ "type": "object",
+ "properties": {
+ "modelCustomizationName": {
+ "description": "reference to the customized set of parameters associated with a model in a given service context",
+ "type": "string"
+ },
+ "modelInvariantId": {
+ "description": "Invariant UUID for the model name, irrespective of the version, as defined in SDC--authoritative",
+ "type": "string",
+ "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
+ },
+ "modelName": {
+ "description": "name of the model as defined in SDC--not authoritative",
+ "type": "string"
+ },
+ "modelNameVersionId": {
+ "description": "UUID for the model name and version combination as defined in SDC--authoritative",
+ "type": "string",
+ "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
+ },
+ "modelType": {
+ "description": "short description of the entity being operated on",
+ "type": "string",
+ "enum": [
+ "network",
+ "service",
+ "vfModule",
+ "vnf",
+ "volumeGroup"
+ ]
+ },
+ "modelVersion": {
+ "description": "the version of the model as defined in SDC--not authoritative",
+ "type": "number"
+ }
+ },
+ "required": ["modelType"]
+}
\ No newline at end of file diff --git a/vid-app-common/src/main/resources/json/mso/relatedInstance b/vid-app-common/src/main/resources/json/mso/relatedInstance new file mode 100755 index 00000000..89554a54 --- /dev/null +++ b/vid-app-common/src/main/resources/json/mso/relatedInstance @@ -0,0 +1,16 @@ +{
+ "description": "modelInfo and optional instanceId and instanceName for a model related to the modelInfo being operated on",
+ "type": "object",
+ "properties": {
+ "instanceName": {
+ "description": "optional name for the instance Id of the related model",
+ "type": "string"
+ },
+ "instanceId": {
+ "description": "instance Id for the related model",
+ "type": "string"
+ },
+ "modelInfo": {}
+ },
+ "required": ["modelInfo"]
+}
\ No newline at end of file diff --git a/vid-app-common/src/main/resources/json/mso/relatedModel b/vid-app-common/src/main/resources/json/mso/relatedModel new file mode 100755 index 00000000..a70a1718 --- /dev/null +++ b/vid-app-common/src/main/resources/json/mso/relatedModel @@ -0,0 +1,15 @@ +{
+ "$schema": "http://json-schema.org/draft-04/schema#",
+ "description": "modelInfo and optional instance id for a model related to the modelInfo being operated on",
+ "type": "object",
+ "properties": {
+ "instanceId": {
+ "description": "instance Id for the related model",
+ "type": "string"
+ },
+ "modelInfo": {}
+ },
+ "required": [ "modelInfo" ]
+}
+
+
diff --git a/vid-app-common/src/main/resources/json/mso/request b/vid-app-common/src/main/resources/json/mso/request new file mode 100755 index 00000000..3aaadbfb --- /dev/null +++ b/vid-app-common/src/main/resources/json/mso/request @@ -0,0 +1,45 @@ +{
+ "$schema": "http://json-schema.org/draft-04/schema#",
+ "description": "request structure",
+ "type": "object",
+ "properties": {
+ "finishTime": {
+ "description": "Date and time the request was finished in GMT with the following sample format: Wed, 15 Oct 2014 13:01:52 GMT",
+ "type": "string"
+ },
+ "instanceIds": {},
+ "requestDetails": {},
+ "requestId": {
+ "description": "UUID for the request generated by the instantiation service",
+ "type": "string",
+ "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
+ },
+ "requestScope": {
+ "description": "short description of the entity being operated on",
+ "type": "string",
+ "enum": [
+ "network",
+ "service",
+ "vfModule",
+ "vnf",
+ "volumeGroup"
+ ]
+ },
+ "requestStatus": {},
+ "requestType": {
+ "description": "short description of the action being performed on the requestScope",
+ "type": "string",
+ "enum": [
+ "createInstance",
+ "deleteInstance",
+ "replaceInstance",
+ "updateInstance"
+ ]
+ },
+ "startTime": {
+ "description": "Date and time the request was created in GMT with the following sample format: Wed, 15 Oct 2014 13:01:52 GMT",
+ "type": "string"
+ }
+ },
+ "required": ["requestDetails", "requestId", "requestScope", "requestType", "startTime"]
+}
\ No newline at end of file diff --git a/vid-app-common/src/main/resources/json/mso/requestDetails b/vid-app-common/src/main/resources/json/mso/requestDetails new file mode 100755 index 00000000..c0ef5304 --- /dev/null +++ b/vid-app-common/src/main/resources/json/mso/requestDetails @@ -0,0 +1,13 @@ +{
+ "description": "aggregates the context, configuraiton and detailed parameters associated with the request into a single structure",
+ "properties": {
+ "cloudConfiguration": {},
+ "modelInfo": {},
+ "relatedModelList": {},
+ "requestInfo": {},
+ "requestParameters": {},
+ "subscriberInfo": {}
+ },
+ "type": "object"
+}
+
diff --git a/vid-app-common/src/main/resources/json/mso/requestError b/vid-app-common/src/main/resources/json/mso/requestError new file mode 100755 index 00000000..497f6719 --- /dev/null +++ b/vid-app-common/src/main/resources/json/mso/requestError @@ -0,0 +1,27 @@ +{
+ "$schema": "http://json-schema.org/draft-04/schema#",
+ "description": "standard request error data structure",
+ "properties": {
+ "messageId": {
+ "description": "Unique message identifier of the format ABCnnnn where ABC is either SVC for Service Exceptions or POL for Policy Exception",
+ "type": "string"
+ },
+ "text": {
+ "description": "Message text, with replacement variables marked with %n, where n is an index into the list of <variables> elements, starting at 1",
+ "type": "string"
+ },
+ "url": {
+ "description": "Hyperlink to a detailed error resource e.g., an HTML page for browser user agents",
+ "type": "string"
+ },
+ "variables": {
+ "description": "List of zero or more strings that represent the contents of the variables used by the message text",
+ "type": "string"
+ }
+ },
+ "required": [
+ "messageId",
+ "text"
+ ],
+ "type": "object"
+}
diff --git a/vid-app-common/src/main/resources/json/mso/requestInfo b/vid-app-common/src/main/resources/json/mso/requestInfo new file mode 100755 index 00000000..56db42fc --- /dev/null +++ b/vid-app-common/src/main/resources/json/mso/requestInfo @@ -0,0 +1,44 @@ +{
+ "$schema": "http://json-schema.org/draft-04/schema#",
+ "description": "fields providing general context information for the request",
+ "properties": {
+ "billingAccountNumber": {
+ "description": "billing account associated with the model being operated on",
+ "type": "string"
+ },
+ "callbackUrl": {
+ "description": "client URL to use for asynchronous responses",
+ "type": "string"
+ },
+ "correlator": {
+ "description": "Optional correlationId for async callback requests",
+ "type": "string"
+ },
+ "instanceName": {
+ "description": "Client provided name for the instance being operated on by the operation (note: not guaranteed to be unique)",
+ "type": "string"
+ },
+ "orderNumber": {
+ "description": "reference to an order",
+ "type": "string"
+ },
+ "orderVersion": {
+ "description": "order version number",
+ "type": "number"
+ },
+ "productFamilyId": {
+ "description": "UUID for the product family associated with the model being operated on",
+ "type": "string"
+ },
+ "source": {
+ "description": "source of the request--not authoritative--actual source revealed via authentication",
+ "type": "string"
+ },
+ "suppressRollback": {
+ "description": "true or false boolean indicating whether rollbacks should be suppressed on failures",
+ "type": "boolean"
+ }
+ },
+
+ "type": "object"
+}
\ No newline at end of file diff --git a/vid-app-common/src/main/resources/json/mso/requestParameters b/vid-app-common/src/main/resources/json/mso/requestParameters new file mode 100755 index 00000000..010d7871 --- /dev/null +++ b/vid-app-common/src/main/resources/json/mso/requestParameters @@ -0,0 +1,23 @@ +{
+ "$schema": "http://json-schema.org/draft-04/schema#",
+ "type": "object",
+ "properties": {
+ "subscriptionServiceType": {
+ "type": "string"
+ },
+ "userParams": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "value": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
\ No newline at end of file diff --git a/vid-app-common/src/main/resources/json/mso/requestReferences b/vid-app-common/src/main/resources/json/mso/requestReferences new file mode 100755 index 00000000..30f64119 --- /dev/null +++ b/vid-app-common/src/main/resources/json/mso/requestReferences @@ -0,0 +1,18 @@ +{
+ "$schema": "http://json-schema.org/draft-04/schema#",
+ "description": "provides the instanceId and requestId associated with the request",
+ "type": "object",
+ "properties": {
+ "instanceId": {
+ "description": "UUID for the service instance",
+ "type": "string",
+ "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
+ },
+ "requestId": {
+ "description": "UUID for the request",
+ "type": "string",
+ "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
+ }
+ },
+ "required": [ "instanceId", "requestId" ]
+}
diff --git a/vid-app-common/src/main/resources/json/mso/requestStatus b/vid-app-common/src/main/resources/json/mso/requestStatus new file mode 100755 index 00000000..9eacb6bb --- /dev/null +++ b/vid-app-common/src/main/resources/json/mso/requestStatus @@ -0,0 +1,37 @@ +{
+ "$schema": "http://json-schema.org/draft-04/schema#",
+ "description": "fields describing the status of a request",
+ "properties": {
+ "percentProgress": {
+ "description": "percentage complete estimate from 0 to 100",
+ "type": "number"
+ },
+ "requestState": {
+ "description": "short description of the instantiation state",
+ "enum": [
+ "complete",
+ "failed",
+ "inProgress"
+ ],
+ "type": "string"
+ },
+ "statusMessage": {
+ "description": "additional descriptive information about the status",
+ "type": "string"
+ },
+ "timestamp": {
+ "description": "GMT Datetime the requestStatus was created e.g.: Wed, 15 Oct 2014 13:01:52 GMT",
+ "type": "string"
+ },
+ "wasRolledBack": {
+ "description": "true or false boolean indicating whether the request was rolled back",
+ "type": "boolean"
+ }
+
+ },
+ "required": [
+ "requestState",
+ "timestamp"
+ ],
+ "type": "object"
+}
diff --git a/vid-app-common/src/main/resources/json/mso/response b/vid-app-common/src/main/resources/json/mso/response new file mode 100755 index 00000000..fa37d2db --- /dev/null +++ b/vid-app-common/src/main/resources/json/mso/response @@ -0,0 +1,13 @@ +{
+ "$schema": "http://json-schema.org/draft-04/schema#",
+ "description": "response structure",
+ "type": "object",
+ "code": {
+ "description": "Return code",
+ "type": "string"
+ },
+ "message": {
+ "description": "Result message",
+ "type": "string"
+ }
+}
\ No newline at end of file diff --git a/vid-app-common/src/main/resources/json/mso/subscriberInfo b/vid-app-common/src/main/resources/json/mso/subscriberInfo new file mode 100755 index 00000000..df787378 --- /dev/null +++ b/vid-app-common/src/main/resources/json/mso/subscriberInfo @@ -0,0 +1,19 @@ +{
+ "$schema": "http://json-schema.org/draft-04/schema#",
+ "description": "fields providing information about the subscriber associated with the request",
+ "type": "object",
+ "properties": {
+ "globalSubscriberId": {
+ "description": "global Customer Id understood by A&AI",
+ "type": "string"
+ },
+ "subscriberCommonSiteId": {
+ "description": "id representing the location of the subscriber",
+ "type": "string"
+ },
+ "subscriberName": {
+ "description": "name of the customer or subscriber",
+ "type": "string"
+ }
+ }
+}
\ No newline at end of file |