docs/offeredapis/api_serviceCatalog/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 LifecycleStatusValues {
  20    NOT_CERTIFIED_CHECKOUT
  21    NOT_CERTIFIED_CHECKIN
  22    READY_FOR_CERTIFICATION
  23    CERTIFICATION_IN_PROGRESS
  24    CERTIFIED
  25 }
  26 enum DistributionStatus {
  27    DISTRIBUTION_NOT_APPROVED
  28    DISTRIBUTION_APPROVED
  29    DISTRIBUTED
  30    DISTRIBUTION_REJECTED
  31 }
  32
  33 class ErrorRepresentation {
  34    code:int
  35    reason:string
  36    message:string
  37    status:string
  38    referenceErrror:string
  39    @type:string
  40    @schemaLocation:string
  41 }
  42
  43 class TimePeriod {
  44    startDateTime:dateTime
  45    endDateTime:dateTime
  46 }
  47
  48 class RelatedPartyRef {
  49    id:string
  50    role:string
  51    name:string
  52 }
  53
  54 class ServiceSpecification {
  55    id:string
  56    href:string
  57    name:string
  58    description:string
  59    @type:string
  60    @schemaLocation:string
  61    @baseType:string
  62    invariantUUID:string
  63    toscaModelURL:string
  64    toscaResourceName:string
  65    category:string
  66    subcategory:string
  67    version:string
  68 }
  69    ServiceSpecification --> "0-1" DistributionStatus : distributionStatus
  70    ServiceSpecification --> "0-1" LifecycleStatusValues : lifecycleStatus
  71    ServiceSpecification --> "0-1" TargetServiceSchemaRef : targetServiceSchema
  72    ServiceSpecification --> "0-*" Attachment : attachment
  73    ServiceSpecification --> "0-*" RelatedPartyRef : relatedParty
  74    ServiceSpecification --> "0-*" ResourceSpecificationRef : resourceSpecification
  75    ServiceSpecification --> "0-*" ServiceSpecCharacteristic : serviceSpecCharacteristic
  76
  77 class ServiceSpecCharacteristic {
  78    name:string
  79    description:string
  80    valueType:string
  81    @type:string
  82    @schemaLocation:string
  83    required:boolean
  84    status:string
  85 }
  86    ServiceSpecCharacteristic --> "0-*" ServiceSpecCharacteristicValue : serviceSpecCharacteristicValue
  87
  88 class Attachment {
  89    id:string
  90    name:string
  91    description:string
  92    @type:string
  93    artifactLabel:string
  94    artifactGroupType:string
  95    artifactTimeout:string
  96    artifactChecksum:string
  97    artifactVersion:string
  98    generatedFromUUID:string
  99    url:string
 100    mimeType:string
 101 }
 102
 103 class ServiceSpecCharacteristicValue {
 104    valueType:string
 105    isDefault:boolean
 106    value:string
 107 }
 108
 109 class ResourceSpecificationRef {
 110    id:string
 111    version:string
 112    name:string
 113    @type:string
 114    resourceInstanceName:string
 115    resourceInvariantUUID:string
 116    resourceType:string
 117    modelCustomizationName:string
 118    modelCustomizationId:string
 119 }
 120
 121 class TargetServiceSchemaRef {
 122    @type:string
 123    @schemaLocation:string
 124 }
 125
 126 @enduml