NSD and ServiceDescriptor

Issue-ID: MODELING-108

Change-Id: I56ccda1a8fff9b583c9295ed1fb105b4f6ec856b
Signed-off-by: guochuyicmri <guochuyi@chinamobile.com>

1 files changed, 583 insertions, 0 deletions

diff --git a/docs/ONAP Model Spec/im/ServiceDescriptor.rst b/docs/ONAP Model Spec/im/ServiceDescriptor.rst
new file mode 100644
index 0000000..b321b14
--- /dev/null
+++ b/docs/ONAP Model Spec/im/ServiceDescriptor.rst
@@ -0,0 +1,583 @@
+.. contents::
+   :depth: 3
+..
+
+ ServiceDescriptor 
+===================
+
+Classes
+=======
+
+Attachment
+----------
+
+Applied stereotypes:
+
+-  OpenModelClass
+
+-  support: MANDATORY
+
++-------------+-------------+-------------+-------------+-------------+
+| **Attribute | **Type**    | **Mult.**   | **Stereotyp | **Descripti |
+| Name**      |             |             | es**        | on**        |
++=============+=============+=============+=============+=============+
+| id          | String      | 1           | OpenModelAt |             |
+|             |             |             | tribute     |             |
+|             |             |             |             |             |
+|             |             |             | -  isInvari |             |
+|             |             |             | ant:        |             |
+|             |             |             |       false |             |
+|             |             |             |             |             |
+|             |             |             | -  valueRan |             |
+|             |             |             | ge:         |             |
+|             |             |             |       no    |             |
+|             |             |             |       range |             |
+|             |             |             |       const |             |
+|             |             |             | raint       |             |
+|             |             |             |             |             |
+|             |             |             | -  support: |             |
+|             |             |             |       MANDA |             |
+|             |             |             | TORY        |             |
++-------------+-------------+-------------+-------------+-------------+
+| name        | String      | 1           | OpenModelAt |             |
+|             |             |             | tribute     |             |
+|             |             |             |             |             |
+|             |             |             | -  isInvari |             |
+|             |             |             | ant:        |             |
+|             |             |             |       false |             |
+|             |             |             |             |             |
+|             |             |             | -  valueRan |             |
+|             |             |             | ge:         |             |
+|             |             |             |       no    |             |
+|             |             |             |       range |             |
+|             |             |             |       const |             |
+|             |             |             | raint       |             |
+|             |             |             |             |             |
+|             |             |             | -  support: |             |
+|             |             |             |       MANDA |             |
+|             |             |             | TORY        |             |
++-------------+-------------+-------------+-------------+-------------+
+| description | String      | 1           | OpenModelAt |             |
+|             |             |             | tribute     |             |
+|             |             |             |             |             |
+|             |             |             | -  isInvari |             |
+|             |             |             | ant:        |             |
+|             |             |             |       false |             |
+|             |             |             |             |             |
+|             |             |             | -  valueRan |             |
+|             |             |             | ge:         |             |
+|             |             |             |       no    |             |
+|             |             |             |       range |             |
+|             |             |             |       const |             |
+|             |             |             | raint       |             |
+|             |             |             |             |             |
+|             |             |             | -  support: |             |
+|             |             |             |       MANDA |             |
+|             |             |             | TORY        |             |
++-------------+-------------+-------------+-------------+-------------+
+| type        | String      | 1           | OpenModelAt |             |
+|             |             |             | tribute     |             |
+|             |             |             |             |             |
+|             |             |             | -  isInvari |             |
+|             |             |             | ant:        |             |
+|             |             |             |       false |             |
+|             |             |             |             |             |
+|             |             |             | -  valueRan |             |
+|             |             |             | ge:         |             |
+|             |             |             |       no    |             |
+|             |             |             |       range |             |
+|             |             |             |       const |             |
+|             |             |             | raint       |             |
+|             |             |             |             |             |
+|             |             |             | -  support: |             |
+|             |             |             |       MANDA |             |
+|             |             |             | TORY        |             |
++-------------+-------------+-------------+-------------+-------------+
+| url         | String      | 1           | OpenModelAt |             |
+|             |             |             | tribute     |             |
+|             |             |             |             |             |
+|             |             |             | -  isInvari |             |
+|             |             |             | ant:        |             |
+|             |             |             |       false |             |
+|             |             |             |             |             |
+|             |             |             | -  valueRan |             |
+|             |             |             | ge:         |             |
+|             |             |             |       no    |             |
+|             |             |             |       range |             |
+|             |             |             |       const |             |
+|             |             |             | raint       |             |
+|             |             |             |             |             |
+|             |             |             | -  support: |             |
+|             |             |             |       MANDA |             |
+|             |             |             | TORY        |             |
++-------------+-------------+-------------+-------------+-------------+
+
+ResourceDescriptor
+------------------
+
+Applied stereotypes:
+
+-  OpenModelClass
+
+-  support: MANDATORY
+
++-------------+-------------+-------------+-------------+-------------+
+| **Attribute | **Type**    | **Mult.**   | **Stereotyp | **Descripti |
+| Name**      |             |             | es**        | on**        |
++=============+=============+=============+=============+=============+
+| id          | String      | 1           | OpenModelAt |             |
+|             |             |             | tribute     |             |
+|             |             |             |             |             |
+|             |             |             | -  isInvari |             |
+|             |             |             | ant:        |             |
+|             |             |             |       false |             |
+|             |             |             |             |             |
+|             |             |             | -  valueRan |             |
+|             |             |             | ge:         |             |
+|             |             |             |       no    |             |
+|             |             |             |       range |             |
+|             |             |             |       const |             |
+|             |             |             | raint       |             |
+|             |             |             |             |             |
+|             |             |             | -  support: |             |
+|             |             |             |       MANDA |             |
+|             |             |             | TORY        |             |
++-------------+-------------+-------------+-------------+-------------+
+| href        | String      | 1           | OpenModelAt |             |
+|             |             |             | tribute     |             |
+|             |             |             |             |             |
+|             |             |             | -  isInvari |             |
+|             |             |             | ant:        |             |
+|             |             |             |       false |             |
+|             |             |             |             |             |
+|             |             |             | -  valueRan |             |
+|             |             |             | ge:         |             |
+|             |             |             |       no    |             |
+|             |             |             |       range |             |
+|             |             |             |       const |             |
+|             |             |             | raint       |             |
+|             |             |             |             |             |
+|             |             |             | -  support: |             |
+|             |             |             |       MANDA |             |
+|             |             |             | TORY        |             |
++-------------+-------------+-------------+-------------+-------------+
+| name        | String      | 1           | OpenModelAt |             |
+|             |             |             | tribute     |             |
+|             |             |             |             |             |
+|             |             |             | -  isInvari |             |
+|             |             |             | ant:        |             |
+|             |             |             |       false |             |
+|             |             |             |             |             |
+|             |             |             | -  valueRan |             |
+|             |             |             | ge:         |             |
+|             |             |             |       no    |             |
+|             |             |             |       range |             |
+|             |             |             |       const |             |
+|             |             |             | raint       |             |
+|             |             |             |             |             |
+|             |             |             | -  support: |             |
+|             |             |             |       MANDA |             |
+|             |             |             | TORY        |             |
++-------------+-------------+-------------+-------------+-------------+
+| description | String      | 1           | OpenModelAt |             |
+|             |             |             | tribute     |             |
+|             |             |             |             |             |
+|             |             |             | -  isInvari |             |
+|             |             |             | ant:        |             |
+|             |             |             |       false |             |
+|             |             |             |             |             |
+|             |             |             | -  valueRan |             |
+|             |             |             | ge:         |             |
+|             |             |             |       no    |             |
+|             |             |             |       range |             |
+|             |             |             |       const |             |
+|             |             |             | raint       |             |
+|             |             |             |             |             |
+|             |             |             | -  support: |             |
+|             |             |             |       MANDA |             |
+|             |             |             | TORY        |             |
++-------------+-------------+-------------+-------------+-------------+
+| type        | String      | 1           | OpenModelAt |             |
+|             |             |             | tribute     |             |
+|             |             |             |             |             |
+|             |             |             | -  isInvari |             |
+|             |             |             | ant:        |             |
+|             |             |             |       false |             |
+|             |             |             |             |             |
+|             |             |             | -  valueRan |             |
+|             |             |             | ge:         |             |
+|             |             |             |       no    |             |
+|             |             |             |       range |             |
+|             |             |             |       const |             |
+|             |             |             | raint       |             |
+|             |             |             |             |             |
+|             |             |             | -  support: |             |
+|             |             |             |       MANDA |             |
+|             |             |             | TORY        |             |
++-------------+-------------+-------------+-------------+-------------+
+| resourceTyp | String      | 1           | OpenModelAt |             |
+| e           |             |             | tribute     |             |
+|             |             |             |             |             |
+|             |             |             | -  isInvari |             |
+|             |             |             | ant:        |             |
+|             |             |             |       false |             |
+|             |             |             |             |             |
+|             |             |             | -  valueRan |             |
+|             |             |             | ge:         |             |
+|             |             |             |       no    |             |
+|             |             |             |       range |             |
+|             |             |             |       const |             |
+|             |             |             | raint       |             |
+|             |             |             |             |             |
+|             |             |             | -  support: |             |
+|             |             |             |       MANDA |             |
+|             |             |             | TORY        |             |
++-------------+-------------+-------------+-------------+-------------+
+| resourceRol | String      | 1           | OpenModelAt |             |
+| e           |             |             | tribute     |             |
+|             |             |             |             |             |
+|             |             |             | -  isInvari |             |
+|             |             |             | ant:        |             |
+|             |             |             |       false |             |
+|             |             |             |             |             |
+|             |             |             | -  valueRan |             |
+|             |             |             | ge:         |             |
+|             |             |             |       no    |             |
+|             |             |             |       range |             |
+|             |             |             |       const |             |
+|             |             |             | raint       |             |
+|             |             |             |             |             |
+|             |             |             | -  support: |             |
+|             |             |             |       MANDA |             |
+|             |             |             | TORY        |             |
++-------------+-------------+-------------+-------------+-------------+
+| version     | String      | 1           | OpenModelAt |             |
+|             |             |             | tribute     |             |
+|             |             |             |             |             |
+|             |             |             | -  isInvari |             |
+|             |             |             | ant:        |             |
+|             |             |             |       false |             |
+|             |             |             |             |             |
+|             |             |             | -  valueRan |             |
+|             |             |             | ge:         |             |
+|             |             |             |       no    |             |
+|             |             |             |       range |             |
+|             |             |             |       const |             |
+|             |             |             | raint       |             |
+|             |             |             |             |             |
+|             |             |             | -  support: |             |
+|             |             |             |       MANDA |             |
+|             |             |             | TORY        |             |
++-------------+-------------+-------------+-------------+-------------+
+
+.. _servicedescriptor-1:
+
+ServiceDescriptor
+-----------------
+
+ServiceDescriptor is used to model the design time representation of a
+service.
+
+Applied stereotypes:
+
+-  OpenModelClass
+
+-  support: MANDATORY
+
++-------------+-------------+-------------+-------------+-------------+
+| **Attribute | **Type**    | **Mult.**   | **Stereotyp | **Descripti |
+| Name**      |             |             | es**        | on**        |
++=============+=============+=============+=============+=============+
+| invariantUu | Uuid        | 1           | OpenModelAt | Constant    |
+| id          |             |             | tribute     | identifier  |
+|             |             |             |             | of the      |
+|             |             |             | -  isInvari | service     |
+|             |             |             | ant:        | model.      |
+|             |             |             |       false |             |
+|             |             |             |             |             |
+|             |             |             | -  valueRan |             |
+|             |             |             | ge:         |             |
+|             |             |             |       no    |             |
+|             |             |             |       range |             |
+|             |             |             |       const |             |
+|             |             |             | raint       |             |
+|             |             |             |             |             |
+|             |             |             | -  support: |             |
+|             |             |             |       MANDA |             |
+|             |             |             | TORY        |             |
++-------------+-------------+-------------+-------------+-------------+
+| uuid        | Uuid        | 1           | OpenModelAt | Versioned   |
+|             |             |             | tribute     | identifier  |
+|             |             |             |             | of the      |
+|             |             |             | -  isInvari | service     |
+|             |             |             | ant:        | model (this |
+|             |             |             |       false | uuid is     |
+|             |             |             |             | changed for |
+|             |             |             | -  valueRan | every major |
+|             |             |             | ge:         | version of  |
+|             |             |             |       no    | the         |
+|             |             |             |       range | service)    |
+|             |             |             |       const |             |
+|             |             |             | raint       |             |
+|             |             |             |             |             |
+|             |             |             | -  support: |             |
+|             |             |             |       MANDA |             |
+|             |             |             | TORY        |             |
++-------------+-------------+-------------+-------------+-------------+
+| name        | String      | 1           | OpenModelAt | The name of |
+|             |             |             | tribute     | the service |
+|             |             |             |             | model       |
+|             |             |             | -  isInvari | designed.   |
+|             |             |             | ant:        |             |
+|             |             |             |       false |             |
+|             |             |             |             |             |
+|             |             |             | -  valueRan |             |
+|             |             |             | ge:         |             |
+|             |             |             |       no    |             |
+|             |             |             |       range |             |
+|             |             |             |       const |             |
+|             |             |             | raint       |             |
+|             |             |             |             |             |
+|             |             |             | -  support: |             |
+|             |             |             |       MANDA |             |
+|             |             |             | TORY        |             |
++-------------+-------------+-------------+-------------+-------------+
+| description | String      | 1           | OpenModelAt | The         |
+|             |             |             | tribute     | description |
+|             |             |             |             | of the      |
+|             |             |             | -  isInvari | service     |
+|             |             |             | ant:        | model       |
+|             |             |             |       false | designed.   |
+|             |             |             |             |             |
+|             |             |             | -  valueRan |             |
+|             |             |             | ge:         |             |
+|             |             |             |       no    |             |
+|             |             |             |       range |             |
+|             |             |             |       const |             |
+|             |             |             | raint       |             |
+|             |             |             |             |             |
+|             |             |             | -  support: |             |
+|             |             |             |       MANDA |             |
+|             |             |             | TORY        |             |
++-------------+-------------+-------------+-------------+-------------+
+| category    | String      | 1..\*       | OpenModelAt | A           |
+|             |             |             | tribute     | predefined  |
+|             |             |             |             | list which  |
+|             |             |             | -  isInvari | identifies  |
+|             |             |             | ant:        | the         |
+|             |             |             |       false | construct's |
+|             |             |             |             | category.   |
+|             |             |             | -  valueRan | There is a  |
+|             |             |             | ge:         | predefined  |
+|             |             |             |       no    | list of     |
+|             |             |             |       range | service     |
+|             |             |             |       const | categories. |
+|             |             |             | raint       |             |
+|             |             |             |             |             |
+|             |             |             | -  support: |             |
+|             |             |             |       MANDA |             |
+|             |             |             | TORY        |             |
++-------------+-------------+-------------+-------------+-------------+
+| version     | String      | 1           | OpenModelAt | The service |
+|             |             |             | tribute     | model       |
+|             |             |             |             | version.    |
+|             |             |             | -  isInvari |             |
+|             |             |             | ant:        |             |
+|             |             |             |       false |             |
+|             |             |             |             |             |
+|             |             |             | -  valueRan |             |
+|             |             |             | ge:         |             |
+|             |             |             |       no    |             |
+|             |             |             |       range |             |
+|             |             |             |       const |             |
+|             |             |             | raint       |             |
+|             |             |             |             |             |
+|             |             |             | -  support: |             |
+|             |             |             |       MANDA |             |
+|             |             |             | TORY        |             |
++-------------+-------------+-------------+-------------+-------------+
+| serviceType | String      | 1           | OpenModelAt | An optional |
+|             |             |             | tribute     | string      |
+|             |             |             |             | field       |
+|             |             |             | -  isInvari | defining a  |
+|             |             |             | ant:        | generic     |
+|             |             |             |       false | type (like  |
+|             |             |             |             | category)   |
+|             |             |             | -  valueRan | of the      |
+|             |             |             | ge:         | service.    |
+|             |             |             |       no    | E.g. this   |
+|             |             |             |       range | field can   |
+|             |             |             |       const | be used for |
+|             |             |             | raint       | defining    |
+|             |             |             |             | the service |
+|             |             |             | -  support: | as          |
+|             |             |             |       MANDA | "TRANSPORT" |
+|             |             |             | TORY        | .           |
++-------------+-------------+-------------+-------------+-------------+
+| serviceRole | String      | 0..1        | OpenModelAt | An optional |
+|             |             |             | tribute     | string      |
+|             |             |             |             | field for   |
+|             |             |             | -  isInvari | shortcode   |
+|             |             |             | ant:        | that        |
+|             |             |             |       false | defines the |
+|             |             |             |             | function    |
+|             |             |             | -  valueRan | that the    |
+|             |             |             | ge:         | service is  |
+|             |             |             |       no    | providing.  |
+|             |             |             |       range | E.g.        |
+|             |             |             |       const | "MISVPN" or |
+|             |             |             | raint       | "AIM".      |
+|             |             |             |             |             |
+|             |             |             | -  support: |             |
+|             |             |             |       MANDA |             |
+|             |             |             | TORY        |             |
++-------------+-------------+-------------+-------------+-------------+
+| icon        | String      | 1           | OpenModelAt | The icon    |
+|             |             |             | tribute     | path of the |
+|             |             |             |             | service.    |
+|             |             |             | -  isInvari |             |
+|             |             |             | ant:        |             |
+|             |             |             |       false |             |
+|             |             |             |             |             |
+|             |             |             | -  valueRan |             |
+|             |             |             | ge:         |             |
+|             |             |             |       no    |             |
+|             |             |             |       range |             |
+|             |             |             |       const |             |
+|             |             |             | raint       |             |
+|             |             |             |             |             |
+|             |             |             | -  support: |             |
+|             |             |             |       MANDA |             |
+|             |             |             | TORY        |             |
++-------------+-------------+-------------+-------------+-------------+
+| serviceComp | Uuid        | 1           | OpenModelAt | The service |
+| onentUuid   |             |             | tribute     | component   |
+|             |             |             |             | descriptor  |
+|             |             |             | -  isInvari | UUIDs that  |
+|             |             |             | ant:        | the service |
+|             |             |             |       false | includes    |
+|             |             |             |             | (relationhi |
+|             |             |             | -  valueRan | p           |
+|             |             |             | ge:         | to Service  |
+|             |             |             |       no    | Component). |
+|             |             |             |       range |             |
+|             |             |             |       const |             |
+|             |             |             | raint       |             |
+|             |             |             |             |             |
+|             |             |             | -  support: |             |
+|             |             |             |       MANDA |             |
+|             |             |             | TORY        |             |
++-------------+-------------+-------------+-------------+-------------+
+| \_serviceDe | ServiceDesc | 0..\*       | OpenModelAt |             |
+| scriptor    | riptor      |             | tribute     |             |
+|             |             |             |             |             |
+|             |             |             | -  isInvari |             |
+|             |             |             | ant:        |             |
+|             |             |             |       false |             |
+|             |             |             |             |             |
+|             |             |             | -  valueRan |             |
+|             |             |             | ge:         |             |
+|             |             |             |       no    |             |
+|             |             |             |       range |             |
+|             |             |             |       const |             |
+|             |             |             | raint       |             |
+|             |             |             |             |             |
+|             |             |             | -  support: |             |
+|             |             |             |       MANDA |             |
+|             |             |             | TORY        |             |
++-------------+-------------+-------------+-------------+-------------+
+| \_serviceIn | ServiceInst | 0..\*       | OpenModelAt |             |
+| stance      | ance        |             | tribute     |             |
+|             |             |             |             |             |
+|             |             |             | -  isInvari |             |
+|             |             |             | ant:        |             |
+|             |             |             |       false |             |
+|             |             |             |             |             |
+|             |             |             | -  valueRan |             |
+|             |             |             | ge:         |             |
+|             |             |             |       no    |             |
+|             |             |             |       range |             |
+|             |             |             |       const |             |
+|             |             |             | raint       |             |
+|             |             |             |             |             |
+|             |             |             | -  support: |             |
+|             |             |             |       MANDA |             |
+|             |             |             | TORY        |             |
++-------------+-------------+-------------+-------------+-------------+
+| \_serviceCo | ServiceComp | 1..\*       | OpenModelAt |             |
+| mponentDesc | onentDescri |             | tribute     |             |
+| riptor      | ptor        |             |             |             |
+|             |             |             | -  isInvari |             |
+|             |             |             | ant:        |             |
+|             |             |             |       false |             |
+|             |             |             |             |             |
+|             |             |             | -  valueRan |             |
+|             |             |             | ge:         |             |
+|             |             |             |       no    |             |
+|             |             |             |       range |             |
+|             |             |             |       const |             |
+|             |             |             | raint       |             |
+|             |             |             |             |             |
+|             |             |             | -  support: |             |
+|             |             |             |       MANDA |             |
+|             |             |             | TORY        |             |
++-------------+-------------+-------------+-------------+-------------+
+| attachment  | Attachment  | 0..\*       | OpenModelAt |             |
+|             |             |             | tribute     |             |
+|             |             |             |             |             |
+|             |             |             | -  isInvari |             |
+|             |             |             | ant:        |             |
+|             |             |             |       false |             |
+|             |             |             |             |             |
+|             |             |             | -  valueRan |             |
+|             |             |             | ge:         |             |
+|             |             |             |       no    |             |
+|             |             |             |       range |             |
+|             |             |             |       const |             |
+|             |             |             | raint       |             |
+|             |             |             |             |             |
+|             |             |             | -  support: |             |
+|             |             |             |       MANDA |             |
+|             |             |             | TORY        |             |
++-------------+-------------+-------------+-------------+-------------+
+
+Data Types
+==========
+
+Enumerations
+============
+
+ OrderState
+-----------
+
+Contains Enumeration Literals:
+
+-  Acknowledged:
+
+-  InProgress:
+
+-  Pending:
+
+-  Held:
+
+-  Cancelled:
+
+-  Completed:
+
+-  Failed:
+
+-  Partial:
+
+-  Rejected:
+
+Primitives
+==========
+
+Interfaces
+==========
+
+Signals
+=======
+
+Operations
+==========