diff options
author | 2019-03-12 18:30:33 +0100 | |
---|---|---|
committer | 2019-03-12 18:30:33 +0100 | |
commit | cf469f63cb490d90b55508efa331073a17297999 (patch) | |
tree | 4cbb6daff2e14d30d2f4d745ec5e8cd8a15f5e5c /docs/offeredapis/serviceCatalog | |
parent | 66403a1729296f9d90ce61a4d4cb0d102e03cd1e (diff) |
Update Swagger files
Change-Id: I02a375b4998fdf23bd7c4eb391011a8e37a1c8e2
Issue-ID: EXTAPI-211
Signed-off-by: MatthieuGeerebaert <matthieu.geerebaert@orange.com>
Diffstat (limited to 'docs/offeredapis/serviceCatalog')
-rw-r--r-- | docs/offeredapis/serviceCatalog/apiServiceCatalog.plantuml | 110 | ||||
-rw-r--r-- | docs/offeredapis/serviceCatalog/asciiDoc.adoc | 492 | ||||
-rw-r--r-- | docs/offeredapis/serviceCatalog/documentation.html | 1489 | ||||
-rw-r--r-- | docs/offeredapis/serviceCatalog/markDown.md | 299 |
4 files changed, 0 insertions, 2390 deletions
diff --git a/docs/offeredapis/serviceCatalog/apiServiceCatalog.plantuml b/docs/offeredapis/serviceCatalog/apiServiceCatalog.plantuml deleted file mode 100644 index 8483238..0000000 --- a/docs/offeredapis/serviceCatalog/apiServiceCatalog.plantuml +++ /dev/null @@ -1,110 +0,0 @@ -@startuml - -enum LifecycleStatusValues { - NOT_CERTIFIED_CHECKOUT - NOT_CERTIFIED_CHECKIN - READY_FOR_CERTIFICATION - CERTIFICATION_IN_PROGRESS - CERTIFIED -} -enum DistributionStatus { - DISTRIBUTION_NOT_APPROVED - DISTRIBUTION_APPROVED - DISTRIBUTED - DISTRIBUTION_REJECTED -} - -class ErrorRepresentation { - code:int - reason:string - message:string - status:string - referenceErrror:string - @type:string - @schemaLocation:string -} - -class TimePeriod { - startDateTime:dateTime - endDateTime:dateTime -} - -class RelatedPartyRef { - id:string - role:string - name:string -} - -class ServiceSpecification { - id:string - href:string - name:string - description:string - @type:string - @schemaLocation:string - @baseType:string - invariantUUID:string - toscaModelURL:string - toscaResourceName:string - category:string - subcategory:string - version:string -} - ServiceSpecification --> "0-1" DistributionStatus : distributionStatus - ServiceSpecification --> "0-1" LifecycleStatusValues : lifecycleStatus - ServiceSpecification --> "0-1" TargetServiceSchemaRef : targetServiceSchema - ServiceSpecification --> "0-*" Attachment : attachment - ServiceSpecification --> "0-*" RelatedPartyRef : relatedParty - ServiceSpecification --> "0-*" ResourceSpecificationRef : resourceSpecification - ServiceSpecification --> "0-*" ServiceSpecCharacteristic : serviceSpecCharacteristic - -class ServiceSpecCharacteristic { - name:string - description:string - valueType:string - @type:string - @schemaLocation:string - required:boolean - status:string -} - ServiceSpecCharacteristic --> "0-*" ServiceSpecCharacteristicValue : serviceSpecCharacteristicValue - -class Attachment { - id:string - name:string - description:string - @type:string - artifactLabel:string - artifactGroupType:string - artifactTimeout:string - artifactChecksum:string - artifactVersion:string - generatedFromUUID:string - url:string - mimeType:string -} - -class ServiceSpecCharacteristicValue { - valueType:string - isDefault:boolean - value:string -} - -class ResourceSpecificationRef { - id:string - version:string - name:string - @type:string - resourceInstanceName:string - resourceInvariantUUID:string - resourceType:string - modelCustomizationName:string - modelCustomizationId:string -} - -class TargetServiceSchemaRef { - @type:string - @schemaLocation:string -} - -@enduml
\ No newline at end of file diff --git a/docs/offeredapis/serviceCatalog/asciiDoc.adoc b/docs/offeredapis/serviceCatalog/asciiDoc.adoc deleted file mode 100644 index 9ce1396..0000000 --- a/docs/offeredapis/serviceCatalog/asciiDoc.adoc +++ /dev/null @@ -1,492 +0,0 @@ -= API ServiceCatalog - - -[[_overview]] -== Overview - -=== Api URL - -https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/XOmvoxNn9d/swagger.json[Swagger UI] - - -https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/XOmvoxNn9d/plantuml&noCache=995303.0[plant UML UI] - -serviceCatalog API designed for ONAP Beijing Release. -This API is build from TMF open API17.5. -Only operation GET (by id & byList) for resource serviceSpecification is available - - -=== Version information -[%hardbreaks] -__Version__ : 3.0.0_inProgress - - -=== URI scheme -[%hardbreaks] -__Host__ : serverRoot -__BasePath__ : /nbi/api/v3 -__Schemes__ : HTTPS - - -=== Tags - -* ServiceSpecification - - -=== Produces - -* `application/json;charset=utf-8` - - -[[_paths]] -== Resources - -[[_servicespecification_resource]] -=== ServiceSpecification - -[[_servicespecificationfind]] -==== List service specifications -.... -GET /serviceSpecification -.... - - -===== Description -This operation returns service specifications from a catalog. -Only a predefined set of attribute is proposed : Based on SDC limitations, only attributes category and distributionStatus are available for serviceSpecification filtering -Fields attribute could be used to filter attributes retrieved - -Specific business errors for current operation will be encapsulated in - -HTTP Response 422 Unprocessable entity - - -===== Parameters - -[options="header", cols=".^2,.^3,.^9,.^4"] -|=== -|Type|Name|Description|Schema -|**Query**|**category** + -__optional__|Service Category (filter)|string -|**Query**|**distributionStatus** + -__optional__|Service distribution status (filter)|string -|**Query**|**fields** + -__optional__|Field selection - used to filtering the attributes to be retreived|string -|=== - - -===== Responses - -[options="header", cols=".^2,.^14,.^4"] -|=== -|HTTP Code|Description|Schema -|**200**|Success|< <<_servicespecification,ServiceSpecification>> > array -|**400**|Bad Request - -List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>> -|**401**|Unauthorized - -List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>> -|**403**|Forbidden - -List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>> -|**404**|Not Found - -List of supported error codes: -- 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>> -|**422**|Unprocessable entity - -Functional error|<<_errorrepresentation,ErrorRepresentation>> -|**500**|Internal Server Error - -List of supported error codes: -- 1: Internal error|<<_errorrepresentation,ErrorRepresentation>> -|**503**|Service Unavailable - -List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>> -|=== - - -===== Produces - -* `application/json;charset=utf-8` - - -[[_servicespecificationget]] -==== Retrieve a service specification -.... -GET /serviceSpecification/{id} -.... - - -===== Description -This operation returns a service specification by its id from a catalog. Attribute selection is enabled using the fields attribute. - -Specific business errors for current operation will be encapsulated in - -HTTP Response 422 Unprocessable entity - - -===== Parameters - -[options="header", cols=".^2,.^3,.^9,.^4"] -|=== -|Type|Name|Description|Schema -|**Path**|**id** + -__required__||string -|**Query**|**fields** + -__optional__|Attribute selection|string -|=== - - -===== Responses - -[options="header", cols=".^2,.^14,.^4"] -|=== -|HTTP Code|Description|Schema -|**200**|Success|<<_servicespecification,ServiceSpecification>> -|**400**|Bad Request - -List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>> -|**401**|Unauthorized - -List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>> -|**403**|Forbidden - -List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>> -|**404**|Not Found - -List of supported error codes: -- 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>> -|**422**|Unprocessable entity - -Functional error|<<_errorrepresentation,ErrorRepresentation>> -|**500**|Internal Server Error - -List of supported error codes: -- 1: Internal error|<<_errorrepresentation,ErrorRepresentation>> -|**503**|Service Unavailable - -List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>> -|=== - - -===== Produces - -* `application/json;charset=utf-8` - - -[[_definitions]] -== Definitions - -[[_attachment]] -=== Attachment -An attachment is a file uses to describe the service. -In nbi we use attachment to retrieve ONAP artifacts. - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**@type** + -__optional__|This attribute allows to dynamically extends TMF class. Valued with 'ONAPartifact'. We used this features to add following attributes: -artifactLabel -artifactGroupType -artifactTimeout -artifactChecksum -artifactVersion -generatedFromUUID + -**Default** : `"ONAPartifact"`|string -|**artifactChecksum** + -__optional__|Additional attribute (not in the TMF API) - extended through @type - artifactChecksum|string -|**artifactGroupType** + -__optional__|Additional attribute (not in the TMF API) - extended through @type - artifactGroupType|string -|**artifactLabel** + -__optional__|Additional attribute (not in the TMF API) - extended through @type - artifactLabel|string -|**artifactTimeout** + -__optional__|Additional attribute (not in the TMF API) - extended through @type - artifactTimeout|string -|**artifactVersion** + -__optional__|Additional attribute (not in the TMF API) - extended through @type - artifactVersion|string -|**description** + -__optional__|Description of the attachment - filled with artifactDescription|string -|**generatedFromUUID** + -__optional__|Additional attribute (not in the TMF API) - extended through @type - generatedFromUUID|string -|**id** + -__optional__|Unique identifier of the attachment - filled with artifactUUID.|string -|**mimeType** + -__optional__|Filled with artifactType|string -|**name** + -__optional__|Name of the attachment - filled with artifactName|string -|**url** + -__optional__|Uniform Resource Locator, is a web page address - filled with artifactURL|string -|=== - - -[[_distributionstatus]] -=== DistributionStatus -Service distribution status from ONAP. - -__Type__ : enum (DISTRIBUTION_NOT_APPROVED, DISTRIBUTION_APPROVED, DISTRIBUTED, DISTRIBUTION_REJECTED) - - -[[_errorrepresentation]] -=== ErrorRepresentation -This class is used to describe error. -for nbi Beijing release we do not manage additional error for serviceCatalog - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**@schemaLocation** + -__optional__|it provides a link to the schema describing a REST resource.|string -|**@type** + -__optional__|The class type of a REST resource.|string -|**code** + -__required__|Application related code (as defined in the API or from a common list)|integer (int32) -|**message** + -__optional__|Text that provide more details and corrective actions related to the error. This can be shown to a client user|string -|**reason** + -__required__|Text that explains the reason for error. This can be shown to a client user.|string -|**referenceErrror** + -__optional__|url pointing to documentation describing the error|string -|**status** + -__optional__|http error code extension like 400-2|string -|=== - - -[[_lifecyclestatusvalues]] -=== LifecycleStatusValues -Service lifecycle value from ONAP SDC - -__Type__ : enum (NOT_CERTIFIED_CHECKOUT, NOT_CERTIFIED_CHECKIN, READY_FOR_CERTIFICATION, CERTIFICATION_IN_PROGRESS, CERTIFIED) - - -[[_relatedpartyref]] -=== RelatedPartyRef -Party linked to the service catalog. -in nbi we retrieve information about last updater of the service in SDC - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**id** + -__optional__|Unique identifier of the related party. Filled with lastUpdaterUserId|string -|**name** + -__optional__|Name of the related party - Filled with lastUpdatedFullName|string -|**role** + -__optional__|Role payed by the related party -Only role 'lastUpdater' is retrieved in Beijing release|string -|=== - - -[[_resourcespecificationref]] -=== ResourceSpecificationRef -A list of resourceSpec identified to deliver the service. -for nbi we retrieve resource information available in service description (through SDC api) bu as well information retrieved in the TOSCA file. - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**@type** + -__optional__|This attribute allows to dynamically extends TMF class. Valued with: 'ONAPresource'. We used this features to add following attributes: -resourceInstanceName -resourceInvariantUUID -resourceType -modelCustomizationName -modelCustomizationId + -**Default** : `"ONAPresource"`|string -|**id** + -__optional__|Unique identifier of the resource specification - filled with resourceUUID|string -|**modelCustomizationId** + -__optional__|Additional attribute (not in the TMF API) - extended through @type - Retrieved in the TOSCA file : attribute customizationUUID in topology_template/node_template for the resource|string -|**modelCustomizationName** + -__optional__|Additional attribute (not in the TMF API) - extended through @type - Retrieved in the TOSCA file : attribute name in topology_template/node_template for the resource|string -|**name** + -__optional__|Name of the resource specification - filled with resourceName|string -|**resourceInstanceName** + -__optional__|Additional attribute (not in the TMF API) - extended through @type - resourceInstanceName|string -|**resourceInvariantUUID** + -__optional__|Additional attribute (not in the TMF API) - extended through @type - resourceInvariantUUID|string -|**resourceType** + -__optional__|Additional attribute (not in the TMF API) - extended through @type - resoucreType|string -|**version** + -__optional__|Version for this resource specification - filled with resourceVersion|string -|=== - - -[[_servicespeccharacteristic]] -=== ServiceSpecCharacteristic -A characteristic quality or distinctive feature of a ServiceSpecification. -ServiceSpecCharacteristic are retrieved in the serviceTosca file in the topology_template section in the inputs section. - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**@schemaLocation** + -__optional__|An url pointing to type description - we do not use it in nbi Beijing release|string -|**@type** + -__optional__|This attribute allows to dynamically extends TMF class. Valued with: 'ONAPserviceCharacteristic'. We do not used this features in nbi Beijing release.|string -|**description** + -__optional__|A narrative that explains in detail what the characteristic is - Filled with parameter_description|string -|**name** + -__optional__|Name of the characteristic - Filled with parameter_name|string -|**required** + -__optional__|A parameter to define if the characteristic is mandatory - Filled from parameter_required – if not fielded by default ‘true’ + -**Default** : `true`|boolean -|**serviceSpecCharacteristicValue** + -__optional__||< <<_servicespeccharacteristicvalue,ServiceSpecCharacteristicValue>> > array -|**status** + -__optional__|Status of the characteristic - filled with status_value|string -|**valueType** + -__optional__|A kind of value that the characteristic can take on, such as numeric, text and so forth - Filled with parameter_type|string -|=== - - -[[_servicespeccharacteristicvalue]] -=== ServiceSpecCharacteristicValue -A number or text that can be assigned to a service specification characteristic. -ServiceSpecCharacteristicValue are retrieved in the service Tosca file - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**isDefault** + -__optional__|Information calculated from parameter default in the Tosca file|boolean -|**value** + -__optional__|A discrete value that the characteristic can take on|string -|**valueType** + -__optional__|A kind of value that the characteristic can take on, such as numeric, text, and so forth -Retrieved in the Tosca in the topology_template section in the inputs section - parameter_type. -We do not manage parameter_type= list or map for Beijing release|string -|=== - - -[[_servicespecification]] -=== ServiceSpecification -ServiceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics. -the service information are retrieved in SDC - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**@baseType** + -__optional__|Not used for Beijing release|string -|**@schemaLocation** + -__optional__|Not used for Beijing release|string -|**@type** + -__optional__|This attribute allows to dynamically extends TMF class. Valued with 'ONAPservice'. We used this features to add following attributes: -invariantUUID -toscaModelURL -toscaResourceName -category (1) -subcategory (1) -distributionStatus + -**Default** : `"ONAPservice"`|string -|**attachment** + -__optional__||< <<_attachment,Attachment>> > array -|**category** + -__optional__|Additional attribute - extended through @type - category -Please note that this attribute is managed in TMF - in future release we'll introduce category resource|string -|**description** + -__optional__|A narrative that explains in detail what the service specification is - Filled with SDC Service description|string -|**distributionStatus** + -__optional__||<<_distributionstatus,DistributionStatus>> -|**href** + -__optional__|Reference of the service specification- not mapped in Beijing|string -|**id** + -__optional__|Unique identifier of the service specification. Filled with SDC Service uuid|string -|**invariantUUID** + -__required__|Additional attribute (not in the TMF API) - extended through @type - invariantUUID|string -|**lifecycleStatus** + -__optional__||<<_lifecyclestatusvalues,LifecycleStatusValues>> -|**name** + -__optional__|Name of the service specification- Filled with SDC Service name|string -|**relatedParty** + -__optional__||< <<_relatedpartyref,RelatedPartyRef>> > array -|**resourceSpecification** + -__optional__||< <<_resourcespecificationref,ResourceSpecificationRef>> > array -|**serviceSpecCharacteristic** + -__optional__||< <<_servicespeccharacteristic,ServiceSpecCharacteristic>> > array -|**subcategory** + -__optional__|Additional attribute - extended through @type - category -Please note that this attribute is managed in TMF - in future release we'll introduce category resourc|string -|**targetServiceSchema** + -__optional__||<<_targetserviceschemaref,TargetServiceSchemaRef>> -|**toscaModelURL** + -__optional__|Additional attribute (not in the TMF API) - extended through @type - toscaModelURL|string -|**toscaResourceName** + -__optional__|Additional attribute (not in the TMF API) - extended through @type - toscaResourceName|string -|**version** + -__optional__|Service specification version - Filled with SDC Service version|string -|=== - - -[[_targetserviceschemaref]] -=== TargetServiceSchemaRef - -[options="header", cols=".^3,.^4"] -|=== -|Name|Schema -|**@schemaLocation** + -__required__|string -|**@type** + -__required__|string -|=== - - -[[_timeperiod]] -=== TimePeriod -A time period - - -[options="header", cols=".^3,.^11,.^4"] -|=== -|Name|Description|Schema -|**endDateTime** + -__optional__|End date and time of the period|string (date-time) -|**startDateTime** + -__optional__|Start date and time of the period|string (date-time) -|=== - diff --git a/docs/offeredapis/serviceCatalog/documentation.html b/docs/offeredapis/serviceCatalog/documentation.html deleted file mode 100644 index 94b011f..0000000 --- a/docs/offeredapis/serviceCatalog/documentation.html +++ /dev/null @@ -1,1489 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> -<head> -<meta charset="UTF-8"> -<!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]--> -<meta name="viewport" content="width=device-width, initial-scale=1.0"> -<meta name="generator" content="Asciidoctor 1.5.6.1"> -<title>API ServiceCatalog</title> -<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"> -<style> -/* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */ -/* Remove comment around @import statement below when using as a custom stylesheet */ -/*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700";*/ -article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block} -audio,canvas,video{display:inline-block} -audio:not([controls]){display:none;height:0} -[hidden],template{display:none} -script{display:none!important} -html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%} -a{background:transparent} -a:focus{outline:thin dotted} -a:active,a:hover{outline:0} -h1{font-size:2em;margin:.67em 0} -abbr[title]{border-bottom:1px dotted} -b,strong{font-weight:bold} -dfn{font-style:italic} -hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0} -mark{background:#ff0;color:#000} -code,kbd,pre,samp{font-family:monospace;font-size:1em} -pre{white-space:pre-wrap} -q{quotes:"\201C" "\201D" "\2018" "\2019"} -small{font-size:80%} -sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline} -sup{top:-.5em} -sub{bottom:-.25em} -img{border:0} -svg:not(:root){overflow:hidden} -figure{margin:0} -fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em} -legend{border:0;padding:0} -button,input,select,textarea{font-family:inherit;font-size:100%;margin:0} -button,input{line-height:normal} -button,select{text-transform:none} -button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer} -button[disabled],html input[disabled]{cursor:default} -input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0} -input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box} -input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none} -button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0} -textarea{overflow:auto;vertical-align:top} -table{border-collapse:collapse;border-spacing:0} -*,*:before,*:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box} -html,body{font-size:100%} -body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto;tab-size:4;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased} -a:hover{cursor:pointer} -img,object,embed{max-width:100%;height:auto} -object,embed{height:100%} -img{-ms-interpolation-mode:bicubic} -.left{float:left!important} -.right{float:right!important} -.text-left{text-align:left!important} -.text-right{text-align:right!important} -.text-center{text-align:center!important} -.text-justify{text-align:justify!important} -.hide{display:none} -img,object,svg{display:inline-block;vertical-align:middle} -textarea{height:auto;min-height:50px} -select{width:100%} -.center{margin-left:auto;margin-right:auto} -.spread{width:100%} -p.lead,.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{font-size:1.21875em;line-height:1.6} -.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em} -div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr} -a{color:#2156a5;text-decoration:underline;line-height:inherit} -a:hover,a:focus{color:#1d4b8f} -a img{border:none} -p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility} -p aside{font-size:.875em;line-height:1.35;font-style:italic} -h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em} -h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0} -h1{font-size:2.125em} -h2{font-size:1.6875em} -h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em} -h4,h5{font-size:1.125em} -h6{font-size:1em} -hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0} -em,i{font-style:italic;line-height:inherit} -strong,b{font-weight:bold;line-height:inherit} -small{font-size:60%;line-height:inherit} -code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)} -ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit} -ul,ol{margin-left:1.5em} -ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em} -ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit} -ul.square{list-style-type:square} -ul.circle{list-style-type:circle} -ul.disc{list-style-type:disc} -ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0} -dl dt{margin-bottom:.3125em;font-weight:bold} -dl dd{margin-bottom:1.25em} -abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help} -abbr{text-transform:none} -blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd} -blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)} -blockquote cite:before{content:"\2014 \0020"} -blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)} -blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)} -@media only screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2} -h1{font-size:2.75em} -h2{font-size:2.3125em} -h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em} -h4{font-size:1.4375em}} -table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede} -table thead,table tfoot{background:#f7f8f7;font-weight:bold} -table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left} -table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)} -table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7} -table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6} -h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em} -h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400} -.clearfix:before,.clearfix:after,.float-group:before,.float-group:after{content:" ";display:table} -.clearfix:after,.float-group:after{clear:both} -*:not(pre)>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background-color:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed;word-wrap:break-word} -*:not(pre)>code.nobreak{word-wrap:normal} -*:not(pre)>code.nowrap{white-space:nowrap} -pre,pre>code{line-height:1.45;color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;text-rendering:optimizeSpeed} -em em{font-style:normal} -strong strong{font-weight:400} -.keyseq{color:rgba(51,51,51,.8)} -kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background-color:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap} -.keyseq kbd:first-child{margin-left:0} -.keyseq kbd:last-child{margin-right:0} -.menuseq,.menuref{color:#000} -.menuseq b:not(.caret),.menuref{font-weight:inherit} -.menuseq{word-spacing:-.02em} -.menuseq b.caret{font-size:1.25em;line-height:.8} -.menuseq i.caret{font-weight:bold;text-align:center;width:.45em} -b.button:before,b.button:after{position:relative;top:-1px;font-weight:400} -b.button:before{content:"[";padding:0 3px 0 2px} -b.button:after{content:"]";padding:0 2px 0 3px} -p a>code:hover{color:rgba(0,0,0,.9)} -#header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em} -#header:before,#header:after,#content:before,#content:after,#footnotes:before,#footnotes:after,#footer:before,#footer:after{content:" ";display:table} -#header:after,#content:after,#footnotes:after,#footer:after{clear:both} -#content{margin-top:1.25em} -#content:before{content:none} -#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0} -#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #ddddd8} -#header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #ddddd8;padding-bottom:8px} -#header .details{border-bottom:1px solid #ddddd8;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap} -#header .details span:first-child{margin-left:-.125em} -#header .details span.email a{color:rgba(0,0,0,.85)} -#header .details br{display:none} -#header .details br+span:before{content:"\00a0\2013\00a0"} -#header .details br+span.author:before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)} -#header .details br+span#revremark:before{content:"\00a0|\00a0"} -#header #revnumber{text-transform:capitalize} -#header #revnumber:after{content:"\00a0"} -#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #ddddd8;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem} -#toc{border-bottom:1px solid #efefed;padding-bottom:.5em} -#toc>ul{margin-left:.125em} -#toc ul.sectlevel0>li>a{font-style:italic} -#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0} -#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none} -#toc li{line-height:1.3334;margin-top:.3334em} -#toc a{text-decoration:none} -#toc a:active{text-decoration:underline} -#toctitle{color:#7a2518;font-size:1.2em} -@media only screen and (min-width:768px){#toctitle{font-size:1.375em} -body.toc2{padding-left:15em;padding-right:0} -#toc.toc2{margin-top:0!important;background-color:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #efefed;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto} -#toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em} -#toc.toc2>ul{font-size:.9em;margin-bottom:0} -#toc.toc2 ul ul{margin-left:0;padding-left:1em} -#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em} -body.toc2.toc-right{padding-left:0;padding-right:15em} -body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #efefed;left:auto;right:0}} -@media only screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0} -#toc.toc2{width:20em} -#toc.toc2 #toctitle{font-size:1.375em} -#toc.toc2>ul{font-size:.95em} -#toc.toc2 ul ul{padding-left:1.25em} -body.toc2.toc-right{padding-left:0;padding-right:20em}} -#content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px} -#content #toc>:first-child{margin-top:0} -#content #toc>:last-child{margin-bottom:0} -#footer{max-width:100%;background-color:rgba(0,0,0,.8);padding:1.25em} -#footer-text{color:rgba(255,255,255,.8);line-height:1.44} -.sect1{padding-bottom:.625em} -@media only screen and (min-width:768px){.sect1{padding-bottom:1.25em}} -.sect1+.sect1{border-top:1px solid #efefed} -#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400} -#content h1>a.anchor:before,h2>a.anchor:before,h3>a.anchor:before,#toctitle>a.anchor:before,.sidebarblock>.content>.title>a.anchor:before,h4>a.anchor:before,h5>a.anchor:before,h6>a.anchor:before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em} -#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible} -#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none} -#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221} -.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em} -.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic} -table.tableblock>caption.title{white-space:nowrap;overflow:visible;max-width:0} -.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{color:rgba(0,0,0,.85)} -table.tableblock #preamble>.sectionbody>.paragraph:first-of-type p{font-size:inherit} -.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%} -.admonitionblock>table td.icon{text-align:center;width:80px} -.admonitionblock>table td.icon img{max-width:initial} -.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase} -.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #ddddd8;color:rgba(0,0,0,.6)} -.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0} -.exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px} -.exampleblock>.content>:first-child{margin-top:0} -.exampleblock>.content>:last-child{margin-bottom:0} -.sidebarblock{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px} -.sidebarblock>:first-child{margin-top:0} -.sidebarblock>:last-child{margin-bottom:0} -.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center} -.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0} -.literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#f7f7f8} -.sidebarblock .literalblock pre,.sidebarblock .listingblock pre:not(.highlight),.sidebarblock .listingblock pre[class="highlight"],.sidebarblock .listingblock pre[class^="highlight "],.sidebarblock .listingblock pre.CodeRay,.sidebarblock .listingblock pre.prettyprint{background:#f2f1f1} -.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;padding:1em;font-size:.8125em} -.literalblock pre.nowrap,.literalblock pre[class].nowrap,.listingblock pre.nowrap,.listingblock pre[class].nowrap{overflow-x:auto;white-space:pre;word-wrap:normal} -@media only screen and (min-width:768px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:.90625em}} -@media only screen and (min-width:1280px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:1em}} -.literalblock.output pre{color:#f7f7f8;background-color:rgba(0,0,0,.9)} -.listingblock pre.highlightjs{padding:0} -.listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px} -.listingblock pre.prettyprint{border-width:0} -.listingblock>.content{position:relative} -.listingblock code[data-lang]:before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:#999} -.listingblock:hover code[data-lang]:before{display:block} -.listingblock.terminal pre .command:before{content:attr(data-prompt);padding-right:.5em;color:#999} -.listingblock.terminal pre .command:not([data-prompt]):before{content:"$"} -table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none} -table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0;line-height:1.45} -table.pyhltable td.code{padding-left:.75em;padding-right:0} -pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #ddddd8} -pre.pygments .lineno{display:inline-block;margin-right:.25em} -table.pyhltable .linenodiv{background:none!important;padding-right:0!important} -.quoteblock{margin:0 1em 1.25em 1.5em;display:table} -.quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em} -.quoteblock blockquote,.quoteblock blockquote p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify} -.quoteblock blockquote{margin:0;padding:0;border:0} -.quoteblock blockquote:before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)} -.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0} -.quoteblock .attribution{margin-top:.5em;margin-right:.5ex;text-align:right} -.quoteblock .quoteblock{margin-left:0;margin-right:0;padding:.5em 0;border-left:3px solid rgba(0,0,0,.6)} -.quoteblock .quoteblock blockquote{padding:0 0 0 .75em} -.quoteblock .quoteblock blockquote:before{display:none} -.verseblock{margin:0 1em 1.25em 1em} -.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility} -.verseblock pre strong{font-weight:400} -.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex} -.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic} -.quoteblock .attribution br,.verseblock .attribution br{display:none} -.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)} -.quoteblock.abstract{margin:0 0 1.25em 0;display:block} -.quoteblock.abstract blockquote,.quoteblock.abstract blockquote p{text-align:left;word-spacing:0} -.quoteblock.abstract blockquote:before,.quoteblock.abstract blockquote p:first-of-type:before{display:none} -table.tableblock{max-width:100%;border-collapse:separate} -table.tableblock td>.paragraph:last-child p>p:last-child,table.tableblock th>p:last-child,table.tableblock td>p:last-child{margin-bottom:0} -table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede} -table.grid-all>thead>tr>.tableblock,table.grid-all>tbody>tr>.tableblock{border-width:0 1px 1px 0} -table.grid-all>tfoot>tr>.tableblock{border-width:1px 1px 0 0} -table.grid-cols>*>tr>.tableblock{border-width:0 1px 0 0} -table.grid-rows>thead>tr>.tableblock,table.grid-rows>tbody>tr>.tableblock{border-width:0 0 1px 0} -table.grid-rows>tfoot>tr>.tableblock{border-width:1px 0 0 0} -table.grid-all>*>tr>.tableblock:last-child,table.grid-cols>*>tr>.tableblock:last-child{border-right-width:0} -table.grid-all>tbody>tr:last-child>.tableblock,table.grid-all>thead:last-child>tr>.tableblock,table.grid-rows>tbody>tr:last-child>.tableblock,table.grid-rows>thead:last-child>tr>.tableblock{border-bottom-width:0} -table.frame-all{border-width:1px} -table.frame-sides{border-width:0 1px} -table.frame-topbot{border-width:1px 0} -th.halign-left,td.halign-left{text-align:left} -th.halign-right,td.halign-right{text-align:right} -th.halign-center,td.halign-center{text-align:center} -th.valign-top,td.valign-top{vertical-align:top} -th.valign-bottom,td.valign-bottom{vertical-align:bottom} -th.valign-middle,td.valign-middle{vertical-align:middle} -table thead th,table tfoot th{font-weight:bold} -tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7} -tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold} -p.tableblock>code:only-child{background:none;padding:0} -p.tableblock{font-size:1em} -td>div.verse{white-space:pre} -ol{margin-left:1.75em} -ul li ol{margin-left:1.5em} -dl dd{margin-left:1.125em} -dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0} -ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em} -ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none} -ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em} -ul.unstyled,ol.unstyled{margin-left:0} -ul.checklist{margin-left:.625em} -ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em} -ul.checklist li>p:first-child>input[type="checkbox"]:first-child{margin-right:.25em} -ul.inline{margin:0 auto .625em auto;margin-left:-1.375em;margin-right:0;padding:0;list-style:none;overflow:hidden} -ul.inline>li{list-style:none;float:left;margin-left:1.375em;display:block} -ul.inline>li>*{display:block} -.unstyled dl dt{font-weight:400;font-style:normal} -ol.arabic{list-style-type:decimal} -ol.decimal{list-style-type:decimal-leading-zero} -ol.loweralpha{list-style-type:lower-alpha} -ol.upperalpha{list-style-type:upper-alpha} -ol.lowerroman{list-style-type:lower-roman} -ol.upperroman{list-style-type:upper-roman} -ol.lowergreek{list-style-type:lower-greek} -.hdlist>table,.colist>table{border:0;background:none} -.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none} -td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em} -td.hdlist1{font-weight:bold;padding-bottom:1.25em} -.literalblock+.colist,.listingblock+.colist{margin-top:-.5em} -.colist>table tr>td:first-of-type{padding:.4em .75em 0 .75em;line-height:1;vertical-align:top} -.colist>table tr>td:first-of-type img{max-width:initial} -.colist>table tr>td:last-of-type{padding:.25em 0} -.thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd} -.imageblock.left,.imageblock[style*="float: left"]{margin:.25em .625em 1.25em 0} -.imageblock.right,.imageblock[style*="float: right"]{margin:.25em 0 1.25em .625em} -.imageblock>.title{margin-bottom:0} -.imageblock.thumb,.imageblock.th{border-width:6px} -.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em} -.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0} -.image.left{margin-right:.625em} -.image.right{margin-left:.625em} -a.image{text-decoration:none;display:inline-block} -a.image object{pointer-events:none} -sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super} -sup.footnote a,sup.footnoteref a{text-decoration:none} -sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline} -#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em} -#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em 0;border-width:1px 0 0 0} -#footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;text-indent:-1.05em;margin-bottom:.2em} -#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none} -#footnotes .footnote:last-of-type{margin-bottom:0} -#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0} -.gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0} -.gist .file-data>table td.line-data{width:99%} -div.unbreakable{page-break-inside:avoid} -.big{font-size:larger} -.small{font-size:smaller} -.underline{text-decoration:underline} -.overline{text-decoration:overline} -.line-through{text-decoration:line-through} -.aqua{color:#00bfbf} -.aqua-background{background-color:#00fafa} -.black{color:#000} -.black-background{background-color:#000} -.blue{color:#0000bf} -.blue-background{background-color:#0000fa} -.fuchsia{color:#bf00bf} -.fuchsia-background{background-color:#fa00fa} -.gray{color:#606060} -.gray-background{background-color:#7d7d7d} -.green{color:#006000} -.green-background{background-color:#007d00} -.lime{color:#00bf00} -.lime-background{background-color:#00fa00} -.maroon{color:#600000} -.maroon-background{background-color:#7d0000} -.navy{color:#000060} -.navy-background{background-color:#00007d} -.olive{color:#606000} -.olive-background{background-color:#7d7d00} -.purple{color:#600060} -.purple-background{background-color:#7d007d} -.red{color:#bf0000} -.red-background{background-color:#fa0000} -.silver{color:#909090} -.silver-background{background-color:#bcbcbc} -.teal{color:#006060} -.teal-background{background-color:#007d7d} -.white{color:#bfbfbf} -.white-background{background-color:#fafafa} -.yellow{color:#bfbf00} -.yellow-background{background-color:#fafa00} -span.icon>.fa{cursor:default} -a span.icon>.fa{cursor:inherit} -.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default} -.admonitionblock td.icon .icon-note:before{content:"\f05a";color:#19407c} -.admonitionblock td.icon .icon-tip:before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111} -.admonitionblock td.icon .icon-warning:before{content:"\f071";color:#bf6900} -.admonitionblock td.icon .icon-caution:before{content:"\f06d";color:#bf3400} -.admonitionblock td.icon .icon-important:before{content:"\f06a";color:#bf0000} -.conum[data-value]{display:inline-block;color:#fff!important;background-color:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold} -.conum[data-value] *{color:#fff!important} -.conum[data-value]+b{display:none} -.conum[data-value]:after{content:attr(data-value)} -pre .conum[data-value]{position:relative;top:-.125em} -b.conum *{color:inherit!important} -.conum:not([data-value]):empty{display:none} -dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility} -h1,h2,p,td.content,span.alt{letter-spacing:-.01em} -p strong,td.content strong,div.footnote strong{letter-spacing:-.005em} -p,blockquote,dt,td.content,span.alt{font-size:1.0625rem} -p{margin-bottom:1.25rem} -.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em} -.exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc} -.print-only{display:none!important} -@media print{@page{margin:1.25cm .75cm} -*{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important} -a{color:inherit!important;text-decoration:underline!important} -a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important} -a[href^="http:"]:not(.bare):after,a[href^="https:"]:not(.bare):after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em} -abbr[title]:after{content:" (" attr(title) ")"} -pre,blockquote,tr,img,object,svg{page-break-inside:avoid} -thead{display:table-header-group} -svg{max-width:100%} -p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3} -h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid} -#toc,.sidebarblock,.exampleblock>.content{background:none!important} -#toc{border-bottom:1px solid #ddddd8!important;padding-bottom:0!important} -.sect1{padding-bottom:0!important} -.sect1+.sect1{border:0!important} -#header>h1:first-child{margin-top:1.25rem} -body.book #header{text-align:center} -body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em 0} -body.book #header .details{border:0!important;display:block;padding:0!important} -body.book #header .details span:first-child{margin-left:0!important} -body.book #header .details br{display:block} -body.book #header .details br+span:before{content:none!important} -body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important} -body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always} -.listingblock code[data-lang]:before{display:block} -#footer{background:none!important;padding:0 .9375em} -#footer-text{color:rgba(0,0,0,.6)!important;font-size:.9em} -.hide-on-print{display:none!important} -.print-only{display:block!important} -.hide-for-print{display:none!important} -.show-for-print{display:inherit!important}} -</style> -</head> -<body class="article toc2 toc-left"> -<div id="header"> -<h1>API ServiceCatalog</h1> -<div id="toc" class="toc2"> -<div id="toctitle">Table of Contents</div> -<ul class="sectlevel1"> -<li><a href="#_overview">Overview</a> -<ul class="sectlevel2"> -<li><a href="#_api_url">Api URL</a></li> -<li><a href="#_version_information">Version information</a></li> -<li><a href="#_uri_scheme">URI scheme</a></li> -<li><a href="#_tags">Tags</a></li> -<li><a href="#_produces">Produces</a></li> -</ul> -</li> -<li><a href="#_paths">Resources</a> -<ul class="sectlevel2"> -<li><a href="#_servicespecification_resource">ServiceSpecification</a></li> -</ul> -</li> -<li><a href="#_definitions">Definitions</a> -<ul class="sectlevel2"> -<li><a href="#_attachment">Attachment</a></li> -<li><a href="#_distributionstatus">DistributionStatus</a></li> -<li><a href="#_errorrepresentation">ErrorRepresentation</a></li> -<li><a href="#_lifecyclestatusvalues">LifecycleStatusValues</a></li> -<li><a href="#_relatedpartyref">RelatedPartyRef</a></li> -<li><a href="#_resourcespecificationref">ResourceSpecificationRef</a></li> -<li><a href="#_servicespeccharacteristic">ServiceSpecCharacteristic</a></li> -<li><a href="#_servicespeccharacteristicvalue">ServiceSpecCharacteristicValue</a></li> -<li><a href="#_servicespecification">ServiceSpecification</a></li> -<li><a href="#_targetserviceschemaref">TargetServiceSchemaRef</a></li> -<li><a href="#_timeperiod">TimePeriod</a></li> -</ul> -</li> -</ul> -</div> -</div> -<div id="content"> -<div class="sect1"> -<h2 id="_overview">Overview</h2> -<div class="sectionbody"> -<div class="sect2"> -<h3 id="_api_url">Api URL</h3> -<div class="paragraph"> -<p><a href="https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/XOmvoxNn9d/swagger.json">Swagger UI</a></p> -</div> -<div class="paragraph"> -<p><a href="https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/XOmvoxNn9d/plantuml&noCache=995303.0">plant UML UI</a></p> -</div> -<div class="paragraph"> -<p>serviceCatalog API designed for ONAP Beijing Release. -This API is build from TMF open API17.5. -Only operation GET (by id & byList) for resource serviceSpecification is available</p> -</div> -</div> -<div class="sect2"> -<h3 id="_version_information">Version information</h3> -<div class="paragraph"> -<p><em>Version</em> : 3.0.0_inProgress</p> -</div> -</div> -<div class="sect2"> -<h3 id="_uri_scheme">URI scheme</h3> -<div class="paragraph"> -<p><em>Host</em> : serverRoot<br> -<em>BasePath</em> : /nbi/api/v3<br> -<em>Schemes</em> : HTTPS</p> -</div> -</div> -<div class="sect2"> -<h3 id="_tags">Tags</h3> -<div class="ulist"> -<ul> -<li> -<p>ServiceSpecification</p> -</li> -</ul> -</div> -</div> -<div class="sect2"> -<h3 id="_produces">Produces</h3> -<div class="ulist"> -<ul> -<li> -<p><code>application/json;charset=utf-8</code></p> -</li> -</ul> -</div> -</div> -</div> -</div> -<div class="sect1"> -<h2 id="_paths">Resources</h2> -<div class="sectionbody"> -<div class="sect2"> -<h3 id="_servicespecification_resource">ServiceSpecification</h3> -<div class="sect3"> -<h4 id="_servicespecificationfind">List service specifications</h4> -<div class="literalblock"> -<div class="content"> -<pre>GET /serviceSpecification</pre> -</div> -</div> -<div class="sect4"> -<h5 id="_description">Description</h5> -<div class="paragraph"> -<p>This operation returns service specifications from a catalog. -Only a predefined set of attribute is proposed : Based on SDC limitations, only attributes category and distributionStatus are available for serviceSpecification filtering -Fields attribute could be used to filter attributes retrieved</p> -</div> -<div class="paragraph"> -<p>Specific business errors for current operation will be encapsulated in</p> -</div> -<div class="paragraph"> -<p>HTTP Response 422 Unprocessable entity</p> -</div> -</div> -<div class="sect4"> -<h5 id="_parameters">Parameters</h5> -<table class="tableblock frame-all grid-all spread"> -<colgroup> -<col style="width: 11.1111%;"> -<col style="width: 16.6666%;"> -<col style="width: 50%;"> -<col style="width: 22.2223%;"> -</colgroup> -<thead> -<tr> -<th class="tableblock halign-left valign-middle">Type</th> -<th class="tableblock halign-left valign-middle">Name</th> -<th class="tableblock halign-left valign-middle">Description</th> -<th class="tableblock halign-left valign-middle">Schema</th> -</tr> -</thead> -<tbody> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>category</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Service Category (filter)</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>distributionStatus</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Service distribution status (filter)</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>fields</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Field selection - used to filtering the attributes to be retreived</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -</tbody> -</table> -</div> -<div class="sect4"> -<h5 id="_responses">Responses</h5> -<table class="tableblock frame-all grid-all spread"> -<colgroup> -<col style="width: 10%;"> -<col style="width: 70%;"> -<col style="width: 20%;"> -</colgroup> -<thead> -<tr> -<th class="tableblock halign-left valign-middle">HTTP Code</th> -<th class="tableblock halign-left valign-middle">Description</th> -<th class="tableblock halign-left valign-middle">Schema</th> -</tr> -</thead> -<tbody> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Success</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_servicespecification">ServiceSpecification</a> > array</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>400</strong></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Bad Request</p> -<p class="tableblock">List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>401</strong></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Unauthorized</p> -<p class="tableblock">List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>403</strong></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Forbidden</p> -<p class="tableblock">List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>404</strong></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Not Found</p> -<p class="tableblock">List of supported error codes: -- 60: Resource not found</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>422</strong></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Unprocessable entity</p> -<p class="tableblock">Functional error</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>500</strong></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Internal Server Error</p> -<p class="tableblock">List of supported error codes: -- 1: Internal error</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>503</strong></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Service Unavailable</p> -<p class="tableblock">List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td> -</tr> -</tbody> -</table> -</div> -<div class="sect4"> -<h5 id="_produces_2">Produces</h5> -<div class="ulist"> -<ul> -<li> -<p><code>application/json;charset=utf-8</code></p> -</li> -</ul> -</div> -</div> -</div> -<div class="sect3"> -<h4 id="_servicespecificationget">Retrieve a service specification</h4> -<div class="literalblock"> -<div class="content"> -<pre>GET /serviceSpecification/{id}</pre> -</div> -</div> -<div class="sect4"> -<h5 id="_description_2">Description</h5> -<div class="paragraph"> -<p>This operation returns a service specification by its id from a catalog. Attribute selection is enabled using the fields attribute.</p> -</div> -<div class="paragraph"> -<p>Specific business errors for current operation will be encapsulated in</p> -</div> -<div class="paragraph"> -<p>HTTP Response 422 Unprocessable entity</p> -</div> -</div> -<div class="sect4"> -<h5 id="_parameters_2">Parameters</h5> -<table class="tableblock frame-all grid-all spread"> -<colgroup> -<col style="width: 11.1111%;"> -<col style="width: 16.6666%;"> -<col style="width: 50%;"> -<col style="width: 22.2223%;"> -</colgroup> -<thead> -<tr> -<th class="tableblock halign-left valign-middle">Type</th> -<th class="tableblock halign-left valign-middle">Name</th> -<th class="tableblock halign-left valign-middle">Description</th> -<th class="tableblock halign-left valign-middle">Schema</th> -</tr> -</thead> -<tbody> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Path</strong></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br> -<em>required</em></p></td> -<td class="tableblock halign-left valign-middle"></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>fields</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Attribute selection</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -</tbody> -</table> -</div> -<div class="sect4"> -<h5 id="_responses_2">Responses</h5> -<table class="tableblock frame-all grid-all spread"> -<colgroup> -<col style="width: 10%;"> -<col style="width: 70%;"> -<col style="width: 20%;"> -</colgroup> -<thead> -<tr> -<th class="tableblock halign-left valign-middle">HTTP Code</th> -<th class="tableblock halign-left valign-middle">Description</th> -<th class="tableblock halign-left valign-middle">Schema</th> -</tr> -</thead> -<tbody> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Success</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_servicespecification">ServiceSpecification</a></p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>400</strong></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Bad Request</p> -<p class="tableblock">List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>401</strong></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Unauthorized</p> -<p class="tableblock">List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>403</strong></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Forbidden</p> -<p class="tableblock">List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>404</strong></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Not Found</p> -<p class="tableblock">List of supported error codes: -- 60: Resource not found</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>422</strong></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Unprocessable entity</p> -<p class="tableblock">Functional error</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>500</strong></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Internal Server Error</p> -<p class="tableblock">List of supported error codes: -- 1: Internal error</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>503</strong></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Service Unavailable</p> -<p class="tableblock">List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_errorrepresentation">ErrorRepresentation</a></p></td> -</tr> -</tbody> -</table> -</div> -<div class="sect4"> -<h5 id="_produces_3">Produces</h5> -<div class="ulist"> -<ul> -<li> -<p><code>application/json;charset=utf-8</code></p> -</li> -</ul> -</div> -</div> -</div> -</div> -</div> -</div> -<div class="sect1"> -<h2 id="_definitions">Definitions</h2> -<div class="sectionbody"> -<div class="sect2"> -<h3 id="_attachment">Attachment</h3> -<div class="paragraph"> -<p>An attachment is a file uses to describe the service. -In nbi we use attachment to retrieve ONAP artifacts.</p> -</div> -<table class="tableblock frame-all grid-all spread"> -<colgroup> -<col style="width: 16.6666%;"> -<col style="width: 61.1111%;"> -<col style="width: 22.2223%;"> -</colgroup> -<thead> -<tr> -<th class="tableblock halign-left valign-middle">Name</th> -<th class="tableblock halign-left valign-middle">Description</th> -<th class="tableblock halign-left valign-middle">Schema</th> -</tr> -</thead> -<tbody> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@type</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">This attribute allows to dynamically extends TMF class. Valued with 'ONAPartifact'. We used this features to add following attributes: -artifactLabel -artifactGroupType -artifactTimeout -artifactChecksum -artifactVersion -generatedFromUUID<br> -<strong>Default</strong> : <code>"ONAPartifact"</code></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>artifactChecksum</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute (not in the TMF API) - extended through @type - artifactChecksum</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>artifactGroupType</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute (not in the TMF API) - extended through @type - artifactGroupType</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>artifactLabel</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute (not in the TMF API) - extended through @type - artifactLabel</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>artifactTimeout</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute (not in the TMF API) - extended through @type - artifactTimeout</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>artifactVersion</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute (not in the TMF API) - extended through @type - artifactVersion</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>description</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Description of the attachment - filled with artifactDescription</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>generatedFromUUID</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute (not in the TMF API) - extended through @type - generatedFromUUID</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Unique identifier of the attachment - filled with artifactUUID.</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>mimeType</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Filled with artifactType</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Name of the attachment - filled with artifactName</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>url</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Uniform Resource Locator, is a web page address - filled with artifactURL</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -</tbody> -</table> -</div> -<div class="sect2"> -<h3 id="_distributionstatus">DistributionStatus</h3> -<div class="paragraph"> -<p>Service distribution status from ONAP.</p> -</div> -<div class="paragraph"> -<p><em>Type</em> : enum (DISTRIBUTION_NOT_APPROVED, DISTRIBUTION_APPROVED, DISTRIBUTED, DISTRIBUTION_REJECTED)</p> -</div> -</div> -<div class="sect2"> -<h3 id="_errorrepresentation">ErrorRepresentation</h3> -<div class="paragraph"> -<p>This class is used to describe error. -for nbi Beijing release we do not manage additional error for serviceCatalog</p> -</div> -<table class="tableblock frame-all grid-all spread"> -<colgroup> -<col style="width: 16.6666%;"> -<col style="width: 61.1111%;"> -<col style="width: 22.2223%;"> -</colgroup> -<thead> -<tr> -<th class="tableblock halign-left valign-middle">Name</th> -<th class="tableblock halign-left valign-middle">Description</th> -<th class="tableblock halign-left valign-middle">Schema</th> -</tr> -</thead> -<tbody> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@schemaLocation</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">it provides a link to the schema describing a REST resource.</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@type</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">The class type of a REST resource.</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>code</strong><br> -<em>required</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Application related code (as defined in the API or from a common list)</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>message</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Text that provide more details and corrective actions related to the error. This can be shown to a client user</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>reason</strong><br> -<em>required</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Text that explains the reason for error. This can be shown to a client user.</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>referenceErrror</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">url pointing to documentation describing the error</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>status</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">http error code extension like 400-2</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -</tbody> -</table> -</div> -<div class="sect2"> -<h3 id="_lifecyclestatusvalues">LifecycleStatusValues</h3> -<div class="paragraph"> -<p>Service lifecycle value from ONAP SDC</p> -</div> -<div class="paragraph"> -<p><em>Type</em> : enum (NOT_CERTIFIED_CHECKOUT, NOT_CERTIFIED_CHECKIN, READY_FOR_CERTIFICATION, CERTIFICATION_IN_PROGRESS, CERTIFIED)</p> -</div> -</div> -<div class="sect2"> -<h3 id="_relatedpartyref">RelatedPartyRef</h3> -<div class="paragraph"> -<p>Party linked to the service catalog. -in nbi we retrieve information about last updater of the service in SDC</p> -</div> -<table class="tableblock frame-all grid-all spread"> -<colgroup> -<col style="width: 16.6666%;"> -<col style="width: 61.1111%;"> -<col style="width: 22.2223%;"> -</colgroup> -<thead> -<tr> -<th class="tableblock halign-left valign-middle">Name</th> -<th class="tableblock halign-left valign-middle">Description</th> -<th class="tableblock halign-left valign-middle">Schema</th> -</tr> -</thead> -<tbody> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Unique identifier of the related party. Filled with lastUpdaterUserId</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Name of the related party - Filled with lastUpdatedFullName</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>role</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Role payed by the related party -Only role 'lastUpdater' is retrieved in Beijing release</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -</tbody> -</table> -</div> -<div class="sect2"> -<h3 id="_resourcespecificationref">ResourceSpecificationRef</h3> -<div class="paragraph"> -<p>A list of resourceSpec identified to deliver the service. -for nbi we retrieve resource information available in service description (through SDC api) bu as well information retrieved in the TOSCA file.</p> -</div> -<table class="tableblock frame-all grid-all spread"> -<colgroup> -<col style="width: 16.6666%;"> -<col style="width: 61.1111%;"> -<col style="width: 22.2223%;"> -</colgroup> -<thead> -<tr> -<th class="tableblock halign-left valign-middle">Name</th> -<th class="tableblock halign-left valign-middle">Description</th> -<th class="tableblock halign-left valign-middle">Schema</th> -</tr> -</thead> -<tbody> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@type</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">This attribute allows to dynamically extends TMF class. Valued with: 'ONAPresource'. We used this features to add following attributes: -resourceInstanceName -resourceInvariantUUID -resourceType -modelCustomizationName -modelCustomizationId<br> -<strong>Default</strong> : <code>"ONAPresource"</code></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Unique identifier of the resource specification - filled with resourceUUID</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelCustomizationId</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute (not in the TMF API) - extended through @type - Retrieved in the TOSCA file : attribute customizationUUID in topology_template/node_template for the resource</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>modelCustomizationName</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute (not in the TMF API) - extended through @type - Retrieved in the TOSCA file : attribute name in topology_template/node_template for the resource</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Name of the resource specification - filled with resourceName</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>resourceInstanceName</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute (not in the TMF API) - extended through @type - resourceInstanceName</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>resourceInvariantUUID</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute (not in the TMF API) - extended through @type - resourceInvariantUUID</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>resourceType</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute (not in the TMF API) - extended through @type - resoucreType</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>version</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Version for this resource specification - filled with resourceVersion</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -</tbody> -</table> -</div> -<div class="sect2"> -<h3 id="_servicespeccharacteristic">ServiceSpecCharacteristic</h3> -<div class="paragraph"> -<p>A characteristic quality or distinctive feature of a ServiceSpecification. -ServiceSpecCharacteristic are retrieved in the serviceTosca file in the topology_template section in the inputs section.</p> -</div> -<table class="tableblock frame-all grid-all spread"> -<colgroup> -<col style="width: 16.6666%;"> -<col style="width: 61.1111%;"> -<col style="width: 22.2223%;"> -</colgroup> -<thead> -<tr> -<th class="tableblock halign-left valign-middle">Name</th> -<th class="tableblock halign-left valign-middle">Description</th> -<th class="tableblock halign-left valign-middle">Schema</th> -</tr> -</thead> -<tbody> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@schemaLocation</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">An url pointing to type description - we do not use it in nbi Beijing release</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@type</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">This attribute allows to dynamically extends TMF class. Valued with: 'ONAPserviceCharacteristic'. We do not used this features in nbi Beijing release.</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>description</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">A narrative that explains in detail what the characteristic is - Filled with parameter_description</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Name of the characteristic - Filled with parameter_name</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>required</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">A parameter to define if the characteristic is mandatory - Filled from parameter_required – if not fielded by default ‘true’<br> -<strong>Default</strong> : <code>true</code></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceSpecCharacteristicValue</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_servicespeccharacteristicvalue">ServiceSpecCharacteristicValue</a> > array</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>status</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Status of the characteristic - filled with status_value</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>valueType</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">A kind of value that the characteristic can take on, such as numeric, text and so forth - Filled with parameter_type</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -</tbody> -</table> -</div> -<div class="sect2"> -<h3 id="_servicespeccharacteristicvalue">ServiceSpecCharacteristicValue</h3> -<div class="paragraph"> -<p>A number or text that can be assigned to a service specification characteristic. -ServiceSpecCharacteristicValue are retrieved in the service Tosca file</p> -</div> -<table class="tableblock frame-all grid-all spread"> -<colgroup> -<col style="width: 16.6666%;"> -<col style="width: 61.1111%;"> -<col style="width: 22.2223%;"> -</colgroup> -<thead> -<tr> -<th class="tableblock halign-left valign-middle">Name</th> -<th class="tableblock halign-left valign-middle">Description</th> -<th class="tableblock halign-left valign-middle">Schema</th> -</tr> -</thead> -<tbody> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>isDefault</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Information calculated from parameter default in the Tosca file</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>value</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">A discrete value that the characteristic can take on</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>valueType</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">A kind of value that the characteristic can take on, such as numeric, text, and so forth -Retrieved in the Tosca in the topology_template section in the inputs section - parameter_type. -We do not manage parameter_type= list or map for Beijing release</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -</tbody> -</table> -</div> -<div class="sect2"> -<h3 id="_servicespecification">ServiceSpecification</h3> -<div class="paragraph"> -<p>ServiceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics. -the service information are retrieved in SDC</p> -</div> -<table class="tableblock frame-all grid-all spread"> -<colgroup> -<col style="width: 16.6666%;"> -<col style="width: 61.1111%;"> -<col style="width: 22.2223%;"> -</colgroup> -<thead> -<tr> -<th class="tableblock halign-left valign-middle">Name</th> -<th class="tableblock halign-left valign-middle">Description</th> -<th class="tableblock halign-left valign-middle">Schema</th> -</tr> -</thead> -<tbody> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@baseType</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Not used for Beijing release</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@schemaLocation</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Not used for Beijing release</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@type</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">This attribute allows to dynamically extends TMF class. Valued with 'ONAPservice'. We used this features to add following attributes: -invariantUUID -toscaModelURL -toscaResourceName -category (1) -subcategory (1) -distributionStatus<br> -<strong>Default</strong> : <code>"ONAPservice"</code></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>attachment</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_attachment">Attachment</a> > array</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>category</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute - extended through @type - category -Please note that this attribute is managed in TMF - in future release we’ll introduce category resource</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>description</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">A narrative that explains in detail what the service specification is - Filled with SDC Service description</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>distributionStatus</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_distributionstatus">DistributionStatus</a></p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>href</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Reference of the service specification- not mapped in Beijing</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Unique identifier of the service specification. Filled with SDC Service uuid</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>invariantUUID</strong><br> -<em>required</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute (not in the TMF API) - extended through @type - invariantUUID</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>lifecycleStatus</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_lifecyclestatusvalues">LifecycleStatusValues</a></p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Name of the service specification- Filled with SDC Service name</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>relatedParty</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_relatedpartyref">RelatedPartyRef</a> > array</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>resourceSpecification</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_resourcespecificationref">ResourceSpecificationRef</a> > array</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceSpecCharacteristic</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_servicespeccharacteristic">ServiceSpecCharacteristic</a> > array</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>subcategory</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute - extended through @type - category -Please note that this attribute is managed in TMF - in future release we’ll introduce category resourc</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>targetServiceSchema</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_targetserviceschemaref">TargetServiceSchemaRef</a></p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>toscaModelURL</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute (not in the TMF API) - extended through @type - toscaModelURL</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>toscaResourceName</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Additional attribute (not in the TMF API) - extended through @type - toscaResourceName</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>version</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Service specification version - Filled with SDC Service version</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -</tbody> -</table> -</div> -<div class="sect2"> -<h3 id="_targetserviceschemaref">TargetServiceSchemaRef</h3> -<table class="tableblock frame-all grid-all spread"> -<colgroup> -<col style="width: 42.8571%;"> -<col style="width: 57.1429%;"> -</colgroup> -<thead> -<tr> -<th class="tableblock halign-left valign-middle">Name</th> -<th class="tableblock halign-left valign-middle">Schema</th> -</tr> -</thead> -<tbody> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@schemaLocation</strong><br> -<em>required</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>@type</strong><br> -<em>required</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> -</tr> -</tbody> -</table> -</div> -<div class="sect2"> -<h3 id="_timeperiod">TimePeriod</h3> -<div class="paragraph"> -<p>A time period</p> -</div> -<table class="tableblock frame-all grid-all spread"> -<colgroup> -<col style="width: 16.6666%;"> -<col style="width: 61.1111%;"> -<col style="width: 22.2223%;"> -</colgroup> -<thead> -<tr> -<th class="tableblock halign-left valign-middle">Name</th> -<th class="tableblock halign-left valign-middle">Description</th> -<th class="tableblock halign-left valign-middle">Schema</th> -</tr> -</thead> -<tbody> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>endDateTime</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">End date and time of the period</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string (date-time)</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>startDateTime</strong><br> -<em>optional</em></p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">Start date and time of the period</p></td> -<td class="tableblock halign-left valign-middle"><p class="tableblock">string (date-time)</p></td> -</tr> -</tbody> -</table> -</div> -</div> -</div> -</div> -<div id="footer"> -<div id="footer-text"> -Last updated 2018-09-12 13:43:40 +00:00 -</div> -</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/offeredapis/serviceCatalog/markDown.md b/docs/offeredapis/serviceCatalog/markDown.md deleted file mode 100644 index 7f1a02d..0000000 --- a/docs/offeredapis/serviceCatalog/markDown.md +++ /dev/null @@ -1,299 +0,0 @@ -# API ServiceCatalog - - -<a name="overview"></a> -## Overview - -### Api URL - -[Swagger UI](https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/XOmvoxNn9d/swagger.json) - - -[plant UML UI](https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/XOmvoxNn9d/plantuml&noCache=995303.0) - -serviceCatalog API designed for ONAP Beijing Release. -This API is build from TMF open API17.5. -Only operation GET (by id & byList) for resource serviceSpecification is available - - -### Version information -*Version* : 3.0.0_inProgress - - -### URI scheme -*Host* : serverRoot -*BasePath* : /nbi/api/v3 -*Schemes* : HTTPS - - -### Tags - -* ServiceSpecification - - -### Produces - -* `application/json;charset=utf-8` - - -<a name="paths"></a> -## Resources - -<a name="servicespecification_resource"></a> -### ServiceSpecification - -<a name="servicespecificationfind"></a> -#### List service specifications -``` -GET /serviceSpecification -``` - - -##### Description -This operation returns service specifications from a catalog. -Only a predefined set of attribute is proposed : Based on SDC limitations, only attributes category and distributionStatus are available for serviceSpecification filtering -Fields attribute could be used to filter attributes retrieved - -Specific business errors for current operation will be encapsulated in - -HTTP Response 422 Unprocessable entity - - -##### Parameters - -|Type|Name|Description|Schema| -|---|---|---|---| -|**Query**|**category** <br>*optional*|Service Category (filter)|string| -|**Query**|**distributionStatus** <br>*optional*|Service distribution status (filter)|string| -|**Query**|**fields** <br>*optional*|Field selection - used to filtering the attributes to be retreived|string| - - -##### Responses - -|HTTP Code|Description|Schema| -|---|---|---| -|**200**|Success|< [ServiceSpecification](#servicespecification) > array| -|**400**|Bad Request<br><br>List of supported error codes:<br>- 20: Invalid URL parameter value<br>- 21: Missing body<br>- 22: Invalid body<br>- 23: Missing body field<br>- 24: Invalid body field<br>- 25: Missing header<br>- 26: Invalid header value<br>- 27: Missing query-string parameter<br>- 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)| -|**401**|Unauthorized<br><br>List of supported error codes:<br>- 40: Missing credentials<br>- 41: Invalid credentials<br>- 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)| -|**403**|Forbidden<br><br>List of supported error codes:<br>- 50: Access denied<br>- 51: Forbidden requester<br>- 52: Forbidden user<br>- 53: Too many requests|[ErrorRepresentation](#errorrepresentation)| -|**404**|Not Found<br><br>List of supported error codes:<br>- 60: Resource not found|[ErrorRepresentation](#errorrepresentation)| -|**422**|Unprocessable entity<br><br>Functional error|[ErrorRepresentation](#errorrepresentation)| -|**500**|Internal Server Error<br><br>List of supported error codes:<br>- 1: Internal error|[ErrorRepresentation](#errorrepresentation)| -|**503**|Service Unavailable<br><br>List of supported error codes:<br>- 5: The service is temporarily unavailable<br>- 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)| - - -##### Produces - -* `application/json;charset=utf-8` - - -<a name="servicespecificationget"></a> -#### Retrieve a service specification -``` -GET /serviceSpecification/{id} -``` - - -##### Description -This operation returns a service specification by its id from a catalog. Attribute selection is enabled using the fields attribute. - -Specific business errors for current operation will be encapsulated in - -HTTP Response 422 Unprocessable entity - - -##### Parameters - -|Type|Name|Description|Schema| -|---|---|---|---| -|**Path**|**id** <br>*required*||string| -|**Query**|**fields** <br>*optional*|Attribute selection|string| - - -##### Responses - -|HTTP Code|Description|Schema| -|---|---|---| -|**200**|Success|[ServiceSpecification](#servicespecification)| -|**400**|Bad Request<br><br>List of supported error codes:<br>- 20: Invalid URL parameter value<br>- 21: Missing body<br>- 22: Invalid body<br>- 23: Missing body field<br>- 24: Invalid body field<br>- 25: Missing header<br>- 26: Invalid header value<br>- 27: Missing query-string parameter<br>- 28: Invalid query-string parameter value|[ErrorRepresentation](#errorrepresentation)| -|**401**|Unauthorized<br><br>List of supported error codes:<br>- 40: Missing credentials<br>- 41: Invalid credentials<br>- 42: Expired credentials|[ErrorRepresentation](#errorrepresentation)| -|**403**|Forbidden<br><br>List of supported error codes:<br>- 50: Access denied<br>- 51: Forbidden requester<br>- 52: Forbidden user<br>- 53: Too many requests|[ErrorRepresentation](#errorrepresentation)| -|**404**|Not Found<br><br>List of supported error codes:<br>- 60: Resource not found|[ErrorRepresentation](#errorrepresentation)| -|**422**|Unprocessable entity<br><br>Functional error|[ErrorRepresentation](#errorrepresentation)| -|**500**|Internal Server Error<br><br>List of supported error codes:<br>- 1: Internal error|[ErrorRepresentation](#errorrepresentation)| -|**503**|Service Unavailable<br><br>List of supported error codes:<br>- 5: The service is temporarily unavailable<br>- 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)| - - -##### Produces - -* `application/json;charset=utf-8` - - -<a name="definitions"></a> -## Definitions - -<a name="attachment"></a> -### Attachment -An attachment is a file uses to describe the service. -In nbi we use attachment to retrieve ONAP artifacts. - - -|Name|Description|Schema| -|---|---|---| -|**@type** <br>*optional*|This attribute allows to dynamically extends TMF class. Valued with 'ONAPartifact'. We used this features to add following attributes: <br>artifactLabel<br>artifactGroupType<br>artifactTimeout<br>artifactChecksum<br>artifactVersion<br>generatedFromUUID <br>**Default** : `"ONAPartifact"`|string| -|**artifactChecksum** <br>*optional*|Additional attribute (not in the TMF API) - extended through @type - artifactChecksum|string| -|**artifactGroupType** <br>*optional*|Additional attribute (not in the TMF API) - extended through @type - artifactGroupType|string| -|**artifactLabel** <br>*optional*|Additional attribute (not in the TMF API) - extended through @type - artifactLabel|string| -|**artifactTimeout** <br>*optional*|Additional attribute (not in the TMF API) - extended through @type - artifactTimeout|string| -|**artifactVersion** <br>*optional*|Additional attribute (not in the TMF API) - extended through @type - artifactVersion|string| -|**description** <br>*optional*|Description of the attachment - filled with artifactDescription|string| -|**generatedFromUUID** <br>*optional*|Additional attribute (not in the TMF API) - extended through @type - generatedFromUUID|string| -|**id** <br>*optional*|Unique identifier of the attachment - filled with artifactUUID.|string| -|**mimeType** <br>*optional*|Filled with artifactType|string| -|**name** <br>*optional*|Name of the attachment - filled with artifactName|string| -|**url** <br>*optional*|Uniform Resource Locator, is a web page address - filled with artifactURL|string| - - -<a name="distributionstatus"></a> -### DistributionStatus -Service distribution status from ONAP. - -*Type* : enum (DISTRIBUTION_NOT_APPROVED, DISTRIBUTION_APPROVED, DISTRIBUTED, DISTRIBUTION_REJECTED) - - -<a name="errorrepresentation"></a> -### ErrorRepresentation -This class is used to describe error. -for nbi Beijing release we do not manage additional error for serviceCatalog - - -|Name|Description|Schema| -|---|---|---| -|**@schemaLocation** <br>*optional*|it provides a link to the schema describing a REST resource.|string| -|**@type** <br>*optional*|The class type of a REST resource.|string| -|**code** <br>*required*|Application related code (as defined in the API or from a common list)|integer (int32)| -|**message** <br>*optional*|Text that provide more details and corrective actions related to the error. This can be shown to a client user|string| -|**reason** <br>*required*|Text that explains the reason for error. This can be shown to a client user.|string| -|**referenceErrror** <br>*optional*|url pointing to documentation describing the error|string| -|**status** <br>*optional*|http error code extension like 400-2|string| - - -<a name="lifecyclestatusvalues"></a> -### LifecycleStatusValues -Service lifecycle value from ONAP SDC - -*Type* : enum (NOT_CERTIFIED_CHECKOUT, NOT_CERTIFIED_CHECKIN, READY_FOR_CERTIFICATION, CERTIFICATION_IN_PROGRESS, CERTIFIED) - - -<a name="relatedpartyref"></a> -### RelatedPartyRef -Party linked to the service catalog. -in nbi we retrieve information about last updater of the service in SDC - - -|Name|Description|Schema| -|---|---|---| -|**id** <br>*optional*|Unique identifier of the related party. Filled with lastUpdaterUserId|string| -|**name** <br>*optional*|Name of the related party - Filled with lastUpdatedFullName|string| -|**role** <br>*optional*|Role payed by the related party<br>Only role 'lastUpdater' is retrieved in Beijing release|string| - - -<a name="resourcespecificationref"></a> -### ResourceSpecificationRef -A list of resourceSpec identified to deliver the service. -for nbi we retrieve resource information available in service description (through SDC api) bu as well information retrieved in the TOSCA file. - - -|Name|Description|Schema| -|---|---|---| -|**@type** <br>*optional*|This attribute allows to dynamically extends TMF class. Valued with: 'ONAPresource'. We used this features to add following attributes:<br>resourceInstanceName<br>resourceInvariantUUID<br>resourceType<br>modelCustomizationName<br>modelCustomizationId <br>**Default** : `"ONAPresource"`|string| -|**id** <br>*optional*|Unique identifier of the resource specification - filled with resourceUUID|string| -|**modelCustomizationId** <br>*optional*|Additional attribute (not in the TMF API) - extended through @type - Retrieved in the TOSCA file : attribute customizationUUID in topology_template/node_template for the resource|string| -|**modelCustomizationName** <br>*optional*|Additional attribute (not in the TMF API) - extended through @type - Retrieved in the TOSCA file : attribute name in topology_template/node_template for the resource|string| -|**name** <br>*optional*|Name of the resource specification - filled with resourceName|string| -|**resourceInstanceName** <br>*optional*|Additional attribute (not in the TMF API) - extended through @type - resourceInstanceName|string| -|**resourceInvariantUUID** <br>*optional*|Additional attribute (not in the TMF API) - extended through @type - resourceInvariantUUID|string| -|**resourceType** <br>*optional*|Additional attribute (not in the TMF API) - extended through @type - resoucreType|string| -|**version** <br>*optional*|Version for this resource specification - filled with resourceVersion|string| - - -<a name="servicespeccharacteristic"></a> -### ServiceSpecCharacteristic -A characteristic quality or distinctive feature of a ServiceSpecification. -ServiceSpecCharacteristic are retrieved in the serviceTosca file in the topology_template section in the inputs section. - - -|Name|Description|Schema| -|---|---|---| -|**@schemaLocation** <br>*optional*|An url pointing to type description - we do not use it in nbi Beijing release|string| -|**@type** <br>*optional*|This attribute allows to dynamically extends TMF class. Valued with: 'ONAPserviceCharacteristic'. We do not used this features in nbi Beijing release.|string| -|**description** <br>*optional*|A narrative that explains in detail what the characteristic is - Filled with parameter_description|string| -|**name** <br>*optional*|Name of the characteristic - Filled with parameter_name|string| -|**required** <br>*optional*|A parameter to define if the characteristic is mandatory - Filled from parameter_required – if not fielded by default ‘true’ <br>**Default** : `true`|boolean| -|**serviceSpecCharacteristicValue** <br>*optional*||< [ServiceSpecCharacteristicValue](#servicespeccharacteristicvalue) > array| -|**status** <br>*optional*|Status of the characteristic - filled with status_value|string| -|**valueType** <br>*optional*|A kind of value that the characteristic can take on, such as numeric, text and so forth - Filled with parameter_type|string| - - -<a name="servicespeccharacteristicvalue"></a> -### ServiceSpecCharacteristicValue -A number or text that can be assigned to a service specification characteristic. -ServiceSpecCharacteristicValue are retrieved in the service Tosca file - - -|Name|Description|Schema| -|---|---|---| -|**isDefault** <br>*optional*|Information calculated from parameter default in the Tosca file|boolean| -|**value** <br>*optional*|A discrete value that the characteristic can take on|string| -|**valueType** <br>*optional*|A kind of value that the characteristic can take on, such as numeric, text, and so forth<br>Retrieved in the Tosca in the topology_template section in the inputs section - parameter_type. <br>We do not manage parameter_type= list or map for Beijing release|string| - - -<a name="servicespecification"></a> -### ServiceSpecification -ServiceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics. -the service information are retrieved in SDC - - -|Name|Description|Schema| -|---|---|---| -|**@baseType** <br>*optional*|Not used for Beijing release|string| -|**@schemaLocation** <br>*optional*|Not used for Beijing release|string| -|**@type** <br>*optional*|This attribute allows to dynamically extends TMF class. Valued with 'ONAPservice'. We used this features to add following attributes:<br>invariantUUID<br>toscaModelURL<br>toscaResourceName<br>category (1)<br>subcategory (1)<br>distributionStatus <br>**Default** : `"ONAPservice"`|string| -|**attachment** <br>*optional*||< [Attachment](#attachment) > array| -|**category** <br>*optional*|Additional attribute - extended through @type - category<br>Please note that this attribute is managed in TMF - in future release we'll introduce category resource|string| -|**description** <br>*optional*|A narrative that explains in detail what the service specification is - Filled with SDC Service description|string| -|**distributionStatus** <br>*optional*||[DistributionStatus](#distributionstatus)| -|**href** <br>*optional*|Reference of the service specification- not mapped in Beijing|string| -|**id** <br>*optional*|Unique identifier of the service specification. Filled with SDC Service uuid|string| -|**invariantUUID** <br>*required*|Additional attribute (not in the TMF API) - extended through @type - invariantUUID|string| -|**lifecycleStatus** <br>*optional*||[LifecycleStatusValues](#lifecyclestatusvalues)| -|**name** <br>*optional*|Name of the service specification- Filled with SDC Service name|string| -|**relatedParty** <br>*optional*||< [RelatedPartyRef](#relatedpartyref) > array| -|**resourceSpecification** <br>*optional*||< [ResourceSpecificationRef](#resourcespecificationref) > array| -|**serviceSpecCharacteristic** <br>*optional*||< [ServiceSpecCharacteristic](#servicespeccharacteristic) > array| -|**subcategory** <br>*optional*|Additional attribute - extended through @type - category<br>Please note that this attribute is managed in TMF - in future release we'll introduce category resourc|string| -|**targetServiceSchema** <br>*optional*||[TargetServiceSchemaRef](#targetserviceschemaref)| -|**toscaModelURL** <br>*optional*|Additional attribute (not in the TMF API) - extended through @type - toscaModelURL|string| -|**toscaResourceName** <br>*optional*|Additional attribute (not in the TMF API) - extended through @type - toscaResourceName|string| -|**version** <br>*optional*|Service specification version - Filled with SDC Service version|string| - - -<a name="targetserviceschemaref"></a> -### TargetServiceSchemaRef - -|Name|Schema| -|---|---| -|**@schemaLocation** <br>*required*|string| -|**@type** <br>*required*|string| - - -<a name="timeperiod"></a> -### TimePeriod -A time period - - -|Name|Description|Schema| -|---|---|---| -|**endDateTime** <br>*optional*|End date and time of the period|string (date-time)| -|**startDateTime** <br>*optional*|Start date and time of the period|string (date-time)| - |