controlloop/common/model-impl/appc/src/main/resources/definitions.yaml

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