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

   1 ###
   2 # ============LICENSE_START=======================================================
   3 # sdnr
   4 # ================================================================================
   5 # Copyright (C) 2018 Wipro Limited 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         - ModifyConfigANR
  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