From 4d1e6b94e2fad7e2bf5fc039e7aec8ee11d26a53 Mon Sep 17 00:00:00 2001 From: sebdet Date: Tue, 23 Oct 2018 16:54:02 +0200 Subject: Update doc and swagger Update the reStructuredText doc and swagger Issue-ID: CLAMP-200 Change-Id: I542498410546f3258f1bb01caca85ac025177412 Signed-off-by: sebdet --- src/main/resources/META-INF/resources/swagger.html | 931 ++++++++++++++++++--- 1 file changed, 835 insertions(+), 96 deletions(-) (limited to 'src/main') diff --git a/src/main/resources/META-INF/resources/swagger.html b/src/main/resources/META-INF/resources/swagger.html index e4d45de1..4b4aad96 100644 --- a/src/main/resources/META-INF/resources/swagger.html +++ b/src/main/resources/META-INF/resources/swagger.html @@ -572,30 +572,90 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
  • 2.19.4. Produces
    • -
  • 2.20. GET /healthcheck +
  • 2.20. GET /dictionary
    • -
  • 2.21. GET /user/getUser +
  • 2.21. PUT /dictionary/{dictionaryName} +
    • +
  • 2.22. GET /dictionary/{dictionaryName}/items + +
    • +
  • 2.23. PUT /dictionary/{dictionaryName}/items + +
    • +
  • 2.24. GET /healthcheck + +
    • +
  • 2.25. GET /tosca/models + +
    • +
  • 2.26. GET /tosca/models/policyType/{policyType} + +
    • +
  • 2.27. GET /tosca/models/{toscaModelName} + +
    • +
  • 2.28. PUT /tosca/models/{toscaModelName} + +
    • +
  • 2.29. GET /user/getUser +
  • 3. Definitions
    • @@ -608,7 +668,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b

    1.1. Version information

    -

    Version : 3.0.0-SNAPSHOT

    +

    Version : 3.0.1-SNAPSHOT

    @@ -1716,24 +1776,27 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

    2.20. GET /healthcheck

    +

    2.20. GET /dictionary

    2.20.1. Responses

    --+++ + - + +
    HTTP CodeDescription Schema

    200

    No Content

    Output type

    CldsDictionary
    @@ -1750,168 +1813,772 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

    2.21. GET /user/getUser

    +

    2.21. PUT /dictionary/{dictionaryName}

    -

    2.21.1. Responses

    +

    2.21.1. Parameters

    +-++ + + + + + + + + + + + + + + + + + + + +
    TypeNameSchema

    Path

    dictionaryName
    +required

    string

    Body

    body
    +required

    CldsDictionary

    +
    +
    +

    2.21.2. Responses

    + ++++ + - + +
    HTTP CodeDescription Schema

    200

    No Content

    Output type

    CldsDictionary
    -

    2.21.2. Produces

    +

    2.21.3. Consumes

    • -

      text/plain

      +

      application/json

    +
    +

    2.21.4. Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    -
    -

    3. Definitions

    -
    -

    3.1. CldsEvent

    +

    2.22. GET /dictionary/{dictionaryName}/items

    +
    +

    2.22.1. Parameters

    --+++ + - - - - - - - - - + + + +
    Type Name Schema

    actionCd
    -optional

    string

    actionStateCd
    -optional

    string

    id
    -optional

    Path

    dictionaryName
    +required

    string
    +
    +
    +

    2.22.2. Responses

    + +++++ + - - + + + + + - - + + +

    processInstanceId
    -optional

    string

    		HTTP CodeDescriptionSchema

    userid
    -optional

    string

    200

    Output type

    CldsDictionary
    +
    +

    2.22.3. Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    -

    3.2. CldsInfo

    +

    2.23. PUT /dictionary/{dictionaryName}/items

    +
    +

    2.23.1. Parameters

    --+++ + - + + - - - - - - - - - - + + + + +
    Type Name Schema

    cldsVersion
    -optional

    Path

    dictionaryName
    +required

    string

    permissionReadCl
    -optional

    boolean

    permissionReadTemplate
    -optional

    boolean

    permissionUpdateCl
    -optional

    boolean

    Body

    body
    +required

    CldsDictionaryItem
    +
    +
    +

    2.23.2. Responses

    + +++++ + - - + + + + + - - + + +

    permissionUpdateTemplate
    -optional

    boolean

    		HTTP CodeDescriptionSchema

    userName
    -optional

    string

    200

    Output type

    CldsDictionaryItem
    +
    +

    2.23.3. Consumes

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    +

    2.23.4. Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    -

    3.3. CldsModel

    +

    2.24. GET /healthcheck

    +
    +

    2.24.1. Responses

    --++ - + - - - - - - + + + +
    NameHTTP Code Schema

    blueprintText
    -optional

    string

    bpmnText
    -optional

    string

    200

    No Content
    +
    +
    +

    2.24.2. Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    +
    +

    2.25. GET /tosca/models

    +
    +

    2.25.1. Responses

    + +++++ + - - + + + + + - - + + + - + +

    cldsModelInstanceList
    -optional

    < CldsModelInstance > array

    		HTTP CodeDescriptionSchema

    controlName
    -optional

    string

    200

    Output type

    CldsToscaModel
    +
    +
    +

    2.25.2. Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    +
    +

    2.26. GET /tosca/models/policyType/{policyType}

    +
    +

    2.26.1. Parameters

    + +++++ + + + + + + + + + + + + + + +
    TypeNameSchema

    Path

    policyType
    +required

    string

    +
    +
    +

    2.26.2. Responses

    + ++++ + + + + + + + + + + + + +
    HTTP CodeSchema

    200

    No Content

    +
    +
    +

    2.26.3. Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    +
    +

    2.27. GET /tosca/models/{toscaModelName}

    +
    +

    2.27.1. Parameters

    + +++++ + + + + + + + + + + + + + + +
    TypeNameSchema

    Path

    toscaModelName
    +required

    string

    +
    +
    +

    2.27.2. Responses

    + +++++ + + + + + + + + + + + + + + +
    HTTP CodeDescriptionSchema

    200

    Output type

    CldsToscaModel

    +
    +
    +

    2.27.3. Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    +
    +

    2.28. PUT /tosca/models/{toscaModelName}

    +
    +

    2.28.1. Parameters

    + +++++ + + + + + + + + + + + + + + + + + + + +
    TypeNameSchema

    Path

    toscaModelName
    +required

    string

    Body

    body
    +required

    CldsToscaModel

    +
    +
    +

    2.28.2. Responses

    + ++++ + + + + + + + + + + + + +
    HTTP CodeSchema

    200

    No Content

    +
    +
    +

    2.28.3. Consumes

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    +

    2.28.4. Produces

    +
    +
      +
    • +

      application/json

      +
      • +
    +
    +
    +
    +
    +

    2.29. GET /user/getUser

    +
    +

    2.29.1. Responses

    + ++++ + + + + + + + + + + + + +
    HTTP CodeSchema

    200

    No Content

    +
    +
    +

    2.29.2. Produces

    +
    +
      +
    • +

      text/plain

      +
      • +
    +
    +
    +
    +
    +
    +
    +

    3. Definitions

    +
    +
    +

    3.1. CldsDictionary

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameSchema

    cldsDictionaryItems
    +optional

    < CldsDictionaryItem > array

    createdBy
    +optional

    string

    dictionaryId
    +optional

    string

    dictionaryName
    +optional

    string

    lastUpdatedDate
    +optional

    string

    updatedBy
    +optional

    string

    +
    +
    +

    3.2. CldsDictionaryItem

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameSchema

    createdBy
    +optional

    string

    dictElementDesc
    +optional

    string

    dictElementId
    +optional

    string

    dictElementName
    +optional

    string

    dictElementShortName
    +optional

    string

    dictElementType
    +optional

    string

    dictionaryId
    +optional

    string

    lastUpdatedDate
    +optional

    string

    updatedBy
    +optional

    string

    +
    +
    +

    3.3. CldsEvent

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameSchema

    actionCd
    +optional

    string

    actionStateCd
    +optional

    string

    id
    +optional

    string

    processInstanceId
    +optional

    string

    userid
    +optional

    string

    +
    +
    +

    3.4. CldsInfo

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameSchema

    cldsVersion
    +optional

    string

    permissionReadCl
    +optional

    boolean

    permissionReadTemplate
    +optional

    boolean

    permissionReadTosca
    +optional

    boolean

    permissionUpdateCl
    +optional

    boolean

    permissionUpdateTemplate
    +optional

    boolean

    permissionUpdateTosca
    +optional

    boolean

    userName
    +optional

    string

    +
    +
    +

    3.5. CldsModel

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + @@ -1932,6 +2599,11 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b + + + + @@ -1990,7 +2662,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    NameSchema

    blueprintText
    +optional

    string

    bpmnText
    +optional

    string

    cldsModelInstanceList
    +optional

    < CldsModelInstance > array

    controlName
    +optional

    string

    controlNamePrefix
    optional

    string

    string

    errorMessageForUi
    +optional

    string

    event
    optional

    CldsEvent

    -

    3.4. CldsModelInstance

    +

    3.6. CldsModelInstance

    @@ -2022,7 +2694,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

    3.5. CldsMonitoringDetails

    +

    3.7. CldsMonitoringDetails

    @@ -2079,7 +2751,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

    3.6. CldsTemplate

    +

    3.8. CldsTemplate

    @@ -2166,7 +2838,74 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

    3.7. DcaeEvent

    +

    3.9. CldsToscaModel

    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameSchema

    createdDate
    +optional

    string

    id
    +optional

    string

    lastUpdatedDate
    +optional

    string

    policyType
    +optional

    string

    revisionId
    +optional

    string

    toscaModelJson
    +optional

    string

    toscaModelName
    +optional

    string

    toscaModelYaml
    +optional

    string

    userId
    +optional

    string

    version
    +optional

    number (double)

    +
    +
    +

    3.10. DcaeEvent

    @@ -2218,7 +2957,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
    -

    3.8. ValueItem

    +

    3.11. ValueItem

    @@ -2244,7 +2983,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b -- cgit 1.2.3-korg