From cf469f63cb490d90b55508efa331073a17297999 Mon Sep 17 00:00:00 2001 From: MatthieuGeerebaert Date: Tue, 12 Mar 2019 18:30:33 +0100 Subject: Update Swagger files Change-Id: I02a375b4998fdf23bd7c4eb391011a8e37a1c8e2 Issue-ID: EXTAPI-211 Signed-off-by: MatthieuGeerebaert --- docs/offeredapis/api_serviceInventory/api.plantuml | 109 ++++ docs/offeredapis/api_serviceInventory/model.xsd | 497 +++++++++++++++++ docs/offeredapis/api_serviceInventory/swagger.json | 603 +++++++++++++++++++++ docs/offeredapis/api_serviceInventory/swagger.yaml | 398 ++++++++++++++ 4 files changed, 1607 insertions(+) create mode 100644 docs/offeredapis/api_serviceInventory/api.plantuml create mode 100644 docs/offeredapis/api_serviceInventory/model.xsd create mode 100644 docs/offeredapis/api_serviceInventory/swagger.json create mode 100644 docs/offeredapis/api_serviceInventory/swagger.yaml (limited to 'docs/offeredapis/api_serviceInventory') diff --git a/docs/offeredapis/api_serviceInventory/api.plantuml b/docs/offeredapis/api_serviceInventory/api.plantuml new file mode 100644 index 0000000..3805ae9 --- /dev/null +++ b/docs/offeredapis/api_serviceInventory/api.plantuml @@ -0,0 +1,109 @@ +@startuml + +enum eventType { + ServiceCreationNotification + ServiceAttributeValueChangeNotification + ServiceRemoveNotification +} + +class ErrorRepresentation { + code:int + reason:string + message:string + status:string + referenceError:string + @type:string + @schemaLocation:string +} + +class Service { + id:string + href:string + name:string + type:string + state:string + @type:string + @baseType:string + @schemaLocation:string +} + Service --> "0-1" ServiceSpecificationRef : serviceSpecification + Service --> "0-*" ServiceCharacteristic : characteristic + Service --> "0-*" SupportingResource : supportingResource + Service --> "0-*" RelatedPartyRef : relatedParty + +class ServiceSpecificationRef { + id:string + href:string + name:string + version:string + @referredType:string + @schemaLocation:string + invariantUUID:string +} + +class ServiceCharacteristic { + name:string + valueType:string +} + ServiceCharacteristic --> "0-1" Value : value + +class SupportingResource { + id:string + href:string + role:string + name:string + @referredType:string + @schemaLocation:string + status:string + modelInvariantId:string + modelVersionId:string + modelCustomisationId:string +} + +class RelatedPartyRef { + id:string + href:string + role:string + @referredType:string +} + +class Value { + @type:string + @schemaLocation:string + serviceCharacteristicValue:string +} + +class ListRelatedPartyRef { + id:string + role:string +} + +class ListServiceSpecificationRef { + id:string + name:string +} + +class ListService { + id:string + name:string +} + ListService --> "0-1" ListServiceSpecificationRef : serviceSpecification + ListService --> "0-1" ListRelatedPartyRef : relatedParty + +class ServiceInventoryEvent { + id:string + href:string + name:string + type:string + state:string +} + ServiceInventoryEvent --> "1-1" RelatedPartyRef : relatedParty + +class Notification { + eventId:string + eventDate:dateTime +} + Notification --> "1-1" eventType : eventType + Notification --> "1-1" ServiceInventoryEvent : event + +@enduml \ No newline at end of file diff --git a/docs/offeredapis/api_serviceInventory/model.xsd b/docs/offeredapis/api_serviceInventory/model.xsd new file mode 100644 index 0000000..2c46857 --- /dev/null +++ b/docs/offeredapis/api_serviceInventory/model.xsd @@ -0,0 +1,497 @@ + + + + API Designer + Model: serviceInventory + Version: 4.0.0_inProgress + Owner: ONAPNBI + Generated on: 2019-03-12T16:45:37.288Z + Generated by: Orange API Designer v2, model-v1 + + + + + + + + + + + This class is used to describe error. + + + + + This class is used to describe error. + + + + + Application related code (as defined in the API or from a common list) + + + + + Text that explains the reason for error. This can be shown to a client user. + + + + + Text that provide more details and corrective actions related to the error. This can be shown to a client user. + + + + + http error code extension like 400-2 + + + + + url pointing to documentation describing the error + + + + + The class type of a REST resource. + + + + + it provides a link to the schema describing a REST resource. + + + + + + + Instantiated service (service_instance) in AAI + + + + + Instantiated service (service_instance) in AAI + + + + + Unique identifier of the service - Valued with service-instance-id + + + + + Reference of the service +Not managed in Beijing release + + + + + Name of the service - Valued with service-instance-name + + + + + Service type - valued with 'service-instance' + + + + + State of the service. + + + + + This attribute allows to dynamically extends TMF class. Not used in Beijing release. + + + + + Not managed in Beijing release + + + + + Not managed in Beijing release + + + + + A service specification reference required to realize a ProductSpecification + + + + + A list of service characteristics i.e. name/value pairs that define the service characteristics + + + + + A list of supporting resources +A supportingResource will be retrieved for each relationship of the relationship-list where related-link describe a vnf + + + + + A list of related party references . A related party defines party or party role linked to a specific entity. + + + + + + + Service specification reference: ServiceSpecification of this service (catalog information) + + + + + Service specification reference: ServiceSpecification of this service (catalog information) + + + + + Unique identifier of the service specification. valued to model-version-id + + + + + Reference of the service specification. +not managed in Beijing release. + + + + + Name of the required service specification + + + + + Service specification version. +Not managed in Beijing release + + + + + This attribute allows to dynamically extends TMF class. Valued with 'ONAPservice'. We used this features to add following attribute: invariantUUID + + + + + Not managed in Beijing release + + + + + Additional attribute (not in the TMF API) - extended through @referredType - model-invariant-id + + + + + + + A list of name value pairs that define the service characteristics +Not managed in Beijing release. + + + + + A list of name value pairs that define the service characteristics +Not managed in Beijing release. + + + + + Name of the characteristic +Not managed in Beijing release. + + + + + Type of value for this characteristic. +Not managed in Beijing release. + + + + + Value of the characteristic +Not managed in Beijing release. + + + + + + + Supporting resource - A supportingResource will be retrieved for each relationship of the relationship-list where related-link describe a vnf + + + + + Supporting resource - A supportingResource will be retrieved for each relationship of the relationship-list where related-link describe a vnf + + + + + Unique identifier of the supporting resource - Valued to vnf-id + + + + + Reference of the supporting resource + + + + + Not managed in Beijing release. + + + + + Name of the supporting resource - Valued with vnf_-name + + + + + This attribute allows to dynamically extends TMF class. Valued with 'ONAP resource'. We used this features to add following attributes: + status + modelInvariantId + modelVersionId + modelCustomisationId + + + + + Not managed in Beijing release. + + + + + Additional attribute (not in the TMF API) - extended through @referredType - valued with prov-status + + + + + Additional attribute (not in the TMF API) - extended through @referredType - valued with model-invariant-id + + + + + Additional attribute (not in the TMF API) - extended through @referredType - valued with model-verson-id + + + + + Additional attribute (not in the TMF API) - extended through @referredType - valued with model-customisation-id + + + + + + + RelatedParty reference. A related party defines party or party role linked to a specific entity. + + + + + RelatedParty reference. A related party defines party or party role linked to a specific entity. + + + + + Unique identifier of a related party + + + + + Reference of a related party. +Not filled in Beijing release. + + + + + Role played by the related party. +Filled with 'ONAPcustomer' + + + + + Not managed in the Beijing release. + + + + + + + Structure used to describe characteristic value. +Not managed in Beijing release. + + + + + Structure used to describe characteristic value. +Not managed in Beijing release. + + + + + Not managed in Beijing release. + + + + + Not managed in Beijing release. + + + + + Not managed in Beijing release. + + + + + + + This class is used to structure list of service(s) retrieved + + + + + This class is used to structure list of service(s) retrieved + + + + + Unique identifier of a related party + + + + + Role played by the related party - only role “ONAPcustomer” is managed in Beijing release. + + + + + + + This class is used to structure list of service(s) retrieved + + + + + This class is used to structure list of service(s) retrieved + + + + + Unique identifier of the service specification + + + + + Name of the required service specification + + + + + + + This class is used to structure list of service(s) retrieved + + + + + This class is used to structure list of service(s) retrieved + + + + + Unique identifier of the service + + + + + Name of the service + + + + + A service specification reference required to realize a ProductSpecification + + + + + Related Party to the service (only ONAP customer is managed) + + + + + + + Structure for a service inventory event notification + + + + + Structure for a service inventory event notification + + + + + The Service Instance Id + + + + + A reference to the service inventory + + + + + The name of the Service Instance + + + + + The type of event, service-instance + + + + + The state of the service instance + + + + + + + + Notification structure for a service notification + + + + + Notification structure for a service notification + + + + + + + + + diff --git a/docs/offeredapis/api_serviceInventory/swagger.json b/docs/offeredapis/api_serviceInventory/swagger.json new file mode 100644 index 0000000..81b882d --- /dev/null +++ b/docs/offeredapis/api_serviceInventory/swagger.json @@ -0,0 +1,603 @@ + + { + "swagger": "2.0", + "info": { + "description": "Query information about instantiated services\n\nList of available subscription for serviceInventory notifications, see /hub resources for more information:\n\n- ServiceCreationNotification\n- ServiceAttributeValueChangeNotification\n- ServiceRemoveNotification\n\n", + "version": "4.0.0_inProgress", + "title": "API ServiceInventory", + "x-logo": { + "url": "/redoc/logo.png", + "backgroundColor": "#FFFFFF" + } + }, + + "host": "localhost:8080", + "basePath": "/nbi/api/v4", + "schemes": [ + "http" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "tags": [ + + { + "name": "Service", + "description": "Provided by NBI" + }, + { + "name": "Notification", + "description": "provided by subscriber, which MUST has been registered by creating a Hub ressource on NBI" + } + ], + "paths": { + "/service": { + "get": { + "tags": [ + "Service" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "operationId": "serviceFind", + "summary": "List services", + "description": "This operation list service entities. \nAttribute selection is restricted. \nfields attribute may be used to filter retrieved attribute(s) for each service", + "deprecated": false, + + "parameters": [ + + { + "name": "relatedParty.id", + "required": false, + "in": "query", + "description": "", + + "type": "string" + }, + { + "name": "serviceSpecification.id", + "required": false, + "in": "query", + "description": "", + + "type": "string" + }, + { + "name": "serviceSpecification.name", + "required": false, + "in": "query", + "description": "", + + "type": "string" + }, + { + "name": "id", + "required": false, + "in": "query", + "description": "", + + "type": "string" + }, + { + "name": "fields", + "required": false, + "in": "query", + "description": "", + + "type": "string" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ListService" + } + } + + } + } + } + }, + "/service/{id}": { + "get": { + "tags": [ + "Service" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "operationId": "serviceGet", + "summary": "Retrieve a service", + "description": "This operation retrieves a service entity. \nAttribute selection is enabled for all first level attributes.", + "deprecated": false, + + "parameters": [ + + { + "name": "id", + "required": true, + "in": "path", + "type" : "string" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/Service" + } + + } + } + } + }, + "/notification": { + "post": { + "tags": [ + "Notification" + ], + "consumes": [ + "application/json;charset=utf-8" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "operationId": "notificationCreate", + "summary": "NBI will send notification to this operation provided by subscribers", + "description": "", + "deprecated": false, + + "parameters": [ + + { + "name": "Notification", + "required": true, + "in": "body", + "description": "", + "schema": { + "$ref": "#/definitions/Notification" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Notification" + } + + } + } + } + } + }, + "definitions": { + + "eventType": { + "description": "", + + "type": "string", + "enum": [ + "ServiceCreationNotification", + "ServiceAttributeValueChangeNotification", + "ServiceRemoveNotification"] + + }, + + "ErrorRepresentation": { + "description": "This class is used to describe error.", + + + "required": [ + + "code", + "reason" + ], + "type": "object", + "properties": { + "code": { + "description": "Application related code (as defined in the API or from a common list)", + "type": "integer", + "format": "int32" + }, + "reason": { + "description": "Text that explains the reason for error. This can be shown to a client user.", + "type": "string" + }, + "message": { + "description": "Text that provide more details and corrective actions related to the error. This can be shown to a client user.", + "type": "string" + }, + "status": { + "description": "http error code extension like 400-2", + "type": "string" + }, + "referenceError": { + "description": "url pointing to documentation describing the error", + "type": "string" + }, + "@type": { + "description": "The class type of a REST resource.", + "type": "string" + }, + "@schemaLocation": { + "description": "it provides a link to the schema describing a REST resource.", + "type": "string" + } + } + + }, + + "Service": { + "description": "Instantiated service (service_instance) in AAI", + + + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the service - Valued with service-instance-id", + "type": "string" + }, + "href": { + "description": "Reference of the service\nNot managed in Beijing release", + "type": "string" + }, + "name": { + "description": "Name of the service - Valued with service-instance-name", + "type": "string" + }, + "type": { + "description": "Service type - valued with 'service-instance'", + "type": "string" + }, + "state": { + "description": "State of the service.", + "type": "string" + }, + "@type": { + "description": "This attribute allows to dynamically extends TMF class. Not used in Beijing release.", + "type": "string" + }, + "@baseType": { + "description": "Not managed in Beijing release", + "type": "string" + }, + "@schemaLocation": { + "description": "Not managed in Beijing release", + "type": "string" + }, + "serviceSpecification": { + + "$ref": "#/definitions/ServiceSpecificationRef" + }, + "characteristic": { + + "type": "array", + "items": { + "$ref": "#/definitions/ServiceCharacteristic" + } + }, + "supportingResource": { + + "type": "array", + "items": { + "$ref": "#/definitions/SupportingResource" + } + }, + "relatedParty": { + + "type": "array", + "items": { + "$ref": "#/definitions/RelatedPartyRef" + } + } + } + + }, + + "ServiceSpecificationRef": { + "description": "Service specification reference: ServiceSpecification of this service (catalog information)", + + + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the service specification. valued to model-version-id", + "type": "string" + }, + "href": { + "description": "Reference of the service specification.\nnot managed in Beijing release.", + "type": "string" + }, + "name": { + "description": "Name of the required service specification", + "type": "string" + }, + "version": { + "description": "Service specification version.\nNot managed in Beijing release", + "type": "string" + }, + "@referredType": { + "description": "This attribute allows to dynamically extends TMF class. Valued with 'ONAPservice'. We used this features to add following attribute: invariantUUID", + "type": "string" + }, + "@schemaLocation": { + "description": "Not managed in Beijing release", + "type": "string" + }, + "invariantUUID": { + "description": "Additional attribute (not in the TMF API) - extended through @referredType - model-invariant-id", + "type": "string" + } + } + + }, + + "ServiceCharacteristic": { + "description": "A list of name value pairs that define the service characteristics\nNot managed in Beijing release.", + + + "required": [ + + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "Name of the characteristic\nNot managed in Beijing release.", + "type": "string" + }, + "valueType": { + "description": "Type of value for this characteristic.\nNot managed in Beijing release.", + "type": "string" + }, + "value": { + + "$ref": "#/definitions/Value" + } + } + + }, + + "SupportingResource": { + "description": "Supporting resource - A supportingResource will be retrieved for each relationship of the relationship-list where related-link describe a vnf", + + + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the supporting resource - Valued to vnf-id", + "type": "string" + }, + "href": { + "description": "Reference of the supporting resource", + "type": "string" + }, + "role": { + "description": "Not managed in Beijing release.", + "type": "string" + }, + "name": { + "description": "Name of the supporting resource - Valued with vnf_-name", + "type": "string" + }, + "@referredType": { + "description": "This attribute allows to dynamically extends TMF class. Valued with 'ONAP resource'. We used this features to add following attributes:\n status\t\n modelInvariantId\n modelVersionId\n modelCustomisationId", + "type": "string" + }, + "@schemaLocation": { + "description": "Not managed in Beijing release.", + "type": "string" + }, + "status": { + "description": "Additional attribute (not in the TMF API) - extended through @referredType - valued with prov-status", + "type": "string" + }, + "modelInvariantId": { + "description": "Additional attribute (not in the TMF API) - extended through @referredType - valued with model-invariant-id", + "type": "string" + }, + "modelVersionId": { + "description": "Additional attribute (not in the TMF API) - extended through @referredType - valued with model-verson-id", + "type": "string" + }, + "modelCustomisationId": { + "description": "Additional attribute (not in the TMF API) - extended through @referredType - valued with model-customisation-id", + "type": "string" + } + } + + }, + + "RelatedPartyRef": { + "description": "RelatedParty reference. A related party defines party or party role linked to a specific entity.", + + + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of a related party", + "type": "string" + }, + "href": { + "description": "Reference of a related party.\nNot filled in Beijing release.", + "type": "string" + }, + "role": { + "description": "Role played by the related party.\nFilled with 'ONAPcustomer'", + "type": "string" + }, + "@referredType": { + "description": "Not managed in the Beijing release.", + "type": "string" + } + } + + }, + + "Value": { + "description": "Structure used to describe characteristic value.\nNot managed in Beijing release.", + + + "type": "object", + "properties": { + "@type": { + "description": "Not managed in Beijing release.", + "type": "string" + }, + "@schemaLocation": { + "description": "Not managed in Beijing release.", + "type": "string" + }, + "serviceCharacteristicValue": { + "description": "Not managed in Beijing release.", + "type": "string" + } + } + + }, + + "ListRelatedPartyRef": { + "description": "This class is used to structure list of service(s) retrieved", + + + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of a related party", + "type": "string" + }, + "role": { + "description": "Role played by the related party - only role “ONAPcustomer” is managed in Beijing release.", + "type": "string" + } + } + + }, + + "ListServiceSpecificationRef": { + "description": "This class is used to structure list of service(s) retrieved", + + + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the service specification", + "type": "string" + }, + "name": { + "description": "Name of the required service specification", + "type": "string" + } + } + + }, + + "ListService": { + "description": "This class is used to structure list of service(s) retrieved", + + + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the service", + "type": "string" + }, + "name": { + "description": "Name of the service", + "type": "string" + }, + "serviceSpecification": { + + "$ref": "#/definitions/ListServiceSpecificationRef" + }, + "relatedParty": { + + "$ref": "#/definitions/ListRelatedPartyRef" + } + } + + }, + + "ServiceInventoryEvent": { + "description": "Structure for a service inventory event notification", + + + "required": [ + + "id", + "href", + "name", + "type", + "state", + "relatedParty" + ], + "type": "object", + "properties": { + "id": { + "description": "The Service Instance Id", + "type": "string" + }, + "href": { + "description": "A reference to the service inventory", + "type": "string" + }, + "name": { + "description": "The name of the Service Instance", + "type": "string" + }, + "type": { + "description": "The type of event, service-instance", + "type": "string" + }, + "state": { + "description": "The state of the service instance", + "type": "string" + }, + "relatedParty": { + + "$ref": "#/definitions/RelatedPartyRef" + } + } + + }, + + "Notification": { + "description": "Notification structure for a service notification", + + + "required": [ + + "eventId", + "eventDate", + "eventType", + "event" + ], + "type": "object", + "properties": { + "eventId": { + "description": "", + "type": "string" + }, + "eventDate": { + "description": "", + "type": "string", + "format": "date-time" + }, + "eventType": { + + "$ref": "#/definitions/eventType" + }, + "event": { + + "$ref": "#/definitions/ServiceInventoryEvent" + } + } + + } + } + } + \ No newline at end of file diff --git a/docs/offeredapis/api_serviceInventory/swagger.yaml b/docs/offeredapis/api_serviceInventory/swagger.yaml new file mode 100644 index 0000000..6550d5d --- /dev/null +++ b/docs/offeredapis/api_serviceInventory/swagger.yaml @@ -0,0 +1,398 @@ +swagger: "2.0" +info: + description: "Query information about instantiated services\n\nList of available\ + \ subscription for serviceInventory notifications, see /hub resources for more\ + \ information:\n\n- ServiceCreationNotification\n- ServiceAttributeValueChangeNotification\n\ + - ServiceRemoveNotification\n\n" + version: "4.0.0_inProgress" + title: "API ServiceInventory" + x-logo: + url: "/redoc/logo.png" + backgroundColor: "#FFFFFF" +host: "localhost:8080" +basePath: "/nbi/api/v4" +schemes: +- "http" +produces: +- "application/json;charset=utf-8" +tags: +- name: "Service" + description: "Provided by NBI" +- name: "Notification" + description: "provided by subscriber, which MUST has been registered by creating\ + \ a Hub ressource on NBI" +paths: + /service: + get: + tags: + - "Service" + produces: + - "application/json;charset=utf-8" + operationId: "serviceFind" + summary: "List services" + description: "This operation list service entities. \nAttribute selection is\ + \ restricted. \nfields attribute may be used to filter retrieved attribute(s)\ + \ for each service" + deprecated: false + parameters: + - name: "relatedParty.id" + required: false + in: "query" + description: "" + type: "string" + - name: "serviceSpecification.id" + required: false + in: "query" + description: "" + type: "string" + - name: "serviceSpecification.name" + required: false + in: "query" + description: "" + type: "string" + - name: "id" + required: false + in: "query" + description: "" + type: "string" + - name: "fields" + required: false + in: "query" + description: "" + type: "string" + responses: + 200: + description: "Ok" + schema: + type: "array" + items: + $ref: "#/definitions/ListService" + /service/{id}: + get: + tags: + - "Service" + produces: + - "application/json;charset=utf-8" + operationId: "serviceGet" + summary: "Retrieve a service" + description: "This operation retrieves a service entity. \nAttribute selection\ + \ is enabled for all first level attributes." + deprecated: false + parameters: + - name: "id" + required: true + in: "path" + type: "string" + responses: + 200: + description: "Ok" + schema: + $ref: "#/definitions/Service" + /notification: + post: + tags: + - "Notification" + consumes: + - "application/json;charset=utf-8" + produces: + - "application/json;charset=utf-8" + operationId: "notificationCreate" + summary: "NBI will send notification to this operation provided by subscribers" + description: "" + deprecated: false + parameters: + - name: "Notification" + required: true + in: "body" + description: "" + schema: + $ref: "#/definitions/Notification" + responses: + 201: + description: "Created" + schema: + $ref: "#/definitions/Notification" +definitions: + eventType: + description: "" + type: "string" + enum: + - "ServiceCreationNotification" + - "ServiceAttributeValueChangeNotification" + - "ServiceRemoveNotification" + ErrorRepresentation: + description: "This class is used to describe error." + required: + - "code" + - "reason" + type: "object" + properties: + code: + description: "Application related code (as defined in the API or from a common\ + \ list)" + type: "integer" + format: "int32" + reason: + description: "Text that explains the reason for error. This can be shown to\ + \ a client user." + type: "string" + message: + description: "Text that provide more details and corrective actions related\ + \ to the error. This can be shown to a client user." + type: "string" + status: + description: "http error code extension like 400-2" + type: "string" + referenceError: + description: "url pointing to documentation describing the error" + type: "string" + '@type': + description: "The class type of a REST resource." + type: "string" + '@schemaLocation': + description: "it provides a link to the schema describing a REST resource." + type: "string" + Service: + description: "Instantiated service (service_instance) in AAI" + type: "object" + properties: + id: + description: "Unique identifier of the service - Valued with service-instance-id" + type: "string" + href: + description: "Reference of the service\nNot managed in Beijing release" + type: "string" + name: + description: "Name of the service - Valued with service-instance-name" + type: "string" + type: + description: "Service type - valued with 'service-instance'" + type: "string" + state: + description: "State of the service." + type: "string" + '@type': + description: "This attribute allows to dynamically extends TMF class. Not\ + \ used in Beijing release." + type: "string" + '@baseType': + description: "Not managed in Beijing release" + type: "string" + '@schemaLocation': + description: "Not managed in Beijing release" + type: "string" + serviceSpecification: + $ref: "#/definitions/ServiceSpecificationRef" + characteristic: + type: "array" + items: + $ref: "#/definitions/ServiceCharacteristic" + supportingResource: + type: "array" + items: + $ref: "#/definitions/SupportingResource" + relatedParty: + type: "array" + items: + $ref: "#/definitions/RelatedPartyRef" + ServiceSpecificationRef: + description: "Service specification reference: ServiceSpecification of this service\ + \ (catalog information)" + type: "object" + properties: + id: + description: "Unique identifier of the service specification. valued to model-version-id" + type: "string" + href: + description: "Reference of the service specification.\nnot managed in Beijing\ + \ release." + type: "string" + name: + description: "Name of the required service specification" + type: "string" + version: + description: "Service specification version.\nNot managed in Beijing release" + type: "string" + '@referredType': + description: "This attribute allows to dynamically extends TMF class. Valued\ + \ with 'ONAPservice'. We used this features to add following attribute:\ + \ invariantUUID" + type: "string" + '@schemaLocation': + description: "Not managed in Beijing release" + type: "string" + invariantUUID: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @referredType - model-invariant-id" + type: "string" + ServiceCharacteristic: + description: "A list of name value pairs that define the service characteristics\n\ + Not managed in Beijing release." + required: + - "name" + type: "object" + properties: + name: + description: "Name of the characteristic\nNot managed in Beijing release." + type: "string" + valueType: + description: "Type of value for this characteristic.\nNot managed in Beijing\ + \ release." + type: "string" + value: + $ref: "#/definitions/Value" + SupportingResource: + description: "Supporting resource - A supportingResource will be retrieved for\ + \ each relationship of the relationship-list where related-link describe a vnf" + type: "object" + properties: + id: + description: "Unique identifier of the supporting resource - Valued to vnf-id" + type: "string" + href: + description: "Reference of the supporting resource" + type: "string" + role: + description: "Not managed in Beijing release." + type: "string" + name: + description: "Name of the supporting resource - Valued with vnf_-name" + type: "string" + '@referredType': + description: "This attribute allows to dynamically extends TMF class. Valued\ + \ with 'ONAP resource'. We used this features to add following attributes:\n\ + \ status\t\n modelInvariantId\n modelVersionId\n modelCustomisationId" + type: "string" + '@schemaLocation': + description: "Not managed in Beijing release." + type: "string" + status: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @referredType - valued with prov-status" + type: "string" + modelInvariantId: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @referredType - valued with model-invariant-id" + type: "string" + modelVersionId: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @referredType - valued with model-verson-id" + type: "string" + modelCustomisationId: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @referredType - valued with model-customisation-id" + type: "string" + RelatedPartyRef: + description: "RelatedParty reference. A related party defines party or party role\ + \ linked to a specific entity." + type: "object" + properties: + id: + description: "Unique identifier of a related party" + type: "string" + href: + description: "Reference of a related party.\nNot filled in Beijing release." + type: "string" + role: + description: "Role played by the related party.\nFilled with 'ONAPcustomer'" + type: "string" + '@referredType': + description: "Not managed in the Beijing release." + type: "string" + Value: + description: "Structure used to describe characteristic value.\nNot managed in\ + \ Beijing release." + type: "object" + properties: + '@type': + description: "Not managed in Beijing release." + type: "string" + '@schemaLocation': + description: "Not managed in Beijing release." + type: "string" + serviceCharacteristicValue: + description: "Not managed in Beijing release." + type: "string" + ListRelatedPartyRef: + description: "This class is used to structure list of service(s) retrieved" + type: "object" + properties: + id: + description: "Unique identifier of a related party" + type: "string" + role: + description: "Role played by the related party - only role “ONAPcustomer”\ + \ is managed in Beijing release." + type: "string" + ListServiceSpecificationRef: + description: "This class is used to structure list of service(s) retrieved" + type: "object" + properties: + id: + description: "Unique identifier of the service specification" + type: "string" + name: + description: "Name of the required service specification" + type: "string" + ListService: + description: "This class is used to structure list of service(s) retrieved" + type: "object" + properties: + id: + description: "Unique identifier of the service" + type: "string" + name: + description: "Name of the service" + type: "string" + serviceSpecification: + $ref: "#/definitions/ListServiceSpecificationRef" + relatedParty: + $ref: "#/definitions/ListRelatedPartyRef" + ServiceInventoryEvent: + description: "Structure for a service inventory event notification" + required: + - "id" + - "href" + - "name" + - "type" + - "state" + - "relatedParty" + type: "object" + properties: + id: + description: "The Service Instance Id" + type: "string" + href: + description: "A reference to the service inventory" + type: "string" + name: + description: "The name of the Service Instance" + type: "string" + type: + description: "The type of event, service-instance" + type: "string" + state: + description: "The state of the service instance" + type: "string" + relatedParty: + $ref: "#/definitions/RelatedPartyRef" + Notification: + description: "Notification structure for a service notification" + required: + - "eventId" + - "eventDate" + - "eventType" + - "event" + type: "object" + properties: + eventId: + description: "" + type: "string" + eventDate: + description: "" + type: "string" + format: "date-time" + eventType: + $ref: "#/definitions/eventType" + event: + $ref: "#/definitions/ServiceInventoryEvent" -- cgit 1.2.3-korg