openapi.ingestion.yaml 8.7 KB
Newer Older
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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
openapi: 3.0.0
info:
  description: |
    Ingestion Service provides high-level API on top of Workflow service that serves as an entry point for OSDU specific Workflows 
  version: 1.0.0
  title: Ingestion Service API
  contact:
    email: SupportGO3-NRG@epam.com
  license:
    name: Apache 2.0
    url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
security:
  - bearer: []
servers:
  - url: 'os-ingest-attcrcktoa-uc.a.run.app'
paths:
  /v1/submit:
    post:
      tags:
        - Submit
      summary: Submit parser-based ingestion workflow
      operationId: submit
      description: This API is used to trigger a new Workflow Run for a parser-based ingestion Workflow.
      responses:
        '200':
          description: Workflow submitted successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/submitResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '401':
          description: Invalid/Expired Credential
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/parserRequest'
        description: Request payload for pareser ingestion workflow
        
  /v1/submitWithManifest:
    post:
      tags:
        - Submit
      summary: Submit manifest ingestion workflow
      operationId: submitManifest
      description: This API is used to trigger a new Workflow Run for a manifest ingestion Workflow.
      responses:
        '200':
          description: Workflow submitted successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/submitResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '401':
          description: Invalid/Expired Credential
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/manifestRequest'
        description: Request payload for manifest ingestion workflow
        
        
  /v2/submit/manifest:
    post:
      tags:
        - Submit V2
      summary: Submit manifest ingestion workflow
      operationId: submitManifestV2
      description: This API is used to trigger a new Workflow Run for a manifest ingestion Workflow.
      responses:
        '200':
          description: Workflow submitted successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/submitResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '401':
          description: Invalid/Expired Credential
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/manifestRequestV2'
        description: Request payload for manifest ingestion workflow
  
  
components:
  securitySchemes:
    bearer:
      type: apiKey
      name: Authorization
      in: header
  schemas:
    submitResponse:
      title: Submit Request Response
      type: object
      properties:
        WorkflowRunID:
          type: string
          description: ID of triggered Workflow Run
    parserRequest:
      title: Parser Ingestion Request
      type: object
      properties:
        FileID:
          type: string
          example: osdu:file:eea57de21ce242ca9e0860148cf5522f
          description: File ID to process in workflow run associated with DataType
        DataType:
          type: string
          description: Name of the workflow registered in Workflow service
        Context:
          type: object
          description: Execution Context that should be passed to Workflow Run
          properties:
            key1:
              type: string
              example: value1
            key2:
              type: string
              example: value
    manifestRequest:
      title: Manifest Ingestion Request
      type: object
      properties:
        Files:
          type: array
          items:
            type: object
            description: OSDU File Record
        WorkProductComponents:
          type: array
          items:
            type: object
            description: OSDU WPC Record
        WorkProduct:
          type: object
          description: OSDU WP Record
    
    manifestRequestV2:
      title: Manifest Ingestion Request
      type: object
      properties:
        kind:
          type: string
          description: Reflected in Manifest R3 schema. Obsolete parameter.
          example: osdu:wks:Manifest:1.0.0
        ReferenceData:
          type: array
          items:
            type: object
            description: Reference-data are submitted as an array of records.
        MasterData:
          type: array
          items:
            type: object
            description: Master-data is submitted as an array of records.
        Data:
          type: object
          description: Manifest schema for work-product, work-product-component, file ensembles. The items in 'Files' are processed first since they are referenced by 'WorkProductComponents' ('data.Files[]' and 'data.Artefacts[].ResourceID'). The WorkProduct is processed last collecting the WorkProductComponents.
          properties:
            WorkProduct:
              type: object
              description: The work-product component capturing the work-product-component records belonging to this loading/ingestion transaction.
            
            WorkProductComponents:
              description: The list of work-product-components records. The record ids are internal surrogate keys enabling the association of work-product-component records with the work-product records.
              type: array
              items:
                type: object
            Files:
              description: The list of 'Files' or data containers holding the actual data. The record ids are usually internal surrogate keys enabling the association of file records with work-product-component records, namely 'Files' and 'Artefacts' (both referring to file group-type entity types).
              type: array
              items:
                type: object
    
    
    error:
      title: Error
      type: object
      properties:
        code:
          type: integer
          format: int32
        errors:
          type: array
          items:
            $ref: '#/components/schemas/errorDetails'
        message:
          type: string
    errorDetails:
      title: Error Details
      type: object
      properties:
        message:
          type: string
        reason:
          type: string