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/documentation.html | 60 ++++++++++++---------- 1 file changed, 32 insertions(+), 28 deletions(-) (limited to 'docs/offeredapis/serviceInventory/documentation.html') 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)

    -
    -
    -- cgit 1.2.3-korg