diff options
| author |   MatthieuGeerebaert <matthieu.geerebaert@orange.com> | 2018-10-19 16:55:55 +0200 |
|---|---|---|
| committer | MatthieuGeerebaert <matthieu.geerebaert@orange.com> | 2018-10-19 16:55:55 +0200 |
| commit | 9c35f307e7019b702b600612bc8eaf6eafc214d3 (patch) | |
| tree | 36c9220ec9d34c94d3eb596c0b8859fc3b2afd77 /docs | |
| parent | d5118bd62d2a4ce8507da47c086b7feb2420eb8c (diff) | |
Update doc
- Remove old swagger
- Update shcemas
Change-Id: I8a262aab82c3fc55e60b6d570999b569d908d62a
Issue-ID: EXTAPI-163
Signed-off-by: MatthieuGeerebaert <matthieu.geerebaert@orange.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/offeredapis/images/ONAP_External_ID_Casablanca.jpg | bin | 127034 -> 126974 bytes | |||
| -rw-r--r-- | docs/offeredapis/swaggers/serviceCatalog_1_0_0.json | 652 | ||||
| -rw-r--r-- | docs/offeredapis/swaggers/serviceCatalog_1_0_0.yaml | 492 | ||||
| -rw-r--r-- | docs/offeredapis/swaggers/serviceInventory_1_0_0.json | 620 | ||||
| -rw-r--r-- | docs/offeredapis/swaggers/serviceInventory_1_0_0.yaml | 427 | ||||
| -rw-r--r-- | docs/offeredapis/swaggers/serviceOrder_1_0_0.json | 1071 | ||||
| -rw-r--r-- | docs/offeredapis/swaggers/serviceOrder_1_0_0.yaml | 772 |
7 files changed, 0 insertions, 4034 deletions
diff --git a/docs/offeredapis/images/ONAP_External_ID_Casablanca.jpg b/docs/offeredapis/images/ONAP_External_ID_Casablanca.jpg Binary files differindex a566e42..721d9f2 100644 --- a/docs/offeredapis/images/ONAP_External_ID_Casablanca.jpg +++ b/docs/offeredapis/images/ONAP_External_ID_Casablanca.jpg diff --git a/docs/offeredapis/swaggers/serviceCatalog_1_0_0.json b/docs/offeredapis/swaggers/serviceCatalog_1_0_0.json deleted file mode 100644 index 74daf5a..0000000 --- a/docs/offeredapis/swaggers/serviceCatalog_1_0_0.json +++ /dev/null @@ -1,652 +0,0 @@ - -{ - "swagger": "2.0", - "info": { - "description": "serviceCatalog API designed for ONAP Beijing Release.\nThis API is build from TMF open API17.5\nonly operation GET (by id & byList) for resource serviceSpecification is available", - "version": "1.0.0", - "title": "API ServiceCatalog" - }, - "host": "serverRoot", - "basePath": "/nbi/api/v1", - "schemes": [ - "https" - ], - "consumes": [ - "application/json;charset=utf-8" - ], - "produces": [ - "application/json;charset=utf-8" - ], - "tags": [ - - { - "name": "ServiceSpecification", - "description": "" - } - ], - "paths": { - "/serviceSpecification": { - "get": { - "tags": [ - "ServiceSpecification" - ], - "operationId": "serviceSpecificationFind", - "summary": "List service specifications", - "description": "This operation returns service specifications from a catalog.\nOnly a predefined set of attribute is proposed : Based on SDC limitations, only attributes category and distributionStatus are available for serviceSpecification filtering\nFields attribute could be used to filter attributes retrieved\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n", - "deprecated": false, - - "parameters": [ - - { - "name": "fields", - "required": false, - "in": "query", - "description": "Field selection - used to filtering the attributes to be retreived", - - "type": "string" - }, - { - "name": "category", - "required": false, - "in": "query", - "description": "Service Category (filter)", - - "type": "string" - }, - { - "name": "distributionStatus", - "required": false, - "in": "query", - "description": "Service distribution status (filter)", - - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceSpecification" - } - } - - }, - "400": { - - "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "401": { - - "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "403": { - - "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "404": { - - "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "422": { - - "description": "Unprocessable entity\n\nFunctional error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "500": { - - "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "503": { - - "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - } - } - } - }, - "/serviceSpecification/{id}": { - "get": { - "tags": [ - "ServiceSpecification" - ], - "operationId": "serviceSpecificationGet", - "summary": "Retrieve a service specification", - "description": "This operation returns a service specification by its id from a catalog. Attribute selection is enabled using the fields attribute.\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n", - "deprecated": false, - - "parameters": [ - - { - "name": "id", - "in": "path", - "required": true, - "type": "string", - "description": "" - }, - { - "name": "fields", - "required": false, - "in": "query", - "description": "Attribute selection", - - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ServiceSpecification" - } - - }, - "400": { - - "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "401": { - - "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "403": { - - "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "404": { - - "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "422": { - - "description": "Unprocessable entity\n\nFunctional error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "500": { - - "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "503": { - - "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - } - } - } - } - }, -"definitions": { - - "LifecycleStatusValues": { - "description": "Service lifecycle value from ONAP SDC", - - "type": "string", - "enum": [ - "NOT_CERTIFIED_CHECKOUT", - "NOT_CERTIFIED_CHECKIN", - "READY_FOR_CERTIFICATION", - "CERTIFICATION_IN_PROGRESS", - "CERTIFIED"] - - }, - "DistributionStatus": { - "description": "Service distribution status from ONAP.", - - "type": "string", - "enum": [ - "DISTRIBUTION_NOT_APPROVED", - "DISTRIBUTION_APPROVED", - "DISTRIBUTED", - "DISTRIBUTION_REJECTED"] - - }, - - "ErrorRepresentation": { - "description": "This class is used to describe error.\nfor nbi Beijing release we do not manage additional error for serviceCatalog", - - - "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" - }, - "referenceErrror": { - "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" - } - } - - }, - - "TimePeriod": { - "description": "A time period", - - - "type": "object", - "properties": { - "startDateTime": { - "description": "Start date and time of the period", - "type": "string", - "format": "date-time" - }, - "endDateTime": { - "description": "End date and time of the period", - "type": "string", - "format": "date-time" - } - } - - }, - - "RelatedPartyRef": { - "description": "Party linked to the service catalog.\nin nbi we retrieve information about last updater of the service in SDC", - - - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the related party. Filled with lastUpdaterUserId", - "type": "string" - }, - "role": { - "description": "Role payed by the related party\nOnly role 'lastUpdater' is retrieved in Beijing release", - "type": "string" - }, - "name": { - "description": "Name of the related party - Filled with lastUpdatedFullName", - "type": "string" - } - } - - }, - - "ServiceSpecification": { - "description": "ServiceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics.\nthe service information are retrieved in SDC", - - - "required": [ - - "invariantUUID" - ], - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the service specification. Filled with SDC Service uuid", - "type": "string" - }, - "href": { - "description": "Reference of the service specification- not mapped in Beijing", - "type": "string" - }, - "name": { - "description": "Name of the service specification- Filled with SDC Service name", - "type": "string" - }, - "description": { - "description": "A narrative that explains in detail what the service specification is - Filled with SDC Service description", - "type": "string" - }, - "@type": { - "description": "This attribute allows to dynamically extends TMF class. Valued with 'ONAPservice'. We used this features to add following attributes:\ninvariantUUID\ntoscaModelURL\ntoscaResourceName\ncategory (1)\nsubcategory (1)\ndistributionStatus", - "type": "string", - - "default": "ONAPservice" - }, - "@schemaLocation": { - "description": "Not used for Beijing release", - "type": "string" - }, - "@baseType": { - "description": "Not used for Beijing release", - "type": "string" - }, - "invariantUUID": { - "description": "Additional attribute (not in the TMF API) - extended through @type - invariantUUID", - "type": "string" - }, - "toscaModelURL": { - "description": "Additional attribute (not in the TMF API) - extended through @type - toscaModelURL", - "type": "string" - }, - "toscaResourceName": { - "description": "Additional attribute (not in the TMF API) - extended through @type - toscaResourceName", - "type": "string" - }, - "category": { - "description": "Additional attribute - extended through @type - category\nPlease note that this attribute is managed in TMF - in future release we'll introduce category resource", - "type": "string" - }, - "subcategory": { - "description": "Additional attribute - extended through @type - category\nPlease note that this attribute is managed in TMF - in future release we'll introduce category resourc", - "type": "string" - }, - "distributionStatus": { - - "$ref": "#/definitions/DistributionStatus" - }, - "version": { - "description": "Service specification version - Filled with SDC Service version", - "type": "string" - }, - "lifecycleStatus": { - - "$ref": "#/definitions/LifecycleStatusValues" - }, - "targetServiceSchema": { - - "$ref": "#/definitions/TargetServiceSchemaRef" - }, - "attachment": { - - "type": "array", - "items": { - "$ref": "#/definitions/Attachment" - } - }, - "relatedParty": { - - "type": "array", - "items": { - "$ref": "#/definitions/RelatedPartyRef" - } - }, - "resourceSpecification": { - - "type": "array", - "items": { - "$ref": "#/definitions/ResourceSpecificationRef" - } - }, - "serviceSpecCharacteristic": { - - "type": "array", - "items": { - "$ref": "#/definitions/ServiceSpecCharacteristic" - } - } - } - - }, - - "ServiceSpecCharacteristic": { - "description": "A characteristic quality or distinctive feature of a ServiceSpecification. \nServiceSpecCharacteristic are retrieved in the serviceTosca file in the topology_template section in the inputs section.", - - - "type": "object", - "properties": { - "name": { - "description": "Name of the characteristic - Filled with parameter_name", - "type": "string" - }, - "description": { - "description": "A narrative that explains in detail what the characteristic is - Filled with parameter_description", - "type": "string" - }, - "valueType": { - "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth - Filled with parameter_type", - "type": "string" - }, - "@type": { - "description": "This attribute allows to dynamically extends TMF class. Valued with: 'ONAPserviceCharacteristic'. We do not used this features in nbi Beijing release.", - "type": "string" - }, - "@schemaLocation": { - "description": "An url pointing to type description - we do not use it in nbi Beijing release", - "type": "string" - }, - "required": { - "description": "A parameter to define if the characteristic is mandatory - Filled from parameter_required – if not fielded by default ‘true’", - "type": "boolean", - - "default": true - }, - "status": { - "description": "Status of the characteristic - filled with status_value", - "type": "string" - }, - "serviceSpecCharacteristicValue": { - - "type": "array", - "items": { - "$ref": "#/definitions/ServiceSpecCharacteristicValue" - } - } - } - - }, - - "Attachment": { - "description": "An attachment is a file uses to describe the service.\nIn nbi we use attachment to retrieve ONAP artifacts.", - - - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the attachment - filled with artifactUUID.", - "type": "string" - }, - "name": { - "description": "Name of the attachment - filled with artifactName", - "type": "string" - }, - "description": { - "description": "Description of the attachment - filled with artifactDescription", - "type": "string" - }, - "@type": { - "description": "This attribute allows to dynamically extends TMF class. Valued with 'ONAPartifact'. We used this features to add following attributes: \nartifactLabel\nartifactGroupType\nartifactTimeout\nartifactChecksum\nartifactVersion\ngeneratedFromUUID", - "type": "string", - - "default": "ONAPartifact" - }, - "artifactLabel": { - "description": "Additional attribute (not in the TMF API) - extended through @type - artifactLabel", - "type": "string" - }, - "artifactGroupType": { - "description": "Additional attribute (not in the TMF API) - extended through @type - artifactGroupType", - "type": "string" - }, - "artifactTimeout": { - "description": "Additional attribute (not in the TMF API) - extended through @type - artifactTimeout", - "type": "string" - }, - "artifactChecksum": { - "description": "Additional attribute (not in the TMF API) - extended through @type - artifactChecksum", - "type": "string" - }, - "artifactVersion": { - "description": "Additional attribute (not in the TMF API) - extended through @type - artifactVersion", - "type": "string" - }, - "generatedFromUUID": { - "description": "Additional attribute (not in the TMF API) - extended through @type - generatedFromUUID", - "type": "string" - }, - "url": { - "description": "Uniform Resource Locator, is a web page address - filled with artifactURL", - "type": "string" - }, - "mimeType": { - "description": "Filled with artifactType", - "type": "string" - } - } - - }, - - "ServiceSpecCharacteristicValue": { - "description": "A number or text that can be assigned to a service specification characteristic.\nServiceSpecCharacteristicValue are retrieved in the service Tosca file", - - - "type": "object", - "properties": { - "valueType": { - "description": "A kind of value that the characteristic can take on, such as numeric, text, and so forth\nRetrieved in the Tosca in the topology_template section in the inputs section - parameter_type. \nWe do not manage parameter_type= list or map for Beijing release", - "type": "string" - }, - "isDefault": { - "description": "Information calculated from parameter default in the Tosca file", - "type": "boolean" - }, - "value": { - "description": "A discrete value that the characteristic can take on", - "type": "string" - } - } - - }, - - "ResourceSpecificationRef": { - "description": "A list of resourceSpec identified to deliver the service.\nfor nbi we retrieve resource information available in service description (through SDC api) bu as well information retrieved in the TOSCA file.", - - - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the resource specification - filled with resourceUUID", - "type": "string" - }, - "version": { - "description": "Version for this resource specification - filled with resourceVersion", - "type": "string" - }, - "name": { - "description": "Name of the resource specification - filled with resourceName", - "type": "string" - }, - "@type": { - "description": "This attribute allows to dynamically extends TMF class. Valued with: 'ONAPresource'. We used this features to add following attributes:\nresourceInstanceName\nresourceInvariantUUID\nresourceType\nmodelCustomizationName\nmodelCustomizationId", - "type": "string", - - "default": "ONAPresource" - }, - "resourceInstanceName": { - "description": "Additional attribute (not in the TMF API) - extended through @type - resourceInstanceName", - "type": "string" - }, - "resourceInvariantUUID": { - "description": "Additional attribute (not in the TMF API) - extended through @type - resourceInvariantUUID", - "type": "string" - }, - "resourceType": { - "description": "Additional attribute (not in the TMF API) - extended through @type - resoucreType", - "type": "string" - }, - "modelCustomizationName": { - "description": "Additional attribute (not in the TMF API) - extended through @type - Retrieved in the TOSCA file : attribute name in topology_template/node_template for the resource", - "type": "string" - }, - "modelCustomizationId": { - "description": "Additional attribute (not in the TMF API) - extended through @type - Retrieved in the TOSCA file : attribute customizationUUID in topology_template/node_template for the resource", - "type": "string" - } - } - - }, - - "TargetServiceSchemaRef": { - "description": "", - - - "required": [ - - "@type", - "@schemaLocation" - ], - "type": "object", - "properties": { - "@type": { - "description": "", - "type": "string" - }, - "@schemaLocation": { - "description": "", - "type": "string" - } - } - - } - } -} -
\ No newline at end of file diff --git a/docs/offeredapis/swaggers/serviceCatalog_1_0_0.yaml b/docs/offeredapis/swaggers/serviceCatalog_1_0_0.yaml deleted file mode 100644 index ab6eaa9..0000000 --- a/docs/offeredapis/swaggers/serviceCatalog_1_0_0.yaml +++ /dev/null @@ -1,492 +0,0 @@ -# This work is licensed under a Creative Commons Attribution 4.0 International License. -# http://creativecommons.org/licenses/by/4.0 -# Copyright 2018 Orange - -swagger: "2.0" -info: - description: "serviceCatalog API designed for ONAP Beijing Release.\nThis API is\ - \ build from TMF open API17.5\nonly operation GET (by id & byList) for resource\ - \ serviceSpecification is available" - version: "1.0.0" - title: "API ServiceCatalog" -host: "serverRoot" -basePath: "/nbi/api/v1" -schemes: -- "https" -consumes: -- "application/json;charset=utf-8" -produces: -- "application/json;charset=utf-8" -tags: -- name: "ServiceSpecification" - description: "" -paths: - /serviceSpecification: - get: - tags: - - "ServiceSpecification" - operationId: "serviceSpecificationFind" - summary: "List service specifications" - description: "This operation returns service specifications from a catalog.\n\ - Only a predefined set of attribute is proposed : Based on SDC limitations,\ - \ only attributes category and distributionStatus are available for serviceSpecification\ - \ filtering\nFields attribute could be used to filter attributes retrieved\n\ - \nSpecific business errors for current operation will be encapsulated in\n\ - \nHTTP Response 422 Unprocessable entity\n" - deprecated: false - parameters: - - name: "fields" - required: false - in: "query" - description: "Field selection - used to filtering the attributes to be retreived" - type: "string" - - name: "category" - required: false - in: "query" - description: "Service Category (filter)" - type: "string" - - name: "distributionStatus" - required: false - in: "query" - description: "Service distribution status (filter)" - type: "string" - responses: - 200: - description: "Success" - schema: - type: "array" - items: - $ref: "#/definitions/ServiceSpecification" - 400: - description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ - \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ - \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ - \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ - \ parameter value" - schema: - $ref: "#/definitions/ErrorRepresentation" - 401: - description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ - \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" - schema: - $ref: "#/definitions/ErrorRepresentation" - 403: - description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ - \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ - \ requests" - schema: - $ref: "#/definitions/ErrorRepresentation" - 404: - description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ - \ not found" - schema: - $ref: "#/definitions/ErrorRepresentation" - 422: - description: "Unprocessable entity\n\nFunctional error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 500: - description: "Internal Server Error\n\nList of supported error codes:\n\ - - 1: Internal error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 503: - description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ - \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ - \ retry later !" - schema: - $ref: "#/definitions/ErrorRepresentation" - /serviceSpecification/{id}: - get: - tags: - - "ServiceSpecification" - operationId: "serviceSpecificationGet" - summary: "Retrieve a service specification" - description: "This operation returns a service specification by its id from\ - \ a catalog. Attribute selection is enabled using the fields attribute.\n\n\ - Specific business errors for current operation will be encapsulated in\n\n\ - HTTP Response 422 Unprocessable entity\n" - deprecated: false - parameters: - - name: "id" - in: "path" - required: true - type: "string" - description: "" - - name: "fields" - required: false - in: "query" - description: "Attribute selection" - type: "string" - responses: - 200: - description: "Success" - schema: - $ref: "#/definitions/ServiceSpecification" - 400: - description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ - \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ - \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ - \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ - \ parameter value" - schema: - $ref: "#/definitions/ErrorRepresentation" - 401: - description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ - \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" - schema: - $ref: "#/definitions/ErrorRepresentation" - 403: - description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ - \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ - \ requests" - schema: - $ref: "#/definitions/ErrorRepresentation" - 404: - description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ - \ not found" - schema: - $ref: "#/definitions/ErrorRepresentation" - 422: - description: "Unprocessable entity\n\nFunctional error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 500: - description: "Internal Server Error\n\nList of supported error codes:\n\ - - 1: Internal error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 503: - description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ - \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ - \ retry later !" - schema: - $ref: "#/definitions/ErrorRepresentation" -definitions: - LifecycleStatusValues: - description: "Service lifecycle value from ONAP SDC" - type: "string" - enum: - - "NOT_CERTIFIED_CHECKOUT" - - "NOT_CERTIFIED_CHECKIN" - - "READY_FOR_CERTIFICATION" - - "CERTIFICATION_IN_PROGRESS" - - "CERTIFIED" - DistributionStatus: - description: "Service distribution status from ONAP." - type: "string" - enum: - - "DISTRIBUTION_NOT_APPROVED" - - "DISTRIBUTION_APPROVED" - - "DISTRIBUTED" - - "DISTRIBUTION_REJECTED" - ErrorRepresentation: - description: "This class is used to describe error.\nfor nbi Beijing release we\ - \ do not manage additional error for serviceCatalog" - 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" - referenceErrror: - 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" - TimePeriod: - description: "A time period" - type: "object" - properties: - startDateTime: - description: "Start date and time of the period" - type: "string" - format: "date-time" - endDateTime: - description: "End date and time of the period" - type: "string" - format: "date-time" - RelatedPartyRef: - description: "Party linked to the service catalog.\nin nbi we retrieve information\ - \ about last updater of the service in SDC" - type: "object" - properties: - id: - description: "Unique identifier of the related party. Filled with lastUpdaterUserId" - type: "string" - role: - description: "Role payed by the related party\nOnly role 'lastUpdater' is\ - \ retrieved in Beijing release" - type: "string" - name: - description: "Name of the related party - Filled with lastUpdatedFullName" - type: "string" - ServiceSpecification: - description: "ServiceSpecification is a class that offers characteristics to describe\ - \ a type of service. Functionally, it acts as a template by which Services may\ - \ be instantiated. By sharing the same specification, these services would therefore\ - \ share the same set of characteristics.\nthe service information are retrieved\ - \ in SDC" - required: - - "invariantUUID" - type: "object" - properties: - id: - description: "Unique identifier of the service specification. Filled with\ - \ SDC Service uuid" - type: "string" - href: - description: "Reference of the service specification- not mapped in Beijing" - type: "string" - name: - description: "Name of the service specification- Filled with SDC Service name" - type: "string" - description: - description: "A narrative that explains in detail what the service specification\ - \ is - Filled with SDC Service description" - type: "string" - '@type': - description: "This attribute allows to dynamically extends TMF class. Valued\ - \ with 'ONAPservice'. We used this features to add following attributes:\n\ - invariantUUID\ntoscaModelURL\ntoscaResourceName\ncategory (1)\nsubcategory\ - \ (1)\ndistributionStatus" - type: "string" - default: "ONAPservice" - '@schemaLocation': - description: "Not used for Beijing release" - type: "string" - '@baseType': - description: "Not used for Beijing release" - type: "string" - invariantUUID: - description: "Additional attribute (not in the TMF API) - extended through\ - \ @type - invariantUUID" - type: "string" - toscaModelURL: - description: "Additional attribute (not in the TMF API) - extended through\ - \ @type - toscaModelURL" - type: "string" - toscaResourceName: - description: "Additional attribute (not in the TMF API) - extended through\ - \ @type - toscaResourceName" - type: "string" - category: - description: "Additional attribute - extended through @type - category\nPlease\ - \ note that this attribute is managed in TMF - in future release we'll introduce\ - \ category resource" - type: "string" - subcategory: - description: "Additional attribute - extended through @type - category\nPlease\ - \ note that this attribute is managed in TMF - in future release we'll introduce\ - \ category resourc" - type: "string" - distributionStatus: - $ref: "#/definitions/DistributionStatus" - version: - description: "Service specification version - Filled with SDC Service version" - type: "string" - lifecycleStatus: - $ref: "#/definitions/LifecycleStatusValues" - targetServiceSchema: - $ref: "#/definitions/TargetServiceSchemaRef" - attachment: - type: "array" - items: - $ref: "#/definitions/Attachment" - relatedParty: - type: "array" - items: - $ref: "#/definitions/RelatedPartyRef" - resourceSpecification: - type: "array" - items: - $ref: "#/definitions/ResourceSpecificationRef" - serviceSpecCharacteristic: - type: "array" - items: - $ref: "#/definitions/ServiceSpecCharacteristic" - ServiceSpecCharacteristic: - description: "A characteristic quality or distinctive feature of a ServiceSpecification.\ - \ \nServiceSpecCharacteristic are retrieved in the serviceTosca file in the\ - \ topology_template section in the inputs section." - type: "object" - properties: - name: - description: "Name of the characteristic - Filled with parameter_name" - type: "string" - description: - description: "A narrative that explains in detail what the characteristic\ - \ is - Filled with parameter_description" - type: "string" - valueType: - description: "A kind of value that the characteristic can take on, such as\ - \ numeric, text and so forth - Filled with parameter_type" - type: "string" - '@type': - description: "This attribute allows to dynamically extends TMF class. Valued\ - \ with: 'ONAPserviceCharacteristic'. We do not used this features in nbi\ - \ Beijing release." - type: "string" - '@schemaLocation': - description: "An url pointing to type description - we do not use it in nbi\ - \ Beijing release" - type: "string" - required: - description: "A parameter to define if the characteristic is mandatory - Filled\ - \ from parameter_required – if not fielded by default ‘true’" - type: "boolean" - default: true - status: - description: "Status of the characteristic - filled with status_value" - type: "string" - serviceSpecCharacteristicValue: - type: "array" - items: - $ref: "#/definitions/ServiceSpecCharacteristicValue" - Attachment: - description: "An attachment is a file uses to describe the service.\nIn nbi we\ - \ use attachment to retrieve ONAP artifacts." - type: "object" - properties: - id: - description: "Unique identifier of the attachment - filled with artifactUUID." - type: "string" - name: - description: "Name of the attachment - filled with artifactName" - type: "string" - description: - description: "Description of the attachment - filled with artifactDescription" - type: "string" - '@type': - description: "This attribute allows to dynamically extends TMF class. Valued\ - \ with 'ONAPartifact'. We used this features to add following attributes:\ - \ \nartifactLabel\nartifactGroupType\nartifactTimeout\nartifactChecksum\n\ - artifactVersion\ngeneratedFromUUID" - type: "string" - default: "ONAPartifact" - artifactLabel: - description: "Additional attribute (not in the TMF API) - extended through\ - \ @type - artifactLabel" - type: "string" - artifactGroupType: - description: "Additional attribute (not in the TMF API) - extended through\ - \ @type - artifactGroupType" - type: "string" - artifactTimeout: - description: "Additional attribute (not in the TMF API) - extended through\ - \ @type - artifactTimeout" - type: "string" - artifactChecksum: - description: "Additional attribute (not in the TMF API) - extended through\ - \ @type - artifactChecksum" - type: "string" - artifactVersion: - description: "Additional attribute (not in the TMF API) - extended through\ - \ @type - artifactVersion" - type: "string" - generatedFromUUID: - description: "Additional attribute (not in the TMF API) - extended through\ - \ @type - generatedFromUUID" - type: "string" - url: - description: "Uniform Resource Locator, is a web page address - filled with\ - \ artifactURL" - type: "string" - mimeType: - description: "Filled with artifactType" - type: "string" - ServiceSpecCharacteristicValue: - description: "A number or text that can be assigned to a service specification\ - \ characteristic.\nServiceSpecCharacteristicValue are retrieved in the service\ - \ Tosca file" - type: "object" - properties: - valueType: - description: "A kind of value that the characteristic can take on, such as\ - \ numeric, text, and so forth\nRetrieved in the Tosca in the topology_template\ - \ section in the inputs section - parameter_type. \nWe do not manage parameter_type=\ - \ list or map for Beijing release" - type: "string" - isDefault: - description: "Information calculated from parameter default in the Tosca file" - type: "boolean" - value: - description: "A discrete value that the characteristic can take on" - type: "string" - ResourceSpecificationRef: - description: "A list of resourceSpec identified to deliver the service.\nfor nbi\ - \ we retrieve resource information available in service description (through\ - \ SDC api) bu as well information retrieved in the TOSCA file." - type: "object" - properties: - id: - description: "Unique identifier of the resource specification - filled with\ - \ resourceUUID" - type: "string" - version: - description: "Version for this resource specification - filled with resourceVersion" - type: "string" - name: - description: "Name of the resource specification - filled with resourceName" - type: "string" - '@type': - description: "This attribute allows to dynamically extends TMF class. Valued\ - \ with: 'ONAPresource'. We used this features to add following attributes:\n\ - resourceInstanceName\nresourceInvariantUUID\nresourceType\nmodelCustomizationName\n\ - modelCustomizationId" - type: "string" - default: "ONAPresource" - resourceInstanceName: - description: "Additional attribute (not in the TMF API) - extended through\ - \ @type - resourceInstanceName" - type: "string" - resourceInvariantUUID: - description: "Additional attribute (not in the TMF API) - extended through\ - \ @type - resourceInvariantUUID" - type: "string" - resourceType: - description: "Additional attribute (not in the TMF API) - extended through\ - \ @type - resoucreType" - type: "string" - modelCustomizationName: - description: "Additional attribute (not in the TMF API) - extended through\ - \ @type - Retrieved in the TOSCA file : attribute name in topology_template/node_template\ - \ for the resource" - type: "string" - modelCustomizationId: - description: "Additional attribute (not in the TMF API) - extended through\ - \ @type - Retrieved in the TOSCA file : attribute customizationUUID in topology_template/node_template\ - \ for the resource" - type: "string" - TargetServiceSchemaRef: - description: "" - required: - - "@type" - - "@schemaLocation" - type: "object" - properties: - '@type': - description: "" - type: "string" - '@schemaLocation': - description: "" - type: "string" diff --git a/docs/offeredapis/swaggers/serviceInventory_1_0_0.json b/docs/offeredapis/swaggers/serviceInventory_1_0_0.json deleted file mode 100644 index 5c2c7c5..0000000 --- a/docs/offeredapis/swaggers/serviceInventory_1_0_0.json +++ /dev/null @@ -1,620 +0,0 @@ - -{ - "swagger": "2.0", - "info": { - "description": "serviceInventory API designed for ONAP Beijing Release.\nThis API is build from TMF open API18.0 (applying TMF Guideline 3.0)\nonly operation GET (by id & byList) for resource serviceSpecification is available", - "version": "1.0.0", - "title": "API ServiceInventory" - }, - - "host": "serverRoot", - "basePath": "/nbi/api/v1", - "schemes": [ - "https" - ], - "consumes": [ - "application/json;charset=utf-8" - ], - "produces": [ - "application/json;charset=utf-8" - ], - "tags": [ - - { - "name": "Service", - "description": "" - } - ], - "paths": { - "/service": { - "get": { - "tags": [ - "Service" - ], - "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\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n", - "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": "Success", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/ListService" - } - } - - }, - "400": { - - "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "401": { - - "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "403": { - - "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "404": { - - "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "422": { - - "description": "Unprocessable entity\n\nFunctional error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "500": { - - "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "503": { - - "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - } - } - } - }, - "/service/{id}": { - "get": { - "tags": [ - "Service" - ], - "operationId": "serviceGet", - "summary": "Retrieve a service", - "description": "This operation retrieves a service entity. \nAttribute selection is enabled for all first level attributes.\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n", - "deprecated": false, - - "parameters": [ - - { - "name": "id", - "in": "path", - "required": true, - "type": "string", - "description": "" - }, - { - "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" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Service" - } - - }, - "400": { - - "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "401": { - - "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "403": { - - "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "404": { - - "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "422": { - - "description": "Unprocessable entity\n\nFunctional error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "500": { - - "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "503": { - - "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - } - } - } - } - }, -"definitions": { - - "stateValues": { - "description": "", - - "type": "string", - "enum": [ - "feasibilityChecked", - "designed", - "reserved", - "inactive", - "active", - "terminated"] - - }, - - "ErrorRepresentation": { - "description": "This class is used to describe error.\nfor nbi Beijing release we do not manage additional error for serviceCatalog", - - - "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": { - - "$ref": "#/definitions/stateValues" - }, - "hasStarted": { - "description": "This is a Boolean attribute that, if TRUE, signifies that this Service has already been started. If the value of this attribute is FALSE, then this signifies that this Service has NOT been Started\nNot managed in Beijing release", - "type": "boolean" - }, - "@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.\nOnly ONAP Customer is managed in Beijing release.", - - - "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" - } - } - - } - } -} -
\ No newline at end of file diff --git a/docs/offeredapis/swaggers/serviceInventory_1_0_0.yaml b/docs/offeredapis/swaggers/serviceInventory_1_0_0.yaml deleted file mode 100644 index c4a169e..0000000 --- a/docs/offeredapis/swaggers/serviceInventory_1_0_0.yaml +++ /dev/null @@ -1,427 +0,0 @@ -# This work is licensed under a Creative Commons Attribution 4.0 International License. -# http://creativecommons.org/licenses/by/4.0 -# Copyright 2018 Orange - -swagger: "2.0" -info: - description: "serviceInventory API designed for ONAP Beijing Release.\nThis API\ - \ is build from TMF open API18.0 (applying TMF Guideline 3.0)\nonly operation\ - \ GET (by id & byList) for resource serviceSpecification is available" - version: "1.0.0" - title: "API ServiceInventory" -host: "serverRoot" -basePath: "/nbi/api/v1" -schemes: -- "https" -consumes: -- "application/json;charset=utf-8" -produces: -- "application/json;charset=utf-8" -tags: -- name: "Service" - description: "" -paths: - /service: - get: - tags: - - "Service" - 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\n\nSpecific business errors for current operation will\ - \ be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n" - 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: "Success" - schema: - type: "array" - items: - $ref: "#/definitions/ListService" - 400: - description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ - \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ - \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ - \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ - \ parameter value" - schema: - $ref: "#/definitions/ErrorRepresentation" - 401: - description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ - \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" - schema: - $ref: "#/definitions/ErrorRepresentation" - 403: - description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ - \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ - \ requests" - schema: - $ref: "#/definitions/ErrorRepresentation" - 404: - description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ - \ not found" - schema: - $ref: "#/definitions/ErrorRepresentation" - 422: - description: "Unprocessable entity\n\nFunctional error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 500: - description: "Internal Server Error\n\nList of supported error codes:\n\ - - 1: Internal error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 503: - description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ - \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ - \ retry later !" - schema: - $ref: "#/definitions/ErrorRepresentation" - /service/{id}: - get: - tags: - - "Service" - operationId: "serviceGet" - summary: "Retrieve a service" - description: "This operation retrieves a service entity. \nAttribute selection\ - \ is enabled for all first level attributes.\n\nSpecific business errors for\ - \ current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable\ - \ entity\n" - deprecated: false - parameters: - - name: "id" - in: "path" - required: true - type: "string" - description: "" - - 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" - responses: - 200: - description: "Success" - schema: - $ref: "#/definitions/Service" - 400: - description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ - \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ - \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ - \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ - \ parameter value" - schema: - $ref: "#/definitions/ErrorRepresentation" - 401: - description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ - \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" - schema: - $ref: "#/definitions/ErrorRepresentation" - 403: - description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ - \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ - \ requests" - schema: - $ref: "#/definitions/ErrorRepresentation" - 404: - description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ - \ not found" - schema: - $ref: "#/definitions/ErrorRepresentation" - 422: - description: "Unprocessable entity\n\nFunctional error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 500: - description: "Internal Server Error\n\nList of supported error codes:\n\ - - 1: Internal error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 503: - description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ - \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ - \ retry later !" - schema: - $ref: "#/definitions/ErrorRepresentation" -definitions: - stateValues: - description: "" - type: "string" - enum: - - "feasibilityChecked" - - "designed" - - "reserved" - - "inactive" - - "active" - - "terminated" - ErrorRepresentation: - description: "This class is used to describe error.\nfor nbi Beijing release we\ - \ do not manage additional error for serviceCatalog" - 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: - $ref: "#/definitions/stateValues" - hasStarted: - description: "This is a Boolean attribute that, if TRUE, signifies that this\ - \ Service has already been started. If the value of this attribute is FALSE,\ - \ then this signifies that this Service has NOT been Started\nNot managed\ - \ in Beijing release" - type: "boolean" - '@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.\nOnly ONAP Customer is managed in Beijing release." - 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" diff --git a/docs/offeredapis/swaggers/serviceOrder_1_0_0.json b/docs/offeredapis/swaggers/serviceOrder_1_0_0.json deleted file mode 100644 index b2ffb2c..0000000 --- a/docs/offeredapis/swaggers/serviceOrder_1_0_0.json +++ /dev/null @@ -1,1071 +0,0 @@ - -{ - "swagger": "2.0", - "info": { - "description": "serviceOrder API designed for ONAP Beijing Release.\nThis API is build from TMF open API18.0 (applying TMF Guideline 3.0);\nOnly operations GET (by id and list) and POST are available.", - "version": "1.0.0_inProgress", - "title": "API ServiceOrder", - "x-logo": { - "url": "/redoc/logo.png", - "backgroundColor": "#FFFFFF" - } - }, - - "host": "serverRoot", - "basePath": "/nbi/api/v1", - "schemes": [ - "https" - ], - "consumes": [ - "application/json;charset=utf-8" - ], - "produces": [ - "application/json;charset=utf-8" - ], - "tags": [ - - { - "name": "ServiceOrder", - "description": "A Service Order is a type of order which can be used to describe a group of operations on service – one service order item per service. An action at the level of the service order item describe the operation to be done on a service (add, terminate for example). The service order is triggered from the BSS system in charge of the product order management to ONAP that will manage the service fulfillment." - } - ], - "paths": { - "/serviceOrder": { - "post": { - "tags": [ - "ServiceOrder" - ], - "operationId": "serviceOrderCreate", - "summary": "Create a service order", - "description": "This operation creates a service order entity.\nThe TMF Open API specification document provides the list of mandatory and non mandatory attributes when creating a ServiceOrder, including any possible rule conditions and applicable default values.\nPOST should be used without specifying the id and the href, the Service Order Management system is in charge of generating the id + href for the ServiceOrder.\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n\n - 100: OrderItem with 'add' action but serviceSpecification id missing\n \n - 101: OrderItem with 'change'/'noChange'/'remove' but service id missing\n \n - 102: OrderItem with 'add' action - serviceSpecification id provided but not existing\n \n - 103: OrderItem with 'add' action but service id already existing in the inventory\n \n - 104: A customer for existing service(s) is provided but he did not exist\n \n - 105: OrderItem with 'change'/'noChange'/'remove' - Service id provided but it is not existing in the inventory\n \n - 106: [Not managed for current Relese] Issue with lcpCloudRegionId and tenantId provided\n ", - "deprecated": false, - - "parameters": [ - - { - "name": "serviceOrder", - "required": true, - "in": "body", - "description": "", - "schema": { - "$ref": "#/definitions/CreateServiceOrder" - } - } - ], - "responses": { - "201": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ServiceOrder" - } - - }, - "400": { - - "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "401": { - - "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "403": { - - "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "404": { - - "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "422": { - - "description": "Unprocessable entity\n\nFunctional error\n\nSpecific encapsulated business errors for current operation\n\n - 100: OrderItem with 'add' action but serviceSpecification id missing\n \n - 101: OrderItem with 'change'/'noChange'/'remove' but service id missing\n \n - 102: OrderItem with 'add' action - serviceSpecification id provided but not existing\n \n - 103: OrderItem with 'add' action but service id already existing in the inventory\n \n - 104: A customer for existing service(s) is provided but he did not exist\n \n - 105: OrderItem with 'change'/'noChange'/'remove' - Service id provided but it is not existing in the inventory\n \n - 106: [Not managed for current Relese] Issue with lcpCloudRegionId and tenantId provided\n ", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "500": { - - "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "503": { - - "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - } - } - }, - "get": { - "tags": [ - "ServiceOrder" - ], - "operationId": "serviceOrderFind", - "summary": "List service orders", - "description": "Retrieve and list service order entities according to given criteria.\nOnly a predefined set of attribute is proposed.\nAttribute selection could be described in the fields attribute.\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n", - "deprecated": false, - - "parameters": [ - - { - "name": "externalId", - "required": false, - "in": "query", - "description": "", - - "type": "string" - }, - { - "name": "state", - "required": false, - "in": "query", - "description": "state of the order(s) to be retrieved", - - "type": "string" - }, - { - "name": "description", - "required": false, - "in": "query", - "description": "", - - "type": "string" - }, - { - "name": "orderDate.gt", - "required": false, - "in": "query", - "description": "order date greather than", - - "type": "string" - }, - { - "name": "orderDate.lt", - "required": false, - "in": "query", - "description": "order date lower than", - - "type": "string" - }, - { - "name": "fields", - "required": false, - "in": "query", - "description": "this attribute could be used to filter retrieved attribute(s) and/or sort SO.", - - "type": "string" - }, - { - "name": "offset", - "required": false, - "in": "query", - "description": "The index of the first element to retrieve. Zero is the first element of the collection.", - - "type": "integer", - "format": "int32" - }, - { - "name": "limit", - "required": false, - "in": "query", - "description": "The maximum number of elements to retrieve (it can be greater than the actual available number of items).", - - "type": "integer", - "format": "int32" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/ServiceOrder" - } - }, - "headers": { - "X-Total-Count": { - "description": "", - "type": "integer", - "format": "int32" - }, - "X-Result-Count": { - "description": "", - "type": "integer", - "format": "int32" - } - } - - }, - "400": { - - "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "401": { - - "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "403": { - - "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "404": { - - "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "422": { - - "description": "Unprocessable entity\n\nFunctional error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "500": { - - "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "503": { - - "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - } - } - } - }, - "/serviceOrder/{id}": { - "get": { - "tags": [ - "ServiceOrder" - ], - "operationId": "serviceOrderGet", - "summary": "Retrieve a service order", - "description": "This operation retrieves a service order entity. \nAttribute selection is enabled for all first level attributes.\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n", - "deprecated": false, - - "parameters": [ - - { - "name": "id", - "in": "path", - "required": true, - "type": "string", - "description": "" - }, - { - "name": "fields", - "required": false, - "in": "query", - "description": "Attribute selection", - - "type": "string" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ServiceOrder" - } - - }, - "400": { - - "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "401": { - - "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "403": { - - "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "404": { - - "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "422": { - - "description": "Unprocessable entity\n\nFunctional error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "500": { - - "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - }, - "503": { - - "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", - "schema": { - - "$ref": "#/definitions/ErrorRepresentation" - } - } - } - } - } - }, -"definitions": { - - "ActionType": { - "description": "Action type to be describer on the order item.\nmodify is not managed in Beijing release", - - "type": "string", - "enum": [ - "add", - "modify", - "delete", - "noChange"] - - }, - "StateType": { - "description": "List of possible state for the order and the orderItem.", - - "type": "string", - "enum": [ - "acknowledged", - "rejected", - "pending", - "held", - "inProgress", - "cancelled", - "completed", - "failed", - "partial"] - - }, - "RelationshipType": { - "description": "Relationship type;\nOnly reliesOn is managed in Beijing release.", - - "type": "string", - "enum": [ - "reliesOn"] - - }, - - "ErrorRepresentation": { - "description": "Representation of an 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" - } - } - - }, - - "ServiceRelationship": { - "description": "Linked Services to the one instantiate\nnbi component used this relationship to sort request to ONAP.", - - - "required": [ - - "type", - "service" - ], - "type": "object", - "properties": { - "type": { - - "$ref": "#/definitions/RelationshipType" - }, - "service": { - - "$ref": "#/definitions/Service" - } - } - - }, - - "ServiceRef": { - "description": "Service references", - - - "required": [ - - "id" - ], - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the service", - "type": "string" - }, - "href": { - "description": "Reference of the service", - "type": "string" - } - } - - }, - - "ServiceCharacteristic": { - "description": "ServiceCharacteristic", - - - "required": [ - - "name" - ], - "type": "object", - "properties": { - "name": { - "description": "Name of characteristic", - "type": "string" - }, - "valueType": { - "description": "", - "type": "string" - }, - "value": { - - "$ref": "#/definitions/Value" - } - } - - }, - - "RelatedParty": { - "description": "A related party defines party which are involved in this order and the role they are playing.\nfor Beijing release:\nWith the current version of APIs used from SO and AAI we need to manage a ‘customer’. This customer concept is confusing with Customer BSS concept. We took the following rules to manage the ‘customer’ information:\no\tIt could be provided through a serviceOrder in the service Order a relatedParty with role ‘ONAPcustomer’ should be provided in the serviceOrder header (we will not consider in this release the party at item level); External API component will check if this customer exists and create it in AAI if not.\no\tIf no relatedParty are provided the service will be affected to ‘generic’ customer (dummy customer) – we assume this ‘generic’ customer always exists.", - - - "required": [ - - "id", - "role" - ], - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of a related party", - "type": "string" - }, - "href": { - "description": "An hyperlink to the party - not used in Beijnig release", - "type": "string" - }, - "role": { - "description": "The role of the related party (e.g. Owner, requester, fullfiller etc).\nONLY 'ONAPcustomer' is considered", - "type": "string" - }, - "name": { - "description": "Name of the related party", - "type": "string" - }, - "@referredType": { - "description": "", - "type": "string" - } - } - - }, - - "ServiceSpecificationRef": { - "description": "The service specification (these attributes are fetched from the catalogue).", - - - "required": [ - - "id" - ], - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the service specification\nThis information will be used to retrieve SDC information + mapped to SO ModelNameVersionIdin the request.", - "type": "string" - }, - "href": { - "description": "Reference of the service specification\nNot used in Beijing release.", - "type": "string" - }, - "name": { - "description": "Name of the service specification\nNot used in Beijing release", - "type": "string" - }, - "version": { - "description": "Version of the service Specification\nNot used in Beijing release", - "type": "string" - }, - "targetServiceSchema": { - - "$ref": "#/definitions/TargetServiceSchema" - }, - "@type": { - "description": "Not used in Beijing release", - "type": "string" - }, - "@schemaLocation": { - "description": "Not used in Beijing release", - "type": "string" - }, - "@baseType": { - "description": "Not used in Beijing release", - "type": "string" - } - } - - }, - - "Service": { - "description": "Service (to be added, modified, deleted) description", - - - "required": [ - - "id" - ], - "type": "object", - "properties": { - "id": { - "description": "Identifier of a service instance.\nIt must be valued if orderItem action is 'delete' and corresponds to a AAI service.id", - "type": "string" - }, - "href": { - "description": "Reference to the Service (useful for delete or modify command).\nNot managed in Beijing release.", - "type": "string" - }, - "name": { - "description": "Name of the service - When orderItem action is 'add' this name will be used in ONAP/SO request as InstaceName.", - "type": "string" - }, - "serviceState": { - "description": "The lifecycle state of the service requested;\nNot managed in Beijing release.", - "type": "string" - }, - "@type": { - "description": "To define the service type\nNot managed in Beijing Release", - "type": "string" - }, - "@schemaLocation": { - "description": "The URL to get the resource schema.\nNot managed in Beijing Release", - "type": "string" - }, - "serviceCharacteristic": { - - "type": "array", - "items": { - "$ref": "#/definitions/ServiceCharacteristic" - } - }, - "serviceRelationship": { - - "type": "array", - "items": { - "$ref": "#/definitions/ServiceRelationship" - } - }, - "relatedParty": { - - "type": "array", - "items": { - "$ref": "#/definitions/RelatedParty" - } - }, - "serviceSpecification": { - - "$ref": "#/definitions/ServiceSpecificationRef" - } - } - - }, - - "OrderItemRelationship": { - "description": "Linked order item to the one containing this attribute.\nnbi component used this relationship to sort request to ONAP.", - - - "required": [ - - "type", - "id" - ], - "type": "object", - "properties": { - "type": { - - "$ref": "#/definitions/RelationshipType" - }, - "id": { - "description": "Unique identifier of an order item", - "type": "string" - } - } - - }, - - "ServiceOrderItem": { - "description": "An identified part of the order. A service order is decomposed into one or more order items.", - - - "required": [ - - "id", - "service" - ], - "type": "object", - "properties": { - "id": { - "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, …)", - "type": "string" - }, - "action": { - - "$ref": "#/definitions/ActionType" - }, - "state": { - - "$ref": "#/definitions/StateType" - }, - "@type": { - "description": "Used to extend the order item.\nnot used in Beijing relase", - "type": "string" - }, - "@schemaLocation": { - "description": "not used in Beijing relase", - "type": "string" - }, - "@baseType": { - "description": "not used in Beijing relase", - "type": "string" - }, - "orderItemRelationship": { - - "type": "array", - "items": { - "$ref": "#/definitions/OrderItemRelationship" - } - }, - "service": { - - "$ref": "#/definitions/Service" - } - } - - }, - - "ServiceOrder": { - "description": "A Service Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa", - - - "required": [ - - "id" - ], - "type": "object", - "properties": { - "id": { - "description": "ID created on repository side", - "type": "string" - }, - "href": { - "description": "Hyperlink to access the order", - "type": "string" - }, - "externalId": { - "description": "ID given by the consumer and only understandable by him (to facilitate his searches)", - "type": "string" - }, - "priority": { - "description": "A way that can be used by consumers to prioritize orders in Service Order Management system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)", - "type": "string" - }, - "description": { - "description": "A free-text description of the service order", - "type": "string" - }, - "category": { - "description": "Used to categorize the order that can be useful for the OM system (e.g. “broadband”, “TVOption”, ...)", - "type": "string" - }, - "state": { - - "$ref": "#/definitions/StateType" - }, - "orderDate": { - "description": "", - "type": "string", - "format": "date-time" - }, - "completionDateTime": { - "description": "Date when the order was completed", - "type": "string", - "format": "date-time" - }, - "requestedStartDate": { - "description": "Order start date wished by the requestor", - "type": "string", - "format": "date-time" - }, - "requestedCompletionDate": { - "description": "Requested delivery date from the requestor perspective", - "type": "string", - "format": "date-time" - }, - "expectedCompletionDate": { - "description": "", - "type": "string", - "format": "date-time" - }, - "startDate": { - "description": "Date when the order was started for processing", - "type": "string", - "format": "date-time" - }, - "@baseType": { - "description": "", - "type": "string" - }, - "@type": { - "description": "", - "type": "string" - }, - "@schemaLocation": { - "description": "", - "type": "string" - }, - "relatedParty": { - - "type": "array", - "items": { - "$ref": "#/definitions/RelatedParty" - } - }, - "orderRelationship": { - - "type": "array", - "items": { - "$ref": "#/definitions/OrderRelationship" - } - }, - "orderItem": { - - "type": "array", - "items": { - "$ref": "#/definitions/ServiceOrderItem" - } - } - } - - }, - - "OrderRelationship": { - "description": "Linked order to the one containing this attribute.\nThis relationship is not used to sort ONAP request.", - - - "required": [ - - "id" - ], - "type": "object", - "properties": { - "type": { - "description": "The type of related order, can be : “dependency” if the order needs to be “not started” until another order item is complete (a service order in this case) or “cross-ref” to keep track of the source order (a productOrder)", - "type": "string" - }, - "id": { - "description": "The id of the related order", - "type": "string" - }, - "href": { - "description": "A hyperlink to the related order", - "type": "string" - }, - "@referredType": { - "description": "Type of the referred order.", - "type": "string" - } - } - - }, - - "TargetServiceSchema": { - "description": "Target to the schema describing the service spec resource", - - - "required": [ - - "@type", - "@schemaLocation" - ], - "type": "object", - "properties": { - "@type": { - "description": "Indicates the (class) type of resource.", - "type": "string" - }, - "@schemaLocation": { - "description": "This field provided a link to the schema describing this REST resource.", - "type": "string" - } - } - - }, - - "Value": { - "description": "Value is a descriptive structure for service characteristic;\nFor Beijing we only manage 'basic' attribute - the serviceCharacteristicValue must be used.", - - - "type": "object", - "properties": { - "@type": { - "description": "Indicates the (class) type of resource.\nNot used in Beijing Release", - "type": "string" - }, - "@schemaLocation": { - "description": "This field provided a link to the schema describing this REST resource.\nNot used in Beijing Release", - "type": "string" - }, - "serviceCharacteristicValue": { - "description": "Value of the characteristic.\nThis attribute must be used in Beijing Release to provide characteristic value.", - "type": "string" - } - } - - }, - - "CreateServiceOrderItem": { - "description": "This structure is used in the operation POST for a serviceOrder request to describe an item.\nAttribute description is not accurate and should be find in the serviceOrderItem class.", - - - "required": [ - - "id", - "service" - ], - "type": "object", - "properties": { - "id": { - "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, …)", - "type": "string" - }, - "action": { - - "$ref": "#/definitions/ActionType" - }, - "@type": { - "description": "Indicates the type of resource.", - "type": "string" - }, - "@schemaLocation": { - "description": "A link to the schema describing this REST resource", - "type": "string" - }, - "@baseType": { - "description": "Indicates the base type of the resource.", - "type": "string" - }, - "orderItemRelationship": { - - "type": "array", - "items": { - "$ref": "#/definitions/OrderItemRelationship" - } - }, - "service": { - - "$ref": "#/definitions/Service" - } - } - - }, - - "CreateServiceOrder": { - "description": "This structure is used in the operation POST for a serviceOrder request.\nAttribute description is not accurate and should be find in the serviceOrder class.", - - - "type": "object", - "properties": { - "externalId": { - "description": "ID given by the consumer and only understandable by him (to facilitate his searches)", - "type": "string" - }, - "priority": { - "description": "A way that can be used by consumers to prioritize orders in Service Order Management system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)", - "type": "string" - }, - "description": { - "description": "A free-text description of the service order", - "type": "string" - }, - "category": { - "description": "Used to categorize the order that can be useful for the OM system (e.g. “broadband”, “TVOption”, ...)", - "type": "string" - }, - "requestedStartDate": { - "description": "Order start date wished by the requestor", - "type": "string", - "format": "date-time" - }, - "requestedCompletionDate": { - "description": "Requested delivery date from the requestor perspective", - "type": "string", - "format": "date-time" - }, - "@baseType": { - "description": "", - "type": "string" - }, - "@type": { - "description": "", - "type": "string" - }, - "@schemaLocation": { - "description": "", - "type": "string" - }, - "relatedParty": { - - "type": "array", - "items": { - "$ref": "#/definitions/RelatedParty" - } - }, - "orderRelationship": { - - "type": "array", - "items": { - "$ref": "#/definitions/OrderRelationship" - } - }, - "orderItem": { - - "type": "array", - "items": { - "$ref": "#/definitions/CreateServiceOrderItem" - } - } - } - - }, - - "Hub": { - "description": "An HUB resource is used by client side to subscribe to notification.\nNot managed in the Beijing release.", - - - "discriminator": "id", - - "required": [ - - "callback" - ], - "type": "object", - "properties": { - "id": { - "description": "", - "type": "string" - }, - "query": { - "description": "", - "type": "string" - }, - "callback": { - "description": "", - "type": "string" - } - } - - } - } -} -
\ No newline at end of file diff --git a/docs/offeredapis/swaggers/serviceOrder_1_0_0.yaml b/docs/offeredapis/swaggers/serviceOrder_1_0_0.yaml deleted file mode 100644 index b881150..0000000 --- a/docs/offeredapis/swaggers/serviceOrder_1_0_0.yaml +++ /dev/null @@ -1,772 +0,0 @@ -# This work is licensed under a Creative Commons Attribution 4.0 International License. -# http://creativecommons.org/licenses/by/4.0 -# Copyright 2018 Orange - -swagger: "2.0" -info: - description: "serviceOrder API designed for ONAP Beijing Release.\nThis API is build\ - \ from TMF open API18.0 (applying TMF Guideline 3.0);\nOnly operations GET (by\ - \ id and list) and POST are available." - version: "1.0.0_inProgress" - title: "API ServiceOrder" - x-logo: - url: "/redoc/logo.png" - backgroundColor: "#FFFFFF" -host: "serverRoot" -basePath: "/nbi/api/v1" -schemes: -- "https" -consumes: -- "application/json;charset=utf-8" -produces: -- "application/json;charset=utf-8" -tags: -- name: "ServiceOrder" - description: "A Service Order is a type of order which can be used to describe a\ - \ group of operations on service – one service order item per service. An action\ - \ at the level of the service order item describe the operation to be done on\ - \ a service (add, terminate for example). The service order is triggered from\ - \ the BSS system in charge of the product order management to ONAP that will manage\ - \ the service fulfillment." -paths: - /serviceOrder: - post: - tags: - - "ServiceOrder" - operationId: "serviceOrderCreate" - summary: "Create a service order" - description: "This operation creates a service order entity.\nThe TMF Open API\ - \ specification document provides the list of mandatory and non mandatory\ - \ attributes when creating a ServiceOrder, including any possible rule conditions\ - \ and applicable default values.\nPOST should be used without specifying the\ - \ id and the href, the Service Order Management system is in charge of generating\ - \ the id + href for the ServiceOrder.\n\nSpecific business errors for current\ - \ operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n\ - \n - 100: OrderItem with 'add' action but serviceSpecification id missing\n\ - \ \n - 101: OrderItem with 'change'/'noChange'/'remove' but service id missing\n\ - \ \n - 102: OrderItem with 'add' action - serviceSpecification id provided\ - \ but not existing\n \n - 103: OrderItem with 'add' action but service id\ - \ already existing in the inventory\n \n - 104: A customer for existing\ - \ service(s) is provided but he did not exist\n \n - 105: OrderItem with\ - \ 'change'/'noChange'/'remove' - Service id provided but it is not existing\ - \ in the inventory\n \n - 106: [Not managed for current Relese] Issue with\ - \ lcpCloudRegionId and tenantId provided\n " - deprecated: false - parameters: - - name: "serviceOrder" - required: true - in: "body" - description: "" - schema: - $ref: "#/definitions/CreateServiceOrder" - responses: - 201: - description: "Success" - schema: - $ref: "#/definitions/ServiceOrder" - 400: - description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ - \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ - \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ - \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ - \ parameter value" - schema: - $ref: "#/definitions/ErrorRepresentation" - 401: - description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ - \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" - schema: - $ref: "#/definitions/ErrorRepresentation" - 403: - description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ - \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ - \ requests" - schema: - $ref: "#/definitions/ErrorRepresentation" - 404: - description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ - \ not found" - schema: - $ref: "#/definitions/ErrorRepresentation" - 422: - description: "Unprocessable entity\n\nFunctional error\n\nSpecific encapsulated\ - \ business errors for current operation\n\n - 100: OrderItem with 'add'\ - \ action but serviceSpecification id missing\n \n - 101: OrderItem with\ - \ 'change'/'noChange'/'remove' but service id missing\n \n - 102: OrderItem\ - \ with 'add' action - serviceSpecification id provided but not existing\n\ - \ \n - 103: OrderItem with 'add' action but service id already existing\ - \ in the inventory\n \n - 104: A customer for existing service(s) is\ - \ provided but he did not exist\n \n - 105: OrderItem with 'change'/'noChange'/'remove'\ - \ - Service id provided but it is not existing in the inventory\n \n\ - \ - 106: [Not managed for current Relese] Issue with lcpCloudRegionId\ - \ and tenantId provided\n " - schema: - $ref: "#/definitions/ErrorRepresentation" - 500: - description: "Internal Server Error\n\nList of supported error codes:\n\ - - 1: Internal error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 503: - description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ - \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ - \ retry later !" - schema: - $ref: "#/definitions/ErrorRepresentation" - get: - tags: - - "ServiceOrder" - operationId: "serviceOrderFind" - summary: "List service orders" - description: "Retrieve and list service order entities according to given criteria.\n\ - Only a predefined set of attribute is proposed.\nAttribute selection could\ - \ be described in the fields attribute.\n\nSpecific business errors for current\ - \ operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n" - deprecated: false - parameters: - - name: "externalId" - required: false - in: "query" - description: "" - type: "string" - - name: "state" - required: false - in: "query" - description: "state of the order(s) to be retrieved" - type: "string" - - name: "description" - required: false - in: "query" - description: "" - type: "string" - - name: "orderDate.gt" - required: false - in: "query" - description: "order date greather than" - type: "string" - - name: "orderDate.lt" - required: false - in: "query" - description: "order date lower than" - type: "string" - - name: "fields" - required: false - in: "query" - description: "this attribute could be used to filter retrieved attribute(s)\ - \ and/or sort SO." - type: "string" - - name: "offset" - required: false - in: "query" - description: "The index of the first element to retrieve. Zero is the first\ - \ element of the collection." - type: "integer" - format: "int32" - - name: "limit" - required: false - in: "query" - description: "The maximum number of elements to retrieve (it can be greater\ - \ than the actual available number of items)." - type: "integer" - format: "int32" - responses: - 200: - description: "Success" - schema: - type: "array" - items: - $ref: "#/definitions/ServiceOrder" - headers: - X-Total-Count: - description: "" - type: "integer" - format: "int32" - X-Result-Count: - description: "" - type: "integer" - format: "int32" - 400: - description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ - \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ - \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ - \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ - \ parameter value" - schema: - $ref: "#/definitions/ErrorRepresentation" - 401: - description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ - \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" - schema: - $ref: "#/definitions/ErrorRepresentation" - 403: - description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ - \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ - \ requests" - schema: - $ref: "#/definitions/ErrorRepresentation" - 404: - description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ - \ not found" - schema: - $ref: "#/definitions/ErrorRepresentation" - 422: - description: "Unprocessable entity\n\nFunctional error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 500: - description: "Internal Server Error\n\nList of supported error codes:\n\ - - 1: Internal error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 503: - description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ - \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ - \ retry later !" - schema: - $ref: "#/definitions/ErrorRepresentation" - /serviceOrder/{id}: - get: - tags: - - "ServiceOrder" - operationId: "serviceOrderGet" - summary: "Retrieve a service order" - description: "This operation retrieves a service order entity. \nAttribute selection\ - \ is enabled for all first level attributes.\n\nSpecific business errors for\ - \ current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable\ - \ entity\n" - deprecated: false - parameters: - - name: "id" - in: "path" - required: true - type: "string" - description: "" - - name: "fields" - required: false - in: "query" - description: "Attribute selection" - type: "string" - responses: - 200: - description: "Success" - schema: - $ref: "#/definitions/ServiceOrder" - 400: - description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ - \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ - \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ - \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ - \ parameter value" - schema: - $ref: "#/definitions/ErrorRepresentation" - 401: - description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ - \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" - schema: - $ref: "#/definitions/ErrorRepresentation" - 403: - description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ - \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ - \ requests" - schema: - $ref: "#/definitions/ErrorRepresentation" - 404: - description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ - \ not found" - schema: - $ref: "#/definitions/ErrorRepresentation" - 422: - description: "Unprocessable entity\n\nFunctional error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 500: - description: "Internal Server Error\n\nList of supported error codes:\n\ - - 1: Internal error" - schema: - $ref: "#/definitions/ErrorRepresentation" - 503: - description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ - \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ - \ retry later !" - schema: - $ref: "#/definitions/ErrorRepresentation" -definitions: - ActionType: - description: "Action type to be describer on the order item.\nmodify is not managed\ - \ in Beijing release" - type: "string" - enum: - - "add" - - "modify" - - "delete" - - "noChange" - StateType: - description: "List of possible state for the order and the orderItem." - type: "string" - enum: - - "acknowledged" - - "rejected" - - "pending" - - "held" - - "inProgress" - - "cancelled" - - "completed" - - "failed" - - "partial" - RelationshipType: - description: "Relationship type;\nOnly reliesOn is managed in Beijing release." - type: "string" - enum: - - "reliesOn" - ErrorRepresentation: - description: "Representation of an 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" - ServiceRelationship: - description: "Linked Services to the one instantiate\nnbi component used this\ - \ relationship to sort request to ONAP." - required: - - "type" - - "service" - type: "object" - properties: - type: - $ref: "#/definitions/RelationshipType" - service: - $ref: "#/definitions/Service" - ServiceRef: - description: "Service references" - required: - - "id" - type: "object" - properties: - id: - description: "Unique identifier of the service" - type: "string" - href: - description: "Reference of the service" - type: "string" - ServiceCharacteristic: - description: "ServiceCharacteristic" - required: - - "name" - type: "object" - properties: - name: - description: "Name of characteristic" - type: "string" - valueType: - description: "" - type: "string" - value: - $ref: "#/definitions/Value" - RelatedParty: - description: "A related party defines party which are involved in this order and\ - \ the role they are playing.\nfor Beijing release:\nWith the current version\ - \ of APIs used from SO and AAI we need to manage a ‘customer’. This customer\ - \ concept is confusing with Customer BSS concept. We took the following rules\ - \ to manage the ‘customer’ information:\no\tIt could be provided through a serviceOrder\ - \ in the service Order a relatedParty with role ‘ONAPcustomer’ should be provided\ - \ in the serviceOrder header (we will not consider in this release the party\ - \ at item level); External API component will check if this customer exists\ - \ and create it in AAI if not.\no\tIf no relatedParty are provided the service\ - \ will be affected to ‘generic’ customer (dummy customer) – we assume this ‘\ - generic’ customer always exists." - required: - - "id" - - "role" - type: "object" - properties: - id: - description: "Unique identifier of a related party" - type: "string" - href: - description: "An hyperlink to the party - not used in Beijnig release" - type: "string" - role: - description: "The role of the related party (e.g. Owner, requester, fullfiller\ - \ etc).\nONLY 'ONAPcustomer' is considered" - type: "string" - name: - description: "Name of the related party" - type: "string" - '@referredType': - description: "" - type: "string" - ServiceSpecificationRef: - description: "The service specification (these attributes are fetched from the\ - \ catalogue)." - required: - - "id" - type: "object" - properties: - id: - description: "Unique identifier of the service specification\nThis information\ - \ will be used to retrieve SDC information + mapped to SO ModelNameVersionIdin\ - \ the request." - type: "string" - href: - description: "Reference of the service specification\nNot used in Beijing\ - \ release." - type: "string" - name: - description: "Name of the service specification\nNot used in Beijing release" - type: "string" - version: - description: "Version of the service Specification\nNot used in Beijing release" - type: "string" - targetServiceSchema: - $ref: "#/definitions/TargetServiceSchema" - '@type': - description: "Not used in Beijing release" - type: "string" - '@schemaLocation': - description: "Not used in Beijing release" - type: "string" - '@baseType': - description: "Not used in Beijing release" - type: "string" - Service: - description: "Service (to be added, modified, deleted) description" - required: - - "id" - type: "object" - properties: - id: - description: "Identifier of a service instance.\nIt must be valued if orderItem\ - \ action is 'delete' and corresponds to a AAI service.id" - type: "string" - href: - description: "Reference to the Service (useful for delete or modify command).\n\ - Not managed in Beijing release." - type: "string" - name: - description: "Name of the service - When orderItem action is 'add' this name\ - \ will be used in ONAP/SO request as InstaceName." - type: "string" - serviceState: - description: "The lifecycle state of the service requested;\nNot managed in\ - \ Beijing release." - type: "string" - '@type': - description: "To define the service type\nNot managed in Beijing Release" - type: "string" - '@schemaLocation': - description: "The URL to get the resource schema.\nNot managed in Beijing\ - \ Release" - type: "string" - serviceCharacteristic: - type: "array" - items: - $ref: "#/definitions/ServiceCharacteristic" - serviceRelationship: - type: "array" - items: - $ref: "#/definitions/ServiceRelationship" - relatedParty: - type: "array" - items: - $ref: "#/definitions/RelatedParty" - serviceSpecification: - $ref: "#/definitions/ServiceSpecificationRef" - OrderItemRelationship: - description: "Linked order item to the one containing this attribute.\nnbi component\ - \ used this relationship to sort request to ONAP." - required: - - "type" - - "id" - type: "object" - properties: - type: - $ref: "#/definitions/RelationshipType" - id: - description: "Unique identifier of an order item" - type: "string" - ServiceOrderItem: - description: "An identified part of the order. A service order is decomposed into\ - \ one or more order items." - required: - - "id" - - "service" - type: "object" - properties: - id: - description: "Identifier of the line item (generally it is a sequence number\ - \ 01, 02, 03, …)" - type: "string" - action: - $ref: "#/definitions/ActionType" - state: - $ref: "#/definitions/StateType" - '@type': - description: "Used to extend the order item.\nnot used in Beijing relase" - type: "string" - '@schemaLocation': - description: "not used in Beijing relase" - type: "string" - '@baseType': - description: "not used in Beijing relase" - type: "string" - orderItemRelationship: - type: "array" - items: - $ref: "#/definitions/OrderItemRelationship" - service: - $ref: "#/definitions/Service" - ServiceOrder: - description: "A Service Order is a type of order which can be used to place an\ - \ order between a customer and a service provider or between a service provider\ - \ and a partner and vice versa" - required: - - "id" - type: "object" - properties: - id: - description: "ID created on repository side" - type: "string" - href: - description: "Hyperlink to access the order" - type: "string" - externalId: - description: "ID given by the consumer and only understandable by him (to\ - \ facilitate his searches)" - type: "string" - priority: - description: "A way that can be used by consumers to prioritize orders in\ - \ Service Order Management system (from 0 to 4 : 0 is the highest priority,\ - \ and 4 the lowest)" - type: "string" - description: - description: "A free-text description of the service order" - type: "string" - category: - description: "Used to categorize the order that can be useful for the OM system\ - \ (e.g. “broadband”, “TVOption”, ...)" - type: "string" - state: - $ref: "#/definitions/StateType" - orderDate: - description: "" - type: "string" - format: "date-time" - completionDateTime: - description: "Date when the order was completed" - type: "string" - format: "date-time" - requestedStartDate: - description: "Order start date wished by the requestor" - type: "string" - format: "date-time" - requestedCompletionDate: - description: "Requested delivery date from the requestor perspective" - type: "string" - format: "date-time" - expectedCompletionDate: - description: "" - type: "string" - format: "date-time" - startDate: - description: "Date when the order was started for processing" - type: "string" - format: "date-time" - '@baseType': - description: "" - type: "string" - '@type': - description: "" - type: "string" - '@schemaLocation': - description: "" - type: "string" - relatedParty: - type: "array" - items: - $ref: "#/definitions/RelatedParty" - orderRelationship: - type: "array" - items: - $ref: "#/definitions/OrderRelationship" - orderItem: - type: "array" - items: - $ref: "#/definitions/ServiceOrderItem" - OrderRelationship: - description: "Linked order to the one containing this attribute.\nThis relationship\ - \ is not used to sort ONAP request." - required: - - "id" - type: "object" - properties: - type: - description: "The type of related order, can be : “dependency” if the order\ - \ needs to be “not started” until another order item is complete (a service\ - \ order in this case) or “cross-ref” to keep track of the source order (a\ - \ productOrder)" - type: "string" - id: - description: "The id of the related order" - type: "string" - href: - description: "A hyperlink to the related order" - type: "string" - '@referredType': - description: "Type of the referred order." - type: "string" - TargetServiceSchema: - description: "Target to the schema describing the service spec resource" - required: - - "@type" - - "@schemaLocation" - type: "object" - properties: - '@type': - description: "Indicates the (class) type of resource." - type: "string" - '@schemaLocation': - description: "This field provided a link to the schema describing this REST\ - \ resource." - type: "string" - Value: - description: "Value is a descriptive structure for service characteristic;\nFor\ - \ Beijing we only manage 'basic' attribute - the serviceCharacteristicValue\ - \ must be used." - type: "object" - properties: - '@type': - description: "Indicates the (class) type of resource.\nNot used in Beijing\ - \ Release" - type: "string" - '@schemaLocation': - description: "This field provided a link to the schema describing this REST\ - \ resource.\nNot used in Beijing Release" - type: "string" - serviceCharacteristicValue: - description: "Value of the characteristic.\nThis attribute must be used in\ - \ Beijing Release to provide characteristic value." - type: "string" - CreateServiceOrderItem: - description: "This structure is used in the operation POST for a serviceOrder\ - \ request to describe an item.\nAttribute description is not accurate and should\ - \ be find in the serviceOrderItem class." - required: - - "id" - - "service" - type: "object" - properties: - id: - description: "Identifier of the line item (generally it is a sequence number\ - \ 01, 02, 03, …)" - type: "string" - action: - $ref: "#/definitions/ActionType" - '@type': - description: "Indicates the type of resource." - type: "string" - '@schemaLocation': - description: "A link to the schema describing this REST resource" - type: "string" - '@baseType': - description: "Indicates the base type of the resource." - type: "string" - orderItemRelationship: - type: "array" - items: - $ref: "#/definitions/OrderItemRelationship" - service: - $ref: "#/definitions/Service" - CreateServiceOrder: - description: "This structure is used in the operation POST for a serviceOrder\ - \ request.\nAttribute description is not accurate and should be find in the\ - \ serviceOrder class." - type: "object" - properties: - externalId: - description: "ID given by the consumer and only understandable by him (to\ - \ facilitate his searches)" - type: "string" - priority: - description: "A way that can be used by consumers to prioritize orders in\ - \ Service Order Management system (from 0 to 4 : 0 is the highest priority,\ - \ and 4 the lowest)" - type: "string" - description: - description: "A free-text description of the service order" - type: "string" - category: - description: "Used to categorize the order that can be useful for the OM system\ - \ (e.g. “broadband”, “TVOption”, ...)" - type: "string" - requestedStartDate: - description: "Order start date wished by the requestor" - type: "string" - format: "date-time" - requestedCompletionDate: - description: "Requested delivery date from the requestor perspective" - type: "string" - format: "date-time" - '@baseType': - description: "" - type: "string" - '@type': - description: "" - type: "string" - '@schemaLocation': - description: "" - type: "string" - relatedParty: - type: "array" - items: - $ref: "#/definitions/RelatedParty" - orderRelationship: - type: "array" - items: - $ref: "#/definitions/OrderRelationship" - orderItem: - type: "array" - items: - $ref: "#/definitions/CreateServiceOrderItem" - Hub: - description: "An HUB resource is used by client side to subscribe to notification.\n\ - Not managed in the Beijing release." - discriminator: "id" - required: - - "callback" - type: "object" - properties: - id: - description: "" - type: "string" - query: - description: "" - type: "string" - callback: - description: "" - type: "string" |
