Merge pull request #764 from hubmapconsortium/Derek-Furst/reorganize-…

…metadata Derek furst/reorganize metadata
hubmapconsortium · Dec 3, 2024 · 6411026 · 6411026
2 parents e8a67ac + 7ef440a
commit 6411026
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 6 deletions.
diff --git a/entity-api-spec.yaml b/entity-api-spec.yaml
@@ -710,7 +710,16 @@ components:
           description: "The email address of the user who published the provided by the authorization mechanism for the person or process authenticated when published."
         ingest_metadata:
           type: object
-          description: "The metadata returned from the ingest pipeline processing at data submission time.  Provided as json."
+          description: "Information associated with running the ingest and processing pipelines."
+        metadata:
+          type: object
+          description: "Metadata associated with the ingested experimental data."
+        files:
+          type: array
+          description: "A list of files associated with the dataset."
+        calculated_metadata:
+          type: object
+          description: "Calculated metadata outputted from the processing pipeline."
         local_directory_rel_path:
           type: string
           readOnly: true
@@ -1114,7 +1123,16 @@ components:
           description: "The email address of the user who published the provided by the authorization mechanism for the person or process authenticated when published."
         ingest_metadata:
           type: object
-          description: "The metadata returned from the ingest pipeline processing at data submission time.  Provided as json."
+          description: "Information associated with running the ingest and processing pipelines."
+        metadata:
+          type: object
+          description: "Metadata associated with the ingested experimental data."
+        files:
+          type: array
+          description: "A list of files associated with the dataset."
+        calculated_metadata:
+          type: object
+          description: "Calculated metadata outputted from the processing pipeline."
         local_directory_rel_path:
           type: string
           readOnly: true

diff --git a/src/schema/provenance_schema.yaml b/src/schema/provenance_schema.yaml
@@ -302,9 +302,8 @@ ENTITIES:
     # Dataset can be either derivation source or target
     excluded_properties_from_public_response:
       - lab_dataset_id
-      - ingest_metadata:
-          metadata:
-            - lab_id
+      - metadata:
+        - lab_id
     derivation:
       source: true
       target: true
@@ -465,7 +464,31 @@ ENTITIES:
       ingest_metadata:
         type: json_string # dict
         indexed: true
-        description: "The metadata returned from the processing at data submission time."
+        description: "Information associated with running the ingest and processing pipelines."
+      metadata:
+        type: json_string
+        indexed: true
+        description: "Metadata associated with the ingested experimental data."
+        before_property_create_validators:
+          - validate_application_header_before_property_update
+        before_property_update_validators:
+          - validate_application_header_before_property_update
+      files:
+        type: list
+        indexed: true
+        before_property_create_validators:
+          - validate_application_header_before_property_update
+        before_property_update_validators:
+          - validate_application_header_before_property_update
+        description: "A list of files associated with the dataset." 
+      calculated_metadata:
+        type: json_string
+        indexed: true
+        before_property_create_validators:
+          - validate_application_header_before_property_update
+        before_property_update_validators:
+          - validate_application_header_before_property_update
+        description: "Calculated metadata outputted from the processing pipeline." 
       local_directory_rel_path:
         # Example: protected/<TMC>/<uuid>
         type: string