From 8f141d17f3ea7720df479f4ae51b5a2e169548cb Mon Sep 17 00:00:00 2001 From: romaingimbert Date: Fri, 14 Sep 2018 14:52:20 +0200 Subject: Add API Documentation for Casablanca -update docs -update version related code -change properties MSB Change-Id: I7fb2a257ec035c53e93666d7571a2c74a0624524 Issue-ID: EXTAPI-141 Signed-off-by: romaingimbert --- .../serviceInventory/apiServiceInventory.plantuml | 14 +---- docs/offeredapis/serviceInventory/asciiDoc.adoc | 36 ++++++------- .../serviceInventory/documentation.html | 60 ++++++++++++---------- docs/offeredapis/serviceInventory/markDown.md | 34 ++++++------ 4 files changed, 63 insertions(+), 81 deletions(-) (limited to 'docs/offeredapis/serviceInventory') 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 @@ - @@ -442,7 +437,6 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
  • Version information
  • URI scheme
  • Tags
    • -
  • Consumes
  • Produces
    • @@ -463,7 +457,6 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
  • ServiceSpecificationRef
  • SupportingResource
  • Value
    • -
  • stateValues
    • @@ -474,6 +467,13 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    Overview

    +

    Api URL

    +
    +

    Swagger UI

    +
    +
    +

    plant UML UI

    +

    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

    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

    @@ -505,16 +505,6 @@ only operation GET (by id & byList) for resource serviceSpecification is ava
    -

    Consumes

    -
    -
      -
    • -

      application/json;charset=utf-8

      -
      • -
    -
    -
    -

    Produces

      @@ -687,6 +677,16 @@ fields attribute may be used to filter retrieved attribute(s) for each service
    +
    +
    Produces
    +
    +
      +
    • +

      application/json;charset=utf-8

      +
      • +
    +
    +

    Retrieve a service

    @@ -837,6 +837,16 @@ Attribute selection is enabled for all first level attributes.

    +
    +
    Produces
    +
    +
      +
    • +

      application/json;charset=utf-8

      +
      • +
    +
    +
    @@ -1156,8 +1166,8 @@ Not managed in Beijing release

    state
    optional

    - -

    stateValues

    +

    State of the service. Not managed in Beijing release

    +

    string

    supportingResource
    @@ -1410,18 +1420,12 @@ Not managed in Beijing release.

    -
    -

    stateValues

    -
    -

    Type : enum (feasibilityChecked, designed, reserved, inactive, active, terminated)

    -
    -
    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

    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` + + #### Retrieve a service ``` @@ -133,6 +129,11 @@ HTTP Response 422 Unprocessable entity |**503**|Service Unavailable

    List of supported error codes:
    - 5: The service is temporarily unavailable
    - 6: Orange API is over capacity, retry later !|[ErrorRepresentation](#errorrepresentation)| +##### Produces + +* `application/json;charset=utf-8` + + ## Definitions @@ -219,7 +220,7 @@ Instantiated service (service_instance) in AAI |**name**
    *optional*|Name of the service - Valued with service-instance-name|string| |**relatedParty**
    *optional*||< [RelatedPartyRef](#relatedpartyref) > array| |**serviceSpecification**
    *optional*||[ServiceSpecificationRef](#servicespecificationref)| -|**state**
    *optional*||[stateValues](#statevalues)| +|**state**
    *optional*|State of the service. Not managed in Beijing release|string| |**supportingResource**
    *optional*||< [SupportingResource](#supportingresource) > array| |**type**
    *optional*|Service type - valued with 'service-instance'|string| @@ -284,8 +285,3 @@ Not managed in Beijing release. |**@type**
    *optional*|Not managed in Beijing release.|string| |**serviceCharacteristicValue**
    *optional*|Not managed in Beijing release.|string| - - -### stateValues -*Type* : enum (feasibilityChecked, designed, reserved, inactive, active, terminated) - -- cgit 1.2.3-korg