diff options
Diffstat (limited to 'docs/sections/apis')
| -rw-r--r-- | docs/sections/apis/mod-onboardingapi.json | 597 | ||||
| -rw-r--r-- | docs/sections/apis/mod-onboardingapi.rst | 1285 | ||||
| -rw-r--r-- | docs/sections/apis/swagger_inventory.yaml | 697 | ||||
| -rw-r--r-- | docs/sections/apis/ves-hv/index.rst | 1 |
4 files changed, 0 insertions, 2580 deletions
diff --git a/docs/sections/apis/mod-onboardingapi.json b/docs/sections/apis/mod-onboardingapi.json deleted file mode 100644 index 8e8ce9af..00000000 --- a/docs/sections/apis/mod-onboardingapi.json +++ /dev/null @@ -1,597 +0,0 @@ -{ - "swagger": "2.0", - "basePath": "/onboarding", - "paths": { - "/components": { - "post": { - "responses": { - "500": { - "description": "Internal Server Error" - }, - "409": { - "description": "Component already exists", - "schema": { - "$ref": "#/definitions/Error message" - } - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/Error message" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Component post" - } - } - }, - "description": "Add a Component to the Catalog", - "operationId": "post_component", - "parameters": [{ - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/Component Spec" - } - }, { - "name": "X-Fields", - "in": "header", - "type": "string", - "format": "mask", - "description": "An optional fields mask to support partial object fetching - https://flask-restplus.readthedocs.io/en/stable/mask.html" - }], - "tags": ["onboarding"] - }, - "get": { - "responses": { - "500": { - "description": "Internal Server Error" - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Component List" - } - } - }, - "description": "Get list of Components in the catalog", - "operationId": "get_components", - "parameters": [{ - "name": "name", - "in": "query", - "type": "string", - "description": "Name of component to filter for" - }, { - "name": "version", - "in": "query", - "type": "string", - "description": "Version of component to filter for" - }, { - "name": "X-Fields", - "in": "header", - "type": "string", - "format": "mask", - "description": "An optional fields mask to support partial object fetching - https://flask-restplus.readthedocs.io/en/stable/mask.html" - }], - "tags": ["onboarding"] - } - }, - "/components/{component_id}": { - "parameters": [{ - "name": "component_id", - "in": "path", - "required": true, - "type": "string" - }], - "put": { - "responses": { - "500": { - "description": "Internal Server Error" - }, - "404": { - "description": "Component not found in Catalog", - "schema": { - "$ref": "#/definitions/Error message" - } - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/Error message" - } - }, - "200": { - "description": "Success, Component replaced" - } - }, - "description": "Replace a Component Spec in the Catalog", - "operationId": "put_component", - "parameters": [{ - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/Component Spec" - } - }], - "tags": ["onboarding"] - }, - "get": { - "responses": { - "500": { - "description": "Internal Server Error" - }, - "404": { - "description": "Component not found in Catalog", - "schema": { - "$ref": "#/definitions/Error message" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/component fields by id" - } - } - }, - "description": "Get a Component", - "operationId": "get_component", - "parameters": [{ - "name": "X-Fields", - "in": "header", - "type": "string", - "format": "mask", - "description": "An optional fields mask to support partial object fetching - https://flask-restplus.readthedocs.io/en/stable/mask.html" - }], - "tags": ["onboarding"] - }, - "patch": { - "responses": { - "500": { - "description": "Internal Server Error" - }, - "404": { - "description": "Component not found in Catalog", - "schema": { - "$ref": "#/definitions/Error message" - } - }, - "403": { - "description": "Forbidden Request", - "schema": { - "$ref": "#/definitions/Error message" - } - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/Error message" - } - }, - "200": { - "description": "Success, Component status updated" - } - }, - "description": "Update a Component's status in the Catalog", - "operationId": "patch_component", - "parameters": [{ - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/Patch Spec" - } - }], - "tags": ["onboarding"] - } - }, - "/dataformats": { - "post": { - "responses": { - "500": { - "description": "Internal Server Error" - }, - "409": { - "description": "Data Format already exists", - "schema": { - "$ref": "#/definitions/Error message" - } - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/Error message" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Data Format post" - } - } - }, - "description": "Add a Data Format to the Catalog", - "operationId": "post_dataformat", - "parameters": [{ - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/Data Format Spec" - } - }, { - "name": "X-Fields", - "in": "header", - "type": "string", - "format": "mask", - "description": "An optional fields mask to support partial object fetching - https://flask-restplus.readthedocs.io/en/stable/mask.html" - }], - "tags": ["onboarding"] - }, - "get": { - "responses": { - "500": { - "description": "Internal Server Error" - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Data Format List" - } - } - }, - "description": "Get list of Data Formats in the catalog", - "operationId": "get_dataformats", - "parameters": [{ - "name": "X-Fields", - "in": "header", - "type": "string", - "format": "mask", - "description": "An optional fields mask to support partial object fetching - https://flask-restplus.readthedocs.io/en/stable/mask.html" - }], - "tags": ["onboarding"] - } - }, - "/dataformats/{dataformat_id}": { - "parameters": [{ - "name": "dataformat_id", - "in": "path", - "required": true, - "type": "string" - }], - "put": { - "responses": { - "500": { - "description": "Internal Server Error" - }, - "404": { - "description": "Data Format not found in Catalog", - "schema": { - "$ref": "#/definitions/Error message" - } - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/Error message" - } - }, - "200": { - "description": "Success, Data Format added" - } - }, - "description": "Replace a Data Format Spec in the Catalog", - "operationId": "put_dataformat", - "parameters": [{ - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/Data Format Spec" - } - }], - "tags": ["onboarding"] - }, - "get": { - "responses": { - "500": { - "description": "Internal Server Error" - }, - "404": { - "description": "Data Format not found in Catalog", - "schema": { - "$ref": "#/definitions/Error message" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/dataformat fields by id" - } - } - }, - "description": "Get a Data Format", - "operationId": "get_dataformat", - "parameters": [{ - "name": "X-Fields", - "in": "header", - "type": "string", - "format": "mask", - "description": "An optional fields mask to support partial object fetching - https://flask-restplus.readthedocs.io/en/stable/mask.html" - }], - "tags": ["onboarding"] - }, - "patch": { - "responses": { - "500": { - "description": "Internal Server Error" - }, - "404": { - "description": "Data Format not found in Catalog", - "schema": { - "$ref": "#/definitions/Error message" - } - }, - "403": { - "description": "Forbidden Request", - "schema": { - "$ref": "#/definitions/Error message" - } - }, - "400": { - "description": "Bad Request", - "schema": { - "$ref": "#/definitions/Error message" - } - }, - "200": { - "description": "Success, Data Format status updated" - } - }, - "description": "Update a Data Format's status in the Catalog", - "operationId": "patch_dataformat", - "parameters": [{ - "name": "payload", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/Patch Spec" - } - }], - "tags": ["onboarding"] - } - } - }, - "info": { - "title": "DCAE Onboarding HTTP API", - "version": "2.12.0" - }, - "produces": ["application/json"], - "consumes": ["application/json"], - "tags": [{ - "name": "onboarding", - "description": "Default namespace" - }], - "definitions": { - "Component Spec": { - "properties": { - "owner": { - "type": "string" - }, - "spec": { - "type": "object", - "description": "The Component Spec schema is here -> https://git.onap.org/dcaegen2/platform/cli/plain/component-json-schemas/component-specification/dcae-cli-v2/component-spec-schema.json" - } - } - }, - "Error message": { - "properties": { - "message": { - "type": "string", - "description": ". . . . .Details about the unsuccessful API request" - } - }, - "type": "object" - }, - "Component post": { - "required": ["componentUrl"], - "properties": { - "componentUrl": { - "type": "string", - "description": ". . . . Url to the Component Specification" - } - }, - "type": "object" - }, - "Component List": { - "properties": { - "components": { - "type": "array", - "items": { - "$ref": "#/definitions/component fields" - } - } - }, - "type": "object" - }, - "component fields": { - "required": ["componentType", "componentUrl", "description", "id", "modified", "name", "owner", "status", "version", "whenAdded"], - "properties": { - "id": { - "type": "string", - "description": ". . . . ID of the component" - }, - "name": { - "type": "string", - "description": ". . . . Name of the component" - }, - "version": { - "type": "string", - "description": ". . . . Version of the component" - }, - "owner": { - "type": "string", - "description": ". . . . ID of who added the component" - }, - "whenAdded": { - "type": "string", - "format": "date-time", - "description": ". . . . When component was added to the Catalog" - }, - "modified": { - "type": "string", - "format": "date-time", - "description": ". . . . When component was last modified" - }, - "status": { - "type": "string", - "description": ". . . . Status of the component" - }, - "description": { - "type": "string", - "description": ". . . . Description of the component" - }, - "componentType": { - "type": "string", - "description": ". . . . only \"docker\"" - }, - "componentUrl": { - "type": "string", - "description": ". . . . Url to the Component Specification" - } - }, - "type": "object" - }, - "Patch Spec": { - "required": ["owner", "status"], - "properties": { - "owner": { - "type": "string", - "description": "User ID" - }, - "status": { - "type": "string", - "description": ". . . . .[published] is the only status change supported right now", - "example": "published", - "enum": ["published", "revoked"] - } - }, - "type": "object" - }, - "component fields by id": { - "allOf": [{ - "$ref": "#/definitions/component fields" - }, { - "required": ["spec"], - "properties": { - "spec": { - "type": "object", - "description": "The Component Specification (json)" - } - }, - "type": "object" - }] - }, - "Data Format Spec": { - "properties": { - "owner": { - "type": "string" - }, - "spec": { - "type": "object", - "description": "The Data Format Spec schema is here -> https://git.onap.org/dcaegen2/platform/cli/plain/component-json-schemas/data-format/dcae-cli-v1/data-format-schema.json" - } - } - }, - "Data Format post": { - "required": ["dataFormatUrl"], - "properties": { - "dataFormatUrl": { - "type": "string", - "description": ". . . . Url to the Data Format Specification" - } - }, - "type": "object" - }, - "Data Format List": { - "properties": { - "dataFormats": { - "type": "array", - "items": { - "$ref": "#/definitions/dataformat fields" - } - } - }, - "type": "object" - }, - "dataformat fields": { - "required": ["dataFormatUrl", "description", "id", "modified", "name", "owner", "status", "version", "whenAdded"], - "properties": { - "id": { - "type": "string", - "description": ". . . . ID of the data format" - }, - "name": { - "type": "string", - "description": ". . . . Name of the data format" - }, - "version": { - "type": "string", - "description": ". . . . Version of the data format" - }, - "owner": { - "type": "string", - "description": ". . . . ID of who added the data format" - }, - "whenAdded": { - "type": "string", - "format": "date-time", - "description": ". . . . When data format was added to the Catalog" - }, - "modified": { - "type": "string", - "format": "date-time", - "description": ". . . . When data format was last modified" - }, - "status": { - "type": "string", - "description": ". . . . Status of the data format" - }, - "description": { - "type": "string", - "description": ". . . . Description of the data format" - }, - "dataFormatUrl": { - "type": "string", - "description": ". . . . Url to the Data Format Specification" - } - }, - "type": "object" - }, - "dataformat fields by id": { - "allOf": [{ - "$ref": "#/definitions/dataformat fields" - }, { - "required": ["spec"], - "properties": { - "spec": { - "type": "object", - "description": "The Data Format Specification (json)" - } - }, - "type": "object" - }] - } - }, - "responses": { - "ParseError": { - "description": "When a mask can't be parsed" - }, - "MaskError": { - "description": "When any error occurs on mask" - } - } -}
\ No newline at end of file diff --git a/docs/sections/apis/mod-onboardingapi.rst b/docs/sections/apis/mod-onboardingapi.rst deleted file mode 100644 index a76bef4a..00000000 --- a/docs/sections/apis/mod-onboardingapi.rst +++ /dev/null @@ -1,1285 +0,0 @@ -.. This work is licensed under a - Creative Commons Attribution 4.0 International License. - -Onboarding HTTP API (MOD) -========================= - -.. toctree:: - :maxdepth: 3 - - -Description -~~~~~~~~~~~ - -Onboarding API is sub-component under MOD provides following function: - -1. API to add/update data-formats -2. API to add/update components (component_Spec) - -These API can be invoked by MS owners or by Acumos adapter to upload artifact into MOD catalog - -.. csv-table:: - :header: "API name", "Swagger" - :widths: 10,5 - - "Inventory", ":download:`link <mod-onboardingapi.json>`" - -Base URL -~~~~~~~~ - -http:///onboarding - -ONBOARDING -~~~~~~~~~~ - - -Default namespace - - - - - -GET ``/components/{component_id}`` ----------------------------------- - - - -Description -+++++++++++ - -.. raw:: html - - Get a Component - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - component_id | path | Yes | string | | | - - -Request -+++++++ - - -Headers -^^^^^^^ - -.. code-block:: javascript - - X-Fields: An optional fields mask to support partial object fetching - https://flask-restplus.readthedocs.io/en/stable/mask.html - - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success - - -Type: :ref:`component fields <d_41cf5e14516a536474c8079d332e86c7>` extended :ref:`inline <i_34dba329148d5512a1350568d728c028>` - -**Example:** - -.. code-block:: javascript - - { - "componentType": "somestring", - "componentUrl": "somestring", - "description": "somestring", - "id": "somestring", - "modified": "2015-01-01T15:00:00.000Z", - "name": "somestring", - "owner": "somestring", - "spec": {}, - "status": "somestring", - "version": "somestring", - "whenAdded": "2015-01-01T15:00:00.000Z" - } - -**404** -^^^^^^^ - -Component not found in Catalog - - -Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring" - } - -**500** -^^^^^^^ - -Internal Server Error - - - - - - -GET ``/components`` -------------------- - - - -Description -+++++++++++ - -.. raw:: html - - Get list of Components in the catalog - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - name | query | No | string | | | Name of component to filter for - version | query | No | string | | | Version of component to filter for - - -Request -+++++++ - - -Headers -^^^^^^^ - -.. code-block:: javascript - - X-Fields: An optional fields mask to support partial object fetching - https://flask-restplus.readthedocs.io/en/stable/mask.html - - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success - - -Type: :ref:`Component List <d_53b82f243acb3fd79572e5a8e909c801>` - -**Example:** - -.. code-block:: javascript - - { - "components": [ - { - "componentType": "somestring", - "componentUrl": "somestring", - "description": "somestring", - "id": "somestring", - "modified": "2015-01-01T15:00:00.000Z", - "name": "somestring", - "owner": "somestring", - "status": "somestring", - "version": "somestring", - "whenAdded": "2015-01-01T15:00:00.000Z" - }, - { - "componentType": "somestring", - "componentUrl": "somestring", - "description": "somestring", - "id": "somestring", - "modified": "2015-01-01T15:00:00.000Z", - "name": "somestring", - "owner": "somestring", - "status": "somestring", - "version": "somestring", - "whenAdded": "2015-01-01T15:00:00.000Z" - } - ] - } - -**500** -^^^^^^^ - -Internal Server Error - - - - - - -GET ``/dataformats/{dataformat_id}`` ------------------------------------- - - - -Description -+++++++++++ - -.. raw:: html - - Get a Data Format - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - dataformat_id | path | Yes | string | | | - - -Request -+++++++ - - -Headers -^^^^^^^ - -.. code-block:: javascript - - X-Fields: An optional fields mask to support partial object fetching - https://flask-restplus.readthedocs.io/en/stable/mask.html - - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success - - -Type: :ref:`dataformat fields <d_68ab1278c950fd214a4077565fd97922>` extended :ref:`inline <i_19c008f5124504e9d9c719d157dab70f>` - -**Example:** - -.. code-block:: javascript - - { - "dataFormatUrl": "somestring", - "description": "somestring", - "id": "somestring", - "modified": "2015-01-01T15:00:00.000Z", - "name": "somestring", - "owner": "somestring", - "spec": {}, - "status": "somestring", - "version": "somestring", - "whenAdded": "2015-01-01T15:00:00.000Z" - } - -**404** -^^^^^^^ - -Data Format not found in Catalog - - -Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring" - } - -**500** -^^^^^^^ - -Internal Server Error - - - - - - -GET ``/dataformats`` --------------------- - - - -Description -+++++++++++ - -.. raw:: html - - Get list of Data Formats in the catalog - - -Request -+++++++ - - -Headers -^^^^^^^ - -.. code-block:: javascript - - X-Fields: An optional fields mask to support partial object fetching - https://flask-restplus.readthedocs.io/en/stable/mask.html - - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success - - -Type: :ref:`Data Format List <d_9479fe3b8fa2fcaeb723c198da99e791>` - -**Example:** - -.. code-block:: javascript - - { - "dataFormats": [ - { - "dataFormatUrl": "somestring", - "description": "somestring", - "id": "somestring", - "modified": "2015-01-01T15:00:00.000Z", - "name": "somestring", - "owner": "somestring", - "status": "somestring", - "version": "somestring", - "whenAdded": "2015-01-01T15:00:00.000Z" - }, - { - "dataFormatUrl": "somestring", - "description": "somestring", - "id": "somestring", - "modified": "2015-01-01T15:00:00.000Z", - "name": "somestring", - "owner": "somestring", - "status": "somestring", - "version": "somestring", - "whenAdded": "2015-01-01T15:00:00.000Z" - } - ] - } - -**500** -^^^^^^^ - -Internal Server Error - - - - - - -PATCH ``/components/{component_id}`` ------------------------------------- - - - -Description -+++++++++++ - -.. raw:: html - - Update a Component's status in the Catalog - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - component_id | path | Yes | string | | | - - -Request -+++++++ - - - -Body -^^^^ - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - owner | Yes | string | | | User ID - status | Yes | string | | {'enum': ['published', 'revoked']} | . . . . .[published] is the only status change supported right now - -.. code-block:: javascript - - { - "owner": "somestring", - "status": "published" - } - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success, Component status updated - - -**400** -^^^^^^^ - -Bad Request - - -Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring" - } - -**403** -^^^^^^^ - -Forbidden Request - - -Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring" - } - -**404** -^^^^^^^ - -Component not found in Catalog - - -Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring" - } - -**500** -^^^^^^^ - -Internal Server Error - - - - - - -PATCH ``/dataformats/{dataformat_id}`` --------------------------------------- - - - -Description -+++++++++++ - -.. raw:: html - - Update a Data Format's status in the Catalog - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - dataformat_id | path | Yes | string | | | - - -Request -+++++++ - - - - -Body -^^^^ - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - owner | Yes | string | | | User ID - status | Yes | string | | {'enum': ['published', 'revoked']} | . . . . .[published] is the only status change supported right now - -.. code-block:: javascript - - { - "owner": "somestring", - "status": "published" - } - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success, Data Format status updated - - -**400** -^^^^^^^ - -Bad Request - - -Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring" - } - -**403** -^^^^^^^ - -Forbidden Request - - -Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring" - } - -**404** -^^^^^^^ - -Data Format not found in Catalog - - -Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring" - } - -**500** -^^^^^^^ - -Internal Server Error - - - - - - -POST ``/components`` --------------------- - - - -Description -+++++++++++ - -.. raw:: html - - Add a Component to the Catalog - - -Request -+++++++ - - -Headers -^^^^^^^ - -.. code-block:: javascript - - X-Fields: An optional fields mask to support partial object fetching - https://flask-restplus.readthedocs.io/en/stable/mask.html - - - - -Body -^^^^ - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - owner | No | string | | | - spec | No | :ref:`spec <i_793f480461dccbb35537f2001ab7af5b>` | | | The Component Spec schema is here -> https://git.onap.org/dcaegen2/platform/cli/plain/component-json-schemas/component-specification/dcae-cli-v2/component-spec-schema.json - -.. _i_793f480461dccbb35537f2001ab7af5b: - -**Spec schema:** - - -The Component Spec schema is here -> https://git.onap.org/dcaegen2/platform/cli/plain/component-json-schemas/component-specification/dcae-cli-v2/component-spec-schema.json - - - -.. code-block:: javascript - - { - "owner": "somestring", - "spec": {} - } - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success - - -Type: :ref:`Component post <d_9eafe9d5168f431205b9fce1312b32bb>` - -**Example:** - -.. code-block:: javascript - - { - "componentUrl": "somestring" - } - -**400** -^^^^^^^ - -Bad Request - - -Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring" - } - -**409** -^^^^^^^ - -Component already exists - - -Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring" - } - -**500** -^^^^^^^ - -Internal Server Error - - - - - - -POST ``/dataformats`` ---------------------- - - - -Description -+++++++++++ - -.. raw:: html - - Add a Data Format to the Catalog - - -Request -+++++++ - - -Headers -^^^^^^^ - -.. code-block:: javascript - - X-Fields: An optional fields mask to support partial object fetching - https://flask-restplus.readthedocs.io/en/stable/mask.html - - - - -Body -^^^^ - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - owner | No | string | | | - spec | No | :ref:`spec <i_24d5c9ce4ae509ac2272fb61bf0e2004>` | | | The Data Format Spec schema is here -> https://git.onap.org/dcaegen2/platform/cli/plain/component-json-schemas/data-format/dcae-cli-v1/data-format-schema.json - -.. _i_24d5c9ce4ae509ac2272fb61bf0e2004: - -**Spec schema:** - - -The Data Format Spec schema is here -> https://git.onap.org/dcaegen2/platform/cli/plain/component-json-schemas/data-format/dcae-cli-v1/data-format-schema.json - - - -.. code-block:: javascript - - { - "owner": "somestring", - "spec": {} - } - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success - - -Type: :ref:`Data Format post <d_6557e42aae4abfe7f132d85f512a1a26>` - -**Example:** - -.. code-block:: javascript - - { - "dataFormatUrl": "somestring" - } - -**400** -^^^^^^^ - -Bad Request - - -Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring" - } - -**409** -^^^^^^^ - -Data Format already exists - - -Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring" - } - -**500** -^^^^^^^ - -Internal Server Error - - - - - - -PUT ``/components/{component_id}`` ----------------------------------- - - - -Description -+++++++++++ - -.. raw:: html - - Replace a Component Spec in the Catalog - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - component_id | path | Yes | string | | | - - -Request -+++++++ - - - -Body -^^^^ - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - owner | No | string | | | - spec | No | :ref:`spec <i_793f480461dccbb35537f2001ab7af5c>` | | | The Component Spec schema is here -> https://git.onap.org/dcaegen2/platform/cli/plain/component-json-schemas/component-specification/dcae-cli-v2/component-spec-schema.json - -.. _i_793f480461dccbb35537f2001ab7af5c: - -**Spec schema:** - - -The Component Spec schema is here -> https://git.onap.org/dcaegen2/platform/cli/plain/component-json-schemas/component-specification/dcae-cli-v2/component-spec-schema.json - - - -.. code-block:: javascript - - { - "owner": "somestring", - "spec": {} - } - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success, Component replaced - - -**400** -^^^^^^^ - -Bad Request - - -Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring" - } - -**404** -^^^^^^^ - -Component not found in Catalog - - -Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring" - } - -**500** -^^^^^^^ - -Internal Server Error - - - - - - -PUT ``/dataformats/{dataformat_id}`` ------------------------------------- - - - -Description -+++++++++++ - -.. raw:: html - - Replace a Data Format Spec in the Catalog - -Parameters -++++++++++ - -.. csv-table:: - :delim: | - :header: "Name", "Located in", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 15, 10, 10, 10, 20, 30 - - dataformat_id | path | Yes | string | | | - - -Request -+++++++ - - - -Body -^^^^ - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - owner | No | string | | | - spec | No | :ref:`spec <i_24d5c9ce4ae509ac2272fb61bf0e2004>` | | | The Data Format Spec schema is here -> https://git.onap.org/dcaegen2/platform/cli/plain/component-json-schemas/data-format/dcae-cli-v1/data-format-schema.json - -.. _i_24d5c9ce4ae509ac2272fb61bf0e2004: - -**Spec schema:** - - -The Data Format Spec schema is here -> https://git.onap.org/dcaegen2/platform/cli/plain/component-json-schemas/data-format/dcae-cli-v1/data-format-schema.json - - - -.. code-block:: javascript - - { - "owner": "somestring", - "spec": {} - } - -Responses -+++++++++ - -**200** -^^^^^^^ - -Success, Data Format added - - -**400** -^^^^^^^ - -Bad Request - - -Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring" - } - -**404** -^^^^^^^ - -Data Format not found in Catalog - - -Type: :ref:`Error message <d_e8453714bcbe180e59d1dfbfc583c9cb>` - -**Example:** - -.. code-block:: javascript - - { - "message": "somestring" - } - -**500** -^^^^^^^ - -Internal Server Error - - - - - -Data Structures -~~~~~~~~~~~~~~~ - -.. _d_53b82f243acb3fd79572e5a8e909c801: - -Component List Model Structure ------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - components | No | array of :ref:`component fields <d_41cf5e14516a536474c8079d332e86c7>` | | | - - -Component Spec Model Structure ------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - owner | No | string | | | - spec | No | :ref:`spec <i_793f480461dccbb35537f2001ab7af5v>` | | | The Component Spec schema is here -> https://git.onap.org/dcaegen2/platform/cli/plain/component-json-schemas/component-specification/dcae-cli-v2/component-spec-schema.json - -.. _i_793f480461dccbb35537f2001ab7af5v: - -**Spec schema:** - - -The Component Spec schema is here -> https://git.onap.org/dcaegen2/platform/cli/plain/component-json-schemas/component-specification/dcae-cli-v2/component-spec-schema.json - - - -.. _d_9eafe9d5168f431205b9fce1312b32bb: - -Component post Model Structure ------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - componentUrl | Yes | string | | | . . . . Url to the Component Specification - -.. _d_9479fe3b8fa2fcaeb723c198da99e791: - -Data Format List Model Structure --------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - dataFormats | No | array of :ref:`dataformat fields <d_68ab1278c950fd214a4077565fd97922>` | | | - - -Data Format Spec Model Structure --------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - owner | No | string | | | - spec | No | :ref:`spec <i_24d5c9ce4ae509ac2272fb61bf0e2003>` | | | The Data Format Spec schema is here -> https://git.onap.org/dcaegen2/platform/cli/plain/component-json-schemas/data-format/dcae-cli-v1/data-format-schema.json - -.. _i_24d5c9ce4ae509ac2272fb61bf0e2003: - -**Spec schema:** - - -The Data Format Spec schema is here -> https://git.onap.org/dcaegen2/platform/cli/plain/component-json-schemas/data-format/dcae-cli-v1/data-format-schema.json - - - -.. _d_6557e42aae4abfe7f132d85f512a1a26: - -Data Format post Model Structure --------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - dataFormatUrl | Yes | string | | | . . . . Url to the Data Format Specification - -.. _d_e8453714bcbe180e59d1dfbfc583c9cb: - -Error message Model Structure ------------------------------ - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - message | No | string | | | . . . . .Details about the unsuccessful API request - - -Patch Spec Model Structure --------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - owner | Yes | string | | | User ID - status | Yes | string | | {'enum': ['published', 'revoked']} | . . . . .[published] is the only status change supported right now - -.. _d_41cf5e14516a536474c8079d332e86c7: - -component fields Model Structure --------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - componentType | Yes | string | | | . . . . only 'docker' - componentUrl | Yes | string | | | . . . . Url to the Component Specification - description | Yes | string | | | . . . . Description of the component - id | Yes | string | | | . . . . ID of the component - modified | Yes | string | date-time | | . . . . When component was last modified - name | Yes | string | | | . . . . Name of the component - owner | Yes | string | | | . . . . ID of who added the component - status | Yes | string | | | . . . . Status of the component - version | Yes | string | | | . . . . Version of the component - whenAdded | Yes | string | date-time | | . . . . When component was added to the Catalog - -.. _d_c86e31bb6b9a2aaf18cab261f501cdf1: - -component fields by id Model Structure --------------------------------------- - -:ref:`component fields <d_41cf5e14516a536474c8079d332e86c7>` extended :ref:`inline <i_34dba329148d5512a1350568d728c028>` - -.. _i_34dba329148d5512a1350568d728c028: - -**Inline schema:** - - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - componentType | Yes | string | | | . . . . only 'docker' - componentUrl | Yes | string | | | . . . . Url to the Component Specification - description | Yes | string | | | . . . . Description of the component - id | Yes | string | | | . . . . ID of the component - modified | Yes | string | date-time | | . . . . When component was last modified - name | Yes | string | | | . . . . Name of the component - owner | Yes | string | | | . . . . ID of who added the component - spec | Yes | :ref:`spec <i_ea9c5ae5ca1fb737a10e33ba863d3d34>` | | | The Component Specification (json) - status | Yes | string | | | . . . . Status of the component - version | Yes | string | | | . . . . Version of the component - whenAdded | Yes | string | date-time | | . . . . When component was added to the Catalog - -.. _i_ea9c5ae5ca1fb737a10e33ba863d3d34: - -**Spec schema:** - - -The Component Specification (json) - - - -.. _d_68ab1278c950fd214a4077565fd97922: - -dataformat fields Model Structure ---------------------------------- - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - dataFormatUrl | Yes | string | | | . . . . Url to the Data Format Specification - description | Yes | string | | | . . . . Description of the data format - id | Yes | string | | | . . . . ID of the data format - modified | Yes | string | date-time | | . . . . When data format was last modified - name | Yes | string | | | . . . . Name of the data format - owner | Yes | string | | | . . . . ID of who added the data format - status | Yes | string | | | . . . . Status of the data format - version | Yes | string | | | . . . . Version of the data format - whenAdded | Yes | string | date-time | | . . . . When data format was added to the Catalog - -.. _d_9c3ce799741cd0dae7f4d25c049e8a79: - -dataformat fields by id Model Structure ---------------------------------------- - -:ref:`dataformat fields <d_68ab1278c950fd214a4077565fd97922>` extended :ref:`inline <i_19c008f5124504e9d9c719d157dab70f>` - -.. _i_19c008f5124504e9d9c719d157dab70f: - -**Inline schema:** - - -.. csv-table:: - :delim: | - :header: "Name", "Required", "Type", "Format", "Properties", "Description" - :widths: 20, 10, 15, 15, 30, 25 - - dataFormatUrl | Yes | string | | | . . . . Url to the Data Format Specification - description | Yes | string | | | . . . . Description of the data format - id | Yes | string | | | . . . . ID of the data format - modified | Yes | string | date-time | | . . . . When data format was last modified - name | Yes | string | | | . . . . Name of the data format - owner | Yes | string | | | . . . . ID of who added the data format - spec | Yes | :ref:`spec <i_c9a99411463ded6c619772d83b3882c8>` | | | The Data Format Specification (json) - status | Yes | string | | | . . . . Status of the data format - version | Yes | string | | | . . . . Version of the data format - whenAdded | Yes | string | date-time | | . . . . When data format was added to the Catalog - -.. _i_c9a99411463ded6c619772d83b3882c8: - -**Spec schema:** - - -The Data Format Specification (json) diff --git a/docs/sections/apis/swagger_inventory.yaml b/docs/sections/apis/swagger_inventory.yaml deleted file mode 100644 index 6fd57162..00000000 --- a/docs/sections/apis/swagger_inventory.yaml +++ /dev/null @@ -1,697 +0,0 @@ -# ================================================================================ -# Copyright (c) 2017-2018 AT&T Intellectual Property. All rights reserved. -# ================================================================================ -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# ============LICENSE_END========================================================= -# -# ECOMP is a trademark and service mark of AT&T Intellectual Property. -swagger: '2.0' -info: - version: "3.0.4" - title: DCAE Inventory API - description: | - DCAE Inventory is a web service that provides the following: - - 1. Real-time data on all DCAE services and their components - 2. Comprehensive details on available DCAE service types - contact: - email: dcae@lists.openecomp.org -externalDocs: - description: DCAE Inventory - url: https://gerrit.onap.org/r/#/admin/projects/dcae/dcae-inventory -paths: - /dcae-service-types: - get: - summary: "" - description: "Get a list of `DCAEServiceType` objects." - operationId: "dcaeServiceTypesGet" - consumes: - - "application/json" - - "application/vnd.dcae.inventory.v1+json" - produces: - - "application/json" - - "application/vnd.dcae.inventory.v1+json" - parameters: - - name: "typeName" - in: "query" - description: "Filter by service type name" - required: false - type: "string" - - name: "onlyLatest" - in: "query" - description: "If set to true, query returns just the latest versions of DCAE\ - \ service types. If set to false, then all versions are returned. Default\ - \ is true" - required: false - type: "boolean" - default: true - - name: "onlyActive" - in: "query" - description: "If set to true, query returns only *active* DCAE service types.\ - \ If set to false, then all DCAE service types are returned. Default is\ - \ true" - required: false - type: "boolean" - default: true - - name: "vnfType" - in: "query" - description: "Filter by associated vnf type. No wildcards, matches are explicit.\ - \ This field is treated case insensitive." - required: false - type: "string" - - name: "serviceId" - in: "query" - description: "Filter by assocaited service id. Instances with service id null\ - \ or empty is always returned." - required: false - type: "string" - - name: "serviceLocation" - in: "query" - description: "Filter by associated service location. Instances with service\ - \ location null or empty is always returned." - required: false - type: "string" - - name: "asdcServiceId" - in: "query" - description: "Filter by associated asdc design service id. Setting this to\ - \ `NONE` will return instances that have asdc service id set to null" - required: false - type: "string" - - name: "asdcResourceId" - in: "query" - description: "Filter by associated asdc design resource id. Setting this to\ - \ `NONE` will return instances that have asdc resource id set to null" - required: false - type: "string" - - name: "offset" - in: "query" - description: "Query resultset offset used for pagination (zero-based)" - required: false - type: "integer" - format: "int32" - responses: - 200: - description: "List of `DCAEServiceType` objects" - schema: - $ref: "#/definitions/InlineResponse200" - post: - summary: "" - description: "Inserts a new `DCAEServiceType` or updates an existing instance.\ - \ Updates are only allowed iff there are no running DCAE services of the requested\ - \ type," - operationId: "dcaeServiceTypesTypeNamePut" - consumes: - - "application/json" - produces: - - "application/json" - parameters: - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/DCAEServiceTypeRequest" - responses: - 200: - description: "Single `DCAEServiceType` object." - schema: - $ref: "#/definitions/DCAEServiceType" - 400: - description: "Bad request provided." - schema: - $ref: "#/definitions/ApiResponseMessage" - 409: - description: "Failed to update because there are still DCAE services of\ - \ the requested type running." - schema: - $ref: "#/definitions/ApiResponseMessage" - /dcae-service-types/{typeId}: - get: - summary: "" - description: "Get a `DCAEServiceType` object." - operationId: "dcaeServiceTypesTypeIdGet" - consumes: - - "application/json" - produces: - - "application/json" - parameters: - - name: "typeId" - in: "path" - required: true - type: "string" - responses: - 200: - description: "Single `DCAEServiceType` object" - schema: - $ref: "#/definitions/DCAEServiceType" - 404: - description: "Resource not found" - schema: - $ref: "#/definitions/DCAEServiceType" - delete: - summary: "" - description: "Deactivates existing `DCAEServiceType` instances" - operationId: "dcaeServiceTypesTypeIdDelete" - consumes: - - "application/vnd.dcae.inventory.v1+json" - - "application/json" - produces: - - "application/vnd.dcae.inventory.v1+json" - - "application/json" - parameters: - - name: "typeId" - in: "path" - required: true - type: "string" - responses: - 200: - description: "`DCAEServiceType` has been deactivated" - schema: - $ref: "#/definitions/ApiResponseMessage" - 410: - description: "`DCAEServiceType` already gone" - schema: - $ref: "#/definitions/ApiResponseMessage" - 404: - description: "`DCAEServiceType` not found" - schema: - $ref: "#/definitions/ApiResponseMessage" - /dcae-services: - get: - summary: "" - description: "Get a list of `DCAEService` objects." - operationId: "dcaeServicesGet" - consumes: - - "application/json" - - "application/vnd.dcae.inventory.v1+json" - produces: - - "application/json" - - "application/vnd.dcae.inventory.v1+json" - parameters: - - name: "typeId" - in: "query" - description: "DCAE service type name" - required: false - type: "string" - - name: "vnfId" - in: "query" - required: false - type: "string" - - name: "vnfType" - in: "query" - description: "Filter by associated vnf type. This field is treated case insensitive." - required: false - type: "string" - - name: "vnfLocation" - in: "query" - required: false - type: "string" - - name: "componentType" - in: "query" - description: "Use to filter by a specific DCAE service component type" - required: false - type: "string" - - name: "shareable" - in: "query" - description: "Use to filter by DCAE services that have shareable components\ - \ or not" - required: false - type: "boolean" - - name: "created" - in: "query" - description: "Use to filter by created time" - required: false - type: "string" - - name: "offset" - in: "query" - description: "Query resultset offset used for pagination (zero-based)" - required: false - type: "integer" - format: "int32" - responses: - 200: - description: "List of `DCAEService` objects" - schema: - $ref: "#/definitions/InlineResponse2001" - 502: - description: "Bad response from DCAE controller" - schema: - $ref: "#/definitions/ApiResponseMessage" - 504: - description: "Failed to connect with DCAE controller" - schema: - $ref: "#/definitions/ApiResponseMessage" - /dcae-services-groupby/{propertyName}: - get: - summary: "" - description: "Get a list of unique values for the given `propertyName`" - operationId: "dcaeServicesGroupbyPropertyNameGet" - consumes: - - "application/json" - - "application/vnd.dcae.inventory.v1+json" - produces: - - "application/json" - - "application/vnd.dcae.inventory.v1+json" - parameters: - - name: "propertyName" - in: "path" - description: "Property to find unique values. Restricted to `type`, `vnfType`,\ - \ `vnfLocation`" - required: true - type: "string" - responses: - 200: - description: "List of unique property values" - schema: - $ref: "#/definitions/DCAEServiceGroupByResults" - /dcae-services/{serviceId}: - get: - summary: "" - description: "Get a `DCAEService` object." - operationId: "dcaeServicesServiceIdGet" - consumes: - - "application/json" - - "application/vnd.dcae.inventory.v1+json" - produces: - - "application/json" - - "application/vnd.dcae.inventory.v1+json" - parameters: - - name: "serviceId" - in: "path" - required: true - type: "string" - responses: - 200: - description: "Single `DCAEService` object" - schema: - $ref: "#/definitions/DCAEService" - 502: - description: "Bad response from DCAE controller" - schema: - $ref: "#/definitions/ApiResponseMessage" - 404: - description: "DCAE service not found" - schema: - $ref: "#/definitions/ApiResponseMessage" - 504: - description: "Failed to connect with DCAE controller" - schema: - $ref: "#/definitions/ApiResponseMessage" - put: - summary: "" - description: "Put a new or update an existing `DCAEService` object." - operationId: "dcaeServicesServiceIdPut" - consumes: - - "application/json" - - "application/vnd.dcae.inventory.v1+json" - produces: - - "application/json" - - "application/vnd.dcae.inventory.v1+json" - parameters: - - name: "serviceId" - in: "path" - required: true - type: "string" - - in: "body" - name: "body" - required: true - schema: - $ref: "#/definitions/DCAEServiceRequest" - responses: - 200: - description: "Single `DCAEService` object" - schema: - $ref: "#/definitions/DCAEService" - 422: - description: "Bad request provided" - schema: - $ref: "#/definitions/ApiResponseMessage" - delete: - summary: "" - description: "Remove an existing `DCAEService` object." - operationId: "dcaeServicesServiceIdDelete" - consumes: - - "application/vnd.dcae.inventory.v1+json" - - "application/json" - produces: - - "application/json" - - "application/vnd.dcae.inventory.v1+json" - parameters: - - name: "serviceId" - in: "path" - required: true - type: "string" - responses: - 200: - description: "DCAE service has been removed" - 404: - description: "Unknown DCAE service" - schema: - $ref: "#/definitions/ApiResponseMessage" -definitions: - DCAEServiceTypeRequest: - type: "object" - required: - - "blueprintTemplate" - - "owner" - - "typeName" - - "typeVersion" - properties: - owner: - type: "string" - typeName: - type: "string" - description: "Descriptive name for this DCAE service type" - typeVersion: - type: "integer" - format: "int32" - description: "Version number for this DCAE service type" - blueprintTemplate: - type: "string" - description: "String representation of a Cloudify blueprint with unbound variables" - serviceIds: - type: "array" - description: "List of service ids that are used to associate with DCAE service\ - \ type. DCAE service types with this propery as null or empty means them\ - \ apply for every service id." - items: - type: "string" - vnfTypes: - type: "array" - items: - type: "string" - serviceLocations: - type: "array" - description: "List of service locations that are used to associate with DCAE\ - \ service type. DCAE service types with this propery as null or empty means\ - \ them apply for every service location." - items: - type: "string" - asdcServiceId: - type: "string" - description: "Id of service this DCAE service type is associated with. Value\ - \ source is from ASDC's notification event's field `serviceInvariantUUID`." - asdcResourceId: - type: "string" - description: "Id of vf/vnf instance this DCAE service type is associated with.\ - \ Value source is from ASDC's notification event's field `resourceInvariantUUID`." - asdcServiceURL: - type: "string" - description: "URL to the ASDC service model" - DCAEServiceComponentRequest: - type: "object" - required: - - "componentId" - - "componentSource" - - "componentType" - - "shareable" - properties: - componentId: - type: "string" - description: "The id format is unique to the source" - componentType: - type: "string" - componentSource: - type: "string" - description: "Specifies the name of the underying source service that is responsible\ - \ for this components" - enum: - - "DCAEController" - - "DMaaPController" - shareable: - type: "integer" - format: "int32" - description: "Used to determine if this component can be shared amongst different\ - \ DCAE services" - DCAEServiceGroupByResultsPropertyValues: - type: "object" - properties: - count: - type: "integer" - format: "int32" - propertyValue: - type: "string" - dcaeServiceQueryLink: - description: "Link.title is the DCAE service property value. Following this\ - \ link will provide a list of DCAE services that all have this property\ - \ value." - $ref: "#/definitions/Link" - DCAEServiceGroupByResults: - type: "object" - properties: - propertyName: - type: "string" - description: "Property name of DCAE service that the group by operation was\ - \ performed on" - propertyValues: - type: "array" - items: - $ref: "#/definitions/DCAEServiceGroupByResultsPropertyValues" - InlineResponse200: - type: "object" - properties: - links: - $ref: "#/definitions/InlineResponse200Links" - totalCount: - type: "integer" - format: "int32" - items: - type: "array" - items: - $ref: "#/definitions/DCAEServiceType" - DCAEServiceRequest: - type: "object" - required: - - "components" - - "typeId" - - "vnfId" - - "vnfLocation" - - "vnfType" - properties: - typeId: - type: "string" - description: "Id of the associated DCAE service type" - vnfId: - type: "string" - description: "Id of the associated VNF that this service is monitoring" - vnfType: - type: "string" - description: "The type of the associated VNF that this service is monitoring" - vnfLocation: - type: "string" - description: "Location identifier of the associated VNF that this service\ - \ is monitoring" - deploymentRef: - type: "string" - description: "Reference to a Cloudify deployment" - components: - type: "array" - description: "List of DCAE service components that this service is composed\ - \ of" - items: - $ref: "#/definitions/DCAEServiceComponentRequest" - InlineResponse200Links: - type: "object" - properties: - previousLink: - $ref: "#/definitions/Link" - nextLink: - $ref: "#/definitions/Link" - description: "Pagination links" - ApiResponseMessage: - type: "object" - properties: - code: - type: "integer" - format: "int32" - type: - type: "string" - message: - type: "string" - DCAEService: - type: "object" - properties: - serviceId: - type: "string" - selfLink: - description: "Link.title is serviceId" - $ref: "#/definitions/Link" - created: - type: "string" - format: "date-time" - modified: - type: "string" - format: "date-time" - typeLink: - description: "Link.title is typeId" - $ref: "#/definitions/Link" - vnfId: - type: "string" - vnfLink: - description: "Link.title is vnfId" - $ref: "#/definitions/Link" - vnfType: - type: "string" - vnfLocation: - type: "string" - description: "Location information of the associated VNF" - deploymentRef: - type: "string" - description: "Reference to a Cloudify deployment" - components: - type: "array" - items: - $ref: "#/definitions/DCAEServiceComponent" - InlineResponse2001: - type: "object" - properties: - links: - $ref: "#/definitions/InlineResponse200Links" - totalCount: - type: "integer" - format: "int32" - items: - type: "array" - items: - $ref: "#/definitions/DCAEService" - UriBuilder: - type: "object" - Link: - type: "object" - properties: - title: - type: "string" - rel: - type: "string" - uri: - type: "string" - format: "uri" - uriBuilder: - $ref: "#/definitions/UriBuilder" - rels: - type: "array" - items: - type: "string" - params: - type: "object" - additionalProperties: - type: "string" - type: - type: "string" - DCAEServiceComponent: - type: "object" - required: - - "componentId" - - "componentLink" - - "componentSource" - - "componentType" - - "created" - - "modified" - - "shareable" - properties: - componentId: - type: "string" - description: "The id format is unique to the source" - componentLink: - description: "Link to the underlying resource of this component" - $ref: "#/definitions/Link" - created: - type: "string" - format: "date-time" - modified: - type: "string" - format: "date-time" - componentType: - type: "string" - componentSource: - type: "string" - description: "Specifies the name of the underying source service that is responsible\ - \ for this components" - enum: - - "DCAEController" - - "DMaaPController" - status: - type: "string" - location: - type: "string" - description: "Location information of the component" - shareable: - type: "integer" - format: "int32" - description: "Used to determine if this component can be shared amongst different\ - \ DCAE services" - DCAEServiceType: - type: "object" - required: - - "blueprintTemplate" - - "created" - - "owner" - - "selfLink" - - "typeId" - - "typeName" - - "typeVersion" - properties: - owner: - type: "string" - typeName: - type: "string" - description: "Descriptive name for this DCAE service type" - typeVersion: - type: "integer" - format: "int32" - description: "Version number for this DCAE service type" - blueprintTemplate: - type: "string" - description: "String representation of a Cloudify blueprint with unbound variables" - serviceIds: - type: "array" - description: "List of service ids that are used to associate with DCAE service\ - \ type. DCAE service types with this propery as null or empty means them\ - \ apply for every service id." - items: - type: "string" - vnfTypes: - type: "array" - items: - type: "string" - serviceLocations: - type: "array" - description: "List of service locations that are used to associate with DCAE\ - \ service type. DCAE service types with this propery as null or empty means\ - \ them apply for every service location." - items: - type: "string" - asdcServiceId: - type: "string" - description: "Id of service this DCAE service type is associated with. Value\ - \ source is from ASDC's notification event's field `serviceInvariantUUID`." - asdcResourceId: - type: "string" - description: "Id of vf/vnf instance this DCAE service type is associated with.\ - \ Value source is from ASDC's notification event's field `resourceInvariantUUID`." - asdcServiceURL: - type: "string" - description: "URL to the ASDC service model" - typeId: - type: "string" - description: "Unique identifier for this DCAE service type" - selfLink: - description: "Link to self where the Link.title is typeName" - $ref: "#/definitions/Link" - created: - type: "string" - format: "date-time" - description: "Created timestamp for this DCAE service type in epoch time" - deactivated: - type: "string" - format: "date-time" - description: "Deactivated timestamp for this DCAE service type in epoch time" diff --git a/docs/sections/apis/ves-hv/index.rst b/docs/sections/apis/ves-hv/index.rst index c82391d4..88a240e6 100644 --- a/docs/sections/apis/ves-hv/index.rst +++ b/docs/sections/apis/ves-hv/index.rst @@ -56,7 +56,6 @@ HV-VES Collector forwards incoming messages to a particular DMaaP Kafka topic ba In both cases raw bytes might be extracted using ``org.apache.kafka.common.serialization.ByteArrayDeserializer``. The resulting bytes might be further passed to ``parseFrom`` methods included in classes generated from GPB definitions. WTP is not used here - it is only used in communication between PNF/VNF and the collector. -By default, **HV-VES** will use routing defined in **k8s-hv-ves.yaml-template** in **dcaegen2/platform/blueprints project** when deployed using Cloudify. In case of Helm deployment routing is defined in values.yaml file in HV-VES Helm Chart. |