docs/offeredapis/api_status/api.plantuml

   1 #
   2 #     Copyright (c) 2018 Orange
   3 #
   4 #     Licensed under the Apache License, Version 2.0 (the "License");
   5 #     you may not use this file except in compliance with the License.
   6 #     You may obtain a copy of the License at
   7 #
   8 #         http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 #     Unless required by applicable law or agreed to in writing, software
  11 #     distributed under the License is distributed on an "AS IS" BASIS,
  12 #     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 #     See the License for the specific language governing permissions and
  14 #     limitations under the License.
  15 #
  16
  17 @startuml
  18
  19 enum StatusValue {
  20    ok
  21    ko
  22 }
  23 enum ComponentsName {
  24    sdc connectivity
  25    so connectivity
  26    aai connectivity
  27    dmaap connectivity
  28 }
  29 enum ApplicationName {
  30    nbi
  31 }
  32
  33 class ErrorDetail {
  34    code:int
  35    message:string
  36    description:string
  37    infoURL:string
  38 }
  39
  40 class Error {
  41    code:int
  42    message:string
  43    description:string
  44    infoURL:string
  45 }
  46    Error --> "0-*" ErrorDetail : details
  47
  48 class Component
  49    Component --> "1-1" ComponentsName : name
  50    Component --> "1-1" StatusValue : status
  51
  52 class Status {
  53    version:string
  54 }
  55    Status --> "1-1" ApplicationName : name
  56    Status --> "1-1" StatusValue : status
  57    Status --> "0-*" Component : components
  58
  59 @enduml