models-interactions/model-impl/appclcm/src/main/resources/definitions.yaml

   1 ###
   2 # ============LICENSE_START=======================================================
   3 # appc
   4 # ================================================================================
   5 # Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6 # Modifications Copyright (C) 2019 Nordix Foundation.
   7 # ================================================================================
   8 # Licensed under the Apache License, Version 2.0 (the "License");
   9 # you may not use this file except in compliance with the License.
  10 # You may obtain a copy of the License at
  11 #
  12 #      http://www.apache.org/licenses/LICENSE-2.0
  13 #
  14 # Unless required by applicable law or agreed to in writing, software
  15 # distributed under the License is distributed on an "AS IS" BASIS,
  16 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17 # See the License for the specific language governing permissions and
  18 # limitations under the License.
  19 # ============LICENSE_END=========================================================
  20 ###
  21
  22 Request:
  23   type: object
  24   properties:
  25     CommonHeader:
  26       type: object
  27       properties:
  28         TimeStamp:
  29           type: string
  30         APIver:
  31           type: string
  32           value: '1.01'
  33         OriginatorID:
  34           type: string
  35         RequestID:
  36           type: string
  37           pattern: "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
  38         SubRequestID:
  39           type: string
  40         Flags:
  41           type: object
  42       required:
  43         - TimeStamp
  44         - APIver
  45         - OriginatorID
  46         - RequestID
  47     Action:
  48       type: string
  49       enum:
  50         - Audit
  51         - ActionStatus
  52         - BlockAudits
  53         - Configure
  54         - HealthCheck
  55         - Install
  56         - LiveUpgrade
  57         - Migrate
  58         - ModifyConfig
  59         - Query
  60         - Rebuild
  61         - Reconfigure
  62         - Restart
  63         - Rollback
  64         - Scale
  65         - Start
  66         - Stop
  67         - Sync
  68         - Terminate
  69         - Test
  70         - Upgrade
  71     TargetID:
  72       type: string
  73     ObjectID:
  74       type: string
  75     Payload:
  76       type: object
  77   required:
  78     - CommonHeader
  79     - Action
  80     - TargetID
  81 Response:
  82   type: object
  83   properties:
  84     CommonHeader:
  85       type: object
  86       properties:
  87         TimeStamp:
  88           type: string
  89         APIver:
  90           type: string
  91         OriginatorID:
  92           type: string
  93         RequestID:
  94           type: string
  95         SubRequestID:
  96           type: string
  97         Flags:
  98           type: object
  99       required:
 100         - TimeStamp
 101         - APIver
 102         - OriginatorID
 103         - RequestID
 104     Status:
 105       type: object
 106       properties:
 107         Code:
 108           type: integer
 109         Value:
 110           type: string
 111       required:
 112         - Code
 113         - Value
 114     Payload:
 115       type: object
 116   required:
 117     - CommonHeader
 118     - Status
 119