witboost-collibra-python-data-catalog-plugin/interface-specification.yml at master · agile-lab-dev/witboost-collibra-python-data-catalog-plugin · GitHub

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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
openapi: 3.0.3
info:
  title: Data Catalog Plugin
  description: "This microservice is responsible for provisioning and unprovisioning metadata in Data Catalog"
  version: "2.2.0"
servers:
  - url: /
tags:
  - name: DataCatalogPlugin
    description: Microservice for provisioning and unprovisioning metadata in Data Catalog
paths:
  /v1/validate:
    post:
      tags:
        - DataCatalogPlugin
      summary: Validate a provisioning request
      operationId: validate
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ProvisioningRequest"
        required: true
      responses:
        200:
          description: Validation result
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ValidationResult"
        500:
          description: System problem
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SystemError"
  /v1/provision:
    post:
      tags:
        - DataCatalogPlugin
      summary: Provisioning of metadata in Data Catalog from input descriptor
      operationId: provision
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ProvisioningRequest"
        required: true
      responses:
        200:
          description: Returns the result of the provisioned Data Catalog entities
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ProvisioningStatus"
        400:
          description: Invalid input
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/RequestValidationError"
        500:
          description: System problem
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SystemError"
  /v1/unprovision:
    post:
      tags:
        - DataCatalogPlugin
      summary: Unprovisioning of metadata in Data Catalog from input descriptor
      operationId: unprovision
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ProvisioningRequest"
        required: true
      responses:
        200:
          description: Returns an OK result
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ProvisioningStatus"
        400:
          description: Invalid input
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/RequestValidationError"
        500:
          description: System problem
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SystemError"
  /v1/provision/{token}/status:
    get:
      tags:
        - DataCatalogPlugin
      summary: Get the status for a provisioning request
      operationId: getStatus
      parameters:
        - name: token
          in: path
          required: true
          schema:
            type: string
      responses:
        200:
          description: The request status
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ProvisioningStatus"
        500:
          description: System problem
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SystemError"
components:
  schemas:
    ProvisioningRequest:
      required:
        - descriptorKind
        - descriptor
      type: object
      properties:
        descriptorKind:
          $ref: "#/components/schemas/DescriptorKind"
        descriptor:
          type: string
    DescriptorKind:
      type: string
      enum: [DATAPRODUCT_DESCRIPTOR, DATAPRODUCT_DESCRIPTOR_WITH_RESULTS]
    ValidationResult:
      required:
        - valid
      type: object
      properties:
        valid:
          type: boolean
        error:
          $ref: "#/components/schemas/ValidationError"
    ValidationError:
      required:
        - errors
      type: object
      properties:
        errors:
          type: array
          items:
            type: string
    ProvisioningStatus:
      required:
        - status
        - result
      properties:
        status:
          type: string
          enum: [RUNNING, COMPLETED, FAILED]
        result:
          type: string
        info:
          $ref: "#/components/schemas/Info"
    Info:
      type: object
      required:
        - publicInfo
        - privateInfo
      properties:
        publicInfo:
          type: object
        privateInfo:
          type: object
    RequestValidationError:
      required:
        - errors
      type: object
      properties:
        errors:
          type: array
          items:
            type: string
        userMessage:
          type: string
        moreInfo:
          $ref: "#/components/schemas/ErrorMoreInfo"
    ErrorMoreInfo:
      required:
        - problems
        - solutions
      type: object
      properties:
        problems:
          type: array
          items:
            type: string
        solutions:
          type: array
          items:
            type: string
    SystemError:
      required:
        - error
      type: object
      properties:
        error:
          type: string
    EntityReference:
      required:
        - reference
      properties:
        reference:
          type: string