diff options
Diffstat (limited to 'docs')
40 files changed, 10183 insertions, 226 deletions
diff --git a/docs/architecture/NBI_Developer_Guide.rst b/docs/architecture/NBI_Developer_Guide.rst index 1a421f6..6a38891 100644 --- a/docs/architecture/NBI_Developer_Guide.rst +++ b/docs/architecture/NBI_Developer_Guide.rst @@ -83,7 +83,7 @@ You can view the log output of the application with the following command: **Testing** When the application is running, you can access the API at -:samp:`http://yourhostname:8080/nbi/api/v1` and fill the URL with the name +:samp:`http://yourhostname:8080/nbi/api/v3` and fill the URL with the name of the resources you asking for (/serviceSpecification, /service, /serviceOrder or /status) You can run a test by using `VisualStudio RestClient plugin <https://github.com/Huachao/vscode-restclient>`_ diff --git a/docs/configuration/configuration.rst b/docs/configuration/configuration.rst index 1ec4054..22bd5fd 100644 --- a/docs/configuration/configuration.rst +++ b/docs/configuration/configuration.rst @@ -23,7 +23,7 @@ Default values :: # SERVER - server.contextPath=/nbi/api/v1 + server.contextPath=/nbi/api/v3 server.port = 8080 # LOGGING @@ -35,7 +35,7 @@ Default values onap.cloudOwner=CloudOwner # NBI - nbi.url=http://localhost:8080/nbi/api/v1 + nbi.url=http://localhost:8080/nbi/api/v3 nbi.callForVNF=false # SDC diff --git a/docs/installation/installation.rst b/docs/installation/installation.rst index 5fce7b8..89a55fb 100644 --- a/docs/installation/installation.rst +++ b/docs/installation/installation.rst @@ -79,14 +79,14 @@ Test **Healthcheck** -http://localhost:8080/nbi/api/v1/status +http://localhost:8080/nbi/api/v3/status You should get:: { "name": "nbi", "status": "ok", - "version": "v1" + "version": "v3" } **Play with RESTclient** diff --git a/docs/offeredapis/images/ONAP_External_ID_Beijing.jpg b/docs/offeredapis/images/ONAP_External_ID_Beijing.jpg Binary files differindex 8fbd4ab..8fbd4ab 100755..100644 --- a/docs/offeredapis/images/ONAP_External_ID_Beijing.jpg +++ b/docs/offeredapis/images/ONAP_External_ID_Beijing.jpg diff --git a/docs/offeredapis/images/ONAP_External_ID_Casablanca.jpg b/docs/offeredapis/images/ONAP_External_ID_Casablanca.jpg Binary files differindex a566e42..a566e42 100755..100644 --- a/docs/offeredapis/images/ONAP_External_ID_Casablanca.jpg +++ b/docs/offeredapis/images/ONAP_External_ID_Casablanca.jpg diff --git a/docs/offeredapis/images/html.png b/docs/offeredapis/images/html.png Binary files differindex f1bda88..f1bda88 100755..100644 --- a/docs/offeredapis/images/html.png +++ b/docs/offeredapis/images/html.png diff --git a/docs/offeredapis/images/notification.jpg b/docs/offeredapis/images/notification.jpg Binary files differindex 672a885..672a885 100755..100644 --- a/docs/offeredapis/images/notification.jpg +++ b/docs/offeredapis/images/notification.jpg diff --git a/docs/offeredapis/images/pdf.png b/docs/offeredapis/images/pdf.png Binary files differindex fed52f9..fed52f9 100755..100644 --- a/docs/offeredapis/images/pdf.png +++ b/docs/offeredapis/images/pdf.png diff --git a/docs/offeredapis/images/postman.png b/docs/offeredapis/images/postman.png Binary files differindex cab386c..cab386c 100755..100644 --- a/docs/offeredapis/images/postman.png +++ b/docs/offeredapis/images/postman.png diff --git a/docs/offeredapis/images/swagger.png b/docs/offeredapis/images/swagger.png Binary files differindex f5a9e0c..f5a9e0c 100755..100644 --- a/docs/offeredapis/images/swagger.png +++ b/docs/offeredapis/images/swagger.png diff --git a/docs/offeredapis/images/swaggerUI.png b/docs/offeredapis/images/swaggerUI.png Binary files differindex f5a9e0c..f5a9e0c 100755..100644 --- a/docs/offeredapis/images/swaggerUI.png +++ b/docs/offeredapis/images/swaggerUI.png diff --git a/docs/offeredapis/images/uml.jpg b/docs/offeredapis/images/uml.jpg Binary files differindex d288c6c..d288c6c 100755..100644 --- a/docs/offeredapis/images/uml.jpg +++ b/docs/offeredapis/images/uml.jpg diff --git a/docs/offeredapis/index.rst b/docs/offeredapis/index.rst index 0146813..fbb0948 100755..100644 --- a/docs/offeredapis/index.rst +++ b/docs/offeredapis/index.rst @@ -25,7 +25,7 @@ Following illustration provides a global view about nbi architecture,integration API Version *********** -APIs are described with a state version with “v” following the API Name, e.g.: 'nbi/api/v1/productOrder'. +APIs are described with a state version with “v” following the API Name, e.g.: 'nbi/api/v3/productOrder'. The schema associated with a REST API must have its version number aligned with that of the REST API. The version number has major, minor and revision numbers. E.g. v1.0.0 @@ -72,9 +72,9 @@ API Table :widths: 10,5,5,5,5,5,5 " ", "json file", "html doc", "plantUML doc", "Swagger Editor", "Postman Collection", "pdf doc" - "serviceCatalog", ":download:`link <swaggers/serviceCatalog_1_0_0.json>`", ":download:`link <serviceCatalog/documentation.html>`", ":download:`link <serviceCatalog/apiServiceCatalog.plantuml>`", "coming", "coming", "coming" - "serviceInventory", ":download:`link <swaggers/serviceInventory_1_0_0.json>`", ":download:`link <serviceInventory/documentation.html>`", ":download:`link <serviceInventory/apiServiceInventory.plantuml>`", "coming", "coming", "coming" - "serviceOrder", ":download:`link <swaggers/serviceOrder_1_0_0.json>`", ":download:`link <serviceOrder/documentation.html>`", ":download:`link <serviceOrder/apiServiceOrder.plantuml>`", "coming", ":download:`link <postman/ONAPBeijingServiceOrderDoc.postman_collection.json>`", "coming" + "serviceCatalog", ":download:`link <swaggers/serviceCatalog_3_0_0.json>`", ":download:`link <serviceCatalog/documentation.html>`", ":download:`link <serviceCatalog/apiServiceCatalog.plantuml>`", "coming", "coming", "coming" + "serviceInventory", ":download:`link <swaggers/serviceInventory_3_0_0.json>`", ":download:`link <serviceInventory/documentation.html>`", ":download:`link <serviceInventory/apiServiceInventory.plantuml>`", "coming", "coming", "coming" + "serviceOrder", ":download:`link <swaggers/serviceOrder_3_0_0.json>`", ":download:`link <serviceOrder/documentation.html>`", ":download:`link <serviceOrder/apiServiceOrder.plantuml>`", "coming", ":download:`link <postman/ONAPBeijingServiceOrderDoc.postman_collection.json>`", "coming" *************** @@ -98,7 +98,7 @@ Only ‘basic’ service characteristics will be managed in this release. By ‘ GET serviceSpecification(list) -(example: GET /nbi/api/v1/serviceSpecification/?category=NetworkService&distributionStatus=DISTRIBUTED) +(example: GET /nbi/api/v3/serviceSpecification/?category=NetworkService&distributionStatus=DISTRIBUTED) It is possible to retrieve a list of serviceSpecification (get by list). @@ -108,7 +108,7 @@ if no serviceSpecification matches, an empty list is send back. GET tservice Specification (id) -(example: GET /nbi/api/v1/serviceSpecification/{uuid}) +(example: GET /nbi/api/v3/serviceSpecification/{uuid}) It is use to retrieve one serviceSpecification - all available information are retieved (see swagger for description) @@ -124,7 +124,7 @@ This API retrieves service(s) in the AAI inventory. Only following attributes wi GET Service Inventory (list): -(example: GET /nbi/api/v1/service/?relatedParty.id=Pontus +(example: GET /nbi/api/v3/service/?relatedParty.id=Pontus ) GET (by list) allows to request with following criteria (all optional) : @@ -143,7 +143,7 @@ if no service matches, an empty list is send back. GET Service Inventory (id): -(example: GET /nbi/api/v1/service/{uuid} but customerId & serviceSpecification.id must passed in requested parameters) +(example: GET /nbi/api/v3/service/{uuid} but customerId & serviceSpecification.id must passed in requested parameters) Because of AAI capability, additionally to the service id, customer id and [serviceSpecification.id or serviceSpecification.name] must be supplied. If the customer id is not supplied, External API will use ‘generic’ customer diff --git a/docs/offeredapis/listener/apiListener.plantuml b/docs/offeredapis/listener/apiListener.plantuml new file mode 100644 index 0000000..fe5ebc8 --- /dev/null +++ b/docs/offeredapis/listener/apiListener.plantuml @@ -0,0 +1,26 @@ +@startuml + +enum EventType { + ServiceOrderCreationNotification + ServiceOrderStateChangeNotification + ServiceOrderItemStateChangeNotification +} + +class ErrorRepresentation { + code:int + reason:string + message:string + status:int + referenceError:string + @type:string + @schemaLocation:string +} + +class Listener { + eventId:string + eventDate:dateTime + event:object +} + Listener --> "1-1" EventType : eventType + +@enduml
\ No newline at end of file diff --git a/docs/offeredapis/listener/asciiDoc.adoc b/docs/offeredapis/listener/asciiDoc.adoc new file mode 100644 index 0000000..dcbb054 --- /dev/null +++ b/docs/offeredapis/listener/asciiDoc.adoc @@ -0,0 +1,175 @@ += API Listener + + +[[_overview]] +== Overview + +=== Api URL + +https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/aoG0EJ01Pv/swagger.json[Swagger UI] + + +https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/aoG0EJ01Pv/plantuml&noCache=7322.0[plant UML UI] + +Listener API has to be implemented on the client side in order to receive notification. +Notification are received if HUB has been posted on server side. + + +=== Version information +[%hardbreaks] +__Version__ : 0.1.0_inProgress + + +=== URI scheme +[%hardbreaks] +__Host__ : serverRoot +__BasePath__ : /externalapi/listener/v1 +__Schemes__ : HTTPS + + +=== Tags + +* Listener + + +=== Produces + +* `application/json;charset=utf-8` + + +[[_paths]] +== Resources + +[[_listener_resource]] +=== Listener + +[[_listenercreate]] +==== createEvent +.... +POST /listener +.... + + +===== Description +The create event is used by the seller to trigger (POST) a notification to the buyer. The buyer has previously subscribed to receive notification + +Specific business errors for current operation will be encapsulated in + +HTTP Response 422 Unprocessable entity + + +===== Parameters + +[options="header", cols=".^2,.^3,.^4"] +|=== +|Type|Name|Schema +|**Body**|**event** + +__required__|<<_listener,Listener>> +|=== + + +===== Responses + +[options="header", cols=".^2,.^14,.^4"] +|=== +|HTTP Code|Description|Schema +|**201**|Success|<<_listener,Listener>> +|**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>> +|**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>> +|=== + + +===== Consumes + +* `application/json;charset=utf-8` + + +===== Produces + +* `application/json;charset=utf-8` + + +[[_definitions]] +== Definitions + +[[_errorrepresentation]] +=== ErrorRepresentation + +[options="header", cols=".^3,.^4"] +|=== +|Name|Schema +|**@schemaLocation** + +__optional__|string +|**@type** + +__optional__|string +|**code** + +__required__|integer (int32) +|**message** + +__optional__|string +|**reason** + +__optional__|string +|**referenceError** + +__optional__|string +|**status** + +__optional__|integer (int32) +|=== + + +[[_eventtype]] +=== EventType +__Type__ : enum (ServiceOrderCreationNotification, ServiceOrderStateChangeNotification, ServiceOrderItemStateChangeNotification) + + +[[_listener]] +=== Listener +An event will be triggered for each time a notification is send to a listener. + + +[options="header", cols=".^3,.^11,.^4"] +|=== +|Name|Description|Schema +|**event** + +__required__|An event representation is the payload of information send with the notification; it will feature event attributes + summary view of the resource.|object +|**eventDate** + +__required__||string (date-time) +|**eventId** + +__required__|id of the event|string +|**eventType** + +__required__||<<_eventtype,EventType>> +|=== + diff --git a/docs/offeredapis/listener/documentation.html b/docs/offeredapis/listener/documentation.html new file mode 100644 index 0000000..58cb7e2 --- /dev/null +++ b/docs/offeredapis/listener/documentation.html @@ -0,0 +1,779 @@ +<!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 Listener</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 Listener</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="#_listener_resource">Listener</a></li> +</ul> +</li> +<li><a href="#_definitions">Definitions</a> +<ul class="sectlevel2"> +<li><a href="#_errorrepresentation">ErrorRepresentation</a></li> +<li><a href="#_eventtype">EventType</a></li> +<li><a href="#_listener">Listener</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/aoG0EJ01Pv/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/aoG0EJ01Pv/plantuml&noCache=7322.0">plant UML UI</a></p> +</div> +<div class="paragraph"> +<p>Listener API has to be implemented on the client side in order to receive notification. +Notification are received if HUB has been posted on server side.</p> +</div> +</div> +<div class="sect2"> +<h3 id="_version_information">Version information</h3> +<div class="paragraph"> +<p><em>Version</em> : 0.1.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> : /externalapi/listener/v1<br> +<em>Schemes</em> : HTTPS</p> +</div> +</div> +<div class="sect2"> +<h3 id="_tags">Tags</h3> +<div class="ulist"> +<ul> +<li> +<p>Listener</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="_listener_resource">Listener</h3> +<div class="sect3"> +<h4 id="_listenercreate">createEvent</h4> +<div class="literalblock"> +<div class="content"> +<pre>POST /listener</pre> +</div> +</div> +<div class="sect4"> +<h5 id="_description">Description</h5> +<div class="paragraph"> +<p>The create event is used by the seller to trigger (POST) a notification to the buyer. The buyer has previously subscribed to receive notification</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: 22.2222%;"> +<col style="width: 33.3333%;"> +<col style="width: 44.4445%;"> +</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">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>event</strong><br> +<em>required</em></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_listener">Listener</a></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>201</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="#_listener">Listener</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>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="_consumes">Consumes</h5> +<div class="ulist"> +<ul> +<li> +<p><code>application/json;charset=utf-8</code></p> +</li> +</ul> +</div> +</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> +</div> +</div> +<div class="sect1"> +<h2 id="_definitions">Definitions</h2> +<div class="sectionbody"> +<div class="sect2"> +<h3 id="_errorrepresentation">ErrorRepresentation</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>optional</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>optional</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>code</strong><br> +<em>required</em></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">string</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>reason</strong><br> +<em>optional</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>referenceError</strong><br> +<em>optional</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>status</strong><br> +<em>optional</em></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect2"> +<h3 id="_eventtype">EventType</h3> +<div class="paragraph"> +<p><em>Type</em> : enum (ServiceOrderCreationNotification, ServiceOrderStateChangeNotification, ServiceOrderItemStateChangeNotification)</p> +</div> +</div> +<div class="sect2"> +<h3 id="_listener">Listener</h3> +<div class="paragraph"> +<p>An event will be triggered for each time a notification is send to a listener.</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>event</strong><br> +<em>required</em></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">An event representation is the payload of information send with the notification; it will feature event attributes + summary view of the resource.</p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">object</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>eventDate</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 (date-time)</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>eventId</strong><br> +<em>required</em></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">id of the event</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>eventType</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"><a href="#_eventtype">EventType</a></p></td> +</tr> +</tbody> +</table> +</div> +</div> +</div> +</div> +<div id="footer"> +<div id="footer-text"> +Last updated 2018-09-12 13:46:31 +00:00 +</div> +</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/offeredapis/listener/markDown.md b/docs/offeredapis/listener/markDown.md new file mode 100644 index 0000000..332c6cf --- /dev/null +++ b/docs/offeredapis/listener/markDown.md @@ -0,0 +1,122 @@ +# API Listener + + +<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/aoG0EJ01Pv/swagger.json) + + +[plant UML UI](https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/aoG0EJ01Pv/plantuml&noCache=7322.0) + +Listener API has to be implemented on the client side in order to receive notification. +Notification are received if HUB has been posted on server side. + + +### Version information +*Version* : 0.1.0_inProgress + + +### URI scheme +*Host* : serverRoot +*BasePath* : /externalapi/listener/v1 +*Schemes* : HTTPS + + +### Tags + +* Listener + + +### Produces + +* `application/json;charset=utf-8` + + +<a name="paths"></a> +## Resources + +<a name="listener_resource"></a> +### Listener + +<a name="listenercreate"></a> +#### createEvent +``` +POST /listener +``` + + +##### Description +The create event is used by the seller to trigger (POST) a notification to the buyer. The buyer has previously subscribed to receive notification + +Specific business errors for current operation will be encapsulated in + +HTTP Response 422 Unprocessable entity + + +##### Parameters + +|Type|Name|Schema| +|---|---|---| +|**Body**|**event** <br>*required*|[Listener](#listener)| + + +##### Responses + +|HTTP Code|Description|Schema| +|---|---|---| +|**201**|Success|[Listener](#listener)| +|**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)| +|**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)| + + +##### Consumes + +* `application/json;charset=utf-8` + + +##### Produces + +* `application/json;charset=utf-8` + + +<a name="definitions"></a> +## Definitions + +<a name="errorrepresentation"></a> +### ErrorRepresentation + +|Name|Schema| +|---|---| +|**@schemaLocation** <br>*optional*|string| +|**@type** <br>*optional*|string| +|**code** <br>*required*|integer (int32)| +|**message** <br>*optional*|string| +|**reason** <br>*optional*|string| +|**referenceError** <br>*optional*|string| +|**status** <br>*optional*|integer (int32)| + + +<a name="eventtype"></a> +### EventType +*Type* : enum (ServiceOrderCreationNotification, ServiceOrderStateChangeNotification, ServiceOrderItemStateChangeNotification) + + +<a name="listener"></a> +### Listener +An event will be triggered for each time a notification is send to a listener. + + +|Name|Description|Schema| +|---|---|---| +|**event** <br>*required*|An event representation is the payload of information send with the notification; it will feature event attributes + summary view of the resource.|object| +|**eventDate** <br>*required*||string (date-time)| +|**eventId** <br>*required*|id of the event|string| +|**eventType** <br>*required*||[EventType](#eventtype)| + diff --git a/docs/offeredapis/offeredapis.rst b/docs/offeredapis/offeredapis.rst index c2d1cdd..4ecfdd9 100755..100644 --- a/docs/offeredapis/offeredapis.rst +++ b/docs/offeredapis/offeredapis.rst @@ -25,7 +25,7 @@ Following illustration provides a global view about nbi architecture,integration API Version *********** -APIs are described with a state version with “v” following the API Name, e.g.: 'nbi/api/v1/productOrder'. +APIs are described with a state version with “v” following the API Name, e.g.: 'nbi/api/v3/productOrder'. The schema associated with a REST API must have its version number aligned with that of the REST API. The version number has major, minor and revision numbers. E.g. v1.0.0 @@ -74,11 +74,12 @@ API Table :widths: 10,5,5,5,5,5,5 " ", "json file", "html doc", "plantUML doc", "Swagger Editor", "Postman Collection", "pdf doc" - "serviceCatalog", ":download:`link <swaggers/serviceCatalog_1_0_0.json>`", ":download:`link <serviceCatalog/documentation.html>`", ":download:`link <serviceCatalog/apiServiceCatalog.plantuml>`", "coming", "coming", "coming" - "serviceInventory", ":download:`link <swaggers/serviceInventory_1_0_0.json>`", ":download:`link <serviceInventory/documentation.html>`", ":download:`link <serviceInventory/apiServiceInventory.plantuml>`", "coming", "coming", "coming" - "serviceOrder", ":download:`link <swaggers/serviceOrder_1_0_0.json>`", ":download:`link <serviceOrder/documentation.html>`", ":download:`link <serviceOrder/apiServiceOrder.plantuml>`", "coming", ":download:`link <postman/ONAPBeijingServiceOrderDoc.postman_collection.json>`", "coming" - + "serviceCatalog", ":download:`link <swaggers/serviceCatalog_3_0_0.json>`", ":download:`link <serviceCatalog/documentation.html>`", ":download:`link <serviceCatalog/apiServiceCatalog.plantuml>`", "coming", "coming", "coming" + "serviceInventory", ":download:`link <swaggers/serviceInventory_3_0_0.json>`", ":download:`link <serviceInventory/documentation.html>`", ":download:`link <serviceInventory/apiServiceInventory.plantuml>`", "coming", "coming", "coming" + "serviceOrder", ":download:`link <swaggers/serviceOrder_3_0_0.json>`", ":download:`link <serviceOrder/documentation.html>`", ":download:`link <serviceOrder/apiServiceOrder.plantuml>`", "coming", ":download:`link <postman/ONAPBeijingServiceOrderDoc.postman_collection.json>`", "coming" + "listener", ":download:`link <swaggers/listener_1_0_0.json>`", ":download:`link <listener/documentation.html>`", ":download:`link <listener/apiListener.plantuml>`", "coming", "coming", "coming" + *************** API Description *************** @@ -100,7 +101,7 @@ Only ‘basic’ service characteristics will be managed in this release. By ‘ GET serviceSpecification(list) -(example: GET /nbi/api/v1/serviceSpecification/?category=NetworkService&distributionStatus=DISTRIBUTED) +(example: GET /nbi/api/v3/serviceSpecification/?category=NetworkService&distributionStatus=DISTRIBUTED) It is possible to retrieve a list of serviceSpecification (get by list). @@ -110,7 +111,7 @@ if no serviceSpecification matches, an empty list is send back. GET tservice Specification (id) -(example: GET /nbi/api/v1/serviceSpecification/{uuid}) +(example: GET /nbi/api/v3/serviceSpecification/{uuid}) It is use to retrieve one serviceSpecification - all available information are retieved (see swagger for description) @@ -126,7 +127,7 @@ This API retrieves service(s) in the AAI inventory. Only following attributes wi GET Service Inventory (list): -(example: GET /nbi/api/v1/service/?relatedParty.id=Pontus +(example: GET /nbi/api/v3/service/?relatedParty.id=Pontus ) GET (by list) allows to request with following criteria (all optional) : @@ -145,7 +146,7 @@ if no service matches, an empty list is send back. GET Service Inventory (id): -(example: GET /nbi/api/v1/service/{uuid} but customerId & serviceSpecification.id must passed in requested parameters) +(example: GET /nbi/api/v3/service/{uuid} but customerId & serviceSpecification.id must passed in requested parameters) Because of AAI capability, additionally to the service id, customer id and [serviceSpecification.id or serviceSpecification.name] must be supplied. If the customer id is not supplied, External API will use ‘generic’ customer diff --git a/docs/offeredapis/pdf/nbicallflow.pdf b/docs/offeredapis/pdf/nbicallflow.pdf Binary files differindex c84f0dc..c84f0dc 100755..100644 --- a/docs/offeredapis/pdf/nbicallflow.pdf +++ b/docs/offeredapis/pdf/nbicallflow.pdf diff --git a/docs/offeredapis/serviceCatalog/apiServiceCatalog.plantuml b/docs/offeredapis/serviceCatalog/apiServiceCatalog.plantuml index 96e8164..8483238 100644 --- a/docs/offeredapis/serviceCatalog/apiServiceCatalog.plantuml +++ b/docs/offeredapis/serviceCatalog/apiServiceCatalog.plantuml @@ -1,7 +1,3 @@ -/' This work is licensed under a Creative Commons Attribution 4.0 International License. - http://creativecommons.org/licenses/by/4.0 - Copyright 2018 Orange'/ - @startuml enum LifecycleStatusValues { diff --git a/docs/offeredapis/serviceCatalog/asciiDoc.adoc b/docs/offeredapis/serviceCatalog/asciiDoc.adoc index c5185bd..9ce1396 100644 --- a/docs/offeredapis/serviceCatalog/asciiDoc.adoc +++ b/docs/offeredapis/serviceCatalog/asciiDoc.adoc @@ -1,9 +1,3 @@ -//// -This work is licensed under a Creative Commons Attribution 4.0 International License. -http://creativecommons.org/licenses/by/4.0 -Copyright 2018 Orange -//// - = API ServiceCatalog @@ -12,10 +6,10 @@ Copyright 2018 Orange === Api URL -https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/N3ma89X1x0/swagger.json[Swagger UI] +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/N3ma89X1x0/plantuml&noCache=797767.0[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[plant UML UI] serviceCatalog API designed for ONAP Beijing Release. This API is build from TMF open API17.5. @@ -24,13 +18,13 @@ Only operation GET (by id & byList) for resource serviceSpecification is ava === Version information [%hardbreaks] -__Version__ : 1.0.0_inProgress +__Version__ : 3.0.0_inProgress === URI scheme [%hardbreaks] __Host__ : serverRoot -__BasePath__ : /nbi/api/v1 +__BasePath__ : /nbi/api/v3 __Schemes__ : HTTPS @@ -39,11 +33,6 @@ __Schemes__ : HTTPS * ServiceSpecification -=== Consumes - -* `application/json;charset=utf-8` - - === Produces * `application/json;charset=utf-8` @@ -136,6 +125,11 @@ List of supported error codes: |=== +===== Produces + +* `application/json;charset=utf-8` + + [[_servicespecificationget]] ==== Retrieve a service specification .... @@ -213,6 +207,11 @@ List of supported error codes: |=== +===== Produces + +* `application/json;charset=utf-8` + + [[_definitions]] == Definitions diff --git a/docs/offeredapis/serviceCatalog/documentation.html b/docs/offeredapis/serviceCatalog/documentation.html index c81c1d8..94b011f 100644 --- a/docs/offeredapis/serviceCatalog/documentation.html +++ b/docs/offeredapis/serviceCatalog/documentation.html @@ -1,8 +1,3 @@ -<!-- -This work is licensed under a Creative Commons Attribution 4.0 International License. -http://creativecommons.org/licenses/by/4.0 -Copyright 2018 Orange ---> <!DOCTYPE html> <html lang="en"> <head> @@ -442,7 +437,6 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b <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="#_consumes">Consumes</a></li> <li><a href="#_produces">Produces</a></li> </ul> </li> @@ -474,6 +468,13 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b <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. @@ -483,14 +484,14 @@ Only operation GET (by id & byList) for resource serviceSpecification is ava <div class="sect2"> <h3 id="_version_information">Version information</h3> <div class="paragraph"> -<p><em>Version</em> : 1.0.0_inProgress</p> +<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/v1<br> +<em>BasePath</em> : /nbi/api/v3<br> <em>Schemes</em> : HTTPS</p> </div> </div> @@ -505,16 +506,6 @@ Only operation GET (by id & byList) for resource serviceSpecification is ava </div> </div> <div class="sect2"> -<h3 id="_consumes">Consumes</h3> -<div class="ulist"> -<ul> -<li> -<p><code>application/json;charset=utf-8</code></p> -</li> -</ul> -</div> -</div> -<div class="sect2"> <h3 id="_produces">Produces</h3> <div class="ulist"> <ul> @@ -680,6 +671,16 @@ Fields attribute could be used to filter attributes retrieved</p> </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> @@ -821,6 +822,16 @@ Fields attribute could be used to filter attributes retrieved</p> </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> @@ -1471,7 +1482,7 @@ Please note that this attribute is managed in TMF - in future release we’l </div> <div id="footer"> <div id="footer-text"> -Last updated 2018-03-21 17:15:23 UTC +Last updated 2018-09-12 13:43:40 +00:00 </div> </div> </body> diff --git a/docs/offeredapis/serviceCatalog/markDown.md b/docs/offeredapis/serviceCatalog/markDown.md index 22d062e..7f1a02d 100644 --- a/docs/offeredapis/serviceCatalog/markDown.md +++ b/docs/offeredapis/serviceCatalog/markDown.md @@ -1,7 +1,3 @@ -# This work is licensed under a Creative Commons Attribution 4.0 International License. -# http://creativecommons.org/licenses/by/4.0 -# Copyright 2018 Orange - # API ServiceCatalog @@ -10,10 +6,10 @@ ### Api URL -[Swagger UI](https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/N3ma89X1x0/swagger.json) +[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/N3ma89X1x0/plantuml&noCache=797767.0) +[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. @@ -21,12 +17,12 @@ Only operation GET (by id & byList) for resource serviceSpecification is availab ### Version information -*Version* : 1.0.0_inProgress +*Version* : 3.0.0_inProgress ### URI scheme *Host* : serverRoot -*BasePath* : /nbi/api/v1 +*BasePath* : /nbi/api/v3 *Schemes* : HTTPS @@ -35,11 +31,6 @@ Only operation GET (by id & byList) for resource serviceSpecification is availab * ServiceSpecification -### Consumes - -* `application/json;charset=utf-8` - - ### Produces * `application/json;charset=utf-8` @@ -91,6 +82,11 @@ HTTP Response 422 Unprocessable entity |**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 ``` @@ -128,6 +124,11 @@ HTTP Response 422 Unprocessable entity |**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 diff --git a/docs/offeredapis/serviceInventory/apiServiceInventory.plantuml b/docs/offeredapis/serviceInventory/apiServiceInventory.plantuml index a7ecc66..2c08be7 100644 --- a/docs/offeredapis/serviceInventory/apiServiceInventory.plantuml +++ b/docs/offeredapis/serviceInventory/apiServiceInventory.plantuml @@ -1,17 +1,5 @@ -/' This work is licensed under a Creative Commons Attribution 4.0 International License. - http://creativecommons.org/licenses/by/4.0 - Copyright 2018 Orange'/ - @startuml -enum stateValues { - feasibilityChecked - designed - reserved - inactive - active - terminated -} class ErrorRepresentation { code:int @@ -28,12 +16,12 @@ class Service { href:string name:string type:string + state:string hasStarted:boolean @type:string @baseType:string @schemaLocation:string } - Service --> "0-1" stateValues : state Service --> "0-1" ServiceSpecificationRef : serviceSpecification Service --> "0-*" ServiceCharacteristic : characteristic Service --> "0-*" SupportingResource : supportingResource diff --git a/docs/offeredapis/serviceInventory/asciiDoc.adoc b/docs/offeredapis/serviceInventory/asciiDoc.adoc index 548a6a9..e34ec44 100644 --- a/docs/offeredapis/serviceInventory/asciiDoc.adoc +++ b/docs/offeredapis/serviceInventory/asciiDoc.adoc @@ -1,9 +1,3 @@ -//// -This work is licensed under a Creative Commons Attribution 4.0 International License. -http://creativecommons.org/licenses/by/4.0 -Copyright 2018 Orange -//// - = API ServiceInventory @@ -12,10 +6,10 @@ Copyright 2018 Orange === Api URL -https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/5an735gnX0/swagger.json[Swagger UI] +https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/5ymwb6l1dR/swagger.json[Swagger UI] -https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/5an735gnX0/plantuml&noCache=304710.0[plant UML UI] +https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/5ymwb6l1dR/plantuml&noCache=137264.0[plant UML UI] serviceInventory API designed for ONAP Beijing Release. This API is build from TMF open API18.0 (applying TMF Guideline 3.0) @@ -24,13 +18,13 @@ only operation GET (by id & byList) for resource serviceSpecification is ava === Version information [%hardbreaks] -__Version__ : 1.0.0_inProgress +__Version__ : 3.0.0_inProgress === URI scheme [%hardbreaks] __Host__ : serverRoot -__BasePath__ : /nbi/api/v1 +__BasePath__ : /nbi/api/v3 __Schemes__ : HTTPS @@ -39,11 +33,6 @@ __Schemes__ : HTTPS * Service -=== Consumes - -* `application/json;charset=utf-8` - - === Produces * `application/json;charset=utf-8` @@ -140,6 +129,11 @@ List of supported error codes: |=== +===== Produces + +* `application/json;charset=utf-8` + + [[_serviceget]] ==== Retrieve a service .... @@ -222,6 +216,11 @@ List of supported error codes: |=== +===== Produces + +* `application/json;charset=utf-8` + + [[_definitions]] == Definitions @@ -353,7 +352,7 @@ __optional__||< <<_relatedpartyref,RelatedPartyRef>> > array |**serviceSpecification** + __optional__||<<_servicespecificationref,ServiceSpecificationRef>> |**state** + -__optional__||<<_statevalues,stateValues>> +__optional__|State of the service. Not managed in Beijing release|string |**supportingResource** + __optional__||< <<_supportingresource,SupportingResource>> > array |**type** + @@ -460,8 +459,3 @@ __optional__|Not managed in Beijing release.|string __optional__|Not managed in Beijing release.|string |=== - -[[_statevalues]] -=== stateValues -__Type__ : enum (feasibilityChecked, designed, reserved, inactive, active, terminated) - diff --git a/docs/offeredapis/serviceInventory/documentation.html b/docs/offeredapis/serviceInventory/documentation.html index a55605a..f7fb115 100644 --- a/docs/offeredapis/serviceInventory/documentation.html +++ b/docs/offeredapis/serviceInventory/documentation.html @@ -1,8 +1,3 @@ -<!-- -This work is licensed under a Creative Commons Attribution 4.0 International License. -http://creativecommons.org/licenses/by/4.0 -Copyright 2018 Orange ---> <!DOCTYPE html> <html lang="en"> <head> @@ -442,7 +437,6 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b <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="#_consumes">Consumes</a></li> <li><a href="#_produces">Produces</a></li> </ul> </li> @@ -463,7 +457,6 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b <li><a href="#_servicespecificationref">ServiceSpecificationRef</a></li> <li><a href="#_supportingresource">SupportingResource</a></li> <li><a href="#_value">Value</a></li> -<li><a href="#_statevalues">stateValues</a></li> </ul> </li> </ul> @@ -474,6 +467,13 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b <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/5ymwb6l1dR/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/5ymwb6l1dR/plantuml&noCache=137264.0">plant UML UI</a></p> +</div> <div class="paragraph"> <p>serviceInventory API designed for ONAP Beijing Release. This API is build from TMF open API18.0 (applying TMF Guideline 3.0) @@ -483,14 +483,14 @@ only operation GET (by id & byList) for resource serviceSpecification is ava <div class="sect2"> <h3 id="_version_information">Version information</h3> <div class="paragraph"> -<p><em>Version</em> : 1.0.0_inProgress</p> +<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/v1<br> +<em>BasePath</em> : /nbi/api/v3<br> <em>Schemes</em> : HTTPS</p> </div> </div> @@ -505,16 +505,6 @@ only operation GET (by id & byList) for resource serviceSpecification is ava </div> </div> <div class="sect2"> -<h3 id="_consumes">Consumes</h3> -<div class="ulist"> -<ul> -<li> -<p><code>application/json;charset=utf-8</code></p> -</li> -</ul> -</div> -</div> -<div class="sect2"> <h3 id="_produces">Produces</h3> <div class="ulist"> <ul> @@ -687,6 +677,16 @@ fields attribute may be used to filter retrieved attribute(s) for each service</ </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="_serviceget">Retrieve a service</h4> @@ -837,6 +837,16 @@ Attribute selection is enabled for all first level attributes.</p> </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> @@ -1156,8 +1166,8 @@ Not managed in Beijing release</p></td> <tr> <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>state</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="#_statevalues">stateValues</a></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">State of the service. Not managed in 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>supportingResource</strong><br> @@ -1410,18 +1420,12 @@ Not managed in Beijing release.</p> </tbody> </table> </div> -<div class="sect2"> -<h3 id="_statevalues">stateValues</h3> -<div class="paragraph"> -<p><em>Type</em> : enum (feasibilityChecked, designed, reserved, inactive, active, terminated)</p> -</div> -</div> </div> </div> </div> <div id="footer"> <div id="footer-text"> -Last updated 2018-03-22 09:31:41 UTC +Last updated 2018-09-12 13:43:17 +00:00 </div> </div> </body> diff --git a/docs/offeredapis/serviceInventory/markDown.md b/docs/offeredapis/serviceInventory/markDown.md index 223c13b..c65263b 100644 --- a/docs/offeredapis/serviceInventory/markDown.md +++ b/docs/offeredapis/serviceInventory/markDown.md @@ -1,7 +1,3 @@ -# This work is licensed under a Creative Commons Attribution 4.0 International License. -# http://creativecommons.org/licenses/by/4.0 -# Copyright 2018 Orange - # API ServiceInventory @@ -10,10 +6,10 @@ ### Api URL -[Swagger UI](https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/5an735gnX0/swagger.json) +[Swagger UI](https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/5ymwb6l1dR/swagger.json) -[plant UML UI](https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/5an735gnX0/plantuml&noCache=304710.0) +[plant UML UI](https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/5ymwb6l1dR/plantuml&noCache=137264.0) serviceInventory API designed for ONAP Beijing Release. This API is build from TMF open API18.0 (applying TMF Guideline 3.0) @@ -21,12 +17,12 @@ only operation GET (by id & byList) for resource serviceSpecification is availab ### Version information -*Version* : 1.0.0_inProgress +*Version* : 3.0.0_inProgress ### URI scheme *Host* : serverRoot -*BasePath* : /nbi/api/v1 +*BasePath* : /nbi/api/v3 *Schemes* : HTTPS @@ -35,11 +31,6 @@ only operation GET (by id & byList) for resource serviceSpecification is availab * Service -### Consumes - -* `application/json;charset=utf-8` - - ### Produces * `application/json;charset=utf-8` @@ -93,6 +84,11 @@ HTTP Response 422 Unprocessable entity |**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="serviceget"></a> #### Retrieve a service ``` @@ -133,6 +129,11 @@ HTTP Response 422 Unprocessable entity |**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 @@ -219,7 +220,7 @@ Instantiated service (service_instance) in AAI |**name** <br>*optional*|Name of the service - Valued with service-instance-name|string| |**relatedParty** <br>*optional*||< [RelatedPartyRef](#relatedpartyref) > array| |**serviceSpecification** <br>*optional*||[ServiceSpecificationRef](#servicespecificationref)| -|**state** <br>*optional*||[stateValues](#statevalues)| +|**state** <br>*optional*|State of the service. Not managed in Beijing release|string| |**supportingResource** <br>*optional*||< [SupportingResource](#supportingresource) > array| |**type** <br>*optional*|Service type - valued with 'service-instance'|string| @@ -284,8 +285,3 @@ Not managed in Beijing release. |**@type** <br>*optional*|Not managed in Beijing release.|string| |**serviceCharacteristicValue** <br>*optional*|Not managed in Beijing release.|string| - -<a name="statevalues"></a> -### stateValues -*Type* : enum (feasibilityChecked, designed, reserved, inactive, active, terminated) - diff --git a/docs/offeredapis/serviceOrder/apiServiceOrder.plantuml b/docs/offeredapis/serviceOrder/apiServiceOrder.plantuml index eb78af2..775fdeb 100644 --- a/docs/offeredapis/serviceOrder/apiServiceOrder.plantuml +++ b/docs/offeredapis/serviceOrder/apiServiceOrder.plantuml @@ -1,7 +1,3 @@ -/' This work is licensed under a Creative Commons Attribution 4.0 International License. - http://creativecommons.org/licenses/by/4.0 - Copyright 2018 Orange'/ - @startuml enum ActionType { @@ -24,6 +20,15 @@ enum StateType { enum RelationshipType { reliesOn } +enum EventType { + ServiceOrderCreationNotification + ServiceOrderStateChangeNotification + ServiceOrderItemStateChangeNotification +} +enum SeverityMessage { + information + error +} class ErrorRepresentation { code:int @@ -89,6 +94,7 @@ class OrderItemRelationship { class ServiceOrderItem { id:string + percentProgress:string @type:string @schemaLocation:string @baseType:string @@ -97,6 +103,7 @@ class ServiceOrderItem { ServiceOrderItem --> "0-1" StateType : state ServiceOrderItem --> "0-*" OrderItemRelationship : orderItemRelationship ServiceOrderItem --> "1-1" Service : service + ServiceOrderItem --> "0-*" OrderMessage : orderItemMessage class ServiceOrder { id:string @@ -119,6 +126,7 @@ class ServiceOrder { ServiceOrder --> "0-*" RelatedParty : relatedParty ServiceOrder --> "0-*" OrderRelationship : orderRelationship ServiceOrder --> "0-*" ServiceOrderItem : orderItem + ServiceOrder --> "0-*" OrderMessage : orderMessage class OrderRelationship { type:string @@ -169,4 +177,66 @@ class Hub { callback:string } +class CreateHub { + query:string + callback:string +} + +class ServiceOrderSummary { + id:string + href:string + externalId:string + orderDate:dateTime + completionDateTime:dateTime +} + ServiceOrderSummary --> "0-1" StateType : state + +class ServiceOrderCreationNotification { + eventId:string + eventDate:dateTime + eventType:string +} + ServiceOrderCreationNotification --> "1-1" ServiceOrderSummary : event + +class Notification + +class ServiceOrderStateChangeNotification { + eventId:string + eventDate:dateTime + eventType:string +} + ServiceOrderStateChangeNotification --> "1-1" ServiceOrderSummary : event + +class ServiceOrderItemSummary { + id:string +} + ServiceOrderItemSummary --> "0-1" ActionType : action + ServiceOrderItemSummary --> "0-1" StateType : state + ServiceOrderItemSummary --> "1-1" Service : service + +class ServiceOrderSummaryWithItem { + id:string + href:string + externalId:string + orderDate:dateTime + completionDateTime:dateTime +} + ServiceOrderSummaryWithItem --> "0-1" StateType : state + ServiceOrderSummaryWithItem --> "0-*" ServiceOrderItemSummary : orderItem + +class ServiceOrderItemStateChangeNotification { + eventId:string + eventDate:dateTime + eventType:string +} + ServiceOrderItemStateChangeNotification --> "1-1" ServiceOrderSummaryWithItem : event + +class OrderMessage { + code:string + field:string + messageInformation:string + correctionRequired:boolean +} + OrderMessage --> "1-1" SeverityMessage : severity + @enduml
\ No newline at end of file diff --git a/docs/offeredapis/serviceOrder/asciiDoc.adoc b/docs/offeredapis/serviceOrder/asciiDoc.adoc index 29da92f..72ba736 100644 --- a/docs/offeredapis/serviceOrder/asciiDoc.adoc +++ b/docs/offeredapis/serviceOrder/asciiDoc.adoc @@ -1,9 +1,3 @@ -//// -This work is licensed under a Creative Commons Attribution 4.0 International License. -http://creativecommons.org/licenses/by/4.0 -Copyright 2018 Orange -//// - = API ServiceOrder @@ -12,45 +6,597 @@ Copyright 2018 Orange === Api URL -https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/kl1kgvz1zR/swagger.json[Swagger UI] +https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/Ve1zj3V1gj/swagger.json[Swagger UI] -https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/kl1kgvz1zR/plantuml&noCache=934804.0[plant UML UI] +https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/Ve1zj3V1gj/plantuml&noCache=366455.0[plant UML UI] -serviceOrder API designed for ONAP Beijing Release. +serviceOrder API designed for ONAP. This API is build from TMF open API18.0 (applying TMF Guideline 3.0); Only operations GET (by id and list) and POST are available. === Version information [%hardbreaks] -__Version__ : 1.0.0_inProgress +__Version__ : 3.0.0_inProgress === URI scheme [%hardbreaks] __Host__ : serverRoot -__BasePath__ : /nbi/api/v1 +__BasePath__ : /nbi/api/v3 __Schemes__ : HTTPS === Tags +* Hub +* Notification * ServiceOrder : A Service Order is a type of order which can be used to describe a group of operations on service – one service order item per service. An action at the level of the service order item describe the operation to be done on a service (add, terminate for example). The service order is triggered from the BSS system in charge of the product order management to ONAP that will manage the service fulfillment. -=== Consumes +=== Produces * `application/json;charset=utf-8` -=== Produces +[[_paths]] +== Resources + +[[_hub_resource]] +=== Hub + +[[_hubcreate]] +==== Create Hub +.... +POST /hub +.... + + +===== Description +Specific business errors for current operation will be encapsulated in + +HTTP Response 422 Unprocessable entity + + +===== Parameters + +[options="header", cols=".^2,.^3,.^4"] +|=== +|Type|Name|Schema +|**Body**|**Hub** + +__required__|<<_createhub,CreateHub>> +|=== + + +===== Responses + +[options="header", cols=".^2,.^14,.^4"] +|=== +|HTTP Code|Description|Schema +|**201**|Success + +**Headers** : + +`location` (string)|file +|**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>> +|=== + + +===== Consumes * `application/json;charset=utf-8` -[[_paths]] -== Resources +[[_hubfind]] +==== Retrieve a lits of hub +.... +GET /hub +.... + + +===== Description +Specific business errors for current operation will be encapsulated in + +HTTP Response 422 Unprocessable entity + + +===== Parameters + +[options="header", cols=".^2,.^3,.^4"] +|=== +|Type|Name|Schema +|**Query**|**eventType** + +__optional__|enum (ServiceOrderCreationNotification, ServiceOrderStateChangeNotification, ServiceOrderItemStateChangeNotification) +|**Query**|**id** + +__optional__|string +|=== + + +===== Responses + +[options="header", cols=".^2,.^14,.^4"] +|=== +|HTTP Code|Description|Schema +|**200**|Success|< <<_hub,Hub>> > 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` + + +[[_hubget]] +==== Retrieve an HUB by id +.... +GET /hub/{hubId} +.... + + +===== Description +Retrieve an HUB by id + +Specific business errors for current operation will be encapsulated in + +HTTP Response 422 Unprocessable entity + + +===== Parameters + +[options="header", cols=".^2,.^3,.^4"] +|=== +|Type|Name|Schema +|**Path**|**hubId** + +__required__|string +|=== + + +===== Responses + +[options="header", cols=".^2,.^14,.^4"] +|=== +|HTTP Code|Description|Schema +|**200**|Success|<<_hub,Hub>> +|**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` + + +[[_hubdelete]] +==== delete hub +.... +DELETE /hub/{hubId} +.... + + +===== Description +Specific business errors for current operation will be encapsulated in + +HTTP Response 422 Unprocessable entity + + +===== Parameters + +[options="header", cols=".^2,.^3,.^4"] +|=== +|Type|Name|Schema +|**Path**|**hubId** + +__required__|string +|=== + + +===== Responses + +[options="header", cols=".^2,.^14,.^4"] +|=== +|HTTP Code|Description|Schema +|**204**|Success|No Content +|**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>> +|=== + + +[[_notification_resource]] +=== Notification + +[[_notificationserviceordercreationnotification]] +==== Service order creation notification +.... +POST /notification/serviceOrderCreationNotification +.... + + +===== Description +Service order creation notification + +Specific business errors for current operation will be encapsulated in + +HTTP Response 422 Unprocessable entity + + +===== Parameters + +[options="header", cols=".^2,.^3,.^4"] +|=== +|Type|Name|Schema +|**Body**|**serviceOrderCreationNotification** + +__required__|<<_serviceordercreationnotification,ServiceOrderCreationNotification>> +|=== + + +===== Responses + +[options="header", cols=".^2,.^14,.^4"] +|=== +|HTTP Code|Description|Schema +|**204**|Success|No Content +|**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>> +|=== + + +===== Consumes + +* `application/json;charset=utf-8` + + +[[_notificationserviceorderitemstatechangenotification]] +==== ServiceOrder Item State Change Notification description +.... +POST /notification/serviceOrderItemStateChangeNotification +.... + + +===== Description +Specific business errors for current operation will be encapsulated in + +HTTP Response 422 Unprocessable entity + + +===== Parameters + +[options="header", cols=".^2,.^3,.^4"] +|=== +|Type|Name|Schema +|**Body**|**serviceOrderItemStateChangeNotification** + +__required__|<<_serviceorderitemstatechangenotification,ServiceOrderItemStateChangeNotification>> +|=== + + +===== Responses + +[options="header", cols=".^2,.^14,.^4"] +|=== +|HTTP Code|Description|Schema +|**204**|Success|No Content +|**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>> +|=== + + +===== Consumes + +* `application/json;charset=utf-8` + + +[[_notificationserviceorderstatechangenotification]] +==== Service order state change notification description +.... +POST /notification/serviceOrderStateChangeNotification +.... + + +===== Description +Specific business errors for current operation will be encapsulated in + +HTTP Response 422 Unprocessable entity + + +===== Parameters + +[options="header", cols=".^2,.^3,.^4"] +|=== +|Type|Name|Schema +|**Body**|**serviceOrderstateChangeNotification** + +__required__|<<_serviceorderstatechangenotification,ServiceOrderStateChangeNotification>> +|=== + + +===== Responses + +[options="header", cols=".^2,.^14,.^4"] +|=== +|HTTP Code|Description|Schema +|**204**|Success|No Content +|**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>> +|=== + + +===== Consumes + +* `application/json;charset=utf-8` + [[_serviceorder_resource]] === ServiceOrder @@ -69,6 +615,11 @@ This operation creates a service order entity. The TMF Open API specification document provides the list of mandatory and non mandatory attributes when creating a ServiceOrder, including any possible rule conditions and applicable default values. POST should be used without specifying the id and the href, the Service Order Management system is in charge of generating the id + href for the ServiceOrder. +In Beijing Release, NBI will use only POST {{url}}/ecomp/mso/infra/serviceInstances/v4 SO API. This mean that only the 'service-instance' level will be created in AAI. Additional resource like VNF and/OR VF are not created. + +In Casablanca release, NBI has been improved to also be able to use POST {{url}}/e2eServiceInstances/v3 SO API. This API is able to instantiate in ONAP E2E service; This is useful for CCVPN and VoLTE UC. +Depending on the service category defined in SDC, NBI will use one or the other SO API. If category starts with e2e, NBI will use {url}}/e2eServiceInstances/v3 SO API - else it will use {{url}}/ecomp/mso/infra/serviceInstances/v4 SO API. + Specific business errors for current operation will be encapsulated in HTTP Response 422 Unprocessable entity @@ -103,7 +654,7 @@ __required__|<<_createserviceorder,CreateServiceOrder>> [options="header", cols=".^2,.^14,.^4"] |=== |HTTP Code|Description|Schema -|**201**|Success|<<_createserviceorder,CreateServiceOrder>> +|**201**|Success|<<_serviceorder,ServiceOrder>> |**400**|Bad Request List of supported error codes: @@ -164,6 +715,16 @@ List of supported error codes: |=== +===== Consumes + +* `application/json;charset=utf-8` + + +===== Produces + +* `application/json;charset=utf-8` + + [[_serviceorderfind]] ==== List service orders .... @@ -258,6 +819,11 @@ List of supported error codes: |=== +===== Produces + +* `application/json;charset=utf-8` + + [[_serviceorderget]] ==== Retrieve a service order .... @@ -336,6 +902,11 @@ List of supported error codes: |=== +===== Produces + +* `application/json;charset=utf-8` + + [[_definitions]] == Definitions @@ -347,6 +918,23 @@ modify is not managed in Beijing release __Type__ : enum (add, modify, delete, noChange) +[[_createhub]] +=== CreateHub +This structure is used as a request for POST Hub operation + + +[options="header", cols=".^3,.^11,.^4"] +|=== +|Name|Description|Schema +|**callback** + +__required__|Address where notification must be send|string +|**query** + +__required__|The query must have an eventType=notificationName information. +Optionally a ? could be added to reduce hub. +query”:”eventType = ServiceOrderStateChangeNotification”&serviceOrder.state=COMPLETED|string +|=== + + [[_createserviceorder]] === CreateServiceOrder This structure is used in the operation POST for a serviceOrder request. @@ -434,24 +1022,36 @@ __optional__|http error code extension like 400-2|string |=== +[[_eventtype]] +=== EventType +__Type__ : enum (ServiceOrderCreationNotification, ServiceOrderStateChangeNotification, ServiceOrderItemStateChangeNotification) + + [[_hub]] === Hub An HUB resource is used by client side to subscribe to notification. Not managed in the Beijing release. -[options="header", cols=".^3,.^4"] +[options="header", cols=".^3,.^11,.^4"] |=== -|Name|Schema +|Name|Description|Schema |**callback** + -__required__|string +__required__|Address where notification must be send|string |**id** + -__optional__|string +__optional__|Hub Id|string |**query** + -__optional__|string +__required__||string |=== +[[_notification]] +=== Notification +Used to describe notification for this API + +__Type__ : object + + [[_orderitemrelationship]] === OrderItemRelationship Linked order item to the one containing this attribute. @@ -468,6 +1068,27 @@ __required__||<<_relationshiptype,RelationshipType>> |=== +[[_ordermessage]] +=== OrderMessage +An optional array of messages associated with the Order + + +[options="header", cols=".^3,.^11,.^4"] +|=== +|Name|Description|Schema +|**code** + +__optional__|A code associated to this message|string +|**correctionRequired** + +__required__|Indicator that an action is required to allow service order fullfilment to follow up|boolean +|**field** + +__optional__|Service Order attribute related to this error message|string +|**messageInformation** + +__optional__|Message related to this order|string +|**severity** + +__required__||<<_severitymessage,SeverityMessage>> +|=== + + [[_orderrelationship]] === OrderRelationship Linked order to the one containing this attribute. @@ -607,6 +1228,8 @@ __required__|ID created on repository side|string __optional__||string (date-time) |**orderItem** + __optional__||< <<_serviceorderitem,ServiceOrderItem>> > array +|**orderMessage** + +__optional__||< <<_ordermessage,OrderMessage>> > array |**orderRelationship** + __optional__||< <<_orderrelationship,OrderRelationship>> > array |**priority** + @@ -624,6 +1247,25 @@ __optional__||<<_statetype,StateType>> |=== +[[_serviceordercreationnotification]] +=== ServiceOrderCreationNotification +Notification structure for a service order creation notification + + +[options="header", cols=".^3,.^11,.^4"] +|=== +|Name|Description|Schema +|**event** + +__required__||<<_serviceordersummary,ServiceOrderSummary>> +|**eventDate** + +__required__||string (date-time) +|**eventId** + +__required__||string +|**eventType** + +__required__|**Default** : `"ServiceOrderCreationNotification"`|string +|=== + + [[_serviceorderitem]] === ServiceOrderItem An identified part of the order. A service order is decomposed into one or more order items. @@ -643,8 +1285,48 @@ not used in Beijing relase|string __optional__||<<_actiontype,ActionType>> |**id** + __required__|Identifier of the line item (generally it is a sequence number 01, 02, 03, …)|string +|**orderItemMessage** + +__optional__||< <<_ordermessage,OrderMessage>> > array |**orderItemRelationship** + __optional__||< <<_orderitemrelationship,OrderItemRelationship>> > array +|**percentProgress** + +__optional__|Progress of the delivery in percentage.|string +|**service** + +__required__||<<_service,Service>> +|**state** + +__optional__||<<_statetype,StateType>> +|=== + + +[[_serviceorderitemstatechangenotification]] +=== ServiceOrderItemStateChangeNotification + +[options="header", cols=".^3,.^11,.^4"] +|=== +|Name|Description|Schema +|**event** + +__required__||<<_serviceordersummarywithitem,ServiceOrderSummaryWithItem>> +|**eventDate** + +__required__||string (date-time) +|**eventId** + +__required__||string +|**eventType** + +__required__|**Default** : `"ServiceOrderStateChangeNotification"`|string +|=== + + +[[_serviceorderitemsummary]] +=== ServiceOrderItemSummary +Service Order item summary to be used for notification + + +[options="header", cols=".^3,.^11,.^4"] +|=== +|Name|Description|Schema +|**action** + +__optional__||<<_actiontype,ActionType>> +|**id** + +__required__|Identifier of the line item (generally it is a sequence number 01, 02, 03, …)|string |**service** + __required__||<<_service,Service>> |**state** + @@ -652,6 +1334,73 @@ __optional__||<<_statetype,StateType>> |=== +[[_serviceorderstatechangenotification]] +=== ServiceOrderStateChangeNotification +Service order state change notification description + + +[options="header", cols=".^3,.^11,.^4"] +|=== +|Name|Description|Schema +|**event** + +__required__||<<_serviceordersummary,ServiceOrderSummary>> +|**eventDate** + +__required__||string (date-time) +|**eventId** + +__required__||string +|**eventType** + +__required__|**Default** : `"ServiceOrderStateChangeNotification"`|string +|=== + + +[[_serviceordersummary]] +=== ServiceOrderSummary +This structure is used to provide a subset of serviceOrder attributes to be provided in particular for notification messages + + +[options="header", cols=".^3,.^11,.^4"] +|=== +|Name|Description|Schema +|**completionDateTime** + +__optional__|Date when the order was completed|string (date-time) +|**externalId** + +__optional__|ID given by the consumer and only understandable by him (to facilitate his searches)|string +|**href** + +__optional__|Hyperlink to access the order|string +|**id** + +__required__|ID created on repository side|string +|**orderDate** + +__optional__||string (date-time) +|**state** + +__optional__||<<_statetype,StateType>> +|=== + + +[[_serviceordersummarywithitem]] +=== ServiceOrderSummaryWithItem +Service order item summary with item description + + +[options="header", cols=".^3,.^11,.^4"] +|=== +|Name|Description|Schema +|**completionDateTime** + +__optional__|Date when the order was completed|string (date-time) +|**externalId** + +__optional__|ID given by the consumer and only understandable by him (to facilitate his searches)|string +|**href** + +__optional__|Hyperlink to access the order|string +|**id** + +__required__|ID created on repository side|string +|**orderDate** + +__optional__||string (date-time) +|**orderItem** + +__optional__||< <<_serviceorderitemsummary,ServiceOrderItemSummary>> > array +|**state** + +__optional__||<<_statetype,StateType>> +|=== + + [[_serviceref]] === ServiceRef Service references @@ -714,6 +1463,11 @@ Not used in Beijing release|string |=== +[[_severitymessage]] +=== SeverityMessage +__Type__ : enum (information, error) + + [[_statetype]] === StateType List of possible state for the order and the orderItem. diff --git a/docs/offeredapis/serviceOrder/documentation.html b/docs/offeredapis/serviceOrder/documentation.html index 09732b5..cab4964 100644 --- a/docs/offeredapis/serviceOrder/documentation.html +++ b/docs/offeredapis/serviceOrder/documentation.html @@ -1,8 +1,3 @@ -<!-- -This work is licensed under a Creative Commons Attribution 4.0 International License. -http://creativecommons.org/licenses/by/4.0 -Copyright 2018 Orange ---> <!DOCTYPE html> <html lang="en"> <head> @@ -442,33 +437,45 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b <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="#_consumes">Consumes</a></li> <li><a href="#_produces">Produces</a></li> </ul> </li> <li><a href="#_paths">Resources</a> <ul class="sectlevel2"> +<li><a href="#_hub_resource">Hub</a></li> +<li><a href="#_notification_resource">Notification</a></li> <li><a href="#_serviceorder_resource">ServiceOrder</a></li> </ul> </li> <li><a href="#_definitions">Definitions</a> <ul class="sectlevel2"> <li><a href="#_actiontype">ActionType</a></li> +<li><a href="#_createhub">CreateHub</a></li> <li><a href="#_createserviceorder">CreateServiceOrder</a></li> <li><a href="#_createserviceorderitem">CreateServiceOrderItem</a></li> <li><a href="#_errorrepresentation">ErrorRepresentation</a></li> +<li><a href="#_eventtype">EventType</a></li> <li><a href="#_hub">Hub</a></li> +<li><a href="#_notification">Notification</a></li> <li><a href="#_orderitemrelationship">OrderItemRelationship</a></li> +<li><a href="#_ordermessage">OrderMessage</a></li> <li><a href="#_orderrelationship">OrderRelationship</a></li> <li><a href="#_relatedparty">RelatedParty</a></li> <li><a href="#_relationshiptype">RelationshipType</a></li> <li><a href="#_service">Service</a></li> <li><a href="#_servicecharacteristic">ServiceCharacteristic</a></li> <li><a href="#_serviceorder">ServiceOrder</a></li> +<li><a href="#_serviceordercreationnotification">ServiceOrderCreationNotification</a></li> <li><a href="#_serviceorderitem">ServiceOrderItem</a></li> +<li><a href="#_serviceorderitemstatechangenotification">ServiceOrderItemStateChangeNotification</a></li> +<li><a href="#_serviceorderitemsummary">ServiceOrderItemSummary</a></li> +<li><a href="#_serviceorderstatechangenotification">ServiceOrderStateChangeNotification</a></li> +<li><a href="#_serviceordersummary">ServiceOrderSummary</a></li> +<li><a href="#_serviceordersummarywithitem">ServiceOrderSummaryWithItem</a></li> <li><a href="#_serviceref">ServiceRef</a></li> <li><a href="#_servicerelationship">ServiceRelationship</a></li> <li><a href="#_servicespecificationref">ServiceSpecificationRef</a></li> +<li><a href="#_severitymessage">SeverityMessage</a></li> <li><a href="#_statetype">StateType</a></li> <li><a href="#_targetserviceschema">TargetServiceSchema</a></li> <li><a href="#_value">Value</a></li> @@ -482,8 +489,15 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b <h2 id="_overview">Overview</h2> <div class="sectionbody"> <div class="sect2"> +<h3 id="_api_url">Api URL</h3> <div class="paragraph"> -<p>serviceOrder API designed for ONAP Beijing Release. +<p><a href="https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/Ve1zj3V1gj/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/Ve1zj3V1gj/plantuml&noCache=366455.0">plant UML UI</a></p> +</div> +<div class="paragraph"> +<p>serviceOrder API designed for ONAP. This API is build from TMF open API18.0 (applying TMF Guideline 3.0); Only operations GET (by id and list) and POST are available.</p> </div> @@ -491,14 +505,14 @@ Only operations GET (by id and list) and POST are available.</p> <div class="sect2"> <h3 id="_version_information">Version information</h3> <div class="paragraph"> -<p><em>Version</em> : 1.0.0_inProgress</p> +<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/v1<br> +<em>BasePath</em> : /nbi/api/v3<br> <em>Schemes</em> : HTTPS</p> </div> </div> @@ -507,13 +521,19 @@ Only operations GET (by id and list) and POST are available.</p> <div class="ulist"> <ul> <li> +<p>Hub</p> +</li> +<li> +<p>Notification</p> +</li> +<li> <p>ServiceOrder : A Service Order is a type of order which can be used to describe a group of operations on service – one service order item per service. An action at the level of the service order item describe the operation to be done on a service (add, terminate for example). The service order is triggered from the BSS system in charge of the product order management to ONAP that will manage the service fulfillment.</p> </li> </ul> </div> </div> <div class="sect2"> -<h3 id="_consumes">Consumes</h3> +<h3 id="_produces">Produces</h3> <div class="ulist"> <ul> <li> @@ -522,8 +542,977 @@ Only operations GET (by id and list) and POST are available.</p> </ul> </div> </div> +</div> +</div> +<div class="sect1"> +<h2 id="_paths">Resources</h2> +<div class="sectionbody"> <div class="sect2"> -<h3 id="_produces">Produces</h3> +<h3 id="_hub_resource">Hub</h3> +<div class="sect3"> +<h4 id="_hubcreate">Create Hub</h4> +<div class="literalblock"> +<div class="content"> +<pre>POST /hub</pre> +</div> +</div> +<div class="sect4"> +<h5 id="_description">Description</h5> +<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: 22.2222%;"> +<col style="width: 33.3333%;"> +<col style="width: 44.4445%;"> +</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">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Hub</strong><br> +<em>required</em></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_createhub">CreateHub</a></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>201</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">Success<br> +<strong>Headers</strong> : <br> +<code>location</code> (string)</p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">file</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="_consumes">Consumes</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="_hubfind">Retrieve a lits of hub</h4> +<div class="literalblock"> +<div class="content"> +<pre>GET /hub</pre> +</div> +</div> +<div class="sect4"> +<h5 id="_description_2">Description</h5> +<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: 22.2222%;"> +<col style="width: 33.3333%;"> +<col style="width: 44.4445%;"> +</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">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>eventType</strong><br> +<em>optional</em></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">enum (ServiceOrderCreationNotification, ServiceOrderStateChangeNotification, ServiceOrderItemStateChangeNotification)</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>id</strong><br> +<em>optional</em></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="#_hub">Hub</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="_hubget">Retrieve an HUB by id</h4> +<div class="literalblock"> +<div class="content"> +<pre>GET /hub/{hubId}</pre> +</div> +</div> +<div class="sect4"> +<h5 id="_description_3">Description</h5> +<div class="paragraph"> +<p>Retrieve an HUB by id</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_3">Parameters</h5> +<table class="tableblock frame-all grid-all spread"> +<colgroup> +<col style="width: 22.2222%;"> +<col style="width: 33.3333%;"> +<col style="width: 44.4445%;"> +</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">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>hubId</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="sect4"> +<h5 id="_responses_3">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="#_hub">Hub</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 class="sect3"> +<h4 id="_hubdelete">delete hub</h4> +<div class="literalblock"> +<div class="content"> +<pre>DELETE /hub/{hubId}</pre> +</div> +</div> +<div class="sect4"> +<h5 id="_description_4">Description</h5> +<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_4">Parameters</h5> +<table class="tableblock frame-all grid-all spread"> +<colgroup> +<col style="width: 22.2222%;"> +<col style="width: 33.3333%;"> +<col style="width: 44.4445%;"> +</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">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>hubId</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="sect4"> +<h5 id="_responses_4">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>204</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">No Content</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> +</div> +<div class="sect2"> +<h3 id="_notification_resource">Notification</h3> +<div class="sect3"> +<h4 id="_notificationserviceordercreationnotification">Service order creation notification</h4> +<div class="literalblock"> +<div class="content"> +<pre>POST /notification/serviceOrderCreationNotification</pre> +</div> +</div> +<div class="sect4"> +<h5 id="_description_5">Description</h5> +<div class="paragraph"> +<p>Service order creation notification</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_5">Parameters</h5> +<table class="tableblock frame-all grid-all spread"> +<colgroup> +<col style="width: 22.2222%;"> +<col style="width: 33.3333%;"> +<col style="width: 44.4445%;"> +</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">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceOrderCreationNotification</strong><br> +<em>required</em></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_serviceordercreationnotification">ServiceOrderCreationNotification</a></p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect4"> +<h5 id="_responses_5">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>204</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">No Content</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="_consumes_2">Consumes</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="_notificationserviceorderitemstatechangenotification">ServiceOrder Item State Change Notification description</h4> +<div class="literalblock"> +<div class="content"> +<pre>POST /notification/serviceOrderItemStateChangeNotification</pre> +</div> +</div> +<div class="sect4"> +<h5 id="_description_6">Description</h5> +<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_6">Parameters</h5> +<table class="tableblock frame-all grid-all spread"> +<colgroup> +<col style="width: 22.2222%;"> +<col style="width: 33.3333%;"> +<col style="width: 44.4445%;"> +</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">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceOrderItemStateChangeNotification</strong><br> +<em>required</em></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_serviceorderitemstatechangenotification">ServiceOrderItemStateChangeNotification</a></p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect4"> +<h5 id="_responses_6">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>204</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">No Content</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="_consumes_3">Consumes</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="_notificationserviceorderstatechangenotification">Service order state change notification description</h4> +<div class="literalblock"> +<div class="content"> +<pre>POST /notification/serviceOrderStateChangeNotification</pre> +</div> +</div> +<div class="sect4"> +<h5 id="_description_7">Description</h5> +<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_7">Parameters</h5> +<table class="tableblock frame-all grid-all spread"> +<colgroup> +<col style="width: 22.2222%;"> +<col style="width: 33.3333%;"> +<col style="width: 44.4445%;"> +</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">Schema</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Body</strong></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>serviceOrderstateChangeNotification</strong><br> +<em>required</em></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_serviceorderstatechangenotification">ServiceOrderStateChangeNotification</a></p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect4"> +<h5 id="_responses_7">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>204</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">No Content</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="_consumes_4">Consumes</h5> <div class="ulist"> <ul> <li> @@ -534,9 +1523,6 @@ Only operations GET (by id and list) and POST are available.</p> </div> </div> </div> -<div class="sect1"> -<h2 id="_paths">Resources</h2> -<div class="sectionbody"> <div class="sect2"> <h3 id="_serviceorder_resource">ServiceOrder</h3> <div class="paragraph"> @@ -550,13 +1536,20 @@ Only operations GET (by id and list) and POST are available.</p> </div> </div> <div class="sect4"> -<h5 id="_description">Description</h5> +<h5 id="_description_8">Description</h5> <div class="paragraph"> <p>This operation creates a service order entity. The TMF Open API specification document provides the list of mandatory and non mandatory attributes when creating a ServiceOrder, including any possible rule conditions and applicable default values. POST should be used without specifying the id and the href, the Service Order Management system is in charge of generating the id + href for the ServiceOrder.</p> </div> <div class="paragraph"> +<p>In Beijing Release, NBI will use only POST {{url}}/ecomp/mso/infra/serviceInstances/v4 SO API. This mean that only the 'service-instance' level will be created in AAI. Additional resource like VNF and/OR VF are not created.</p> +</div> +<div class="paragraph"> +<p>In Casablanca release, NBI has been improved to also be able to use POST {{url}}/e2eServiceInstances/v3 SO API. This API is able to instantiate in ONAP E2E service; This is useful for CCVPN and VoLTE UC. +Depending on the service category defined in SDC, NBI will use one or the other SO API. If category starts with e2e, NBI will use {url}}/e2eServiceInstances/v3 SO API - else it will use {{url}}/ecomp/mso/infra/serviceInstances/v4 SO API.</p> +</div> +<div class="paragraph"> <p>Specific business errors for current operation will be encapsulated in</p> </div> <div class="paragraph"> @@ -589,7 +1582,7 @@ POST should be used without specifying the id and the href, the Service Order Ma </div> </div> <div class="sect4"> -<h5 id="_parameters">Parameters</h5> +<h5 id="_parameters_8">Parameters</h5> <table class="tableblock frame-all grid-all spread"> <colgroup> <col style="width: 22.2222%;"> @@ -614,7 +1607,7 @@ POST should be used without specifying the id and the href, the Service Order Ma </table> </div> <div class="sect4"> -<h5 id="_responses">Responses</h5> +<h5 id="_responses_8">Responses</h5> <table class="tableblock frame-all grid-all spread"> <colgroup> <col style="width: 10%;"> @@ -632,7 +1625,7 @@ POST should be used without specifying the id and the href, the Service Order Ma <tr> <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>201</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="#_createserviceorder">CreateServiceOrder</a></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_serviceorder">ServiceOrder</a></p></td> </tr> <tr> <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>400</strong></p></td> @@ -707,6 +1700,26 @@ POST should be used without specifying the id and the href, the Service Order Ma </tbody> </table> </div> +<div class="sect4"> +<h5 id="_consumes_5">Consumes</h5> +<div class="ulist"> +<ul> +<li> +<p><code>application/json;charset=utf-8</code></p> +</li> +</ul> +</div> +</div> +<div class="sect4"> +<h5 id="_produces_4">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="_serviceorderfind">List service orders</h4> @@ -716,7 +1729,7 @@ POST should be used without specifying the id and the href, the Service Order Ma </div> </div> <div class="sect4"> -<h5 id="_description_2">Description</h5> +<h5 id="_description_9">Description</h5> <div class="paragraph"> <p>Retrieve and list service order entities according to given criteria. Only a predefined set of attribute is proposed. @@ -730,7 +1743,7 @@ Attribute selection could be described in the fields attribute.</p> </div> </div> <div class="sect4"> -<h5 id="_parameters_2">Parameters</h5> +<h5 id="_parameters_9">Parameters</h5> <table class="tableblock frame-all grid-all spread"> <colgroup> <col style="width: 11.1111%;"> @@ -807,7 +1820,7 @@ Attribute selection could be described in the fields attribute.</p> </table> </div> <div class="sect4"> -<h5 id="_responses_2">Responses</h5> +<h5 id="_responses_9">Responses</h5> <table class="tableblock frame-all grid-all spread"> <colgroup> <col style="width: 10%;"> @@ -895,6 +1908,16 @@ Attribute selection could be described in the fields attribute.</p> </tbody> </table> </div> +<div class="sect4"> +<h5 id="_produces_5">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="_serviceorderget">Retrieve a service order</h4> @@ -904,7 +1927,7 @@ Attribute selection could be described in the fields attribute.</p> </div> </div> <div class="sect4"> -<h5 id="_description_3">Description</h5> +<h5 id="_description_10">Description</h5> <div class="paragraph"> <p>This operation retrieves a service order entity. Attribute selection is enabled for all first level attributes.</p> @@ -917,7 +1940,7 @@ Attribute selection is enabled for all first level attributes.</p> </div> </div> <div class="sect4"> -<h5 id="_parameters_3">Parameters</h5> +<h5 id="_parameters_10">Parameters</h5> <table class="tableblock frame-all grid-all spread"> <colgroup> <col style="width: 11.1111%;"> @@ -952,7 +1975,7 @@ Attribute selection is enabled for all first level attributes.</p> </table> </div> <div class="sect4"> -<h5 id="_responses_3">Responses</h5> +<h5 id="_responses_10">Responses</h5> <table class="tableblock frame-all grid-all spread"> <colgroup> <col style="width: 10%;"> @@ -1037,6 +2060,16 @@ Attribute selection is enabled for all first level attributes.</p> </tbody> </table> </div> +<div class="sect4"> +<h5 id="_produces_6">Produces</h5> +<div class="ulist"> +<ul> +<li> +<p><code>application/json;charset=utf-8</code></p> +</li> +</ul> +</div> +</div> </div> </div> </div> @@ -1055,6 +2088,42 @@ modify is not managed in Beijing release</p> </div> </div> <div class="sect2"> +<h3 id="_createhub">CreateHub</h3> +<div class="paragraph"> +<p>This structure is used as a request for POST Hub operation</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>callback</strong><br> +<em>required</em></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">Address where notification must be send</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><br> +<em>required</em></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">The query must have an eventType=notificationName information. +Optionally a ? could be added to reduce hub. +query”:”eventType = ServiceOrderStateChangeNotification”&serviceOrder.state=COMPLETED</p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect2"> <h3 id="_createserviceorder">CreateServiceOrder</h3> <div class="paragraph"> <p>This structure is used in the operation POST for a serviceOrder request. @@ -1279,6 +2348,12 @@ Attribute description is not accurate and should be find in the serviceOrderItem </table> </div> <div class="sect2"> +<h3 id="_eventtype">EventType</h3> +<div class="paragraph"> +<p><em>Type</em> : enum (ServiceOrderCreationNotification, ServiceOrderStateChangeNotification, ServiceOrderItemStateChangeNotification)</p> +</div> +</div> +<div class="sect2"> <h3 id="_hub">Hub</h3> <div class="paragraph"> <p>An HUB resource is used by client side to subscribe to notification. @@ -1286,12 +2361,14 @@ Not managed in the Beijing release.</p> </div> <table class="tableblock frame-all grid-all spread"> <colgroup> -<col style="width: 42.8571%;"> -<col style="width: 57.1429%;"> +<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> @@ -1299,22 +2376,34 @@ Not managed in the Beijing release.</p> <tr> <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>callback</strong><br> <em>required</em></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">Address where notification must be send</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">Hub Id</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><br> -<em>optional</em></p></td> +<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> </tbody> </table> </div> <div class="sect2"> +<h3 id="_notification">Notification</h3> +<div class="paragraph"> +<p>Used to describe notification for this API</p> +</div> +<div class="paragraph"> +<p><em>Type</em> : object</p> +</div> +</div> +<div class="sect2"> <h3 id="_orderitemrelationship">OrderItemRelationship</h3> <div class="paragraph"> <p>Linked order item to the one containing this attribute. @@ -1350,6 +2439,58 @@ nbi component used this relationship to sort request to ONAP.</p> </table> </div> <div class="sect2"> +<h3 id="_ordermessage">OrderMessage</h3> +<div class="paragraph"> +<p>An optional array of messages associated with the Order</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>code</strong><br> +<em>optional</em></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">A code associated to this message</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>correctionRequired</strong><br> +<em>required</em></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">Indicator that an action is required to allow service order fullfilment to follow up</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>field</strong><br> +<em>optional</em></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">Service Order attribute related to this error message</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>messageInformation</strong><br> +<em>optional</em></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">Message related to this order</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>severity</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"><a href="#_severitymessage">SeverityMessage</a></p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect2"> <h3 id="_orderrelationship">OrderRelationship</h3> <div class="paragraph"> <p>Linked order to the one containing this attribute. @@ -1682,6 +2823,12 @@ Not managed in Beijing release.</p></td> <td class="tableblock halign-left valign-middle"><p class="tableblock">< <a href="#_serviceorderitem">ServiceOrderItem</a> > array</p></td> </tr> <tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>orderMessage</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="#_ordermessage">OrderMessage</a> > array</p></td> +</tr> +<tr> <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>orderRelationship</strong><br> <em>optional</em></p></td> <td class="tableblock halign-left valign-middle"></td> @@ -1727,6 +2874,52 @@ Not managed in Beijing release.</p></td> </table> </div> <div class="sect2"> +<h3 id="_serviceordercreationnotification">ServiceOrderCreationNotification</h3> +<div class="paragraph"> +<p>Notification structure for a service order creation notification</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>event</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"><a href="#_serviceordersummary">ServiceOrderSummary</a></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>eventDate</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 (date-time)</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>eventId</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>eventType</strong><br> +<em>required</em></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Default</strong> : <code>"ServiceOrderCreationNotification"</code></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect2"> <h3 id="_serviceorderitem">ServiceOrderItem</h3> <div class="paragraph"> <p>An identified part of the order. A service order is decomposed into one or more order items.</p> @@ -1777,12 +2970,113 @@ not used in Beijing relase</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>orderItemMessage</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="#_ordermessage">OrderMessage</a> > array</p></td> +</tr> +<tr> <td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>orderItemRelationship</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="#_orderitemrelationship">OrderItemRelationship</a> > array</p></td> </tr> <tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>percentProgress</strong><br> +<em>optional</em></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">Progress of the delivery in percentage.</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>service</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"><a href="#_service">Service</a></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>state</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="#_statetype">StateType</a></p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect2"> +<h3 id="_serviceorderitemstatechangenotification">ServiceOrderItemStateChangeNotification</h3> +<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>event</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"><a href="#_serviceordersummarywithitem">ServiceOrderSummaryWithItem</a></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>eventDate</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 (date-time)</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>eventId</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>eventType</strong><br> +<em>required</em></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Default</strong> : <code>"ServiceOrderStateChangeNotification"</code></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect2"> +<h3 id="_serviceorderitemsummary">ServiceOrderItemSummary</h3> +<div class="paragraph"> +<p>Service Order item summary to be used for notification</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>action</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="#_actiontype">ActionType</a></p></td> +</tr> +<tr> +<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"><p class="tableblock">Identifier of the line item (generally it is a sequence number 01, 02, 03, …)</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>service</strong><br> <em>required</em></p></td> <td class="tableblock halign-left valign-middle"></td> @@ -1798,6 +3092,174 @@ not used in Beijing relase</p></td> </table> </div> <div class="sect2"> +<h3 id="_serviceorderstatechangenotification">ServiceOrderStateChangeNotification</h3> +<div class="paragraph"> +<p>Service order state change notification description</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>event</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"><a href="#_serviceordersummary">ServiceOrderSummary</a></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>eventDate</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 (date-time)</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>eventId</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>eventType</strong><br> +<em>required</em></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Default</strong> : <code>"ServiceOrderStateChangeNotification"</code></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect2"> +<h3 id="_serviceordersummary">ServiceOrderSummary</h3> +<div class="paragraph"> +<p>This structure is used to provide a subset of serviceOrder attributes to be provided in particular for notification messages</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>completionDateTime</strong><br> +<em>optional</em></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">Date when the order was completed</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>externalId</strong><br> +<em>optional</em></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">ID given by the consumer and only understandable by him (to facilitate his searches)</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>href</strong><br> +<em>optional</em></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">Hyperlink to access the order</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>required</em></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">ID created on repository side</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>orderDate</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">string (date-time)</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>state</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="#_statetype">StateType</a></p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect2"> +<h3 id="_serviceordersummarywithitem">ServiceOrderSummaryWithItem</h3> +<div class="paragraph"> +<p>Service order item summary with item description</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>completionDateTime</strong><br> +<em>optional</em></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">Date when the order was completed</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>externalId</strong><br> +<em>optional</em></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">ID given by the consumer and only understandable by him (to facilitate his searches)</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>href</strong><br> +<em>optional</em></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">Hyperlink to access the order</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>required</em></p></td> +<td class="tableblock halign-left valign-middle"><p class="tableblock">ID created on repository side</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>orderDate</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">string (date-time)</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>orderItem</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="#_serviceorderitemsummary">ServiceOrderItemSummary</a> > array</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>state</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="#_statetype">StateType</a></p></td> +</tr> +</tbody> +</table> +</div> +<div class="sect2"> <h3 id="_serviceref">ServiceRef</h3> <div class="paragraph"> <p>Service references</p> @@ -1937,6 +3399,12 @@ Not used in Beijing release</p></td> </table> </div> <div class="sect2"> +<h3 id="_severitymessage">SeverityMessage</h3> +<div class="paragraph"> +<p><em>Type</em> : enum (information, error)</p> +</div> +</div> +<div class="sect2"> <h3 id="_statetype">StateType</h3> <div class="paragraph"> <p>List of possible state for the order and the orderItem.</p> @@ -2028,7 +3496,7 @@ This attribute must be used in Beijing Release to provide characteristic value.< </div> <div id="footer"> <div id="footer-text"> -Last updated 2018-03-22 09:37:52 UTC +Last updated 2018-09-12 13:42:33 +00:00 </div> </div> </body> diff --git a/docs/offeredapis/serviceOrder/markDown.md b/docs/offeredapis/serviceOrder/markDown.md index b47779b..0c11b20 100644 --- a/docs/offeredapis/serviceOrder/markDown.md +++ b/docs/offeredapis/serviceOrder/markDown.md @@ -1,7 +1,3 @@ -# This work is licensed under a Creative Commons Attribution 4.0 International License. -# http://creativecommons.org/licenses/by/4.0 -# Copyright 2018 Orange - # API ServiceOrder @@ -10,43 +6,319 @@ ### Api URL -[Swagger UI](https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/kl1kgvz1zR/swagger.json) +[Swagger UI](https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/Ve1zj3V1gj/swagger.json) -[plant UML UI](https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/kl1kgvz1zR/plantuml&noCache=934804.0) +[plant UML UI](https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/Ve1zj3V1gj/plantuml&noCache=366455.0) -serviceOrder API designed for ONAP Beijing Release. +serviceOrder API designed for ONAP. This API is build from TMF open API18.0 (applying TMF Guideline 3.0); Only operations GET (by id and list) and POST are available. ### Version information -*Version* : 1.0.0_inProgress +*Version* : 3.0.0_inProgress ### URI scheme *Host* : serverRoot -*BasePath* : /nbi/api/v1 +*BasePath* : /nbi/api/v3 *Schemes* : HTTPS ### Tags +* Hub +* Notification * ServiceOrder : A Service Order is a type of order which can be used to describe a group of operations on service – one service order item per service. An action at the level of the service order item describe the operation to be done on a service (add, terminate for example). The service order is triggered from the BSS system in charge of the product order management to ONAP that will manage the service fulfillment. -### Consumes +### Produces * `application/json;charset=utf-8` -### Produces +<a name="paths"></a> +## Resources + +<a name="hub_resource"></a> +### Hub + +<a name="hubcreate"></a> +#### Create Hub +``` +POST /hub +``` + + +##### Description +Specific business errors for current operation will be encapsulated in + +HTTP Response 422 Unprocessable entity + + +##### Parameters + +|Type|Name|Schema| +|---|---|---| +|**Body**|**Hub** <br>*required*|[CreateHub](#createhub)| + + +##### Responses + +|HTTP Code|Description|Schema| +|---|---|---| +|**201**|Success <br>**Headers** : <br>`location` (string)|file| +|**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)| + + +##### Consumes * `application/json;charset=utf-8` -<a name="paths"></a> -## Resources +<a name="hubfind"></a> +#### Retrieve a lits of hub +``` +GET /hub +``` + + +##### Description +Specific business errors for current operation will be encapsulated in + +HTTP Response 422 Unprocessable entity + + +##### Parameters + +|Type|Name|Schema| +|---|---|---| +|**Query**|**eventType** <br>*optional*|enum (ServiceOrderCreationNotification, ServiceOrderStateChangeNotification, ServiceOrderItemStateChangeNotification)| +|**Query**|**id** <br>*optional*|string| + + +##### Responses + +|HTTP Code|Description|Schema| +|---|---|---| +|**200**|Success|< [Hub](#hub) > 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="hubget"></a> +#### Retrieve an HUB by id +``` +GET /hub/{hubId} +``` + + +##### Description +Retrieve an HUB by id + +Specific business errors for current operation will be encapsulated in + +HTTP Response 422 Unprocessable entity + + +##### Parameters + +|Type|Name|Schema| +|---|---|---| +|**Path**|**hubId** <br>*required*|string| + + +##### Responses + +|HTTP Code|Description|Schema| +|---|---|---| +|**200**|Success|[Hub](#hub)| +|**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="hubdelete"></a> +#### delete hub +``` +DELETE /hub/{hubId} +``` + + +##### Description +Specific business errors for current operation will be encapsulated in + +HTTP Response 422 Unprocessable entity + + +##### Parameters + +|Type|Name|Schema| +|---|---|---| +|**Path**|**hubId** <br>*required*|string| + + +##### Responses + +|HTTP Code|Description|Schema| +|---|---|---| +|**204**|Success|No Content| +|**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)| + + +<a name="notification_resource"></a> +### Notification + +<a name="notificationserviceordercreationnotification"></a> +#### Service order creation notification +``` +POST /notification/serviceOrderCreationNotification +``` + + +##### Description +Service order creation notification + +Specific business errors for current operation will be encapsulated in + +HTTP Response 422 Unprocessable entity + + +##### Parameters + +|Type|Name|Schema| +|---|---|---| +|**Body**|**serviceOrderCreationNotification** <br>*required*|[ServiceOrderCreationNotification](#serviceordercreationnotification)| + + +##### Responses + +|HTTP Code|Description|Schema| +|---|---|---| +|**204**|Success|No Content| +|**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)| + + +##### Consumes + +* `application/json;charset=utf-8` + + +<a name="notificationserviceorderitemstatechangenotification"></a> +#### ServiceOrder Item State Change Notification description +``` +POST /notification/serviceOrderItemStateChangeNotification +``` + + +##### Description +Specific business errors for current operation will be encapsulated in + +HTTP Response 422 Unprocessable entity + + +##### Parameters + +|Type|Name|Schema| +|---|---|---| +|**Body**|**serviceOrderItemStateChangeNotification** <br>*required*|[ServiceOrderItemStateChangeNotification](#serviceorderitemstatechangenotification)| + + +##### Responses + +|HTTP Code|Description|Schema| +|---|---|---| +|**204**|Success|No Content| +|**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)| + + +##### Consumes + +* `application/json;charset=utf-8` + + +<a name="notificationserviceorderstatechangenotification"></a> +#### Service order state change notification description +``` +POST /notification/serviceOrderStateChangeNotification +``` + + +##### Description +Specific business errors for current operation will be encapsulated in + +HTTP Response 422 Unprocessable entity + + +##### Parameters + +|Type|Name|Schema| +|---|---|---| +|**Body**|**serviceOrderstateChangeNotification** <br>*required*|[ServiceOrderStateChangeNotification](#serviceorderstatechangenotification)| + + +##### Responses + +|HTTP Code|Description|Schema| +|---|---|---| +|**204**|Success|No Content| +|**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)| + + +##### Consumes + +* `application/json;charset=utf-8` + <a name="serviceorder_resource"></a> ### ServiceOrder @@ -65,6 +337,11 @@ This operation creates a service order entity. The TMF Open API specification document provides the list of mandatory and non mandatory attributes when creating a ServiceOrder, including any possible rule conditions and applicable default values. POST should be used without specifying the id and the href, the Service Order Management system is in charge of generating the id + href for the ServiceOrder. +In Beijing Release, NBI will use only POST {{url}}/ecomp/mso/infra/serviceInstances/v4 SO API. This mean that only the 'service-instance' level will be created in AAI. Additional resource like VNF and/OR VF are not created. + +In Casablanca release, NBI has been improved to also be able to use POST {{url}}/e2eServiceInstances/v3 SO API. This API is able to instantiate in ONAP E2E service; This is useful for CCVPN and VoLTE UC. +Depending on the service category defined in SDC, NBI will use one or the other SO API. If category starts with e2e, NBI will use {url}}/e2eServiceInstances/v3 SO API - else it will use {{url}}/ecomp/mso/infra/serviceInstances/v4 SO API. + Specific business errors for current operation will be encapsulated in HTTP Response 422 Unprocessable entity @@ -95,7 +372,7 @@ HTTP Response 422 Unprocessable entity |HTTP Code|Description|Schema| |---|---|---| -|**201**|Success|[CreateServiceOrder](#createserviceorder)| +|**201**|Success|[ServiceOrder](#serviceorder)| |**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)| @@ -105,6 +382,16 @@ HTTP Response 422 Unprocessable entity |**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)| +##### Consumes + +* `application/json;charset=utf-8` + + +##### Produces + +* `application/json;charset=utf-8` + + <a name="serviceorderfind"></a> #### List service orders ``` @@ -150,6 +437,11 @@ HTTP Response 422 Unprocessable entity |**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="serviceorderget"></a> #### Retrieve a service order ``` @@ -188,6 +480,11 @@ HTTP Response 422 Unprocessable entity |**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 @@ -199,6 +496,17 @@ modify is not managed in Beijing release *Type* : enum (add, modify, delete, noChange) +<a name="createhub"></a> +### CreateHub +This structure is used as a request for POST Hub operation + + +|Name|Description|Schema| +|---|---|---| +|**callback** <br>*required*|Address where notification must be send|string| +|**query** <br>*required*|The query must have an eventType=notificationName information.<br>Optionally a ? could be added to reduce hub.<br>query”:”eventType = ServiceOrderStateChangeNotification”&serviceOrder.state=COMPLETED|string| + + <a name="createserviceorder"></a> ### CreateServiceOrder This structure is used in the operation POST for a serviceOrder request. @@ -254,17 +562,29 @@ Representation of an error. |**status** <br>*optional*|http error code extension like 400-2|string| +<a name="eventtype"></a> +### EventType +*Type* : enum (ServiceOrderCreationNotification, ServiceOrderStateChangeNotification, ServiceOrderItemStateChangeNotification) + + <a name="hub"></a> ### Hub An HUB resource is used by client side to subscribe to notification. Not managed in the Beijing release. -|Name|Schema| -|---|---| -|**callback** <br>*required*|string| -|**id** <br>*optional*|string| -|**query** <br>*optional*|string| +|Name|Description|Schema| +|---|---|---| +|**callback** <br>*required*|Address where notification must be send|string| +|**id** <br>*optional*|Hub Id|string| +|**query** <br>*required*||string| + + +<a name="notification"></a> +### Notification +Used to describe notification for this API + +*Type* : object <a name="orderitemrelationship"></a> @@ -279,6 +599,20 @@ nbi component used this relationship to sort request to ONAP. |**type** <br>*required*||[RelationshipType](#relationshiptype)| +<a name="ordermessage"></a> +### OrderMessage +An optional array of messages associated with the Order + + +|Name|Description|Schema| +|---|---|---| +|**code** <br>*optional*|A code associated to this message|string| +|**correctionRequired** <br>*required*|Indicator that an action is required to allow service order fullfilment to follow up|boolean| +|**field** <br>*optional*|Service Order attribute related to this error message|string| +|**messageInformation** <br>*optional*|Message related to this order|string| +|**severity** <br>*required*||[SeverityMessage](#severitymessage)| + + <a name="orderrelationship"></a> ### OrderRelationship Linked order to the one containing this attribute. @@ -369,6 +703,7 @@ A Service Order is a type of order which can be used to place an order between a |**id** <br>*required*|ID created on repository side|string| |**orderDate** <br>*optional*||string (date-time)| |**orderItem** <br>*optional*||< [ServiceOrderItem](#serviceorderitem) > array| +|**orderMessage** <br>*optional*||< [OrderMessage](#ordermessage) > array| |**orderRelationship** <br>*optional*||< [OrderRelationship](#orderrelationship) > array| |**priority** <br>*optional*|A way that can be used by consumers to prioritize orders in Service Order Management system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)|string| |**relatedParty** <br>*optional*||< [RelatedParty](#relatedparty) > array| @@ -378,6 +713,19 @@ A Service Order is a type of order which can be used to place an order between a |**state** <br>*optional*||[StateType](#statetype)| +<a name="serviceordercreationnotification"></a> +### ServiceOrderCreationNotification +Notification structure for a service order creation notification + + +|Name|Description|Schema| +|---|---|---| +|**event** <br>*required*||[ServiceOrderSummary](#serviceordersummary)| +|**eventDate** <br>*required*||string (date-time)| +|**eventId** <br>*required*||string| +|**eventType** <br>*required*|**Default** : `"ServiceOrderCreationNotification"`|string| + + <a name="serviceorderitem"></a> ### ServiceOrderItem An identified part of the order. A service order is decomposed into one or more order items. @@ -390,11 +738,81 @@ An identified part of the order. A service order is decomposed into one or more |**@type** <br>*optional*|Used to extend the order item.<br>not used in Beijing relase|string| |**action** <br>*optional*||[ActionType](#actiontype)| |**id** <br>*required*|Identifier of the line item (generally it is a sequence number 01, 02, 03, …)|string| +|**orderItemMessage** <br>*optional*||< [OrderMessage](#ordermessage) > array| |**orderItemRelationship** <br>*optional*||< [OrderItemRelationship](#orderitemrelationship) > array| +|**percentProgress** <br>*optional*|Progress of the delivery in percentage.|string| |**service** <br>*required*||[Service](#service)| |**state** <br>*optional*||[StateType](#statetype)| +<a name="serviceorderitemstatechangenotification"></a> +### ServiceOrderItemStateChangeNotification + +|Name|Description|Schema| +|---|---|---| +|**event** <br>*required*||[ServiceOrderSummaryWithItem](#serviceordersummarywithitem)| +|**eventDate** <br>*required*||string (date-time)| +|**eventId** <br>*required*||string| +|**eventType** <br>*required*|**Default** : `"ServiceOrderStateChangeNotification"`|string| + + +<a name="serviceorderitemsummary"></a> +### ServiceOrderItemSummary +Service Order item summary to be used for notification + + +|Name|Description|Schema| +|---|---|---| +|**action** <br>*optional*||[ActionType](#actiontype)| +|**id** <br>*required*|Identifier of the line item (generally it is a sequence number 01, 02, 03, …)|string| +|**service** <br>*required*||[Service](#service)| +|**state** <br>*optional*||[StateType](#statetype)| + + +<a name="serviceorderstatechangenotification"></a> +### ServiceOrderStateChangeNotification +Service order state change notification description + + +|Name|Description|Schema| +|---|---|---| +|**event** <br>*required*||[ServiceOrderSummary](#serviceordersummary)| +|**eventDate** <br>*required*||string (date-time)| +|**eventId** <br>*required*||string| +|**eventType** <br>*required*|**Default** : `"ServiceOrderStateChangeNotification"`|string| + + +<a name="serviceordersummary"></a> +### ServiceOrderSummary +This structure is used to provide a subset of serviceOrder attributes to be provided in particular for notification messages + + +|Name|Description|Schema| +|---|---|---| +|**completionDateTime** <br>*optional*|Date when the order was completed|string (date-time)| +|**externalId** <br>*optional*|ID given by the consumer and only understandable by him (to facilitate his searches)|string| +|**href** <br>*optional*|Hyperlink to access the order|string| +|**id** <br>*required*|ID created on repository side|string| +|**orderDate** <br>*optional*||string (date-time)| +|**state** <br>*optional*||[StateType](#statetype)| + + +<a name="serviceordersummarywithitem"></a> +### ServiceOrderSummaryWithItem +Service order item summary with item description + + +|Name|Description|Schema| +|---|---|---| +|**completionDateTime** <br>*optional*|Date when the order was completed|string (date-time)| +|**externalId** <br>*optional*|ID given by the consumer and only understandable by him (to facilitate his searches)|string| +|**href** <br>*optional*|Hyperlink to access the order|string| +|**id** <br>*required*|ID created on repository side|string| +|**orderDate** <br>*optional*||string (date-time)| +|**orderItem** <br>*optional*||< [ServiceOrderItemSummary](#serviceorderitemsummary) > array| +|**state** <br>*optional*||[StateType](#statetype)| + + <a name="serviceref"></a> ### ServiceRef Service references @@ -435,6 +853,11 @@ The service specification (these attributes are fetched from the catalogue). |**version** <br>*optional*|Version of the service Specification<br>Not used in Beijing release|string| +<a name="severitymessage"></a> +### SeverityMessage +*Type* : enum (information, error) + + <a name="statetype"></a> ### StateType List of possible state for the order and the orderItem. diff --git a/docs/offeredapis/swaggers/listener-1_0_0.json b/docs/offeredapis/swaggers/listener-1_0_0.json new file mode 100644 index 0000000..7aa65fb --- /dev/null +++ b/docs/offeredapis/swaggers/listener-1_0_0.json @@ -0,0 +1,210 @@ + +{ + "swagger": "2.0", + "info": { + "description": "Listener API has to be implemented on the client side in order to receive notification.\nNotification are received if HUB has been posted on server side.", + "version": "0.1.0", + "title": "API Listener", + "x-logo": { + "url": "/redoc/logo.png", + "backgroundColor": "#FFFFFF" + } + }, + + "host": "serverRoot", + "basePath": "/externalapi/listener/v1", + "schemes": [ + "https" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "tags": [ + + { + "name": "Listener", + "description": "" + } + ], + "paths": { + "/listener": { + "post": { + "tags": [ + "Listener" + ], + "consumes": [ + "application/json;charset=utf-8" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "operationId": "listenerCreate", + "summary": "createEvent", + "description": "The create event is used by the seller to trigger (POST) a notification to the buyer. The buyer has previously subscribed to receive notification\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n", + "deprecated": false, + + "parameters": [ + + { + "name": "event", + "required": true, + "in": "body", + "description": "", + "schema": { + "$ref": "#/definitions/Listener" + } + } + ], + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Listener" + } + + }, + "400": { + + "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "401": { + + "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "403": { + + "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "422": { + + "description": "Unprocessable entity\n\nFunctional error", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "500": { + + "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "503": { + + "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + } + } + } + } + }, +"definitions": { + + "EventType": { + "description": "", + + "type": "string", + "enum": [ + "ServiceOrderCreationNotification", + "ServiceOrderStateChangeNotification", + "ServiceOrderItemStateChangeNotification"] + + }, + + "ErrorRepresentation": { + "description": "", + + + "required": [ + + "code" + ], + "type": "object", + "properties": { + "code": { + "description": "", + "type": "integer", + "format": "int32" + }, + "reason": { + "description": "", + "type": "string" + }, + "message": { + "description": "", + "type": "string" + }, + "status": { + "description": "", + "type": "integer", + "format": "int32" + }, + "referenceError": { + "description": "", + "type": "string" + }, + "@type": { + "description": "", + "type": "string" + }, + "@schemaLocation": { + "description": "", + "type": "string" + } + } + + }, + + "Listener": { + "description": "An event will be triggered for each time a notification is send to a listener.", + + + "required": [ + + "eventId", + "eventDate", + "eventType", + "event" + ], + "type": "object", + "properties": { + "eventId": { + "description": "id of the event", + "type": "string" + }, + "eventDate": { + "description": "", + "type": "string", + "format": "date-time" + }, + "eventType": { + + "$ref": "#/definitions/EventType" + }, + "event": { + "description": "An event representation is the payload of information send with the notification; it will feature event attributes + summary view of the resource.", + "type": "object" + } + } + + } + } +} +
\ No newline at end of file diff --git a/docs/offeredapis/swaggers/listener-1_0_0.yaml b/docs/offeredapis/swaggers/listener-1_0_0.yaml new file mode 100644 index 0000000..390abe0 --- /dev/null +++ b/docs/offeredapis/swaggers/listener-1_0_0.yaml @@ -0,0 +1,142 @@ +swagger: "2.0" +info: + description: "Listener API has to be implemented on the client side in order to\ + \ receive notification.\nNotification are received if HUB has been posted on server\ + \ side." + version: "0.1.0" + title: "API Listener" + x-logo: + url: "/redoc/logo.png" + backgroundColor: "#FFFFFF" +host: "serverRoot" +basePath: "/externalapi/listener/v1" +schemes: +- "https" +produces: +- "application/json;charset=utf-8" +tags: +- name: "Listener" + description: "" +paths: + /listener: + post: + tags: + - "Listener" + consumes: + - "application/json;charset=utf-8" + produces: + - "application/json;charset=utf-8" + operationId: "listenerCreate" + summary: "createEvent" + description: "The create event is used by the seller to trigger (POST) a notification\ + \ to the buyer. The buyer has previously subscribed to receive notification\n\ + \nSpecific business errors for current operation will be encapsulated in\n\ + \nHTTP Response 422 Unprocessable entity\n" + deprecated: false + parameters: + - name: "event" + required: true + in: "body" + description: "" + schema: + $ref: "#/definitions/Listener" + responses: + 201: + description: "Success" + schema: + $ref: "#/definitions/Listener" + 400: + description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ + \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ + \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ + \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ + \ parameter value" + schema: + $ref: "#/definitions/ErrorRepresentation" + 401: + description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ + \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" + schema: + $ref: "#/definitions/ErrorRepresentation" + 403: + description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ + \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ + \ requests" + schema: + $ref: "#/definitions/ErrorRepresentation" + 422: + description: "Unprocessable entity\n\nFunctional error" + schema: + $ref: "#/definitions/ErrorRepresentation" + 500: + description: "Internal Server Error\n\nList of supported error codes:\n\ + - 1: Internal error" + schema: + $ref: "#/definitions/ErrorRepresentation" + 503: + description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ + \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ + \ retry later !" + schema: + $ref: "#/definitions/ErrorRepresentation" +definitions: + EventType: + description: "" + type: "string" + enum: + - "ServiceOrderCreationNotification" + - "ServiceOrderStateChangeNotification" + - "ServiceOrderItemStateChangeNotification" + ErrorRepresentation: + description: "" + required: + - "code" + type: "object" + properties: + code: + description: "" + type: "integer" + format: "int32" + reason: + description: "" + type: "string" + message: + description: "" + type: "string" + status: + description: "" + type: "integer" + format: "int32" + referenceError: + description: "" + type: "string" + '@type': + description: "" + type: "string" + '@schemaLocation': + description: "" + type: "string" + Listener: + description: "An event will be triggered for each time a notification is send\ + \ to a listener." + required: + - "eventId" + - "eventDate" + - "eventType" + - "event" + type: "object" + properties: + eventId: + description: "id of the event" + type: "string" + eventDate: + description: "" + type: "string" + format: "date-time" + eventType: + $ref: "#/definitions/EventType" + event: + description: "An event representation is the payload of information send with\ + \ the notification; it will feature event attributes + summary view of the\ + \ resource." + type: "object" diff --git a/docs/offeredapis/swaggers/serviceCatalog_3_0_0.json b/docs/offeredapis/swaggers/serviceCatalog_3_0_0.json new file mode 100644 index 0000000..aedd4a5 --- /dev/null +++ b/docs/offeredapis/swaggers/serviceCatalog_3_0_0.json @@ -0,0 +1,660 @@ + +{ + "swagger": "2.0", + "info": { + "description": "serviceCatalog API designed for ONAP Casablanca Release.\nThis API is build from TMF open API17.5. \nOnly operation GET (by id & byList) for resource serviceSpecification is available", + "version": "3.0.0", + "title": "API ServiceCatalog", + "x-logo": { + "url": "/redoc/logo.png", + "backgroundColor": "#FFFFFF" + } + }, + + "host": "serverRoot", + "basePath": "/nbi/api/v3", + "schemes": [ + "https" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "tags": [ + + { + "name": "ServiceSpecification", + "description": "" + } + ], + "paths": { + "/serviceSpecification": { + "get": { + "tags": [ + "ServiceSpecification" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "operationId": "serviceSpecificationFind", + "summary": "List service specifications", + "description": "This operation returns service specifications from a catalog.\nOnly a predefined set of attribute is proposed : Based on SDC limitations, only attributes category and distributionStatus are available for serviceSpecification filtering\nFields attribute could be used to filter attributes retrieved\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n", + "deprecated": false, + + "parameters": [ + + { + "name": "fields", + "required": false, + "in": "query", + "description": "Field selection - used to filtering the attributes to be retreived", + + "type": "string" + }, + { + "name": "category", + "required": false, + "in": "query", + "description": "Service Category (filter)", + + "type": "string" + }, + { + "name": "distributionStatus", + "required": false, + "in": "query", + "description": "Service distribution status (filter)", + + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceSpecification" + } + } + + }, + "400": { + + "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "401": { + + "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "403": { + + "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "404": { + + "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "422": { + + "description": "Unprocessable entity\n\nFunctional error", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "500": { + + "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "503": { + + "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + } + } + } + }, + "/serviceSpecification/{id}": { + "get": { + "tags": [ + "ServiceSpecification" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "operationId": "serviceSpecificationGet", + "summary": "Retrieve a service specification", + "description": "This operation returns a service specification by its id from a catalog. Attribute selection is enabled using the fields attribute.\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n", + "deprecated": false, + + "parameters": [ + + { + "name": "id", + "in": "path", + "required": true, + "type": "string", + "description": "" + }, + { + "name": "fields", + "required": false, + "in": "query", + "description": "Attribute selection", + + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ServiceSpecification" + } + + }, + "400": { + + "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "401": { + + "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "403": { + + "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "404": { + + "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "422": { + + "description": "Unprocessable entity\n\nFunctional error", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "500": { + + "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "503": { + + "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + } + } + } + } + }, +"definitions": { + + "LifecycleStatusValues": { + "description": "Service lifecycle value from ONAP SDC", + + "type": "string", + "enum": [ + "NOT_CERTIFIED_CHECKOUT", + "NOT_CERTIFIED_CHECKIN", + "READY_FOR_CERTIFICATION", + "CERTIFICATION_IN_PROGRESS", + "CERTIFIED"] + + }, + "DistributionStatus": { + "description": "Service distribution status from ONAP.", + + "type": "string", + "enum": [ + "DISTRIBUTION_NOT_APPROVED", + "DISTRIBUTION_APPROVED", + "DISTRIBUTED", + "DISTRIBUTION_REJECTED"] + + }, + + "ErrorRepresentation": { + "description": "This class is used to describe error.\nfor nbi Beijing release we do not manage additional error for serviceCatalog", + + + "required": [ + + "code", + "reason" + ], + "type": "object", + "properties": { + "code": { + "description": "Application related code (as defined in the API or from a common list)", + "type": "integer", + "format": "int32" + }, + "reason": { + "description": "Text that explains the reason for error. This can be shown to a client user.", + "type": "string" + }, + "message": { + "description": "Text that provide more details and corrective actions related to the error. This can be shown to a client user", + "type": "string" + }, + "status": { + "description": "http error code extension like 400-2", + "type": "string" + }, + "referenceErrror": { + "description": "url pointing to documentation describing the error", + "type": "string" + }, + "@type": { + "description": "The class type of a REST resource.", + "type": "string" + }, + "@schemaLocation": { + "description": "it provides a link to the schema describing a REST resource.", + "type": "string" + } + } + + }, + + "TimePeriod": { + "description": "A time period", + + + "type": "object", + "properties": { + "startDateTime": { + "description": "Start date and time of the period", + "type": "string", + "format": "date-time" + }, + "endDateTime": { + "description": "End date and time of the period", + "type": "string", + "format": "date-time" + } + } + + }, + + "RelatedPartyRef": { + "description": "Party linked to the service catalog.\nin nbi we retrieve information about last updater of the service in SDC", + + + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the related party. Filled with lastUpdaterUserId", + "type": "string" + }, + "role": { + "description": "Role payed by the related party\nOnly role 'lastUpdater' is retrieved in Beijing release", + "type": "string" + }, + "name": { + "description": "Name of the related party - Filled with lastUpdatedFullName", + "type": "string" + } + } + + }, + + "ServiceSpecification": { + "description": "ServiceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics.\nthe service information are retrieved in SDC", + + + "required": [ + + "invariantUUID" + ], + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the service specification. Filled with SDC Service uuid", + "type": "string" + }, + "href": { + "description": "Reference of the service specification- not mapped in Beijing", + "type": "string" + }, + "name": { + "description": "Name of the service specification- Filled with SDC Service name", + "type": "string" + }, + "description": { + "description": "A narrative that explains in detail what the service specification is - Filled with SDC Service description", + "type": "string" + }, + "@type": { + "description": "This attribute allows to dynamically extends TMF class. Valued with 'ONAPservice'. We used this features to add following attributes:\ninvariantUUID\ntoscaModelURL\ntoscaResourceName\ncategory (1)\nsubcategory (1)\ndistributionStatus", + "type": "string", + + "default": "ONAPservice" + }, + "@schemaLocation": { + "description": "Not used for Beijing release", + "type": "string" + }, + "@baseType": { + "description": "Not used for Beijing release", + "type": "string" + }, + "invariantUUID": { + "description": "Additional attribute (not in the TMF API) - extended through @type - invariantUUID", + "type": "string" + }, + "toscaModelURL": { + "description": "Additional attribute (not in the TMF API) - extended through @type - toscaModelURL", + "type": "string" + }, + "toscaResourceName": { + "description": "Additional attribute (not in the TMF API) - extended through @type - toscaResourceName", + "type": "string" + }, + "category": { + "description": "Additional attribute - extended through @type - category\nPlease note that this attribute is managed in TMF - in future release we'll introduce category resource", + "type": "string" + }, + "subcategory": { + "description": "Additional attribute - extended through @type - category\nPlease note that this attribute is managed in TMF - in future release we'll introduce category resourc", + "type": "string" + }, + "distributionStatus": { + + "$ref": "#/definitions/DistributionStatus" + }, + "version": { + "description": "Service specification version - Filled with SDC Service version", + "type": "string" + }, + "lifecycleStatus": { + + "$ref": "#/definitions/LifecycleStatusValues" + }, + "targetServiceSchema": { + + "$ref": "#/definitions/TargetServiceSchemaRef" + }, + "attachment": { + + "type": "array", + "items": { + "$ref": "#/definitions/Attachment" + } + }, + "relatedParty": { + + "type": "array", + "items": { + "$ref": "#/definitions/RelatedPartyRef" + } + }, + "resourceSpecification": { + + "type": "array", + "items": { + "$ref": "#/definitions/ResourceSpecificationRef" + } + }, + "serviceSpecCharacteristic": { + + "type": "array", + "items": { + "$ref": "#/definitions/ServiceSpecCharacteristic" + } + } + } + + }, + + "ServiceSpecCharacteristic": { + "description": "A characteristic quality or distinctive feature of a ServiceSpecification. \nServiceSpecCharacteristic are retrieved in the serviceTosca file in the topology_template section in the inputs section.", + + + "type": "object", + "properties": { + "name": { + "description": "Name of the characteristic - Filled with parameter_name", + "type": "string" + }, + "description": { + "description": "A narrative that explains in detail what the characteristic is - Filled with parameter_description", + "type": "string" + }, + "valueType": { + "description": "A kind of value that the characteristic can take on, such as numeric, text and so forth - Filled with parameter_type", + "type": "string" + }, + "@type": { + "description": "This attribute allows to dynamically extends TMF class. Valued with: 'ONAPserviceCharacteristic'. We do not used this features in nbi Beijing release.", + "type": "string" + }, + "@schemaLocation": { + "description": "An url pointing to type description - we do not use it in nbi Beijing release", + "type": "string" + }, + "required": { + "description": "A parameter to define if the characteristic is mandatory - Filled from parameter_required – if not fielded by default ‘true’", + "type": "boolean", + + "default": true + }, + "status": { + "description": "Status of the characteristic - filled with status_value", + "type": "string" + }, + "serviceSpecCharacteristicValue": { + + "type": "array", + "items": { + "$ref": "#/definitions/ServiceSpecCharacteristicValue" + } + } + } + + }, + + "Attachment": { + "description": "An attachment is a file uses to describe the service.\nIn nbi we use attachment to retrieve ONAP artifacts.", + + + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the attachment - filled with artifactUUID.", + "type": "string" + }, + "name": { + "description": "Name of the attachment - filled with artifactName", + "type": "string" + }, + "description": { + "description": "Description of the attachment - filled with artifactDescription", + "type": "string" + }, + "@type": { + "description": "This attribute allows to dynamically extends TMF class. Valued with 'ONAPartifact'. We used this features to add following attributes: \nartifactLabel\nartifactGroupType\nartifactTimeout\nartifactChecksum\nartifactVersion\ngeneratedFromUUID", + "type": "string", + + "default": "ONAPartifact" + }, + "artifactLabel": { + "description": "Additional attribute (not in the TMF API) - extended through @type - artifactLabel", + "type": "string" + }, + "artifactGroupType": { + "description": "Additional attribute (not in the TMF API) - extended through @type - artifactGroupType", + "type": "string" + }, + "artifactTimeout": { + "description": "Additional attribute (not in the TMF API) - extended through @type - artifactTimeout", + "type": "string" + }, + "artifactChecksum": { + "description": "Additional attribute (not in the TMF API) - extended through @type - artifactChecksum", + "type": "string" + }, + "artifactVersion": { + "description": "Additional attribute (not in the TMF API) - extended through @type - artifactVersion", + "type": "string" + }, + "generatedFromUUID": { + "description": "Additional attribute (not in the TMF API) - extended through @type - generatedFromUUID", + "type": "string" + }, + "url": { + "description": "Uniform Resource Locator, is a web page address - filled with artifactURL", + "type": "string" + }, + "mimeType": { + "description": "Filled with artifactType", + "type": "string" + } + } + + }, + + "ServiceSpecCharacteristicValue": { + "description": "A number or text that can be assigned to a service specification characteristic.\nServiceSpecCharacteristicValue are retrieved in the service Tosca file", + + + "type": "object", + "properties": { + "valueType": { + "description": "A kind of value that the characteristic can take on, such as numeric, text, and so forth\nRetrieved in the Tosca in the topology_template section in the inputs section - parameter_type. \nWe do not manage parameter_type= list or map for Beijing release", + "type": "string" + }, + "isDefault": { + "description": "Information calculated from parameter default in the Tosca file", + "type": "boolean" + }, + "value": { + "description": "A discrete value that the characteristic can take on", + "type": "string" + } + } + + }, + + "ResourceSpecificationRef": { + "description": "A list of resourceSpec identified to deliver the service.\nfor nbi we retrieve resource information available in service description (through SDC api) bu as well information retrieved in the TOSCA file.", + + + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the resource specification - filled with resourceUUID", + "type": "string" + }, + "version": { + "description": "Version for this resource specification - filled with resourceVersion", + "type": "string" + }, + "name": { + "description": "Name of the resource specification - filled with resourceName", + "type": "string" + }, + "@type": { + "description": "This attribute allows to dynamically extends TMF class. Valued with: 'ONAPresource'. We used this features to add following attributes:\nresourceInstanceName\nresourceInvariantUUID\nresourceType\nmodelCustomizationName\nmodelCustomizationId", + "type": "string", + + "default": "ONAPresource" + }, + "resourceInstanceName": { + "description": "Additional attribute (not in the TMF API) - extended through @type - resourceInstanceName", + "type": "string" + }, + "resourceInvariantUUID": { + "description": "Additional attribute (not in the TMF API) - extended through @type - resourceInvariantUUID", + "type": "string" + }, + "resourceType": { + "description": "Additional attribute (not in the TMF API) - extended through @type - resoucreType", + "type": "string" + }, + "modelCustomizationName": { + "description": "Additional attribute (not in the TMF API) - extended through @type - Retrieved in the TOSCA file : attribute name in topology_template/node_template for the resource", + "type": "string" + }, + "modelCustomizationId": { + "description": "Additional attribute (not in the TMF API) - extended through @type - Retrieved in the TOSCA file : attribute customizationUUID in topology_template/node_template for the resource", + "type": "string" + } + } + + }, + + "TargetServiceSchemaRef": { + "description": "", + + + "required": [ + + "@type", + "@schemaLocation" + ], + "type": "object", + "properties": { + "@type": { + "description": "", + "type": "string" + }, + "@schemaLocation": { + "description": "", + "type": "string" + } + } + + } + } +} +
\ No newline at end of file diff --git a/docs/offeredapis/swaggers/serviceCatalog_3_0_0.yaml b/docs/offeredapis/swaggers/serviceCatalog_3_0_0.yaml new file mode 100644 index 0000000..50ae7cf --- /dev/null +++ b/docs/offeredapis/swaggers/serviceCatalog_3_0_0.yaml @@ -0,0 +1,493 @@ +swagger: "2.0" +info: + description: "serviceCatalog API designed for ONAP Casablanca Release.\nThis API is\ + \ build from TMF open API17.5. \nOnly operation GET (by id & byList) for resource\ + \ serviceSpecification is available" + version: "3.0.0" + title: "API ServiceCatalog" + x-logo: + url: "/redoc/logo.png" + backgroundColor: "#FFFFFF" +host: "serverRoot" +basePath: "/nbi/api/v3" +schemes: +- "https" +produces: +- "application/json;charset=utf-8" +tags: +- name: "ServiceSpecification" + description: "" +paths: + /serviceSpecification: + get: + tags: + - "ServiceSpecification" + produces: + - "application/json;charset=utf-8" + operationId: "serviceSpecificationFind" + summary: "List service specifications" + description: "This operation returns service specifications from a catalog.\n\ + Only a predefined set of attribute is proposed : Based on SDC limitations,\ + \ only attributes category and distributionStatus are available for serviceSpecification\ + \ filtering\nFields attribute could be used to filter attributes retrieved\n\ + \nSpecific business errors for current operation will be encapsulated in\n\ + \nHTTP Response 422 Unprocessable entity\n" + deprecated: false + parameters: + - name: "fields" + required: false + in: "query" + description: "Field selection - used to filtering the attributes to be retreived" + type: "string" + - name: "category" + required: false + in: "query" + description: "Service Category (filter)" + type: "string" + - name: "distributionStatus" + required: false + in: "query" + description: "Service distribution status (filter)" + type: "string" + responses: + 200: + description: "Success" + schema: + type: "array" + items: + $ref: "#/definitions/ServiceSpecification" + 400: + description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ + \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ + \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ + \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ + \ parameter value" + schema: + $ref: "#/definitions/ErrorRepresentation" + 401: + description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ + \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" + schema: + $ref: "#/definitions/ErrorRepresentation" + 403: + description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ + \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ + \ requests" + schema: + $ref: "#/definitions/ErrorRepresentation" + 404: + description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ + \ not found" + schema: + $ref: "#/definitions/ErrorRepresentation" + 422: + description: "Unprocessable entity\n\nFunctional error" + schema: + $ref: "#/definitions/ErrorRepresentation" + 500: + description: "Internal Server Error\n\nList of supported error codes:\n\ + - 1: Internal error" + schema: + $ref: "#/definitions/ErrorRepresentation" + 503: + description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ + \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ + \ retry later !" + schema: + $ref: "#/definitions/ErrorRepresentation" + /serviceSpecification/{id}: + get: + tags: + - "ServiceSpecification" + produces: + - "application/json;charset=utf-8" + operationId: "serviceSpecificationGet" + summary: "Retrieve a service specification" + description: "This operation returns a service specification by its id from\ + \ a catalog. Attribute selection is enabled using the fields attribute.\n\n\ + Specific business errors for current operation will be encapsulated in\n\n\ + HTTP Response 422 Unprocessable entity\n" + deprecated: false + parameters: + - name: "id" + in: "path" + required: true + type: "string" + description: "" + - name: "fields" + required: false + in: "query" + description: "Attribute selection" + type: "string" + responses: + 200: + description: "Success" + schema: + $ref: "#/definitions/ServiceSpecification" + 400: + description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ + \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ + \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ + \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ + \ parameter value" + schema: + $ref: "#/definitions/ErrorRepresentation" + 401: + description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ + \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" + schema: + $ref: "#/definitions/ErrorRepresentation" + 403: + description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ + \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ + \ requests" + schema: + $ref: "#/definitions/ErrorRepresentation" + 404: + description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ + \ not found" + schema: + $ref: "#/definitions/ErrorRepresentation" + 422: + description: "Unprocessable entity\n\nFunctional error" + schema: + $ref: "#/definitions/ErrorRepresentation" + 500: + description: "Internal Server Error\n\nList of supported error codes:\n\ + - 1: Internal error" + schema: + $ref: "#/definitions/ErrorRepresentation" + 503: + description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ + \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ + \ retry later !" + schema: + $ref: "#/definitions/ErrorRepresentation" +definitions: + LifecycleStatusValues: + description: "Service lifecycle value from ONAP SDC" + type: "string" + enum: + - "NOT_CERTIFIED_CHECKOUT" + - "NOT_CERTIFIED_CHECKIN" + - "READY_FOR_CERTIFICATION" + - "CERTIFICATION_IN_PROGRESS" + - "CERTIFIED" + DistributionStatus: + description: "Service distribution status from ONAP." + type: "string" + enum: + - "DISTRIBUTION_NOT_APPROVED" + - "DISTRIBUTION_APPROVED" + - "DISTRIBUTED" + - "DISTRIBUTION_REJECTED" + ErrorRepresentation: + description: "This class is used to describe error.\nfor nbi Beijing release we\ + \ do not manage additional error for serviceCatalog" + required: + - "code" + - "reason" + type: "object" + properties: + code: + description: "Application related code (as defined in the API or from a common\ + \ list)" + type: "integer" + format: "int32" + reason: + description: "Text that explains the reason for error. This can be shown to\ + \ a client user." + type: "string" + message: + description: "Text that provide more details and corrective actions related\ + \ to the error. This can be shown to a client user" + type: "string" + status: + description: "http error code extension like 400-2" + type: "string" + referenceErrror: + description: "url pointing to documentation describing the error" + type: "string" + '@type': + description: "The class type of a REST resource." + type: "string" + '@schemaLocation': + description: "it provides a link to the schema describing a REST resource." + type: "string" + TimePeriod: + description: "A time period" + type: "object" + properties: + startDateTime: + description: "Start date and time of the period" + type: "string" + format: "date-time" + endDateTime: + description: "End date and time of the period" + type: "string" + format: "date-time" + RelatedPartyRef: + description: "Party linked to the service catalog.\nin nbi we retrieve information\ + \ about last updater of the service in SDC" + type: "object" + properties: + id: + description: "Unique identifier of the related party. Filled with lastUpdaterUserId" + type: "string" + role: + description: "Role payed by the related party\nOnly role 'lastUpdater' is\ + \ retrieved in Beijing release" + type: "string" + name: + description: "Name of the related party - Filled with lastUpdatedFullName" + type: "string" + ServiceSpecification: + description: "ServiceSpecification is a class that offers characteristics to describe\ + \ a type of service. Functionally, it acts as a template by which Services may\ + \ be instantiated. By sharing the same specification, these services would therefore\ + \ share the same set of characteristics.\nthe service information are retrieved\ + \ in SDC" + required: + - "invariantUUID" + type: "object" + properties: + id: + description: "Unique identifier of the service specification. Filled with\ + \ SDC Service uuid" + type: "string" + href: + description: "Reference of the service specification- not mapped in Beijing" + type: "string" + name: + description: "Name of the service specification- Filled with SDC Service name" + type: "string" + description: + description: "A narrative that explains in detail what the service specification\ + \ is - Filled with SDC Service description" + type: "string" + '@type': + description: "This attribute allows to dynamically extends TMF class. Valued\ + \ with 'ONAPservice'. We used this features to add following attributes:\n\ + invariantUUID\ntoscaModelURL\ntoscaResourceName\ncategory (1)\nsubcategory\ + \ (1)\ndistributionStatus" + type: "string" + default: "ONAPservice" + '@schemaLocation': + description: "Not used for Beijing release" + type: "string" + '@baseType': + description: "Not used for Beijing release" + type: "string" + invariantUUID: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @type - invariantUUID" + type: "string" + toscaModelURL: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @type - toscaModelURL" + type: "string" + toscaResourceName: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @type - toscaResourceName" + type: "string" + category: + description: "Additional attribute - extended through @type - category\nPlease\ + \ note that this attribute is managed in TMF - in future release we'll introduce\ + \ category resource" + type: "string" + subcategory: + description: "Additional attribute - extended through @type - category\nPlease\ + \ note that this attribute is managed in TMF - in future release we'll introduce\ + \ category resourc" + type: "string" + distributionStatus: + $ref: "#/definitions/DistributionStatus" + version: + description: "Service specification version - Filled with SDC Service version" + type: "string" + lifecycleStatus: + $ref: "#/definitions/LifecycleStatusValues" + targetServiceSchema: + $ref: "#/definitions/TargetServiceSchemaRef" + attachment: + type: "array" + items: + $ref: "#/definitions/Attachment" + relatedParty: + type: "array" + items: + $ref: "#/definitions/RelatedPartyRef" + resourceSpecification: + type: "array" + items: + $ref: "#/definitions/ResourceSpecificationRef" + serviceSpecCharacteristic: + type: "array" + items: + $ref: "#/definitions/ServiceSpecCharacteristic" + ServiceSpecCharacteristic: + description: "A characteristic quality or distinctive feature of a ServiceSpecification.\ + \ \nServiceSpecCharacteristic are retrieved in the serviceTosca file in the\ + \ topology_template section in the inputs section." + type: "object" + properties: + name: + description: "Name of the characteristic - Filled with parameter_name" + type: "string" + description: + description: "A narrative that explains in detail what the characteristic\ + \ is - Filled with parameter_description" + type: "string" + valueType: + description: "A kind of value that the characteristic can take on, such as\ + \ numeric, text and so forth - Filled with parameter_type" + type: "string" + '@type': + description: "This attribute allows to dynamically extends TMF class. Valued\ + \ with: 'ONAPserviceCharacteristic'. We do not used this features in nbi\ + \ Beijing release." + type: "string" + '@schemaLocation': + description: "An url pointing to type description - we do not use it in nbi\ + \ Beijing release" + type: "string" + required: + description: "A parameter to define if the characteristic is mandatory - Filled\ + \ from parameter_required – if not fielded by default ‘true’" + type: "boolean" + default: true + status: + description: "Status of the characteristic - filled with status_value" + type: "string" + serviceSpecCharacteristicValue: + type: "array" + items: + $ref: "#/definitions/ServiceSpecCharacteristicValue" + Attachment: + description: "An attachment is a file uses to describe the service.\nIn nbi we\ + \ use attachment to retrieve ONAP artifacts." + type: "object" + properties: + id: + description: "Unique identifier of the attachment - filled with artifactUUID." + type: "string" + name: + description: "Name of the attachment - filled with artifactName" + type: "string" + description: + description: "Description of the attachment - filled with artifactDescription" + type: "string" + '@type': + description: "This attribute allows to dynamically extends TMF class. Valued\ + \ with 'ONAPartifact'. We used this features to add following attributes:\ + \ \nartifactLabel\nartifactGroupType\nartifactTimeout\nartifactChecksum\n\ + artifactVersion\ngeneratedFromUUID" + type: "string" + default: "ONAPartifact" + artifactLabel: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @type - artifactLabel" + type: "string" + artifactGroupType: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @type - artifactGroupType" + type: "string" + artifactTimeout: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @type - artifactTimeout" + type: "string" + artifactChecksum: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @type - artifactChecksum" + type: "string" + artifactVersion: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @type - artifactVersion" + type: "string" + generatedFromUUID: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @type - generatedFromUUID" + type: "string" + url: + description: "Uniform Resource Locator, is a web page address - filled with\ + \ artifactURL" + type: "string" + mimeType: + description: "Filled with artifactType" + type: "string" + ServiceSpecCharacteristicValue: + description: "A number or text that can be assigned to a service specification\ + \ characteristic.\nServiceSpecCharacteristicValue are retrieved in the service\ + \ Tosca file" + type: "object" + properties: + valueType: + description: "A kind of value that the characteristic can take on, such as\ + \ numeric, text, and so forth\nRetrieved in the Tosca in the topology_template\ + \ section in the inputs section - parameter_type. \nWe do not manage parameter_type=\ + \ list or map for Beijing release" + type: "string" + isDefault: + description: "Information calculated from parameter default in the Tosca file" + type: "boolean" + value: + description: "A discrete value that the characteristic can take on" + type: "string" + ResourceSpecificationRef: + description: "A list of resourceSpec identified to deliver the service.\nfor nbi\ + \ we retrieve resource information available in service description (through\ + \ SDC api) bu as well information retrieved in the TOSCA file." + type: "object" + properties: + id: + description: "Unique identifier of the resource specification - filled with\ + \ resourceUUID" + type: "string" + version: + description: "Version for this resource specification - filled with resourceVersion" + type: "string" + name: + description: "Name of the resource specification - filled with resourceName" + type: "string" + '@type': + description: "This attribute allows to dynamically extends TMF class. Valued\ + \ with: 'ONAPresource'. We used this features to add following attributes:\n\ + resourceInstanceName\nresourceInvariantUUID\nresourceType\nmodelCustomizationName\n\ + modelCustomizationId" + type: "string" + default: "ONAPresource" + resourceInstanceName: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @type - resourceInstanceName" + type: "string" + resourceInvariantUUID: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @type - resourceInvariantUUID" + type: "string" + resourceType: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @type - resoucreType" + type: "string" + modelCustomizationName: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @type - Retrieved in the TOSCA file : attribute name in topology_template/node_template\ + \ for the resource" + type: "string" + modelCustomizationId: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @type - Retrieved in the TOSCA file : attribute customizationUUID in topology_template/node_template\ + \ for the resource" + type: "string" + TargetServiceSchemaRef: + description: "" + required: + - "@type" + - "@schemaLocation" + type: "object" + properties: + '@type': + description: "" + type: "string" + '@schemaLocation': + description: "" + type: "string" diff --git a/docs/offeredapis/swaggers/serviceInventory_3_0_0.json b/docs/offeredapis/swaggers/serviceInventory_3_0_0.json new file mode 100644 index 0000000..3a5bfc1 --- /dev/null +++ b/docs/offeredapis/swaggers/serviceInventory_3_0_0.json @@ -0,0 +1,614 @@ + +{ + "swagger": "2.0", + "info": { + "description": "serviceInventory API designed for ONAP Casablanca Release.\nThis API is build from TMF open API18.0 (applying TMF Guideline 3.0)\nonly operation GET (by id & byList) for resource serviceSpecification is available", + "version": "3.0.0", + "title": "API ServiceInventory", + "x-logo": { + "url": "/redoc/logo.png", + "backgroundColor": "#FFFFFF" + } + }, + + "host": "serverRoot", + "basePath": "/nbi/api/v3", + "schemes": [ + "https" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "tags": [ + + { + "name": "Service", + "description": "" + } + ], + "paths": { + "/service": { + "get": { + "tags": [ + "Service" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "operationId": "serviceFind", + "summary": "List services", + "description": "This operation list service entities. \nAttribute selection is restricted. \nfields attribute may be used to filter retrieved attribute(s) for each service\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n", + "deprecated": false, + + "parameters": [ + + { + "name": "relatedParty.id", + "required": false, + "in": "query", + "description": "", + + "type": "string" + }, + { + "name": "serviceSpecification.id", + "required": false, + "in": "query", + "description": "", + + "type": "string" + }, + { + "name": "serviceSpecification.name", + "required": false, + "in": "query", + "description": "", + + "type": "string" + }, + { + "name": "id", + "required": false, + "in": "query", + "description": "", + + "type": "string" + }, + { + "name": "fields", + "required": false, + "in": "query", + "description": "", + + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ListService" + } + } + + }, + "400": { + + "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "401": { + + "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "403": { + + "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "404": { + + "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "422": { + + "description": "Unprocessable entity\n\nFunctional error", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "500": { + + "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "503": { + + "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + } + } + } + }, + "/service/{id}": { + "get": { + "tags": [ + "Service" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "operationId": "serviceGet", + "summary": "Retrieve a service", + "description": "This operation retrieves a service entity. \nAttribute selection is enabled for all first level attributes.\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n", + "deprecated": false, + + "parameters": [ + + { + "name": "id", + "in": "path", + "required": true, + "type": "string", + "description": "" + }, + { + "name": "relatedParty.id", + "required": false, + "in": "query", + "description": "", + + "type": "string" + }, + { + "name": "serviceSpecification.id", + "required": false, + "in": "query", + "description": "", + + "type": "string" + }, + { + "name": "serviceSpecification.name", + "required": false, + "in": "query", + "description": "", + + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Service" + } + + }, + "400": { + + "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "401": { + + "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "403": { + + "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "404": { + + "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "422": { + + "description": "Unprocessable entity\n\nFunctional error", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "500": { + + "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "503": { + + "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + } + } + } + } + }, +"definitions": { + + + "ErrorRepresentation": { + "description": "This class is used to describe error.\nfor nbi Beijing release we do not manage additional error for serviceCatalog", + + + "required": [ + + "code", + "reason" + ], + "type": "object", + "properties": { + "code": { + "description": "Application related code (as defined in the API or from a common list)", + "type": "integer", + "format": "int32" + }, + "reason": { + "description": "Text that explains the reason for error. This can be shown to a client user.", + "type": "string" + }, + "message": { + "description": "Text that provide more details and corrective actions related to the error. This can be shown to a client user.", + "type": "string" + }, + "status": { + "description": "http error code extension like 400-2", + "type": "string" + }, + "referenceError": { + "description": "url pointing to documentation describing the error", + "type": "string" + }, + "@type": { + "description": "The class type of a REST resource.", + "type": "string" + }, + "@schemaLocation": { + "description": "it provides a link to the schema describing a REST resource.", + "type": "string" + } + } + + }, + + "Service": { + "description": "Instantiated service (service_instance) in AAI", + + + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the service - Valued with service-instance-id", + "type": "string" + }, + "href": { + "description": "Reference of the service\nNot managed in Beijing release", + "type": "string" + }, + "name": { + "description": "Name of the service - Valued with service-instance-name", + "type": "string" + }, + "type": { + "description": "Service type - valued with 'service-instance'", + "type": "string" + }, + "state": { + "description": "State of the service. Not managed in Beijing release", + "type": "string" + }, + "hasStarted": { + "description": "This is a Boolean attribute that, if TRUE, signifies that this Service has already been started. If the value of this attribute is FALSE, then this signifies that this Service has NOT been Started\nNot managed in Beijing release", + "type": "boolean" + }, + "@type": { + "description": "This attribute allows to dynamically extends TMF class. Not used in Beijing release.", + "type": "string" + }, + "@baseType": { + "description": "Not managed in Beijing release", + "type": "string" + }, + "@schemaLocation": { + "description": "Not managed in Beijing release", + "type": "string" + }, + "serviceSpecification": { + + "$ref": "#/definitions/ServiceSpecificationRef" + }, + "characteristic": { + + "type": "array", + "items": { + "$ref": "#/definitions/ServiceCharacteristic" + } + }, + "supportingResource": { + + "type": "array", + "items": { + "$ref": "#/definitions/SupportingResource" + } + }, + "relatedParty": { + + "type": "array", + "items": { + "$ref": "#/definitions/RelatedPartyRef" + } + } + } + + }, + + "ServiceSpecificationRef": { + "description": "Service specification reference: ServiceSpecification of this service (catalog information)", + + + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the service specification. valued to model-version-id", + "type": "string" + }, + "href": { + "description": "Reference of the service specification.\nnot managed in Beijing release.", + "type": "string" + }, + "name": { + "description": "Name of the required service specification", + "type": "string" + }, + "version": { + "description": "Service specification version.\nNot managed in Beijing release", + "type": "string" + }, + "@referredType": { + "description": "This attribute allows to dynamically extends TMF class. Valued with 'ONAPservice'. We used this features to add following attribute: invariantUUID", + "type": "string" + }, + "@schemaLocation": { + "description": "Not managed in Beijing release", + "type": "string" + }, + "invariantUUID": { + "description": "Additional attribute (not in the TMF API) - extended through @referredType - model-invariant-id", + "type": "string" + } + } + + }, + + "ServiceCharacteristic": { + "description": "A list of name value pairs that define the service characteristics\nNot managed in Beijing release.", + + + "required": [ + + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "Name of the characteristic\nNot managed in Beijing release.", + "type": "string" + }, + "valueType": { + "description": "Type of value for this characteristic.\nNot managed in Beijing release.", + "type": "string" + }, + "value": { + + "$ref": "#/definitions/Value" + } + } + + }, + + "SupportingResource": { + "description": "Supporting resource - A supportingResource will be retrieved for each relationship of the relationship-list where related-link describe a vnf", + + + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the supporting resource - Valued to vnf-id", + "type": "string" + }, + "href": { + "description": "Reference of the supporting resource", + "type": "string" + }, + "role": { + "description": "Not managed in Beijing release.", + "type": "string" + }, + "name": { + "description": "Name of the supporting resource - Valued with vnf_-name", + "type": "string" + }, + "@referredType": { + "description": "This attribute allows to dynamically extends TMF class. Valued with 'ONAP resource'. We used this features to add following attributes:\n status\t\n modelInvariantId\n modelVersionId\n modelCustomisationId", + "type": "string" + }, + "@schemaLocation": { + "description": "Not managed in Beijing release.", + "type": "string" + }, + "status": { + "description": "Additional attribute (not in the TMF API) - extended through @referredType - valued with prov-status", + "type": "string" + }, + "modelInvariantId": { + "description": "Additional attribute (not in the TMF API) - extended through @referredType - valued with model-invariant-id", + "type": "string" + }, + "modelVersionId": { + "description": "Additional attribute (not in the TMF API) - extended through @referredType - valued with model-verson-id", + "type": "string" + }, + "modelCustomisationId": { + "description": "Additional attribute (not in the TMF API) - extended through @referredType - valued with model-customisation-id", + "type": "string" + } + } + + }, + + "RelatedPartyRef": { + "description": "RelatedParty reference. A related party defines party or party role linked to a specific entity.\nOnly ONAP Customer is managed in Beijing release.", + + + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of a related party", + "type": "string" + }, + "href": { + "description": "Reference of a related party.\nNot filled in Beijing release.", + "type": "string" + }, + "role": { + "description": "Role played by the related party.\nFilled with 'ONAPcustomer'", + "type": "string" + }, + "@referredType": { + "description": "Not managed in the Beijing release.", + "type": "string" + } + } + + }, + + "Value": { + "description": "Structure used to describe characteristic value.\nNot managed in Beijing release.", + + + "type": "object", + "properties": { + "@type": { + "description": "Not managed in Beijing release.", + "type": "string" + }, + "@schemaLocation": { + "description": "Not managed in Beijing release.", + "type": "string" + }, + "serviceCharacteristicValue": { + "description": "Not managed in Beijing release.", + "type": "string" + } + } + + }, + + "ListRelatedPartyRef": { + "description": "This class is used to structure list of service(s) retrieved", + + + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of a related party", + "type": "string" + }, + "role": { + "description": "Role played by the related party - only role “ONAPcustomer” is managed in Beijing release.", + "type": "string" + } + } + + }, + + "ListServiceSpecificationRef": { + "description": "This class is used to structure list of service(s) retrieved", + + + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the service specification", + "type": "string" + }, + "name": { + "description": "Name of the required service specification", + "type": "string" + } + } + + }, + + "ListService": { + "description": "This class is used to structure list of service(s) retrieved", + + + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the service", + "type": "string" + }, + "name": { + "description": "Name of the service", + "type": "string" + }, + "serviceSpecification": { + + "$ref": "#/definitions/ListServiceSpecificationRef" + }, + "relatedParty": { + + "$ref": "#/definitions/ListRelatedPartyRef" + } + } + + } + } +} +
\ No newline at end of file diff --git a/docs/offeredapis/swaggers/serviceInventory_3_0_0.yaml b/docs/offeredapis/swaggers/serviceInventory_3_0_0.yaml new file mode 100644 index 0000000..dd1097f --- /dev/null +++ b/docs/offeredapis/swaggers/serviceInventory_3_0_0.yaml @@ -0,0 +1,419 @@ +swagger: "2.0" +info: + description: "serviceInventory API designed for ONAP Casablanca Release.\nThis API\ + \ is build from TMF open API18.0 (applying TMF Guideline 3.0)\nonly operation\ + \ GET (by id & byList) for resource serviceSpecification is available" + version: "3.0.0" + title: "API ServiceInventory" + x-logo: + url: "/redoc/logo.png" + backgroundColor: "#FFFFFF" +host: "serverRoot" +basePath: "/nbi/api/v3" +schemes: +- "https" +produces: +- "application/json;charset=utf-8" +tags: +- name: "Service" + description: "" +paths: + /service: + get: + tags: + - "Service" + produces: + - "application/json;charset=utf-8" + operationId: "serviceFind" + summary: "List services" + description: "This operation list service entities. \nAttribute selection is\ + \ restricted. \nfields attribute may be used to filter retrieved attribute(s)\ + \ for each service\n\nSpecific business errors for current operation will\ + \ be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n" + deprecated: false + parameters: + - name: "relatedParty.id" + required: false + in: "query" + description: "" + type: "string" + - name: "serviceSpecification.id" + required: false + in: "query" + description: "" + type: "string" + - name: "serviceSpecification.name" + required: false + in: "query" + description: "" + type: "string" + - name: "id" + required: false + in: "query" + description: "" + type: "string" + - name: "fields" + required: false + in: "query" + description: "" + type: "string" + responses: + 200: + description: "Success" + schema: + type: "array" + items: + $ref: "#/definitions/ListService" + 400: + description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ + \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ + \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ + \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ + \ parameter value" + schema: + $ref: "#/definitions/ErrorRepresentation" + 401: + description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ + \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" + schema: + $ref: "#/definitions/ErrorRepresentation" + 403: + description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ + \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ + \ requests" + schema: + $ref: "#/definitions/ErrorRepresentation" + 404: + description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ + \ not found" + schema: + $ref: "#/definitions/ErrorRepresentation" + 422: + description: "Unprocessable entity\n\nFunctional error" + schema: + $ref: "#/definitions/ErrorRepresentation" + 500: + description: "Internal Server Error\n\nList of supported error codes:\n\ + - 1: Internal error" + schema: + $ref: "#/definitions/ErrorRepresentation" + 503: + description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ + \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ + \ retry later !" + schema: + $ref: "#/definitions/ErrorRepresentation" + /service/{id}: + get: + tags: + - "Service" + produces: + - "application/json;charset=utf-8" + operationId: "serviceGet" + summary: "Retrieve a service" + description: "This operation retrieves a service entity. \nAttribute selection\ + \ is enabled for all first level attributes.\n\nSpecific business errors for\ + \ current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable\ + \ entity\n" + deprecated: false + parameters: + - name: "id" + in: "path" + required: true + type: "string" + description: "" + - name: "relatedParty.id" + required: false + in: "query" + description: "" + type: "string" + - name: "serviceSpecification.id" + required: false + in: "query" + description: "" + type: "string" + - name: "serviceSpecification.name" + required: false + in: "query" + description: "" + type: "string" + responses: + 200: + description: "Success" + schema: + $ref: "#/definitions/Service" + 400: + description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ + \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ + \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ + \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ + \ parameter value" + schema: + $ref: "#/definitions/ErrorRepresentation" + 401: + description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ + \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" + schema: + $ref: "#/definitions/ErrorRepresentation" + 403: + description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ + \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ + \ requests" + schema: + $ref: "#/definitions/ErrorRepresentation" + 404: + description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ + \ not found" + schema: + $ref: "#/definitions/ErrorRepresentation" + 422: + description: "Unprocessable entity\n\nFunctional error" + schema: + $ref: "#/definitions/ErrorRepresentation" + 500: + description: "Internal Server Error\n\nList of supported error codes:\n\ + - 1: Internal error" + schema: + $ref: "#/definitions/ErrorRepresentation" + 503: + description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ + \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ + \ retry later !" + schema: + $ref: "#/definitions/ErrorRepresentation" +definitions: + ErrorRepresentation: + description: "This class is used to describe error.\nfor nbi Beijing release we\ + \ do not manage additional error for serviceCatalog" + required: + - "code" + - "reason" + type: "object" + properties: + code: + description: "Application related code (as defined in the API or from a common\ + \ list)" + type: "integer" + format: "int32" + reason: + description: "Text that explains the reason for error. This can be shown to\ + \ a client user." + type: "string" + message: + description: "Text that provide more details and corrective actions related\ + \ to the error. This can be shown to a client user." + type: "string" + status: + description: "http error code extension like 400-2" + type: "string" + referenceError: + description: "url pointing to documentation describing the error" + type: "string" + '@type': + description: "The class type of a REST resource." + type: "string" + '@schemaLocation': + description: "it provides a link to the schema describing a REST resource." + type: "string" + Service: + description: "Instantiated service (service_instance) in AAI" + type: "object" + properties: + id: + description: "Unique identifier of the service - Valued with service-instance-id" + type: "string" + href: + description: "Reference of the service\nNot managed in Beijing release" + type: "string" + name: + description: "Name of the service - Valued with service-instance-name" + type: "string" + type: + description: "Service type - valued with 'service-instance'" + type: "string" + state: + description: "State of the service. Not managed in Beijing release" + type: "string" + hasStarted: + description: "This is a Boolean attribute that, if TRUE, signifies that this\ + \ Service has already been started. If the value of this attribute is FALSE,\ + \ then this signifies that this Service has NOT been Started\nNot managed\ + \ in Beijing release" + type: "boolean" + '@type': + description: "This attribute allows to dynamically extends TMF class. Not\ + \ used in Beijing release." + type: "string" + '@baseType': + description: "Not managed in Beijing release" + type: "string" + '@schemaLocation': + description: "Not managed in Beijing release" + type: "string" + serviceSpecification: + $ref: "#/definitions/ServiceSpecificationRef" + characteristic: + type: "array" + items: + $ref: "#/definitions/ServiceCharacteristic" + supportingResource: + type: "array" + items: + $ref: "#/definitions/SupportingResource" + relatedParty: + type: "array" + items: + $ref: "#/definitions/RelatedPartyRef" + ServiceSpecificationRef: + description: "Service specification reference: ServiceSpecification of this service\ + \ (catalog information)" + type: "object" + properties: + id: + description: "Unique identifier of the service specification. valued to model-version-id" + type: "string" + href: + description: "Reference of the service specification.\nnot managed in Beijing\ + \ release." + type: "string" + name: + description: "Name of the required service specification" + type: "string" + version: + description: "Service specification version.\nNot managed in Beijing release" + type: "string" + '@referredType': + description: "This attribute allows to dynamically extends TMF class. Valued\ + \ with 'ONAPservice'. We used this features to add following attribute:\ + \ invariantUUID" + type: "string" + '@schemaLocation': + description: "Not managed in Beijing release" + type: "string" + invariantUUID: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @referredType - model-invariant-id" + type: "string" + ServiceCharacteristic: + description: "A list of name value pairs that define the service characteristics\n\ + Not managed in Beijing release." + required: + - "name" + type: "object" + properties: + name: + description: "Name of the characteristic\nNot managed in Beijing release." + type: "string" + valueType: + description: "Type of value for this characteristic.\nNot managed in Beijing\ + \ release." + type: "string" + value: + $ref: "#/definitions/Value" + SupportingResource: + description: "Supporting resource - A supportingResource will be retrieved for\ + \ each relationship of the relationship-list where related-link describe a vnf" + type: "object" + properties: + id: + description: "Unique identifier of the supporting resource - Valued to vnf-id" + type: "string" + href: + description: "Reference of the supporting resource" + type: "string" + role: + description: "Not managed in Beijing release." + type: "string" + name: + description: "Name of the supporting resource - Valued with vnf_-name" + type: "string" + '@referredType': + description: "This attribute allows to dynamically extends TMF class. Valued\ + \ with 'ONAP resource'. We used this features to add following attributes:\n\ + \ status\t\n modelInvariantId\n modelVersionId\n modelCustomisationId" + type: "string" + '@schemaLocation': + description: "Not managed in Beijing release." + type: "string" + status: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @referredType - valued with prov-status" + type: "string" + modelInvariantId: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @referredType - valued with model-invariant-id" + type: "string" + modelVersionId: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @referredType - valued with model-verson-id" + type: "string" + modelCustomisationId: + description: "Additional attribute (not in the TMF API) - extended through\ + \ @referredType - valued with model-customisation-id" + type: "string" + RelatedPartyRef: + description: "RelatedParty reference. A related party defines party or party role\ + \ linked to a specific entity.\nOnly ONAP Customer is managed in Beijing release." + type: "object" + properties: + id: + description: "Unique identifier of a related party" + type: "string" + href: + description: "Reference of a related party.\nNot filled in Beijing release." + type: "string" + role: + description: "Role played by the related party.\nFilled with 'ONAPcustomer'" + type: "string" + '@referredType': + description: "Not managed in the Beijing release." + type: "string" + Value: + description: "Structure used to describe characteristic value.\nNot managed in\ + \ Beijing release." + type: "object" + properties: + '@type': + description: "Not managed in Beijing release." + type: "string" + '@schemaLocation': + description: "Not managed in Beijing release." + type: "string" + serviceCharacteristicValue: + description: "Not managed in Beijing release." + type: "string" + ListRelatedPartyRef: + description: "This class is used to structure list of service(s) retrieved" + type: "object" + properties: + id: + description: "Unique identifier of a related party" + type: "string" + role: + description: "Role played by the related party - only role “ONAPcustomer”\ + \ is managed in Beijing release." + type: "string" + ListServiceSpecificationRef: + description: "This class is used to structure list of service(s) retrieved" + type: "object" + properties: + id: + description: "Unique identifier of the service specification" + type: "string" + name: + description: "Name of the required service specification" + type: "string" + ListService: + description: "This class is used to structure list of service(s) retrieved" + type: "object" + properties: + id: + description: "Unique identifier of the service" + type: "string" + name: + description: "Name of the service" + type: "string" + serviceSpecification: + $ref: "#/definitions/ListServiceSpecificationRef" + relatedParty: + $ref: "#/definitions/ListRelatedPartyRef" diff --git a/docs/offeredapis/swaggers/serviceOrder_3_0_0.json b/docs/offeredapis/swaggers/serviceOrder_3_0_0.json new file mode 100644 index 0000000..47a0113 --- /dev/null +++ b/docs/offeredapis/swaggers/serviceOrder_3_0_0.json @@ -0,0 +1,2062 @@ + +{ + "swagger": "2.0", + "info": { + "description": "serviceOrder API designed for ONAP Casablanca release.\nThis API is build from TMF open API18.0 (applying TMF Guideline 3.0);\nOnly operations GET (by id and list) and POST are available.", + "version": "3.0.0", + "title": "API ServiceOrder", + "x-logo": { + "url": "/redoc/logo.png", + "backgroundColor": "#FFFFFF" + } + }, + + "host": "serverRoot", + "basePath": "/nbi/api/v3", + "schemes": [ + "https" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "tags": [ + + { + "name": "ServiceOrder", + "description": "A Service Order is a type of order which can be used to describe a group of operations on service – one service order item per service. An action at the level of the service order item describe the operation to be done on a service (add, terminate for example). The service order is triggered from the BSS system in charge of the product order management to ONAP that will manage the service fulfillment." + }, + { + "name": "Hub", + "description": "" + }, + { + "name": "Notification", + "description": "" + } + ], + "paths": { + "/serviceOrder": { + "post": { + "tags": [ + "ServiceOrder" + ], + "consumes": [ + "application/json;charset=utf-8" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "operationId": "serviceOrderCreate", + "summary": "Create a service order", + "description": "This operation creates a service order entity.\nThe TMF Open API specification document provides the list of mandatory and non mandatory attributes when creating a ServiceOrder, including any possible rule conditions and applicable default values.\nPOST should be used without specifying the id and the href, the Service Order Management system is in charge of generating the id + href for the ServiceOrder.\n\nIn Beijing Release, NBI will use only POST {{url}}/ecomp/mso/infra/serviceInstances/v4 SO API. This mean that only the 'service-instance' level will be created in AAI. Additional resource like VNF and/OR VF are not created.\n\nIn Casablanca release, NBI has been improved to also be able to use POST {{url}}/e2eServiceInstances/v3 SO API. This API is able to instantiate in ONAP E2E service; This is useful for CCVPN and VoLTE UC.\nDepending on the service category defined in SDC, NBI will use one or the other SO API. If category starts with e2e, NBI will use {url}}/e2eServiceInstances/v3 SO API - else it will use {{url}}/ecomp/mso/infra/serviceInstances/v4 SO API.\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n\n - 100: OrderItem with 'add' action but serviceSpecification id missing\n \n - 101: OrderItem with 'change'/'noChange'/'remove' but service id missing\n \n - 102: OrderItem with 'add' action - serviceSpecification id provided but not existing\n \n - 103: OrderItem with 'add' action but service id already existing in the inventory\n \n - 104: A customer for existing service(s) is provided but he did not exist\n \n - 105: OrderItem with 'change'/'noChange'/'remove' - Service id provided but it is not existing in the inventory\n \n - 106: [Not managed for current Relese] Issue with lcpCloudRegionId and tenantId provided\n ", + "deprecated": false, + + "parameters": [ + + { + "name": "serviceOrder", + "required": true, + "in": "body", + "description": "", + "schema": { + "$ref": "#/definitions/CreateServiceOrder" + } + } + ], + "responses": { + "201": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ServiceOrder" + } + + }, + "400": { + + "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "401": { + + "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "403": { + + "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "404": { + + "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "422": { + + "description": "Unprocessable entity\n\nFunctional error\n\nSpecific encapsulated business errors for current operation\n\n - 100: OrderItem with 'add' action but serviceSpecification id missing\n \n - 101: OrderItem with 'change'/'noChange'/'remove' but service id missing\n \n - 102: OrderItem with 'add' action - serviceSpecification id provided but not existing\n \n - 103: OrderItem with 'add' action but service id already existing in the inventory\n \n - 104: A customer for existing service(s) is provided but he did not exist\n \n - 105: OrderItem with 'change'/'noChange'/'remove' - Service id provided but it is not existing in the inventory\n \n - 106: [Not managed for current Relese] Issue with lcpCloudRegionId and tenantId provided\n ", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "500": { + + "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "503": { + + "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + } + } + }, + "get": { + "tags": [ + "ServiceOrder" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "operationId": "serviceOrderFind", + "summary": "List service orders", + "description": "Retrieve and list service order entities according to given criteria.\nOnly a predefined set of attribute is proposed.\nAttribute selection could be described in the fields attribute.\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n", + "deprecated": false, + + "parameters": [ + + { + "name": "externalId", + "required": false, + "in": "query", + "description": "", + + "type": "string" + }, + { + "name": "state", + "required": false, + "in": "query", + "description": "state of the order(s) to be retrieved", + + "type": "string" + }, + { + "name": "description", + "required": false, + "in": "query", + "description": "", + + "type": "string" + }, + { + "name": "orderDate.gt", + "required": false, + "in": "query", + "description": "order date greather than", + + "type": "string" + }, + { + "name": "orderDate.lt", + "required": false, + "in": "query", + "description": "order date lower than", + + "type": "string" + }, + { + "name": "fields", + "required": false, + "in": "query", + "description": "this attribute could be used to filter retrieved attribute(s) and/or sort SO.", + + "type": "string" + }, + { + "name": "offset", + "required": false, + "in": "query", + "description": "The index of the first element to retrieve. Zero is the first element of the collection.", + + "type": "integer", + "format": "int32" + }, + { + "name": "limit", + "required": false, + "in": "query", + "description": "The maximum number of elements to retrieve (it can be greater than the actual available number of items).", + + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceOrder" + } + }, + "headers": { + "X-Total-Count": { + "description": "", + "type": "integer", + "format": "int32" + }, + "X-Result-Count": { + "description": "", + "type": "integer", + "format": "int32" + } + } + + }, + "400": { + + "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "401": { + + "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "403": { + + "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "404": { + + "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "422": { + + "description": "Unprocessable entity\n\nFunctional error", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "500": { + + "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "503": { + + "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + } + } + } + }, + "/serviceOrder/{id}": { + "get": { + "tags": [ + "ServiceOrder" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "operationId": "serviceOrderGet", + "summary": "Retrieve a service order", + "description": "This operation retrieves a service order entity. \nAttribute selection is enabled for all first level attributes.\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n", + "deprecated": false, + + "parameters": [ + + { + "name": "id", + "in": "path", + "required": true, + "type": "string", + "description": "" + }, + { + "name": "fields", + "required": false, + "in": "query", + "description": "Attribute selection", + + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ServiceOrder" + } + + }, + "400": { + + "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "401": { + + "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "403": { + + "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "404": { + + "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "422": { + + "description": "Unprocessable entity\n\nFunctional error", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "500": { + + "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "503": { + + "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + } + } + } + }, + "/hub": { + "post": { + "tags": [ + "Hub" + ], + "consumes": [ + "application/json;charset=utf-8" + ], + "operationId": "hubCreate", + "summary": "Create Hub", + "description": "\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n", + "deprecated": false, + + "parameters": [ + + { + "name": "Hub", + "required": true, + "in": "body", + "description": "", + "schema": { + "$ref": "#/definitions/CreateHub" + } + } + ], + "responses": { + "201": { + "description": "Success", + "schema": { + "type": "file" + }, + "headers": { + "location": { + "description": "", + "type": "string" + } + } + + }, + "400": { + + "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "401": { + + "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "403": { + + "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "404": { + + "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "422": { + + "description": "Unprocessable entity\n\nFunctional error", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "500": { + + "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "503": { + + "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + } + } + }, + "get": { + "tags": [ + "Hub" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "operationId": "hubFind", + "summary": "Retrieve a lits of hub", + "description": "\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n", + "deprecated": false, + + "parameters": [ + + { + "name": "id", + "required": false, + "in": "query", + "description": "", + + "type": "string" + }, + { + "name": "eventType", + "required": false, + "in": "query", + "description": "", + + "type": "string", + "enum": [ + "ServiceOrderCreationNotification", + "ServiceOrderStateChangeNotification", + "ServiceOrderItemStateChangeNotification"] + + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Hub" + } + } + + }, + "400": { + + "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "401": { + + "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "403": { + + "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "404": { + + "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "422": { + + "description": "Unprocessable entity\n\nFunctional error", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "500": { + + "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "503": { + + "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + } + } + } + }, + "/hub/{hubId}": { + "get": { + "tags": [ + "Hub" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "operationId": "hubGet", + "summary": "Retrieve an HUB by id", + "description": "Retrieve an HUB by id\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n", + "deprecated": false, + + "parameters": [ + + { + "name": "hubId", + "in": "path", + "required": true, + "type": "string", + "description": "" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Hub" + } + + }, + "400": { + + "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "401": { + + "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "403": { + + "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "404": { + + "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "422": { + + "description": "Unprocessable entity\n\nFunctional error", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "500": { + + "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "503": { + + "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + } + } + }, + "delete": { + "tags": [ + "Hub" + ], + "operationId": "hubDelete", + "summary": "delete hub", + "description": "\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n", + "deprecated": false, + + "parameters": [ + + { + "name": "hubId", + "in": "path", + "required": true, + "type": "string", + "description": "" + } + ], + "responses": { + "204": { + "description": "Success" + + }, + "400": { + + "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "401": { + + "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "403": { + + "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "404": { + + "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "422": { + + "description": "Unprocessable entity\n\nFunctional error", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "500": { + + "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "503": { + + "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + } + } + } + }, + "/notification/serviceOrderCreationNotification": { + "post": { + "tags": [ + "Notification" + ], + "consumes": [ + "application/json;charset=utf-8" + ], + "operationId": "notificationServiceOrderCreationNotification", + "summary": "Service order creation notification", + "description": "Service order creation notification\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n", + "deprecated": false, + + "parameters": [ + + { + "name": "serviceOrderCreationNotification", + "required": true, + "in": "body", + "description": "", + "schema": { + "$ref": "#/definitions/ServiceOrderCreationNotification" + } + } + ], + "responses": { + "204": { + "description": "Success" + + }, + "400": { + + "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "401": { + + "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "403": { + + "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "404": { + + "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "422": { + + "description": "Unprocessable entity\n\nFunctional error", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "500": { + + "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "503": { + + "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + } + } + } + }, + "/notification/serviceOrderStateChangeNotification": { + "post": { + "tags": [ + "Notification" + ], + "consumes": [ + "application/json;charset=utf-8" + ], + "operationId": "notificationServiceOrderStateChangeNotification", + "summary": "Service order state change notification description", + "description": "\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n", + "deprecated": false, + + "parameters": [ + + { + "name": "serviceOrderstateChangeNotification", + "required": true, + "in": "body", + "description": "", + "schema": { + "$ref": "#/definitions/ServiceOrderStateChangeNotification" + } + } + ], + "responses": { + "204": { + "description": "Success" + + }, + "400": { + + "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "401": { + + "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "403": { + + "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "404": { + + "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "422": { + + "description": "Unprocessable entity\n\nFunctional error", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "500": { + + "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "503": { + + "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + } + } + } + }, + "/notification/serviceOrderItemStateChangeNotification": { + "post": { + "tags": [ + "Notification" + ], + "consumes": [ + "application/json;charset=utf-8" + ], + "operationId": "notificationServiceOrderItemStateChangeNotification", + "summary": "ServiceOrder Item State Change Notification description", + "description": "\n\nSpecific business errors for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n", + "deprecated": false, + + "parameters": [ + + { + "name": "serviceOrderItemStateChangeNotification", + "required": true, + "in": "body", + "description": "", + "schema": { + "$ref": "#/definitions/ServiceOrderItemStateChangeNotification" + } + } + ], + "responses": { + "204": { + "description": "Success" + + }, + "400": { + + "description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "401": { + + "description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "403": { + + "description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "404": { + + "description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "422": { + + "description": "Unprocessable entity\n\nFunctional error", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "500": { + + "description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + }, + "503": { + + "description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !", + "schema": { + + "$ref": "#/definitions/ErrorRepresentation" + } + } + } + } + } + }, +"definitions": { + + "ActionType": { + "description": "Action type to be describer on the order item.\nmodify is not managed in Beijing release", + + "type": "string", + "enum": [ + "add", + "modify", + "delete", + "noChange"] + + }, + "StateType": { + "description": "List of possible state for the order and the orderItem.", + + "type": "string", + "enum": [ + "acknowledged", + "rejected", + "pending", + "held", + "inProgress", + "cancelled", + "completed", + "failed", + "partial"] + + }, + "RelationshipType": { + "description": "Relationship type;\nOnly reliesOn is managed in Beijing release.", + + "type": "string", + "enum": [ + "reliesOn"] + + }, + "EventType": { + "description": "", + + "type": "string", + "enum": [ + "ServiceOrderCreationNotification", + "ServiceOrderStateChangeNotification", + "ServiceOrderItemStateChangeNotification"] + + }, + "SeverityMessage": { + "description": "", + + "type": "string", + "enum": [ + "information", + "error"] + + }, + + "ErrorRepresentation": { + "description": "Representation of an error.", + + + "required": [ + + "code", + "reason" + ], + "type": "object", + "properties": { + "code": { + "description": "Application related code (as defined in the API or from a common list)", + "type": "integer", + "format": "int32" + }, + "reason": { + "description": "Text that explains the reason for error. This can be shown to a client user.", + "type": "string" + }, + "message": { + "description": "Text that provide more details and corrective actions related to the error. This can be shown to a client user", + "type": "string" + }, + "status": { + "description": "http error code extension like 400-2", + "type": "string" + }, + "referenceError": { + "description": "url pointing to documentation describing the error", + "type": "string" + }, + "@type": { + "description": "The class type of a REST resource", + "type": "string" + }, + "@schemaLocation": { + "description": "it provides a link to the schema describing a REST resource", + "type": "string" + } + } + + }, + + "ServiceRelationship": { + "description": "Linked Services to the one instantiate\nnbi component used this relationship to sort request to ONAP.", + + + "required": [ + + "type", + "service" + ], + "type": "object", + "properties": { + "type": { + + "$ref": "#/definitions/RelationshipType" + }, + "service": { + + "$ref": "#/definitions/Service" + } + } + + }, + + "ServiceRef": { + "description": "Service references", + + + "required": [ + + "id" + ], + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the service", + "type": "string" + }, + "href": { + "description": "Reference of the service", + "type": "string" + } + } + + }, + + "ServiceCharacteristic": { + "description": "ServiceCharacteristic", + + + "required": [ + + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "Name of characteristic", + "type": "string" + }, + "valueType": { + "description": "", + "type": "string" + }, + "value": { + + "$ref": "#/definitions/Value" + } + } + + }, + + "RelatedParty": { + "description": "A related party defines party which are involved in this order and the role they are playing.\nfor Beijing release:\nWith the current version of APIs used from SO and AAI we need to manage a ‘customer’. This customer concept is confusing with Customer BSS concept. We took the following rules to manage the ‘customer’ information:\no\tIt could be provided through a serviceOrder in the service Order a relatedParty with role ‘ONAPcustomer’ should be provided in the serviceOrder header (we will not consider in this release the party at item level); External API component will check if this customer exists and create it in AAI if not.\no\tIf no relatedParty are provided the service will be affected to ‘generic’ customer (dummy customer) – we assume this ‘generic’ customer always exists.", + + + "required": [ + + "id", + "role" + ], + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of a related party", + "type": "string" + }, + "href": { + "description": "An hyperlink to the party - not used in Beijnig release", + "type": "string" + }, + "role": { + "description": "The role of the related party (e.g. Owner, requester, fullfiller etc).\nONLY 'ONAPcustomer' is considered", + "type": "string" + }, + "name": { + "description": "Name of the related party", + "type": "string" + }, + "@referredType": { + "description": "", + "type": "string" + } + } + + }, + + "ServiceSpecificationRef": { + "description": "The service specification (these attributes are fetched from the catalogue).", + + + "required": [ + + "id" + ], + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the service specification\nThis information will be used to retrieve SDC information + mapped to SO ModelNameVersionIdin the request.", + "type": "string" + }, + "href": { + "description": "Reference of the service specification\nNot used in Beijing release.", + "type": "string" + }, + "name": { + "description": "Name of the service specification\nNot used in Beijing release", + "type": "string" + }, + "version": { + "description": "Version of the service Specification\nNot used in Beijing release", + "type": "string" + }, + "targetServiceSchema": { + + "$ref": "#/definitions/TargetServiceSchema" + }, + "@type": { + "description": "Not used in Beijing release", + "type": "string" + }, + "@schemaLocation": { + "description": "Not used in Beijing release", + "type": "string" + }, + "@baseType": { + "description": "Not used in Beijing release", + "type": "string" + } + } + + }, + + "Service": { + "description": "Service (to be added, modified, deleted) description", + + + "required": [ + + "id" + ], + "type": "object", + "properties": { + "id": { + "description": "Identifier of a service instance.\nIt must be valued if orderItem action is 'delete' and corresponds to a AAI service.id", + "type": "string" + }, + "href": { + "description": "Reference to the Service (useful for delete or modify command).\nNot managed in Beijing release.", + "type": "string" + }, + "name": { + "description": "Name of the service - When orderItem action is 'add' this name will be used in ONAP/SO request as InstaceName.", + "type": "string" + }, + "serviceState": { + "description": "The lifecycle state of the service requested;\nNot managed in Beijing release.", + "type": "string" + }, + "@type": { + "description": "To define the service type\nNot managed in Beijing Release", + "type": "string" + }, + "@schemaLocation": { + "description": "The URL to get the resource schema.\nNot managed in Beijing Release", + "type": "string" + }, + "serviceCharacteristic": { + + "type": "array", + "items": { + "$ref": "#/definitions/ServiceCharacteristic" + } + }, + "serviceRelationship": { + + "type": "array", + "items": { + "$ref": "#/definitions/ServiceRelationship" + } + }, + "relatedParty": { + + "type": "array", + "items": { + "$ref": "#/definitions/RelatedParty" + } + }, + "serviceSpecification": { + + "$ref": "#/definitions/ServiceSpecificationRef" + } + } + + }, + + "OrderItemRelationship": { + "description": "Linked order item to the one containing this attribute.\nnbi component used this relationship to sort request to ONAP.", + + + "required": [ + + "type", + "id" + ], + "type": "object", + "properties": { + "type": { + + "$ref": "#/definitions/RelationshipType" + }, + "id": { + "description": "Unique identifier of an order item", + "type": "string" + } + } + + }, + + "ServiceOrderItem": { + "description": "An identified part of the order. A service order is decomposed into one or more order items.", + + + "required": [ + + "id", + "service" + ], + "type": "object", + "properties": { + "id": { + "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, …)", + "type": "string" + }, + "action": { + + "$ref": "#/definitions/ActionType" + }, + "state": { + + "$ref": "#/definitions/StateType" + }, + "percentProgress": { + "description": "Progress of the delivery in percentage.", + "type": "string" + }, + "@type": { + "description": "Used to extend the order item.\nnot used in Beijing relase", + "type": "string" + }, + "@schemaLocation": { + "description": "not used in Beijing relase", + "type": "string" + }, + "@baseType": { + "description": "not used in Beijing relase", + "type": "string" + }, + "orderItemRelationship": { + + "type": "array", + "items": { + "$ref": "#/definitions/OrderItemRelationship" + } + }, + "service": { + + "$ref": "#/definitions/Service" + }, + "orderItemMessage": { + + "type": "array", + "items": { + "$ref": "#/definitions/OrderMessage" + } + } + } + + }, + + "ServiceOrder": { + "description": "A Service Order is a type of order which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa", + + + "required": [ + + "id" + ], + "type": "object", + "properties": { + "id": { + "description": "ID created on repository side", + "type": "string" + }, + "href": { + "description": "Hyperlink to access the order", + "type": "string" + }, + "externalId": { + "description": "ID given by the consumer and only understandable by him (to facilitate his searches)", + "type": "string" + }, + "priority": { + "description": "A way that can be used by consumers to prioritize orders in Service Order Management system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)", + "type": "string" + }, + "description": { + "description": "A free-text description of the service order", + "type": "string" + }, + "category": { + "description": "Used to categorize the order that can be useful for the OM system (e.g. “broadband”, “TVOption”, ...)", + "type": "string" + }, + "state": { + + "$ref": "#/definitions/StateType" + }, + "orderDate": { + "description": "", + "type": "string", + "format": "date-time" + }, + "completionDateTime": { + "description": "Date when the order was completed", + "type": "string", + "format": "date-time" + }, + "requestedStartDate": { + "description": "Order start date wished by the requestor", + "type": "string", + "format": "date-time" + }, + "requestedCompletionDate": { + "description": "Requested delivery date from the requestor perspective", + "type": "string", + "format": "date-time" + }, + "expectedCompletionDate": { + "description": "", + "type": "string", + "format": "date-time" + }, + "startDate": { + "description": "Date when the order was started for processing", + "type": "string", + "format": "date-time" + }, + "@baseType": { + "description": "", + "type": "string" + }, + "@type": { + "description": "", + "type": "string" + }, + "@schemaLocation": { + "description": "", + "type": "string" + }, + "relatedParty": { + + "type": "array", + "items": { + "$ref": "#/definitions/RelatedParty" + } + }, + "orderRelationship": { + + "type": "array", + "items": { + "$ref": "#/definitions/OrderRelationship" + } + }, + "orderItem": { + + "type": "array", + "items": { + "$ref": "#/definitions/ServiceOrderItem" + } + }, + "orderMessage": { + + "type": "array", + "items": { + "$ref": "#/definitions/OrderMessage" + } + } + } + + }, + + "OrderRelationship": { + "description": "Linked order to the one containing this attribute.\nThis relationship is not used to sort ONAP request.", + + + "required": [ + + "id" + ], + "type": "object", + "properties": { + "type": { + "description": "The type of related order, can be : “dependency” if the order needs to be “not started” until another order item is complete (a service order in this case) or “cross-ref” to keep track of the source order (a productOrder)", + "type": "string" + }, + "id": { + "description": "The id of the related order", + "type": "string" + }, + "href": { + "description": "A hyperlink to the related order", + "type": "string" + }, + "@referredType": { + "description": "Type of the referred order.", + "type": "string" + } + } + + }, + + "TargetServiceSchema": { + "description": "Target to the schema describing the service spec resource", + + + "required": [ + + "@type", + "@schemaLocation" + ], + "type": "object", + "properties": { + "@type": { + "description": "Indicates the (class) type of resource.", + "type": "string" + }, + "@schemaLocation": { + "description": "This field provided a link to the schema describing this REST resource.", + "type": "string" + } + } + + }, + + "Value": { + "description": "Value is a descriptive structure for service characteristic;\nFor Beijing we only manage 'basic' attribute - the serviceCharacteristicValue must be used.", + + + "type": "object", + "properties": { + "@type": { + "description": "Indicates the (class) type of resource.\nNot used in Beijing Release", + "type": "string" + }, + "@schemaLocation": { + "description": "This field provided a link to the schema describing this REST resource.\nNot used in Beijing Release", + "type": "string" + }, + "serviceCharacteristicValue": { + "description": "Value of the characteristic.\nThis attribute must be used in Beijing Release to provide characteristic value.", + "type": "string" + } + } + + }, + + "CreateServiceOrderItem": { + "description": "This structure is used in the operation POST for a serviceOrder request to describe an item.\nAttribute description is not accurate and should be find in the serviceOrderItem class.", + + + "required": [ + + "id", + "service" + ], + "type": "object", + "properties": { + "id": { + "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, …)", + "type": "string" + }, + "action": { + + "$ref": "#/definitions/ActionType" + }, + "@type": { + "description": "Indicates the type of resource.", + "type": "string" + }, + "@schemaLocation": { + "description": "A link to the schema describing this REST resource", + "type": "string" + }, + "@baseType": { + "description": "Indicates the base type of the resource.", + "type": "string" + }, + "orderItemRelationship": { + + "type": "array", + "items": { + "$ref": "#/definitions/OrderItemRelationship" + } + }, + "service": { + + "$ref": "#/definitions/Service" + } + } + + }, + + "CreateServiceOrder": { + "description": "This structure is used in the operation POST for a serviceOrder request.\nAttribute description is not accurate and should be find in the serviceOrder class.", + + + "type": "object", + "properties": { + "externalId": { + "description": "ID given by the consumer and only understandable by him (to facilitate his searches)", + "type": "string" + }, + "priority": { + "description": "A way that can be used by consumers to prioritize orders in Service Order Management system (from 0 to 4 : 0 is the highest priority, and 4 the lowest)", + "type": "string" + }, + "description": { + "description": "A free-text description of the service order", + "type": "string" + }, + "category": { + "description": "Used to categorize the order that can be useful for the OM system (e.g. “broadband”, “TVOption”, ...)", + "type": "string" + }, + "requestedStartDate": { + "description": "Order start date wished by the requestor", + "type": "string", + "format": "date-time" + }, + "requestedCompletionDate": { + "description": "Requested delivery date from the requestor perspective", + "type": "string", + "format": "date-time" + }, + "@baseType": { + "description": "", + "type": "string" + }, + "@type": { + "description": "", + "type": "string" + }, + "@schemaLocation": { + "description": "", + "type": "string" + }, + "relatedParty": { + + "type": "array", + "items": { + "$ref": "#/definitions/RelatedParty" + } + }, + "orderRelationship": { + + "type": "array", + "items": { + "$ref": "#/definitions/OrderRelationship" + } + }, + "orderItem": { + + "type": "array", + "items": { + "$ref": "#/definitions/CreateServiceOrderItem" + } + } + } + + }, + + "Hub": { + "description": "An HUB resource is used by client side to subscribe to notification.\nNot managed in the Beijing release.", + + + "discriminator": "id", + + "required": [ + + "query", + "callback" + ], + "type": "object", + "properties": { + "id": { + "description": "Hub Id", + "type": "string" + }, + "query": { + "description": "", + "type": "string" + }, + "callback": { + "description": "Address where notification must be send", + "type": "string" + } + } + + }, + + "CreateHub": { + "description": "This structure is used as a request for POST Hub operation", + + + "required": [ + + "query", + "callback" + ], + "type": "object", + "properties": { + "query": { + "description": "The query must have an eventType=notificationName information.\nOptionally a ? could be added to reduce hub.\nquery”:”eventType = ServiceOrderStateChangeNotification”&serviceOrder.state=COMPLETED", + "type": "string" + }, + "callback": { + "description": "Address where notification must be send", + "type": "string" + } + } + + }, + + "ServiceOrderSummary": { + "description": "This structure is used to provide a subset of serviceOrder attributes to be provided in particular for notification messages", + + + "required": [ + + "id" + ], + "type": "object", + "properties": { + "id": { + "description": "ID created on repository side", + "type": "string" + }, + "href": { + "description": "Hyperlink to access the order", + "type": "string" + }, + "externalId": { + "description": "ID given by the consumer and only understandable by him (to facilitate his searches)", + "type": "string" + }, + "state": { + + "$ref": "#/definitions/StateType" + }, + "orderDate": { + "description": "", + "type": "string", + "format": "date-time" + }, + "completionDateTime": { + "description": "Date when the order was completed", + "type": "string", + "format": "date-time" + } + } + + }, + + "ServiceOrderCreationNotification": { + "description": "Notification structure for a service order creation notification", + + + "required": [ + + "eventId", + "eventDate", + "eventType", + "event" + ], + "type": "object", + "properties": { + "eventId": { + "description": "", + "type": "string" + }, + "eventDate": { + "description": "", + "type": "string", + "format": "date-time" + }, + "eventType": { + "description": "", + "type": "string", + + "default": "ServiceOrderCreationNotification" + }, + "event": { + + "$ref": "#/definitions/ServiceOrderSummary" + } + } + + }, + + "Notification": { + "description": "Used to describe notification for this API", + + + "type": "object", + "properties": { + } + + }, + + "ServiceOrderStateChangeNotification": { + "description": "Service order state change notification description", + + + "required": [ + + "eventId", + "eventDate", + "eventType", + "event" + ], + "type": "object", + "properties": { + "eventId": { + "description": "", + "type": "string" + }, + "eventDate": { + "description": "", + "type": "string", + "format": "date-time" + }, + "eventType": { + "description": "", + "type": "string", + + "default": "ServiceOrderStateChangeNotification" + }, + "event": { + + "$ref": "#/definitions/ServiceOrderSummary" + } + } + + }, + + "ServiceOrderItemSummary": { + "description": "Service Order item summary to be used for notification", + + + "required": [ + + "id", + "service" + ], + "type": "object", + "properties": { + "id": { + "description": "Identifier of the line item (generally it is a sequence number 01, 02, 03, …)", + "type": "string" + }, + "action": { + + "$ref": "#/definitions/ActionType" + }, + "state": { + + "$ref": "#/definitions/StateType" + }, + "service": { + + "$ref": "#/definitions/Service" + } + } + + }, + + "ServiceOrderSummaryWithItem": { + "description": "Service order item summary with item description", + + + "required": [ + + "id" + ], + "type": "object", + "properties": { + "id": { + "description": "ID created on repository side", + "type": "string" + }, + "href": { + "description": "Hyperlink to access the order", + "type": "string" + }, + "externalId": { + "description": "ID given by the consumer and only understandable by him (to facilitate his searches)", + "type": "string" + }, + "state": { + + "$ref": "#/definitions/StateType" + }, + "orderDate": { + "description": "", + "type": "string", + "format": "date-time" + }, + "completionDateTime": { + "description": "Date when the order was completed", + "type": "string", + "format": "date-time" + }, + "orderItem": { + + "type": "array", + "items": { + "$ref": "#/definitions/ServiceOrderItemSummary" + } + } + } + + }, + + "ServiceOrderItemStateChangeNotification": { + "description": "", + + + "required": [ + + "eventId", + "eventDate", + "eventType", + "event" + ], + "type": "object", + "properties": { + "eventId": { + "description": "", + "type": "string" + }, + "eventDate": { + "description": "", + "type": "string", + "format": "date-time" + }, + "eventType": { + "description": "", + "type": "string", + + "default": "ServiceOrderStateChangeNotification" + }, + "event": { + + "$ref": "#/definitions/ServiceOrderSummaryWithItem" + } + } + + }, + + "OrderMessage": { + "description": "An optional array of messages associated with the Order", + + + "required": [ + + "severity", + "correctionRequired" + ], + "type": "object", + "properties": { + "code": { + "description": "A code associated to this message", + "type": "string" + }, + "field": { + "description": "Service Order attribute related to this error message", + "type": "string" + }, + "messageInformation": { + "description": "Message related to this order", + "type": "string" + }, + "severity": { + + "$ref": "#/definitions/SeverityMessage" + }, + "correctionRequired": { + "description": "Indicator that an action is required to allow service order fullfilment to follow up", + "type": "boolean" + } + } + + } + } +} +
\ No newline at end of file diff --git a/docs/offeredapis/swaggers/serviceOrder_3_0_0.yaml b/docs/offeredapis/swaggers/serviceOrder_3_0_0.yaml new file mode 100644 index 0000000..db0479f --- /dev/null +++ b/docs/offeredapis/swaggers/serviceOrder_3_0_0.yaml @@ -0,0 +1,1428 @@ +swagger: "2.0" +info: + description: "serviceOrder API designed for ONAP Casablanca release.\nThis API is build from TMF open\ + \ API18.0 (applying TMF Guideline 3.0);\nOnly operations GET (by id and list)\ + \ and POST are available." + version: "3.0.0" + title: "API ServiceOrder" + x-logo: + url: "/redoc/logo.png" + backgroundColor: "#FFFFFF" +host: "serverRoot" +basePath: "/nbi/api/v3" +schemes: +- "https" +produces: +- "application/json;charset=utf-8" +tags: +- name: "ServiceOrder" + description: "A Service Order is a type of order which can be used to describe a\ + \ group of operations on service – one service order item per service. An action\ + \ at the level of the service order item describe the operation to be done on\ + \ a service (add, terminate for example). The service order is triggered from\ + \ the BSS system in charge of the product order management to ONAP that will manage\ + \ the service fulfillment." +- name: "Hub" + description: "" +- name: "Notification" + description: "" +paths: + /serviceOrder: + post: + tags: + - "ServiceOrder" + consumes: + - "application/json;charset=utf-8" + produces: + - "application/json;charset=utf-8" + operationId: "serviceOrderCreate" + summary: "Create a service order" + description: "This operation creates a service order entity.\nThe TMF Open API\ + \ specification document provides the list of mandatory and non mandatory\ + \ attributes when creating a ServiceOrder, including any possible rule conditions\ + \ and applicable default values.\nPOST should be used without specifying the\ + \ id and the href, the Service Order Management system is in charge of generating\ + \ the id + href for the ServiceOrder.\n\nIn Beijing Release, NBI will use\ + \ only POST {{url}}/ecomp/mso/infra/serviceInstances/v4 SO API. This mean\ + \ that only the 'service-instance' level will be created in AAI. Additional\ + \ resource like VNF and/OR VF are not created.\n\nIn Casablanca release, NBI\ + \ has been improved to also be able to use POST {{url}}/e2eServiceInstances/v3\ + \ SO API. This API is able to instantiate in ONAP E2E service; This is useful\ + \ for CCVPN and VoLTE UC.\nDepending on the service category defined in SDC,\ + \ NBI will use one or the other SO API. If category starts with e2e, NBI will\ + \ use {url}}/e2eServiceInstances/v3 SO API - else it will use {{url}}/ecomp/mso/infra/serviceInstances/v4\ + \ SO API.\n\nSpecific business errors for current operation will be encapsulated\ + \ in\n\nHTTP Response 422 Unprocessable entity\n\n - 100: OrderItem with 'add'\ + \ action but serviceSpecification id missing\n \n - 101: OrderItem with\ + \ 'change'/'noChange'/'remove' but service id missing\n \n - 102: OrderItem\ + \ with 'add' action - serviceSpecification id provided but not existing\n\ + \ \n - 103: OrderItem with 'add' action but service id already existing\ + \ in the inventory\n \n - 104: A customer for existing service(s) is provided\ + \ but he did not exist\n \n - 105: OrderItem with 'change'/'noChange'/'remove'\ + \ - Service id provided but it is not existing in the inventory\n \n - 106:\ + \ [Not managed for current Relese] Issue with lcpCloudRegionId and tenantId\ + \ provided\n " + deprecated: false + parameters: + - name: "serviceOrder" + required: true + in: "body" + description: "" + schema: + $ref: "#/definitions/CreateServiceOrder" + responses: + 201: + description: "Success" + schema: + $ref: "#/definitions/ServiceOrder" + 400: + description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ + \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ + \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ + \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ + \ parameter value" + schema: + $ref: "#/definitions/ErrorRepresentation" + 401: + description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ + \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" + schema: + $ref: "#/definitions/ErrorRepresentation" + 403: + description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ + \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ + \ requests" + schema: + $ref: "#/definitions/ErrorRepresentation" + 404: + description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ + \ not found" + schema: + $ref: "#/definitions/ErrorRepresentation" + 422: + description: "Unprocessable entity\n\nFunctional error\n\nSpecific encapsulated\ + \ business errors for current operation\n\n - 100: OrderItem with 'add'\ + \ action but serviceSpecification id missing\n \n - 101: OrderItem with\ + \ 'change'/'noChange'/'remove' but service id missing\n \n - 102: OrderItem\ + \ with 'add' action - serviceSpecification id provided but not existing\n\ + \ \n - 103: OrderItem with 'add' action but service id already existing\ + \ in the inventory\n \n - 104: A customer for existing service(s) is\ + \ provided but he did not exist\n \n - 105: OrderItem with 'change'/'noChange'/'remove'\ + \ - Service id provided but it is not existing in the inventory\n \n\ + \ - 106: [Not managed for current Relese] Issue with lcpCloudRegionId\ + \ and tenantId provided\n " + schema: + $ref: "#/definitions/ErrorRepresentation" + 500: + description: "Internal Server Error\n\nList of supported error codes:\n\ + - 1: Internal error" + schema: + $ref: "#/definitions/ErrorRepresentation" + 503: + description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ + \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ + \ retry later !" + schema: + $ref: "#/definitions/ErrorRepresentation" + get: + tags: + - "ServiceOrder" + produces: + - "application/json;charset=utf-8" + operationId: "serviceOrderFind" + summary: "List service orders" + description: "Retrieve and list service order entities according to given criteria.\n\ + Only a predefined set of attribute is proposed.\nAttribute selection could\ + \ be described in the fields attribute.\n\nSpecific business errors for current\ + \ operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n" + deprecated: false + parameters: + - name: "externalId" + required: false + in: "query" + description: "" + type: "string" + - name: "state" + required: false + in: "query" + description: "state of the order(s) to be retrieved" + type: "string" + - name: "description" + required: false + in: "query" + description: "" + type: "string" + - name: "orderDate.gt" + required: false + in: "query" + description: "order date greather than" + type: "string" + - name: "orderDate.lt" + required: false + in: "query" + description: "order date lower than" + type: "string" + - name: "fields" + required: false + in: "query" + description: "this attribute could be used to filter retrieved attribute(s)\ + \ and/or sort SO." + type: "string" + - name: "offset" + required: false + in: "query" + description: "The index of the first element to retrieve. Zero is the first\ + \ element of the collection." + type: "integer" + format: "int32" + - name: "limit" + required: false + in: "query" + description: "The maximum number of elements to retrieve (it can be greater\ + \ than the actual available number of items)." + type: "integer" + format: "int32" + responses: + 200: + description: "Success" + schema: + type: "array" + items: + $ref: "#/definitions/ServiceOrder" + headers: + X-Total-Count: + description: "" + type: "integer" + format: "int32" + X-Result-Count: + description: "" + type: "integer" + format: "int32" + 400: + description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ + \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ + \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ + \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ + \ parameter value" + schema: + $ref: "#/definitions/ErrorRepresentation" + 401: + description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ + \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" + schema: + $ref: "#/definitions/ErrorRepresentation" + 403: + description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ + \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ + \ requests" + schema: + $ref: "#/definitions/ErrorRepresentation" + 404: + description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ + \ not found" + schema: + $ref: "#/definitions/ErrorRepresentation" + 422: + description: "Unprocessable entity\n\nFunctional error" + schema: + $ref: "#/definitions/ErrorRepresentation" + 500: + description: "Internal Server Error\n\nList of supported error codes:\n\ + - 1: Internal error" + schema: + $ref: "#/definitions/ErrorRepresentation" + 503: + description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ + \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ + \ retry later !" + schema: + $ref: "#/definitions/ErrorRepresentation" + /serviceOrder/{id}: + get: + tags: + - "ServiceOrder" + produces: + - "application/json;charset=utf-8" + operationId: "serviceOrderGet" + summary: "Retrieve a service order" + description: "This operation retrieves a service order entity. \nAttribute selection\ + \ is enabled for all first level attributes.\n\nSpecific business errors for\ + \ current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable\ + \ entity\n" + deprecated: false + parameters: + - name: "id" + in: "path" + required: true + type: "string" + description: "" + - name: "fields" + required: false + in: "query" + description: "Attribute selection" + type: "string" + responses: + 200: + description: "Success" + schema: + $ref: "#/definitions/ServiceOrder" + 400: + description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ + \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ + \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ + \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ + \ parameter value" + schema: + $ref: "#/definitions/ErrorRepresentation" + 401: + description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ + \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" + schema: + $ref: "#/definitions/ErrorRepresentation" + 403: + description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ + \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ + \ requests" + schema: + $ref: "#/definitions/ErrorRepresentation" + 404: + description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ + \ not found" + schema: + $ref: "#/definitions/ErrorRepresentation" + 422: + description: "Unprocessable entity\n\nFunctional error" + schema: + $ref: "#/definitions/ErrorRepresentation" + 500: + description: "Internal Server Error\n\nList of supported error codes:\n\ + - 1: Internal error" + schema: + $ref: "#/definitions/ErrorRepresentation" + 503: + description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ + \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ + \ retry later !" + schema: + $ref: "#/definitions/ErrorRepresentation" + /hub: + post: + tags: + - "Hub" + consumes: + - "application/json;charset=utf-8" + operationId: "hubCreate" + summary: "Create Hub" + description: "\n\nSpecific business errors for current operation will be encapsulated\ + \ in\n\nHTTP Response 422 Unprocessable entity\n" + deprecated: false + parameters: + - name: "Hub" + required: true + in: "body" + description: "" + schema: + $ref: "#/definitions/CreateHub" + responses: + 201: + description: "Success" + schema: + type: "file" + headers: + location: + description: "" + type: "string" + 400: + description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ + \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ + \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ + \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ + \ parameter value" + schema: + $ref: "#/definitions/ErrorRepresentation" + 401: + description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ + \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" + schema: + $ref: "#/definitions/ErrorRepresentation" + 403: + description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ + \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ + \ requests" + schema: + $ref: "#/definitions/ErrorRepresentation" + 404: + description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ + \ not found" + schema: + $ref: "#/definitions/ErrorRepresentation" + 422: + description: "Unprocessable entity\n\nFunctional error" + schema: + $ref: "#/definitions/ErrorRepresentation" + 500: + description: "Internal Server Error\n\nList of supported error codes:\n\ + - 1: Internal error" + schema: + $ref: "#/definitions/ErrorRepresentation" + 503: + description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ + \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ + \ retry later !" + schema: + $ref: "#/definitions/ErrorRepresentation" + get: + tags: + - "Hub" + produces: + - "application/json;charset=utf-8" + operationId: "hubFind" + summary: "Retrieve a lits of hub" + description: "\n\nSpecific business errors for current operation will be encapsulated\ + \ in\n\nHTTP Response 422 Unprocessable entity\n" + deprecated: false + parameters: + - name: "id" + required: false + in: "query" + description: "" + type: "string" + - name: "eventType" + required: false + in: "query" + description: "" + type: "string" + enum: + - "ServiceOrderCreationNotification" + - "ServiceOrderStateChangeNotification" + - "ServiceOrderItemStateChangeNotification" + responses: + 200: + description: "Success" + schema: + type: "array" + items: + $ref: "#/definitions/Hub" + 400: + description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ + \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ + \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ + \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ + \ parameter value" + schema: + $ref: "#/definitions/ErrorRepresentation" + 401: + description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ + \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" + schema: + $ref: "#/definitions/ErrorRepresentation" + 403: + description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ + \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ + \ requests" + schema: + $ref: "#/definitions/ErrorRepresentation" + 404: + description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ + \ not found" + schema: + $ref: "#/definitions/ErrorRepresentation" + 422: + description: "Unprocessable entity\n\nFunctional error" + schema: + $ref: "#/definitions/ErrorRepresentation" + 500: + description: "Internal Server Error\n\nList of supported error codes:\n\ + - 1: Internal error" + schema: + $ref: "#/definitions/ErrorRepresentation" + 503: + description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ + \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ + \ retry later !" + schema: + $ref: "#/definitions/ErrorRepresentation" + /hub/{hubId}: + get: + tags: + - "Hub" + produces: + - "application/json;charset=utf-8" + operationId: "hubGet" + summary: "Retrieve an HUB by id" + description: "Retrieve an HUB by id\n\nSpecific business errors for current\ + \ operation will be encapsulated in\n\nHTTP Response 422 Unprocessable entity\n" + deprecated: false + parameters: + - name: "hubId" + in: "path" + required: true + type: "string" + description: "" + responses: + 200: + description: "Success" + schema: + $ref: "#/definitions/Hub" + 400: + description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ + \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ + \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ + \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ + \ parameter value" + schema: + $ref: "#/definitions/ErrorRepresentation" + 401: + description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ + \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" + schema: + $ref: "#/definitions/ErrorRepresentation" + 403: + description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ + \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ + \ requests" + schema: + $ref: "#/definitions/ErrorRepresentation" + 404: + description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ + \ not found" + schema: + $ref: "#/definitions/ErrorRepresentation" + 422: + description: "Unprocessable entity\n\nFunctional error" + schema: + $ref: "#/definitions/ErrorRepresentation" + 500: + description: "Internal Server Error\n\nList of supported error codes:\n\ + - 1: Internal error" + schema: + $ref: "#/definitions/ErrorRepresentation" + 503: + description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ + \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ + \ retry later !" + schema: + $ref: "#/definitions/ErrorRepresentation" + delete: + tags: + - "Hub" + operationId: "hubDelete" + summary: "delete hub" + description: "\n\nSpecific business errors for current operation will be encapsulated\ + \ in\n\nHTTP Response 422 Unprocessable entity\n" + deprecated: false + parameters: + - name: "hubId" + in: "path" + required: true + type: "string" + description: "" + responses: + 204: + description: "Success" + 400: + description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ + \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ + \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ + \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ + \ parameter value" + schema: + $ref: "#/definitions/ErrorRepresentation" + 401: + description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ + \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" + schema: + $ref: "#/definitions/ErrorRepresentation" + 403: + description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ + \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ + \ requests" + schema: + $ref: "#/definitions/ErrorRepresentation" + 404: + description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ + \ not found" + schema: + $ref: "#/definitions/ErrorRepresentation" + 422: + description: "Unprocessable entity\n\nFunctional error" + schema: + $ref: "#/definitions/ErrorRepresentation" + 500: + description: "Internal Server Error\n\nList of supported error codes:\n\ + - 1: Internal error" + schema: + $ref: "#/definitions/ErrorRepresentation" + 503: + description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ + \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ + \ retry later !" + schema: + $ref: "#/definitions/ErrorRepresentation" + /notification/serviceOrderCreationNotification: + post: + tags: + - "Notification" + consumes: + - "application/json;charset=utf-8" + operationId: "notificationServiceOrderCreationNotification" + summary: "Service order creation notification" + description: "Service order creation notification\n\nSpecific business errors\ + \ for current operation will be encapsulated in\n\nHTTP Response 422 Unprocessable\ + \ entity\n" + deprecated: false + parameters: + - name: "serviceOrderCreationNotification" + required: true + in: "body" + description: "" + schema: + $ref: "#/definitions/ServiceOrderCreationNotification" + responses: + 204: + description: "Success" + 400: + description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ + \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ + \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ + \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ + \ parameter value" + schema: + $ref: "#/definitions/ErrorRepresentation" + 401: + description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ + \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" + schema: + $ref: "#/definitions/ErrorRepresentation" + 403: + description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ + \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ + \ requests" + schema: + $ref: "#/definitions/ErrorRepresentation" + 404: + description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ + \ not found" + schema: + $ref: "#/definitions/ErrorRepresentation" + 422: + description: "Unprocessable entity\n\nFunctional error" + schema: + $ref: "#/definitions/ErrorRepresentation" + 500: + description: "Internal Server Error\n\nList of supported error codes:\n\ + - 1: Internal error" + schema: + $ref: "#/definitions/ErrorRepresentation" + 503: + description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ + \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ + \ retry later !" + schema: + $ref: "#/definitions/ErrorRepresentation" + /notification/serviceOrderStateChangeNotification: + post: + tags: + - "Notification" + consumes: + - "application/json;charset=utf-8" + operationId: "notificationServiceOrderStateChangeNotification" + summary: "Service order state change notification description" + description: "\n\nSpecific business errors for current operation will be encapsulated\ + \ in\n\nHTTP Response 422 Unprocessable entity\n" + deprecated: false + parameters: + - name: "serviceOrderstateChangeNotification" + required: true + in: "body" + description: "" + schema: + $ref: "#/definitions/ServiceOrderStateChangeNotification" + responses: + 204: + description: "Success" + 400: + description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ + \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ + \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ + \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ + \ parameter value" + schema: + $ref: "#/definitions/ErrorRepresentation" + 401: + description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ + \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" + schema: + $ref: "#/definitions/ErrorRepresentation" + 403: + description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ + \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ + \ requests" + schema: + $ref: "#/definitions/ErrorRepresentation" + 404: + description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ + \ not found" + schema: + $ref: "#/definitions/ErrorRepresentation" + 422: + description: "Unprocessable entity\n\nFunctional error" + schema: + $ref: "#/definitions/ErrorRepresentation" + 500: + description: "Internal Server Error\n\nList of supported error codes:\n\ + - 1: Internal error" + schema: + $ref: "#/definitions/ErrorRepresentation" + 503: + description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ + \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ + \ retry later !" + schema: + $ref: "#/definitions/ErrorRepresentation" + /notification/serviceOrderItemStateChangeNotification: + post: + tags: + - "Notification" + consumes: + - "application/json;charset=utf-8" + operationId: "notificationServiceOrderItemStateChangeNotification" + summary: "ServiceOrder Item State Change Notification description" + description: "\n\nSpecific business errors for current operation will be encapsulated\ + \ in\n\nHTTP Response 422 Unprocessable entity\n" + deprecated: false + parameters: + - name: "serviceOrderItemStateChangeNotification" + required: true + in: "body" + description: "" + schema: + $ref: "#/definitions/ServiceOrderItemStateChangeNotification" + responses: + 204: + description: "Success" + 400: + description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\ + \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\ + \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\ + \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\ + \ parameter value" + schema: + $ref: "#/definitions/ErrorRepresentation" + 401: + description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\ + \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials" + schema: + $ref: "#/definitions/ErrorRepresentation" + 403: + description: "Forbidden\n\nList of supported error codes:\n- 50: Access\ + \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\ + \ requests" + schema: + $ref: "#/definitions/ErrorRepresentation" + 404: + description: "Not Found\n\nList of supported error codes:\n- 60: Resource\ + \ not found" + schema: + $ref: "#/definitions/ErrorRepresentation" + 422: + description: "Unprocessable entity\n\nFunctional error" + schema: + $ref: "#/definitions/ErrorRepresentation" + 500: + description: "Internal Server Error\n\nList of supported error codes:\n\ + - 1: Internal error" + schema: + $ref: "#/definitions/ErrorRepresentation" + 503: + description: "Service Unavailable\n\nList of supported error codes:\n- 5:\ + \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\ + \ retry later !" + schema: + $ref: "#/definitions/ErrorRepresentation" +definitions: + ActionType: + description: "Action type to be describer on the order item.\nmodify is not managed\ + \ in Beijing release" + type: "string" + enum: + - "add" + - "modify" + - "delete" + - "noChange" + StateType: + description: "List of possible state for the order and the orderItem." + type: "string" + enum: + - "acknowledged" + - "rejected" + - "pending" + - "held" + - "inProgress" + - "cancelled" + - "completed" + - "failed" + - "partial" + RelationshipType: + description: "Relationship type;\nOnly reliesOn is managed in Beijing release." + type: "string" + enum: + - "reliesOn" + EventType: + description: "" + type: "string" + enum: + - "ServiceOrderCreationNotification" + - "ServiceOrderStateChangeNotification" + - "ServiceOrderItemStateChangeNotification" + SeverityMessage: + description: "" + type: "string" + enum: + - "information" + - "error" + ErrorRepresentation: + description: "Representation of an error." + required: + - "code" + - "reason" + type: "object" + properties: + code: + description: "Application related code (as defined in the API or from a common\ + \ list)" + type: "integer" + format: "int32" + reason: + description: "Text that explains the reason for error. This can be shown to\ + \ a client user." + type: "string" + message: + description: "Text that provide more details and corrective actions related\ + \ to the error. This can be shown to a client user" + type: "string" + status: + description: "http error code extension like 400-2" + type: "string" + referenceError: + description: "url pointing to documentation describing the error" + type: "string" + '@type': + description: "The class type of a REST resource" + type: "string" + '@schemaLocation': + description: "it provides a link to the schema describing a REST resource" + type: "string" + ServiceRelationship: + description: "Linked Services to the one instantiate\nnbi component used this\ + \ relationship to sort request to ONAP." + required: + - "type" + - "service" + type: "object" + properties: + type: + $ref: "#/definitions/RelationshipType" + service: + $ref: "#/definitions/Service" + ServiceRef: + description: "Service references" + required: + - "id" + type: "object" + properties: + id: + description: "Unique identifier of the service" + type: "string" + href: + description: "Reference of the service" + type: "string" + ServiceCharacteristic: + description: "ServiceCharacteristic" + required: + - "name" + type: "object" + properties: + name: + description: "Name of characteristic" + type: "string" + valueType: + description: "" + type: "string" + value: + $ref: "#/definitions/Value" + RelatedParty: + description: "A related party defines party which are involved in this order and\ + \ the role they are playing.\nfor Beijing release:\nWith the current version\ + \ of APIs used from SO and AAI we need to manage a ‘customer’. This customer\ + \ concept is confusing with Customer BSS concept. We took the following rules\ + \ to manage the ‘customer’ information:\no\tIt could be provided through a serviceOrder\ + \ in the service Order a relatedParty with role ‘ONAPcustomer’ should be provided\ + \ in the serviceOrder header (we will not consider in this release the party\ + \ at item level); External API component will check if this customer exists\ + \ and create it in AAI if not.\no\tIf no relatedParty are provided the service\ + \ will be affected to ‘generic’ customer (dummy customer) – we assume this ‘\ + generic’ customer always exists." + required: + - "id" + - "role" + type: "object" + properties: + id: + description: "Unique identifier of a related party" + type: "string" + href: + description: "An hyperlink to the party - not used in Beijnig release" + type: "string" + role: + description: "The role of the related party (e.g. Owner, requester, fullfiller\ + \ etc).\nONLY 'ONAPcustomer' is considered" + type: "string" + name: + description: "Name of the related party" + type: "string" + '@referredType': + description: "" + type: "string" + ServiceSpecificationRef: + description: "The service specification (these attributes are fetched from the\ + \ catalogue)." + required: + - "id" + type: "object" + properties: + id: + description: "Unique identifier of the service specification\nThis information\ + \ will be used to retrieve SDC information + mapped to SO ModelNameVersionIdin\ + \ the request." + type: "string" + href: + description: "Reference of the service specification\nNot used in Beijing\ + \ release." + type: "string" + name: + description: "Name of the service specification\nNot used in Beijing release" + type: "string" + version: + description: "Version of the service Specification\nNot used in Beijing release" + type: "string" + targetServiceSchema: + $ref: "#/definitions/TargetServiceSchema" + '@type': + description: "Not used in Beijing release" + type: "string" + '@schemaLocation': + description: "Not used in Beijing release" + type: "string" + '@baseType': + description: "Not used in Beijing release" + type: "string" + Service: + description: "Service (to be added, modified, deleted) description" + required: + - "id" + type: "object" + properties: + id: + description: "Identifier of a service instance.\nIt must be valued if orderItem\ + \ action is 'delete' and corresponds to a AAI service.id" + type: "string" + href: + description: "Reference to the Service (useful for delete or modify command).\n\ + Not managed in Beijing release." + type: "string" + name: + description: "Name of the service - When orderItem action is 'add' this name\ + \ will be used in ONAP/SO request as InstaceName." + type: "string" + serviceState: + description: "The lifecycle state of the service requested;\nNot managed in\ + \ Beijing release." + type: "string" + '@type': + description: "To define the service type\nNot managed in Beijing Release" + type: "string" + '@schemaLocation': + description: "The URL to get the resource schema.\nNot managed in Beijing\ + \ Release" + type: "string" + serviceCharacteristic: + type: "array" + items: + $ref: "#/definitions/ServiceCharacteristic" + serviceRelationship: + type: "array" + items: + $ref: "#/definitions/ServiceRelationship" + relatedParty: + type: "array" + items: + $ref: "#/definitions/RelatedParty" + serviceSpecification: + $ref: "#/definitions/ServiceSpecificationRef" + OrderItemRelationship: + description: "Linked order item to the one containing this attribute.\nnbi component\ + \ used this relationship to sort request to ONAP." + required: + - "type" + - "id" + type: "object" + properties: + type: + $ref: "#/definitions/RelationshipType" + id: + description: "Unique identifier of an order item" + type: "string" + ServiceOrderItem: + description: "An identified part of the order. A service order is decomposed into\ + \ one or more order items." + required: + - "id" + - "service" + type: "object" + properties: + id: + description: "Identifier of the line item (generally it is a sequence number\ + \ 01, 02, 03, …)" + type: "string" + action: + $ref: "#/definitions/ActionType" + state: + $ref: "#/definitions/StateType" + percentProgress: + description: "Progress of the delivery in percentage." + type: "string" + '@type': + description: "Used to extend the order item.\nnot used in Beijing relase" + type: "string" + '@schemaLocation': + description: "not used in Beijing relase" + type: "string" + '@baseType': + description: "not used in Beijing relase" + type: "string" + orderItemRelationship: + type: "array" + items: + $ref: "#/definitions/OrderItemRelationship" + service: + $ref: "#/definitions/Service" + orderItemMessage: + type: "array" + items: + $ref: "#/definitions/OrderMessage" + ServiceOrder: + description: "A Service Order is a type of order which can be used to place an\ + \ order between a customer and a service provider or between a service provider\ + \ and a partner and vice versa" + required: + - "id" + type: "object" + properties: + id: + description: "ID created on repository side" + type: "string" + href: + description: "Hyperlink to access the order" + type: "string" + externalId: + description: "ID given by the consumer and only understandable by him (to\ + \ facilitate his searches)" + type: "string" + priority: + description: "A way that can be used by consumers to prioritize orders in\ + \ Service Order Management system (from 0 to 4 : 0 is the highest priority,\ + \ and 4 the lowest)" + type: "string" + description: + description: "A free-text description of the service order" + type: "string" + category: + description: "Used to categorize the order that can be useful for the OM system\ + \ (e.g. “broadband”, “TVOption”, ...)" + type: "string" + state: + $ref: "#/definitions/StateType" + orderDate: + description: "" + type: "string" + format: "date-time" + completionDateTime: + description: "Date when the order was completed" + type: "string" + format: "date-time" + requestedStartDate: + description: "Order start date wished by the requestor" + type: "string" + format: "date-time" + requestedCompletionDate: + description: "Requested delivery date from the requestor perspective" + type: "string" + format: "date-time" + expectedCompletionDate: + description: "" + type: "string" + format: "date-time" + startDate: + description: "Date when the order was started for processing" + type: "string" + format: "date-time" + '@baseType': + description: "" + type: "string" + '@type': + description: "" + type: "string" + '@schemaLocation': + description: "" + type: "string" + relatedParty: + type: "array" + items: + $ref: "#/definitions/RelatedParty" + orderRelationship: + type: "array" + items: + $ref: "#/definitions/OrderRelationship" + orderItem: + type: "array" + items: + $ref: "#/definitions/ServiceOrderItem" + orderMessage: + type: "array" + items: + $ref: "#/definitions/OrderMessage" + OrderRelationship: + description: "Linked order to the one containing this attribute.\nThis relationship\ + \ is not used to sort ONAP request." + required: + - "id" + type: "object" + properties: + type: + description: "The type of related order, can be : “dependency” if the order\ + \ needs to be “not started” until another order item is complete (a service\ + \ order in this case) or “cross-ref” to keep track of the source order (a\ + \ productOrder)" + type: "string" + id: + description: "The id of the related order" + type: "string" + href: + description: "A hyperlink to the related order" + type: "string" + '@referredType': + description: "Type of the referred order." + type: "string" + TargetServiceSchema: + description: "Target to the schema describing the service spec resource" + required: + - "@type" + - "@schemaLocation" + type: "object" + properties: + '@type': + description: "Indicates the (class) type of resource." + type: "string" + '@schemaLocation': + description: "This field provided a link to the schema describing this REST\ + \ resource." + type: "string" + Value: + description: "Value is a descriptive structure for service characteristic;\nFor\ + \ Beijing we only manage 'basic' attribute - the serviceCharacteristicValue\ + \ must be used." + type: "object" + properties: + '@type': + description: "Indicates the (class) type of resource.\nNot used in Beijing\ + \ Release" + type: "string" + '@schemaLocation': + description: "This field provided a link to the schema describing this REST\ + \ resource.\nNot used in Beijing Release" + type: "string" + serviceCharacteristicValue: + description: "Value of the characteristic.\nThis attribute must be used in\ + \ Beijing Release to provide characteristic value." + type: "string" + CreateServiceOrderItem: + description: "This structure is used in the operation POST for a serviceOrder\ + \ request to describe an item.\nAttribute description is not accurate and should\ + \ be find in the serviceOrderItem class." + required: + - "id" + - "service" + type: "object" + properties: + id: + description: "Identifier of the line item (generally it is a sequence number\ + \ 01, 02, 03, …)" + type: "string" + action: + $ref: "#/definitions/ActionType" + '@type': + description: "Indicates the type of resource." + type: "string" + '@schemaLocation': + description: "A link to the schema describing this REST resource" + type: "string" + '@baseType': + description: "Indicates the base type of the resource." + type: "string" + orderItemRelationship: + type: "array" + items: + $ref: "#/definitions/OrderItemRelationship" + service: + $ref: "#/definitions/Service" + CreateServiceOrder: + description: "This structure is used in the operation POST for a serviceOrder\ + \ request.\nAttribute description is not accurate and should be find in the\ + \ serviceOrder class." + type: "object" + properties: + externalId: + description: "ID given by the consumer and only understandable by him (to\ + \ facilitate his searches)" + type: "string" + priority: + description: "A way that can be used by consumers to prioritize orders in\ + \ Service Order Management system (from 0 to 4 : 0 is the highest priority,\ + \ and 4 the lowest)" + type: "string" + description: + description: "A free-text description of the service order" + type: "string" + category: + description: "Used to categorize the order that can be useful for the OM system\ + \ (e.g. “broadband”, “TVOption”, ...)" + type: "string" + requestedStartDate: + description: "Order start date wished by the requestor" + type: "string" + format: "date-time" + requestedCompletionDate: + description: "Requested delivery date from the requestor perspective" + type: "string" + format: "date-time" + '@baseType': + description: "" + type: "string" + '@type': + description: "" + type: "string" + '@schemaLocation': + description: "" + type: "string" + relatedParty: + type: "array" + items: + $ref: "#/definitions/RelatedParty" + orderRelationship: + type: "array" + items: + $ref: "#/definitions/OrderRelationship" + orderItem: + type: "array" + items: + $ref: "#/definitions/CreateServiceOrderItem" + Hub: + description: "An HUB resource is used by client side to subscribe to notification.\n\ + Not managed in the Beijing release." + discriminator: "id" + required: + - "query" + - "callback" + type: "object" + properties: + id: + description: "Hub Id" + type: "string" + query: + description: "" + type: "string" + callback: + description: "Address where notification must be send" + type: "string" + CreateHub: + description: "This structure is used as a request for POST Hub operation" + required: + - "query" + - "callback" + type: "object" + properties: + query: + description: "The query must have an eventType=notificationName information.\n\ + Optionally a ? could be added to reduce hub.\nquery”:”eventType = ServiceOrderStateChangeNotification”\ + &serviceOrder.state=COMPLETED" + type: "string" + callback: + description: "Address where notification must be send" + type: "string" + ServiceOrderSummary: + description: "This structure is used to provide a subset of serviceOrder attributes\ + \ to be provided in particular for notification messages" + required: + - "id" + type: "object" + properties: + id: + description: "ID created on repository side" + type: "string" + href: + description: "Hyperlink to access the order" + type: "string" + externalId: + description: "ID given by the consumer and only understandable by him (to\ + \ facilitate his searches)" + type: "string" + state: + $ref: "#/definitions/StateType" + orderDate: + description: "" + type: "string" + format: "date-time" + completionDateTime: + description: "Date when the order was completed" + type: "string" + format: "date-time" + ServiceOrderCreationNotification: + description: "Notification structure for a service order creation notification" + required: + - "eventId" + - "eventDate" + - "eventType" + - "event" + type: "object" + properties: + eventId: + description: "" + type: "string" + eventDate: + description: "" + type: "string" + format: "date-time" + eventType: + description: "" + type: "string" + default: "ServiceOrderCreationNotification" + event: + $ref: "#/definitions/ServiceOrderSummary" + Notification: + description: "Used to describe notification for this API" + type: "object" + properties: {} + ServiceOrderStateChangeNotification: + description: "Service order state change notification description" + required: + - "eventId" + - "eventDate" + - "eventType" + - "event" + type: "object" + properties: + eventId: + description: "" + type: "string" + eventDate: + description: "" + type: "string" + format: "date-time" + eventType: + description: "" + type: "string" + default: "ServiceOrderStateChangeNotification" + event: + $ref: "#/definitions/ServiceOrderSummary" + ServiceOrderItemSummary: + description: "Service Order item summary to be used for notification" + required: + - "id" + - "service" + type: "object" + properties: + id: + description: "Identifier of the line item (generally it is a sequence number\ + \ 01, 02, 03, …)" + type: "string" + action: + $ref: "#/definitions/ActionType" + state: + $ref: "#/definitions/StateType" + service: + $ref: "#/definitions/Service" + ServiceOrderSummaryWithItem: + description: "Service order item summary with item description" + required: + - "id" + type: "object" + properties: + id: + description: "ID created on repository side" + type: "string" + href: + description: "Hyperlink to access the order" + type: "string" + externalId: + description: "ID given by the consumer and only understandable by him (to\ + \ facilitate his searches)" + type: "string" + state: + $ref: "#/definitions/StateType" + orderDate: + description: "" + type: "string" + format: "date-time" + completionDateTime: + description: "Date when the order was completed" + type: "string" + format: "date-time" + orderItem: + type: "array" + items: + $ref: "#/definitions/ServiceOrderItemSummary" + ServiceOrderItemStateChangeNotification: + description: "" + required: + - "eventId" + - "eventDate" + - "eventType" + - "event" + type: "object" + properties: + eventId: + description: "" + type: "string" + eventDate: + description: "" + type: "string" + format: "date-time" + eventType: + description: "" + type: "string" + default: "ServiceOrderStateChangeNotification" + event: + $ref: "#/definitions/ServiceOrderSummaryWithItem" + OrderMessage: + description: "An optional array of messages associated with the Order" + required: + - "severity" + - "correctionRequired" + type: "object" + properties: + code: + description: "A code associated to this message" + type: "string" + field: + description: "Service Order attribute related to this error message" + type: "string" + messageInformation: + description: "Message related to this order" + type: "string" + severity: + $ref: "#/definitions/SeverityMessage" + correctionRequired: + description: "Indicator that an action is required to allow service order\ + \ fullfilment to follow up" + type: "boolean" diff --git a/docs/releasenotes/releasenotes.rst b/docs/releasenotes/releasenotes.rst new file mode 100755 index 0000000..1551e3a --- /dev/null +++ b/docs/releasenotes/releasenotes.rst @@ -0,0 +1,122 @@ +.. This work is licensed under a +.. Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2018 ORANGE + +Release Notes +============= + +Version: 3.0.0 +-------------- + +:Release Date: 2018-11-15 + +**New Features** + +Main features are: + +- `EXTAPI-96 <https://jira.onap.org/browse/EXTAPI-96>`_ - Add notification for serviceOrder API +- `EXTAPI-97 <https://jira.onap.org/browse/EXTAPI-97>`_ - Upgrade ServiceOrder API to manage modification UC +- `EXTAPI-100 <https://jira.onap.org/browse/EXTAPI-100>`_ - Improve ServiceInventory API +- `EXTAPI-101 <https://jira.onap.org/browse/EXTAPI-101>`_ - Integrate ExtAPI/NBI to MSB +- `EXTAPI-102 <https://jira.onap.org/browse/EXTAPI-102>`_ - Integrate ExtAPI/NBI to an E2E ONAP UC +- `EXTAPI-116 <https://jira.onap.org/browse/EXTAPI-116>`_ - Help NBI user to get information when Service order fails +- `EXTAPI-125 <https://jira.onap.org/browse/EXTAPI-125>`_ - Hadd support for progress percentage on ServiceOrder tracking + +Detail of features described in the readTheDoc documentation. + +**Bug Fixes** + +- `EXTAPI-70 <https://jira.onap.org/browse/EXTAPI-70>`_ - NBI should add relationship to tenant when creating service-subscription in AAI + + +**Known Issues** + +No new issue (see Beijing ones) + +**Security Notes** + +To be completed + +Quick Links: + +- `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_ +- `Passing Badge information for External API <to be completed>`_ +- `Project Vulnerability Review Table for External API <to be completed>`_ + +**Upgrade Notes** + +To be completed + +**Deprecation Notes** + +No deprecated feature from Beijing. + +**Other** + +=========== + +Version: 1.0.0 +-------------- + +:Release Date: 2018-06-07 + +**New Features** + +Main features are: + +- `EXTAPI-39 <https://jira.onap.org/browse/EXTAPI-39>`_ - Retrieve SDC information (catalog information) for service level artifacts based on TMF633 open APIs - operation GET +- `EXTAPI-41 <https://jira.onap.org/browse/EXTAPI-41>`_ - Retrieve AAI information (inventory information) for service instance level artifacts based on TMF638 open APIs - operation GET +- `EXTAPI-42 <https://jira.onap.org/browse/EXTAPI-42>`_ - Create and retrieve SO service request for service level based on TMF641 open APIS - Operations POST & GET + +Detail of features described in the readTheDoc documentation. + +**Bug Fixes** + +Not applicable - This is an initial release + +**Known Issues** + +For service catalog: + +- Find criteria are limited + +For service inventory: + +- Customer information must be passed to get complete service representation. +- Find criteria are limited. + +For service order: + +- ServiceOrder will manage only ‘add’ and ‘delete’ operation (no change). +- Only service level request is performed. +- No request for VNF/VF and no call to SDNC. +- `EXTAPI-70 <https://jira.onap.org/browse/EXTAPI-70>`_ : links between customer/service instance and cloud/tenant not done (trigger VID issue). +- Only active service state is considered to add a service. + +Detail of limitations described in the readTheDoc documentation. + +**Security Notes** + +External API code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The External API open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28382906>`_. +Authentication management and Data Access rights have not been implemented. + +Quick Links: + +- `External API project page <https://wiki.onap.org/display/DW/External+API+Framework+Project>`_ +- `Passing Badge information for External API <https://bestpractices.coreinfrastructure.org/en/projects/1771>`_ +- `Project Vulnerability Review Table for External API <https://wiki.onap.org/pages/viewpage.action?pageId=28382906>`_ + +**Upgrade Notes** + +Not applicable - This is an initial release + +**Deprecation Notes** + +Not applicable - This is an initial release + +**Other** + +=========== + +End of Release Notes |
