OpenLineage/spec/OpenLineage.yml at main · creazyfrog/OpenLineage · 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
openapi: 3.0.2
info:
  title: OpenLineage
  version: 2.0.2
  description: OpenLineage is an open source **lineage and metadata collection API** for the data ecosystem.
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
paths:
  /lineage:
    post:
      summary: Send an event related to the state of a run, job, or a dataset
      description: Updates a state of a run, job, or a dataset.
      operationId: postRunEvent
      tags:
        - OpenLineage
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: "OpenLineage.json#/$defs/RunEvent"
                - $ref: "OpenLineage.json#/$defs/DatasetEvent"
                - $ref: "OpenLineage.json#/$defs/JobEvent"
      responses:
        "200":
          description: OK
  /lineage/batch:
    post:
      summary: Send a batch of events related to the state of a run, job, or a dataset
      description: A batch of events with updates of a state of a run, job, or a dataset.
      operationId: postEventBatch
      tags:
        - OpenLineage
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                oneOf:
                  - $ref: "OpenLineage.json#/$defs/RunEvent"
                  - $ref: "OpenLineage.json#/$defs/DatasetEvent"
                  - $ref: "OpenLineage.json#/$defs/JobEvent"
      responses:
        "204":
          description: OK response - batch was received
        "200":
          description: OK response - batch was received, response body contains processing details
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - success
                      - partial_success
                    description: Indicates that some events failed to process
                  summary:
                    type: object
                    properties:
                      received:
                        type: integer
                        example: 10
                      successful:
                        type: integer
                        example: 6
                      failed:
                        type: integer
                        example: 4
                      retriable:
                        type: integer
                        example: 2
                      non_retriable:
                        type: integer
                        example: 2
                    required:
                      - received
                      - successful
                      - failed
                  failed_events:
                    type: array
                    items:
                      type: object
                      properties:
                        index:
                          type: integer
                          example: 0
                        reason:
                          type: string
                          description:
                            "Failure reason (example values: Unsupported event type, Unsupported facets, Server error,
                            Timeout)"
                          example: "Unsupported event type, Unsupported facets, Server error, Timeout"
                        retriable:
                          type: boolean
                          example: true
                required:
                  - status
                  - summary