summaryrefslogtreecommitdiffstats
path: root/controlloop/common/model-impl/appc/src/main/resources/definitions.yaml
blob: 680a9929c1b51aa3914d62e7ac0be5190b4b5ff0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
###
# ============LICENSE_START=======================================================
# appc
# ================================================================================
# Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
# ================================================================================
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# 
#      http://www.apache.org/licenses/LICENSE-2.0
# 
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ============LICENSE_END=========================================================
###

Request:
  type: object
  properties:
    CommonHeader:
      type: object
      properties:
        TimeStamp:
          type: string
        APIver:
          type: string
          value: '1.01'
        OriginatorID:
          type: string
        RequestID:
          type: string
          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}$"
        SubRequestID:
          type: string
        Flags:
          type: object
      required:
        - TimeStamp
        - APIver
        - OriginatorID
        - RequestID
    Action:
      type: string
      enum:
        - Audit
        - ActionStatus
        - BlockAudits
        - Configure
        - HealthCheck
        - Install
        - LiveUpgrade
        - Migrate
        - ModifyConfig
        - Query
        - Rebuild
        - Reconfigure
        - Restart
        - Rollback
        - Scale
        - Start
        - Stop
        - Sync
        - Terminate
        - Test
        - Upgrade
    TargetID:
      type: string
    ObjectID:
      type: string
    Payload:
      type: object
  required:
    - CommonHeader
    - Action
    - TargetID
Response:
  type: object
  properties:
    CommonHeader:
      type: object
      properties:
        TimeStamp:
          type: string
        APIver:
          type: string
        OriginatorID:
          type: string
        RequestID:
          type: string
        SubRequestID:
          type: string
        Flags:
          type: object
      required:
        - TimeStamp
        - APIver
        - OriginatorID
        - RequestID
    Status:
      type: object
      properties:
        Code:
          type: integer
        Value:
          type: string
      required:
        - Code
        - Value
    Payload:
      type: object
  required:
    - CommonHeader
    - Status