fix syntax

Signed-off-by: Julien Le Dem <julien@apache.org>
mobuchowski · Dec 17, 2020 · ead3e02 · ead3e02
1 parent a17ec19
commit ead3e02
Showing 1 changed file with 16 additions and 13 deletions.
diff --git a/spec/OpenLineage.yml b/spec/OpenLineage.yml
@@ -138,6 +138,7 @@ components:
 # Base Facet
 
     BaseFacet:
+      description: all fields of the base facet are prefixed with _ to avoid name conflicts in facets
       type: object
       properties:
         _producer:
@@ -156,33 +157,35 @@ components:
 
 # Custom facets
     CustomFacet:
+      description: a Custom Facet is defined is a separate spec. field must not start with _
       allOf:
-        - ref: '#/components/schemas/BaseFacet'
+        - $ref: '#/components/schemas/BaseFacet'
         - type: object
-          properties:
           additionalProperties: true
 
 ## Run Facets
     NominalTimeRunFacet:
       allOf:
-        - ref: '#/components/schemas/BaseFacet'
+        - $ref: '#/components/schemas/BaseFacet'
         - type: object
           properties:
             nominalStartTime:
-              description: An [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp representing the nominal start time of the run. AKA the schedule time
+              description: An [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp representing the nominal start time (included) of the run. AKA the schedule time
               type: string
               format: date-time
+              example: "2020-12-17T03:00:00.000Z"
             nominalEndTime:
-              description: An [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp representing the nominal end time of the run.
+              description: An [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp representing the nominal end time (excluded) of the run. (Should be the nominal start time of the next run)
               type: string
               format: date-time
+              example: "2020-12-17T04:00:00.000Z"
           required:
             - nominalStartTime
 
     ParentRunFacet:
       description: the id of the parent run and job, iff this run was spawn from an other run (for example, the Dag run scheduling its tasks)
       allOf:
-        - ref: '#/components/schemas/BaseFacet'
+        - $ref: '#/components/schemas/BaseFacet'
         - type: object
           properties:
             run:
@@ -213,7 +216,7 @@ components:
 ## Job Facets
     DocumentationJobFacet:
       allOf:
-        - ref: '#/components/schemas/BaseFacet'
+        - $ref: '#/components/schemas/BaseFacet'
         - type: object
           properties:
             description:
@@ -224,7 +227,7 @@ components:
 
     SourceCodeLocationJobFacet:
       allOf:
-        - ref: '#/components/schemas/BaseFacet'
+        - $ref: '#/components/schemas/BaseFacet'
         - type: object
           properties:
             type:
@@ -236,7 +239,7 @@ components:
 
     SQLJobFacet:
       allOf:
-        - ref: '#/components/schemas/BaseFacet'
+        - $ref: '#/components/schemas/BaseFacet'
         - type: object
           properties:
             query:
@@ -248,7 +251,7 @@ components:
 ## Dataset facets
     DocumentationDatasetFacet:
       allOf:
-        - ref: '#/components/schemas/BaseFacet'
+        - $ref: '#/components/schemas/BaseFacet'
         - type: object
           properties:
             description:
@@ -260,7 +263,7 @@ components:
 
     SchemaDatasetFacet:
       allOf:
-        - ref: '#/components/schemas/BaseFacet'
+        - $ref: '#/components/schemas/BaseFacet'
         - type: object
           properties:
             fields:
@@ -286,11 +289,11 @@ components:
 
     DatasourceDatasetFacet:
       allOf:
-        - ref: '#/components/schemas/BaseFacet'
+        - $ref: '#/components/schemas/BaseFacet'
         - type: object
           properties:
             name:
               type: string
             uri:
               type: string
-              format: uri
+              format: uri