diff options
author | 2017-05-09 09:52:15 -0400 | |
---|---|---|
committer | 2017-05-10 20:23:54 +0000 | |
commit | 03b4fd0a6e6bc0ce88b8904cfa01869b74a2f210 (patch) | |
tree | 8d76a527ed86807658a879df6153c6c6e73ba971 /docs | |
parent | 473bcb6c7dea189d9481f894b82358f6ec93629b (diff) |
[DCAE-16] Merge changes from internal AT&T 1707
Non-functional changes like licensing, pom consolidation, filtering of
keywords.
Functional changes include support for integration with asdc which
caused an API breaking change.
Change-Id: I5a52d968c6403a7d35c4bbf49f7ddf7a5ba4428e
Signed-off-by: Michael Hwang <mhwang@research.att.com>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/API.adoc | 623 | ||||
-rw-r--r-- | docs/API.md | 528 | ||||
-rw-r--r-- | docs/DatabaseTables.md | 10 | ||||
-rw-r--r-- | docs/Deployment.md | 2 |
4 files changed, 536 insertions, 627 deletions
diff --git a/docs/API.adoc b/docs/API.adoc deleted file mode 100644 index ea837e6..0000000 --- a/docs/API.adoc +++ /dev/null @@ -1,623 +0,0 @@ -= DCAE Inventory API - - -[[_overview]] -== Overview -DCAE Inventory is a web service that provides the following: - -. Real-time data on all DCAE services and their components -. Comprehensive details on available DCAE service types - - -=== Version information -[%hardbreaks] -_Version_ : 1.0.0 - - - - -[[_paths]] -== Paths - -[[_dcaeservicetypesget]] -=== GET /dcae-service-types - -==== Description -Get a list of `DCAEServiceType` objects. - - -==== Parameters - -[options="header", cols=".^2,.^3,.^9,.^4,.^2"] -|=== -|Type|Name|Description|Schema|Default -|*Query*|*offset* + -_optional_|Query resultset offset used for pagination (zero-based)|integer(int32)| -|*Query*|*serviceId* + -_optional_||string| -|*Query*|*serviceLocation* + -_optional_||string| -|*Query*|*vnfType* + -_optional_||string| -|=== - - -==== Responses - -[options="header", cols=".^2,.^14,.^4"] -|=== -|HTTP Code|Description|Schema -|*200*|List of `DCAEServiceType` objects|<<_inlineresponse200,InlineResponse200>> -|=== - - -==== Consumes - -* `application/json` -* `application/vnd.dcae.inventory.v1+json` - - -==== Produces - -* `application/json` -* `application/vnd.dcae.inventory.v1+json` - - -[[_dcaeservicetypestypenameget]] -=== GET /dcae-service-types/{typeName} - -==== Description -Get a `DCAEServiceType` object. - - -==== Parameters - -[options="header", cols=".^2,.^3,.^9,.^4,.^2"] -|=== -|Type|Name|Description|Schema|Default -|*Path*|*typeName* + -_required_||string| -|=== - - -==== Responses - -[options="header", cols=".^2,.^14,.^4"] -|=== -|HTTP Code|Description|Schema -|*200*|Single `DCAEServiceType` object|<<_dcaeservicetype,DCAEServiceType>> -|*404*|Resource not found|<<_dcaeservicetype,DCAEServiceType>> -|=== - - -==== Consumes - -* `application/json` -* `application/vnd.dcae.inventory.v1+json` - - -==== Produces - -* `application/json` -* `application/vnd.dcae.inventory.v1+json` - - -[[_dcaeservicetypestypenameput]] -=== PUT /dcae-service-types/{typeName} - -==== 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, - - -==== Parameters - -[options="header", cols=".^2,.^3,.^9,.^4,.^2"] -|=== -|Type|Name|Description|Schema|Default -|*Path*|*typeName* + -_required_||string| -|*Body*|*body* + -_required_||<<_dcaeservicetyperequest,DCAEServiceTypeRequest>>| -|=== - - -==== Responses - -[options="header", cols=".^2,.^14,.^4"] -|=== -|HTTP Code|Description|Schema -|*200*|Single `DCAEServiceType` object.|<<_dcaeservicetype,DCAEServiceType>> -|*400*|Bad request provided.|<<_apiresponsemessage,ApiResponseMessage>> -|*409*|Failed to update because there are still DCAE services of the requested type running.|<<_apiresponsemessage,ApiResponseMessage>> -|=== - - -==== Consumes - -* `application/json` -* `application/vnd.dcae.inventory.v1+json` - - -==== Produces - -* `application/json` -* `application/vnd.dcae.inventory.v1+json` - - -[[_dcaeservicesget]] -=== GET /dcae-services - -==== Description -Get a list of `DCAEService` objects. - - -==== Parameters - -[options="header", cols=".^2,.^3,.^9,.^4,.^2"] -|=== -|Type|Name|Description|Schema|Default -|*Query*|*componentType* + -_optional_|Use to filter by a specific DCAE service component type|string| -|*Query*|*created* + -_optional_|Use to filter by created time|string| -|*Query*|*offset* + -_optional_|Query resultset offset used for pagination (zero-based)|integer(int32)| -|*Query*|*shareable* + -_optional_|Use to filter by DCAE services that have shareable components or not|boolean| -|*Query*|*typeName* + -_optional_|DCAE service type name|string| -|*Query*|*vnfId* + -_optional_||string| -|*Query*|*vnfLocation* + -_optional_||string| -|*Query*|*vnfType* + -_optional_||string| -|=== - - -==== Responses - -[options="header", cols=".^2,.^14,.^4"] -|=== -|HTTP Code|Description|Schema -|*200*|List of `DCAEService` objects|<<_inlineresponse2001,InlineResponse2001>> -|*502*|Bad response from DCAE controller|<<_apiresponsemessage,ApiResponseMessage>> -|*504*|Failed to connect with DCAE controller|<<_apiresponsemessage,ApiResponseMessage>> -|=== - - -==== Consumes - -* `application/json` -* `application/vnd.dcae.inventory.v1+json` - - -==== Produces - -* `application/json` -* `application/vnd.dcae.inventory.v1+json` - - -[[_dcaeservicesgroupbypropertynameget]] -=== GET /dcae-services-groupby/{propertyName} - -==== Description -Get a list of unique values for the given `propertyName` - - -==== Parameters - -[options="header", cols=".^2,.^3,.^9,.^4,.^2"] -|=== -|Type|Name|Description|Schema|Default -|*Path*|*propertyName* + -_required_|Property to find unique values. Restricted to `type`, `vnfType`, `vnfLocation`|string| -|=== - - -==== Responses - -[options="header", cols=".^2,.^14,.^4"] -|=== -|HTTP Code|Description|Schema -|*200*|List of unique property values|<<_dcaeservicegroupbyresults,DCAEServiceGroupByResults>> -|=== - - -==== Consumes - -* `application/json` -* `application/vnd.dcae.inventory.v1+json` - - -==== Produces - -* `application/json` -* `application/vnd.dcae.inventory.v1+json` - - -[[_dcaeservicesserviceidget]] -=== GET /dcae-services/{serviceId} - -==== Description -Get a `DCAEService` object. - - -==== Parameters - -[options="header", cols=".^2,.^3,.^9,.^4,.^2"] -|=== -|Type|Name|Description|Schema|Default -|*Path*|*serviceId* + -_required_||string| -|=== - - -==== Responses - -[options="header", cols=".^2,.^14,.^4"] -|=== -|HTTP Code|Description|Schema -|*200*|Single `DCAEService` object|<<_dcaeservice,DCAEService>> -|*404*|DCAE service not found|<<_apiresponsemessage,ApiResponseMessage>> -|*502*|Bad response from DCAE controller|<<_apiresponsemessage,ApiResponseMessage>> -|*504*|Failed to connect with DCAE controller|<<_apiresponsemessage,ApiResponseMessage>> -|=== - - -==== Consumes - -* `application/json` -* `application/vnd.dcae.inventory.v1+json` - - -==== Produces - -* `application/json` -* `application/vnd.dcae.inventory.v1+json` - - -[[_dcaeservicesserviceidput]] -=== PUT /dcae-services/{serviceId} - -==== Description -Put a new or update an existing `DCAEService` object. - - -==== Parameters - -[options="header", cols=".^2,.^3,.^9,.^4,.^2"] -|=== -|Type|Name|Description|Schema|Default -|*Path*|*serviceId* + -_required_||string| -|*Body*|*body* + -_required_||<<_dcaeservicerequest,DCAEServiceRequest>>| -|=== - - -==== Responses - -[options="header", cols=".^2,.^14,.^4"] -|=== -|HTTP Code|Description|Schema -|*200*|Single `DCAEService` object|<<_dcaeservice,DCAEService>> -|*422*|Bad request provided|<<_apiresponsemessage,ApiResponseMessage>> -|=== - - -==== Consumes - -* `application/json` -* `application/vnd.dcae.inventory.v1+json` - - -==== Produces - -* `application/json` -* `application/vnd.dcae.inventory.v1+json` - - -[[_dcaeservicesserviceiddelete]] -=== DELETE /dcae-services/{serviceId} - -==== Description -Remove an existing `DCAEService` object. - - -==== Parameters - -[options="header", cols=".^2,.^3,.^9,.^4,.^2"] -|=== -|Type|Name|Description|Schema|Default -|*Path*|*serviceId* + -_required_||string| -|=== - - -==== Responses - -[options="header", cols=".^2,.^14,.^4"] -|=== -|HTTP Code|Description|Schema -|*200*|DCAE service has been removed|No Content -|*404*|Unknown DCAE service|<<_apiresponsemessage,ApiResponseMessage>> -|=== - - -==== Consumes - -* `application/vnd.dcae.inventory.v1+json` -* `application/json` - - -==== Produces - -* `application/json` -* `application/vnd.dcae.inventory.v1+json` - - - - -[[_definitions]] -== Definitions - -[[_apiresponsemessage]] -=== ApiResponseMessage - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|*code* + -_optional_||integer(int32) -|*message* + -_optional_||string -|*type* + -_optional_||string -|=== - - -[[_dcaeservice]] -=== DCAEService - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|*components* + -_optional_||< <<_dcaeservicecomponent,DCAEServiceComponent>> > array -|*created* + -_optional_||string(date-time) -|*deploymentRef* + -_optional_|Reference to a Cloudify deployment|string -|*modified* + -_optional_||string(date-time) -|*selfLink* + -_optional_|Link.title is serviceId|<<_link,Link>> -|*serviceId* + -_optional_||string -|*typeLink* + -_optional_|Link.title is typeName|<<_link,Link>> -|*vnfId* + -_optional_||string -|*vnfLink* + -_optional_|Link.title is vnfId|<<_link,Link>> -|*vnfLocation* + -_optional_|Location information of the associated VNF|string -|*vnfType* + -_optional_||string -|=== - - -[[_dcaeservicecomponent]] -=== DCAEServiceComponent - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|*componentId* + -_required_|The id format is unique to the source|string -|*componentLink* + -_required_|Link to the underlying resource of this component|<<_link,Link>> -|*componentSource* + -_required_|Specifies the name of the underying source service that is responsible for this components|enum (DCAEController, DMaaPController) -|*componentType* + -_required_||string -|*created* + -_required_||string(date-time) -|*location* + -_optional_|Location information of the component|string -|*modified* + -_required_||string(date-time) -|*shareable* + -_required_|Used to determine if this component can be shared amongst different DCAE services|integer(int32) -|*status* + -_optional_||string -|=== - - -[[_dcaeservicecomponentrequest]] -=== DCAEServiceComponentRequest - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|*componentId* + -_required_|The id format is unique to the source|string -|*componentSource* + -_required_|Specifies the name of the underying source service that is responsible for this components|enum (DCAEController, DMaaPController) -|*componentType* + -_required_||string -|*shareable* + -_required_|Used to determine if this component can be shared amongst different DCAE services|integer(int32) -|=== - - -[[_dcaeservicegroupbyresults]] -=== DCAEServiceGroupByResults - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|*propertyName* + -_optional_|Property name of DCAE service that the group by operation was performed on|string -|*propertyValues* + -_optional_||< <<_dcaeservicegroupbyresultspropertyvalues,DCAEServiceGroupByResultsPropertyValues>> > array -|=== - - -[[_dcaeservicegroupbyresultspropertyvalues]] -=== DCAEServiceGroupByResultsPropertyValues - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|*count* + -_optional_||integer(int32) -|*dcaeServiceQueryLink* + -_optional_|Link.title is the DCAE service property value. Following this link will provide a list of DCAE services that all have this property value.|<<_link,Link>> -|*propertyValue* + -_optional_||string -|=== - - -[[_dcaeservicerequest]] -=== DCAEServiceRequest - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|*components* + -_required_|List of DCAE service components that this service is composed of|< <<_dcaeservicecomponentrequest,DCAEServiceComponentRequest>> > array -|*deploymentRef* + -_optional_|Reference to a Cloudify deployment|string -|*typeName* + -_required_|Name of the associated DCAE service type|string -|*vnfId* + -_required_|Id of the associated VNF that this service is monitoring|string -|*vnfLocation* + -_required_|Location identifier of the associated VNF that this service is monitoring|string -|*vnfType* + -_required_|The type of the associated VNF that this service is monitoring|string -|=== - - -[[_dcaeservicetype]] -=== DCAEServiceType - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|*blueprintTemplate* + -_required_|String representation of a Cloudify blueprint with unbound variables|string -|*created* + -_required_|Created timestamp for this DCAE service type in epoch time|string(date-time) -|*owner* + -_required_|Name of the owner of this DCAE service type|string -|*selfLink* + -_optional_|Link.title is typeName|<<_link,Link>> -|*serviceIds* + -_optional_|List of service ids that are associated with this DCAE service type|< string > array -|*serviceLocations* + -_optional_|List of service locations that are associated with this DCAE service type|< string > array -|*typeName* + -_required_|Unique name for this DCAE service type|string -|*vnfTypes* + -_required_|List of VNF types associated with this DCAE service type|< string > array -|=== - - -[[_dcaeservicetyperequest]] -=== DCAEServiceTypeRequest - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|*blueprintTemplate* + -_required_|String representation of a Cloudify blueprint with unbound variables|string -|*owner* + -_required_||string -|*serviceIds* + -_optional_|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.|< string > array -|*serviceLocations* + -_optional_|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.|< string > array -|*vnfTypes* + -_required_||< string > array -|=== - - -[[_inlineresponse200]] -=== InlineResponse200 - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|*items* + -_optional_||< <<_dcaeservicetype,DCAEServiceType>> > array -|*links* + -_optional_||<<_inlineresponse200links,InlineResponse200Links>> -|*totalCount* + -_optional_||integer(int32) -|=== - - -[[_inlineresponse2001]] -=== InlineResponse2001 - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|*items* + -_optional_||< <<_dcaeservice,DCAEService>> > array -|*links* + -_optional_||<<_inlineresponse200links,InlineResponse200Links>> -|*totalCount* + -_optional_||integer(int32) -|=== - - -[[_inlineresponse200links]] -=== InlineResponse200Links -Pagination links - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|*nextLink* + -_optional_||<<_link,Link>> -|*previousLink* + -_optional_||<<_link,Link>> -|=== - - -[[_link]] -=== Link - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|*params* + -_optional_||< string, string > map -|*rel* + -_optional_||string -|*rels* + -_optional_||< string > array -|*title* + -_optional_||string -|*type* + -_optional_||string -|*uri* + -_optional_||string -|*uriBuilder* + -_optional_||<<_uribuilder,UriBuilder>> -|=== - - -[[_uribuilder]] -=== UriBuilder -_Type_ : object - - - - - diff --git a/docs/API.md b/docs/API.md new file mode 100644 index 0000000..a6f0472 --- /dev/null +++ b/docs/API.md @@ -0,0 +1,528 @@ +# DCAE Inventory API + + +<a name="overview"></a> +## Overview +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 + + +### Version information +*Version* : 2.1.0 + + +### Contact information +*Contact Email* : dcae@lists.openecomp.org + + + + +<a name="paths"></a> +## Paths + +<a name="dcaeservicetypestypenameput"></a> +### POST /dcae-service-types + +#### 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, + + +#### Parameters + +|Type|Name|Description|Schema|Default| +|---|---|---|---|---| +|**Body**|**body** <br>*required*||[DCAEServiceTypeRequest](#dcaeservicetyperequest)|| + + +#### Responses + +|HTTP Code|Description|Schema| +|---|---|---| +|**200**|Single `DCAEServiceType` object.|[DCAEServiceType](#dcaeservicetype)| +|**400**|Bad request provided.|[ApiResponseMessage](#apiresponsemessage)| +|**409**|Failed to update because there are still DCAE services of the requested type running.|[ApiResponseMessage](#apiresponsemessage)| + + +#### Consumes + +* `application/json` + + +#### Produces + +* `application/json` + + +<a name="dcaeservicetypesget"></a> +### GET /dcae-service-types + +#### Description +Get a list of `DCAEServiceType` objects. + + +#### Parameters + +|Type|Name|Description|Schema|Default| +|---|---|---|---|---| +|**Query**|**asdcResourceId** <br>*optional*|Filter by associated asdc design resource id. Setting this to `NONE` will return instances that have asdc resource id set to null|string|| +|**Query**|**asdcServiceId** <br>*optional*|Filter by associated asdc design service id. Setting this to `NONE` will return instances that have asdc service id set to null|string|| +|**Query**|**offset** <br>*optional*|Query resultset offset used for pagination (zero-based)|integer(int32)|| +|**Query**|**onlyActive** <br>*optional*|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|boolean|`"true"`| +|**Query**|**onlyLatest** <br>*optional*|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|boolean|`"true"`| +|**Query**|**serviceId** <br>*optional*|Filter by assocaited service id. Instances with service id null or empty is always returned.|string|| +|**Query**|**serviceLocation** <br>*optional*|Filter by associated service location. Instances with service location null or empty is always returned.|string|| +|**Query**|**typeName** <br>*optional*|Filter by service type name|string|| +|**Query**|**vnfType** <br>*optional*|Filter by associated vnf type. No wildcards, matches are explicit. This field is treated case insensitive.|string|| + + +#### Responses + +|HTTP Code|Description|Schema| +|---|---|---| +|**200**|List of `DCAEServiceType` objects|[InlineResponse200](#inlineresponse200)| + + +#### Consumes + +* `application/json` +* `application/vnd.dcae.inventory.v1+json` + + +#### Produces + +* `application/json` +* `application/vnd.dcae.inventory.v1+json` + + +<a name="dcaeservicetypestypeidget"></a> +### GET /dcae-service-types/{typeId} + +#### Description +Get a `DCAEServiceType` object. + + +#### Parameters + +|Type|Name|Description|Schema|Default| +|---|---|---|---|---| +|**Path**|**typeId** <br>*required*||string|| + + +#### Responses + +|HTTP Code|Description|Schema| +|---|---|---| +|**200**|Single `DCAEServiceType` object|[DCAEServiceType](#dcaeservicetype)| +|**404**|Resource not found|[DCAEServiceType](#dcaeservicetype)| + + +#### Consumes + +* `application/json` + + +#### Produces + +* `application/json` + + +<a name="dcaeservicetypestypeiddelete"></a> +### DELETE /dcae-service-types/{typeId} + +#### Description +Deactivates existing `DCAEServiceType` instances + + +#### Parameters + +|Type|Name|Description|Schema|Default| +|---|---|---|---|---| +|**Path**|**typeId** <br>*required*||string|| + + +#### Responses + +|HTTP Code|Description|Schema| +|---|---|---| +|**200**|`DCAEServiceType` has been deactivated|[ApiResponseMessage](#apiresponsemessage)| +|**404**|`DCAEServiceType` not found|[ApiResponseMessage](#apiresponsemessage)| +|**410**|`DCAEServiceType` already gone|[ApiResponseMessage](#apiresponsemessage)| + + +#### Consumes + +* `application/vnd.dcae.inventory.v1+json` +* `application/json` + + +#### Produces + +* `application/vnd.dcae.inventory.v1+json` +* `application/json` + + +<a name="dcaeservicesget"></a> +### GET /dcae-services + +#### Description +Get a list of `DCAEService` objects. + + +#### Parameters + +|Type|Name|Description|Schema|Default| +|---|---|---|---|---| +|**Query**|**componentType** <br>*optional*|Use to filter by a specific DCAE service component type|string|| +|**Query**|**created** <br>*optional*|Use to filter by created time|string|| +|**Query**|**offset** <br>*optional*|Query resultset offset used for pagination (zero-based)|integer(int32)|| +|**Query**|**shareable** <br>*optional*|Use to filter by DCAE services that have shareable components or not|boolean|| +|**Query**|**typeId** <br>*optional*|DCAE service type name|string|| +|**Query**|**vnfId** <br>*optional*||string|| +|**Query**|**vnfLocation** <br>*optional*||string|| +|**Query**|**vnfType** <br>*optional*|Filter by associated vnf type. This field is treated case insensitive.|string|| + + +#### Responses + +|HTTP Code|Description|Schema| +|---|---|---| +|**200**|List of `DCAEService` objects|[InlineResponse2001](#inlineresponse2001)| +|**502**|Bad response from DCAE controller|[ApiResponseMessage](#apiresponsemessage)| +|**504**|Failed to connect with DCAE controller|[ApiResponseMessage](#apiresponsemessage)| + + +#### Consumes + +* `application/json` +* `application/vnd.dcae.inventory.v1+json` + + +#### Produces + +* `application/json` +* `application/vnd.dcae.inventory.v1+json` + + +<a name="dcaeservicesgroupbypropertynameget"></a> +### GET /dcae-services-groupby/{propertyName} + +#### Description +Get a list of unique values for the given `propertyName` + + +#### Parameters + +|Type|Name|Description|Schema|Default| +|---|---|---|---|---| +|**Path**|**propertyName** <br>*required*|Property to find unique values. Restricted to `type`, `vnfType`, `vnfLocation`|string|| + + +#### Responses + +|HTTP Code|Description|Schema| +|---|---|---| +|**200**|List of unique property values|[DCAEServiceGroupByResults](#dcaeservicegroupbyresults)| + + +#### Consumes + +* `application/json` +* `application/vnd.dcae.inventory.v1+json` + + +#### Produces + +* `application/json` +* `application/vnd.dcae.inventory.v1+json` + + +<a name="dcaeservicesserviceidget"></a> +### GET /dcae-services/{serviceId} + +#### Description +Get a `DCAEService` object. + + +#### Parameters + +|Type|Name|Description|Schema|Default| +|---|---|---|---|---| +|**Path**|**serviceId** <br>*required*||string|| + + +#### Responses + +|HTTP Code|Description|Schema| +|---|---|---| +|**200**|Single `DCAEService` object|[DCAEService](#dcaeservice)| +|**404**|DCAE service not found|[ApiResponseMessage](#apiresponsemessage)| +|**502**|Bad response from DCAE controller|[ApiResponseMessage](#apiresponsemessage)| +|**504**|Failed to connect with DCAE controller|[ApiResponseMessage](#apiresponsemessage)| + + +#### Consumes + +* `application/json` +* `application/vnd.dcae.inventory.v1+json` + + +#### Produces + +* `application/json` +* `application/vnd.dcae.inventory.v1+json` + + +<a name="dcaeservicesserviceidput"></a> +### PUT /dcae-services/{serviceId} + +#### Description +Put a new or update an existing `DCAEService` object. + + +#### Parameters + +|Type|Name|Description|Schema|Default| +|---|---|---|---|---| +|**Path**|**serviceId** <br>*required*||string|| +|**Body**|**body** <br>*required*||[DCAEServiceRequest](#dcaeservicerequest)|| + + +#### Responses + +|HTTP Code|Description|Schema| +|---|---|---| +|**200**|Single `DCAEService` object|[DCAEService](#dcaeservice)| +|**422**|Bad request provided|[ApiResponseMessage](#apiresponsemessage)| + + +#### Consumes + +* `application/json` +* `application/vnd.dcae.inventory.v1+json` + + +#### Produces + +* `application/json` +* `application/vnd.dcae.inventory.v1+json` + + +<a name="dcaeservicesserviceiddelete"></a> +### DELETE /dcae-services/{serviceId} + +#### Description +Remove an existing `DCAEService` object. + + +#### Parameters + +|Type|Name|Description|Schema|Default| +|---|---|---|---|---| +|**Path**|**serviceId** <br>*required*||string|| + + +#### Responses + +|HTTP Code|Description|Schema| +|---|---|---| +|**200**|DCAE service has been removed|No Content| +|**404**|Unknown DCAE service|[ApiResponseMessage](#apiresponsemessage)| + + +#### Consumes + +* `application/vnd.dcae.inventory.v1+json` +* `application/json` + + +#### Produces + +* `application/json` +* `application/vnd.dcae.inventory.v1+json` + + + + +<a name="definitions"></a> +## Definitions + +<a name="apiresponsemessage"></a> +### ApiResponseMessage + +|Name|Description|Schema| +|---|---|---| +|**code** <br>*optional*||integer(int32)| +|**message** <br>*optional*||string| +|**type** <br>*optional*||string| + + +<a name="dcaeservice"></a> +### DCAEService + +|Name|Description|Schema| +|---|---|---| +|**components** <br>*optional*||< [DCAEServiceComponent](#dcaeservicecomponent) > array| +|**created** <br>*optional*||string(date-time)| +|**deploymentRef** <br>*optional*|Reference to a Cloudify deployment|string| +|**modified** <br>*optional*||string(date-time)| +|**selfLink** <br>*optional*|Link.title is serviceId|[Link](#link)| +|**serviceId** <br>*optional*||string| +|**typeLink** <br>*optional*|Link.title is typeId|[Link](#link)| +|**vnfId** <br>*optional*||string| +|**vnfLink** <br>*optional*|Link.title is vnfId|[Link](#link)| +|**vnfLocation** <br>*optional*|Location information of the associated VNF|string| +|**vnfType** <br>*optional*||string| + + +<a name="dcaeservicecomponent"></a> +### DCAEServiceComponent + +|Name|Description|Schema| +|---|---|---| +|**componentId** <br>*required*|The id format is unique to the source|string| +|**componentLink** <br>*required*|Link to the underlying resource of this component|[Link](#link)| +|**componentSource** <br>*required*|Specifies the name of the underying source service that is responsible for this components|enum (DCAEController, DMaaPController)| +|**componentType** <br>*required*||string| +|**created** <br>*required*||string(date-time)| +|**location** <br>*optional*|Location information of the component|string| +|**modified** <br>*required*||string(date-time)| +|**shareable** <br>*required*|Used to determine if this component can be shared amongst different DCAE services|integer(int32)| +|**status** <br>*optional*||string| + + +<a name="dcaeservicecomponentrequest"></a> +### DCAEServiceComponentRequest + +|Name|Description|Schema| +|---|---|---| +|**componentId** <br>*required*|The id format is unique to the source|string| +|**componentSource** <br>*required*|Specifies the name of the underying source service that is responsible for this components|enum (DCAEController, DMaaPController)| +|**componentType** <br>*required*||string| +|**shareable** <br>*required*|Used to determine if this component can be shared amongst different DCAE services|integer(int32)| + + +<a name="dcaeservicegroupbyresults"></a> +### DCAEServiceGroupByResults + +|Name|Description|Schema| +|---|---|---| +|**propertyName** <br>*optional*|Property name of DCAE service that the group by operation was performed on|string| +|**propertyValues** <br>*optional*||< [DCAEServiceGroupByResultsPropertyValues](#dcaeservicegroupbyresultspropertyvalues) > array| + + +<a name="dcaeservicegroupbyresultspropertyvalues"></a> +### DCAEServiceGroupByResultsPropertyValues + +|Name|Description|Schema| +|---|---|---| +|**count** <br>*optional*||integer(int32)| +|**dcaeServiceQueryLink** <br>*optional*|Link.title is the DCAE service property value. Following this link will provide a list of DCAE services that all have this property value.|[Link](#link)| +|**propertyValue** <br>*optional*||string| + + +<a name="dcaeservicerequest"></a> +### DCAEServiceRequest + +|Name|Description|Schema| +|---|---|---| +|**components** <br>*required*|List of DCAE service components that this service is composed of|< [DCAEServiceComponentRequest](#dcaeservicecomponentrequest) > array| +|**deploymentRef** <br>*optional*|Reference to a Cloudify deployment|string| +|**typeId** <br>*required*|Id of the associated DCAE service type|string| +|**vnfId** <br>*required*|Id of the associated VNF that this service is monitoring|string| +|**vnfLocation** <br>*required*|Location identifier of the associated VNF that this service is monitoring|string| +|**vnfType** <br>*required*|The type of the associated VNF that this service is monitoring|string| + + +<a name="dcaeservicetype"></a> +### DCAEServiceType + +|Name|Description|Schema| +|---|---|---| +|**asdcResourceId** <br>*optional*|Id of vf/vnf instance this DCAE service type is associated with. Value source is from ASDC's notification event's field `resourceInvariantUUID`.|string| +|**asdcServiceId** <br>*optional*|Id of service this DCAE service type is associated with. Value source is from ASDC's notification event's field `serviceInvariantUUID`.|string| +|**asdcServiceURL** <br>*optional*|URL to the ASDC service model|string| +|**blueprintTemplate** <br>*required*|String representation of a Cloudify blueprint with unbound variables|string| +|**created** <br>*required*|Created timestamp for this DCAE service type in epoch time|string(date-time)| +|**deactivated** <br>*optional*|Deactivated timestamp for this DCAE service type in epoch time|string(date-time)| +|**owner** <br>*required*||string| +|**selfLink** <br>*required*|Link to self where the Link.title is typeName|[Link](#link)| +|**serviceIds** <br>*optional*|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.|< string > array| +|**serviceLocations** <br>*optional*|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.|< string > array| +|**typeId** <br>*required*|Unique identifier for this DCAE service type|string| +|**typeName** <br>*required*|Descriptive name for this DCAE service type|string| +|**typeVersion** <br>*required*|Version number for this DCAE service type|integer(int32)| +|**vnfTypes** <br>*optional*||< string > array| + + +<a name="dcaeservicetyperequest"></a> +### DCAEServiceTypeRequest + +|Name|Description|Schema| +|---|---|---| +|**asdcResourceId** <br>*optional*|Id of vf/vnf instance this DCAE service type is associated with. Value source is from ASDC's notification event's field `resourceInvariantUUID`.|string| +|**asdcServiceId** <br>*optional*|Id of service this DCAE service type is associated with. Value source is from ASDC's notification event's field `serviceInvariantUUID`.|string| +|**asdcServiceURL** <br>*optional*|URL to the ASDC service model|string| +|**blueprintTemplate** <br>*required*|String representation of a Cloudify blueprint with unbound variables|string| +|**owner** <br>*required*||string| +|**serviceIds** <br>*optional*|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.|< string > array| +|**serviceLocations** <br>*optional*|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.|< string > array| +|**typeName** <br>*required*|Descriptive name for this DCAE service type|string| +|**typeVersion** <br>*required*|Version number for this DCAE service type|integer(int32)| +|**vnfTypes** <br>*optional*||< string > array| + + +<a name="inlineresponse200"></a> +### InlineResponse200 + +|Name|Description|Schema| +|---|---|---| +|**items** <br>*optional*||< [DCAEServiceType](#dcaeservicetype) > array| +|**links** <br>*optional*||[InlineResponse200Links](#inlineresponse200links)| +|**totalCount** <br>*optional*||integer(int32)| + + +<a name="inlineresponse2001"></a> +### InlineResponse2001 + +|Name|Description|Schema| +|---|---|---| +|**items** <br>*optional*||< [DCAEService](#dcaeservice) > array| +|**links** <br>*optional*||[InlineResponse200Links](#inlineresponse200links)| +|**totalCount** <br>*optional*||integer(int32)| + + +<a name="inlineresponse200links"></a> +### InlineResponse200Links +Pagination links + + +|Name|Description|Schema| +|---|---|---| +|**nextLink** <br>*optional*||[Link](#link)| +|**previousLink** <br>*optional*||[Link](#link)| + + +<a name="link"></a> +### Link + +|Name|Description|Schema| +|---|---|---| +|**params** <br>*optional*||< string, string > map| +|**rel** <br>*optional*||string| +|**rels** <br>*optional*||< string > array| +|**title** <br>*optional*||string| +|**type** <br>*optional*||string| +|**uri** <br>*optional*||string| +|**uriBuilder** <br>*optional*||[UriBuilder](#uribuilder)| + + +<a name="uribuilder"></a> +### UriBuilder +*Type* : object + + + + + diff --git a/docs/DatabaseTables.md b/docs/DatabaseTables.md index f3df9e1..30f4f7b 100644 --- a/docs/DatabaseTables.md +++ b/docs/DatabaseTables.md @@ -14,16 +14,20 @@ As of version 0.12.0. Table "public.dcae_service_types" Column | Type | Modifiers --------------------+-----------------------------+----------- + type_id | character varying | not null + type_version | integer | not null type_name | character varying | not null owner | character varying | not null + blueprint_template | text | not null vnf_types | character varying[] | not null service_ids | character varying[] | service_locations | character varying[] | - blueprint_template | text | not null + asdc_service_id | character varying | not null + asdc_resource_id | character varying | not null created | timestamp without time zone | not null is_active | boolean | not null Indexes: - "pk_type_created" PRIMARY KEY, btree (type_name, created) + "pk_type_created" PRIMARY KEY, btree (type_id, created) ``` ## `dcae_services` @@ -40,7 +44,7 @@ Indexes: Column | Type | Modifiers ----------------+-----------------------------+----------- service_id | character varying | not null - type_name | character varying | not null + type_id | character varying | not null vnf_id | character varying | not null vnf_type | character varying | not null vnf_location | character varying | not null diff --git a/docs/Deployment.md b/docs/Deployment.md index 762af85..ff3974f 100644 --- a/docs/Deployment.md +++ b/docs/Deployment.md @@ -35,5 +35,5 @@ In order for HTTPS to be enabled for DCAE Inventory, an HTTPS `applicationConnec The DCAE Inventory has been developed and tested using Java 8. Here is a sample run command: ``` -java -jar dcae-inventory-1.0.0.jar server /opt/config.yml +java -jar dcae-inventory-2.3.1.jar server /opt/config.yml ``` |