From 93b596b67e1ecd0c4d846912efab111e8ad37a88 Mon Sep 17 00:00:00 2001 From: minotti_c Date: Fri, 5 Dec 2025 10:36:22 +0100 Subject: [PATCH] fix: review required fields --- docs/ingestorManual.md | 80 ++++++++++++++++++++---------------------- 1 file changed, 39 insertions(+), 41 deletions(-) diff --git a/docs/ingestorManual.md b/docs/ingestorManual.md index ccbf285..3dcf197 100644 --- a/docs/ingestorManual.md +++ b/docs/ingestorManual.md @@ -932,53 +932,51 @@ All "Date" fields must follow the date/time format defined in RFC #### Metadata field definitions for datasets of type "base" -| field | type | must | comment | -|------------------|---------------|------|------------------------------------------------------| -| pid | string | m | filled by API automatically, do *not* provide this | -| owner | string | m | filled by datasetIngestor if missing | -| ownerEmail | string | | filled by datasetIngestor if missing | -| orcidOfOwner | string | | | -| contactEmail | string | m | filled by datasetIngestor if missing | -| datasetName | string | | set to "tail" of sourceFolder path if missing | -| sourceFolder | string | m | | -| size | number | | autofilled when OrigDataBlock created | -| packedSize | number | | autofilled when DataBlock created | -| creationTime | date | m | filled by API if missing | -| type | string | m | (raw, derived...) | -| validationStatus | string | | | -| keywords | Array[string] | | | -| description | string | | | -| classification | string | | filled by API or datasetIngestor if missing | -| license | string | | filled by datasetIngestor if missing (CC By-SA 4.0) | -| version | string | | autofilled by API | -| doi | string | | filled as part of publication workflow | -| isPublished | boolean | | filled by datasetIngestor if missing (false) | -| ownerGroup | string | m | must be filled explicitly | -| accessGroups | Array[string] | | filled by datasetIngestor to beamline specific group | -| | | | derived from creationLocation | -| | | | e.g. /PSI/SLS/TOMCAT -> accessGroups=["slstomcat"] | +| field | type | required | comment | +|------------------|---------------|-----------|------------------------------------------------------| +| pid | string | | filled by API automatically, do *not* provide this | +| owner | string | | filled by datasetIngestor if missing | +| ownerEmail | string | | filled by datasetIngestor if missing | +| orcidOfOwner | string | | | +| contactEmail | string | | filled by datasetIngestor if missing | +| datasetName | string | | set to "tail" of sourceFolder path if missing | +| sourceFolder | string | x | | +| size | number | | autofilled when OrigDataBlock created | +| packedSize | number | | autofilled when DataBlock created | +| creationTime | date | | filled by API if missing | +| type | string | x | (raw, derived...) | +| validationStatus | string | | | +| keywords | Array[string] | | | +| description | string | | | +| classification | string | | filled by API or datasetIngestor if missing | +| license | string | | filled by datasetIngestor if missing (CC By-SA 4.0) | +| version | string | | autofilled by API | +| doi | string | | filled as part of publication workflow | +| isPublished | boolean | | filled by datasetIngestor if missing (false) | +| ownerGroup | string | x | must be filled explicitly | +| accessGroups | Array[string] | | filled by datasetIngestor to beamline specific group | #### Additional fields for type="raw" -| field | type | must | comment | -|-----------------------|--------|------|------------------------------------------------------------| -| principalInvestigator | string | m | filled in datasetIngestor if missing (proposal must exist) | -| endTime | date | | filled from datasetIngetor if missing | -| creationLocation | string | m | see known Instrument list below | -| dataFormat | string | | | -| scientificMetadata | object | | | -| proposalId | string | | filled by API automatically if missing | +| field | type | required | comment | +|-----------------------|--------|-----------|------------------------------------------------------------| +| principalInvestigator | string | | filled in datasetIngestor if missing (proposal must exist) | +| endTime | date | | filled from datasetIngetor if missing | +| creationLocation | string | x | see known Instrument list below | +| dataFormat | string | | | +| scientificMetadata | object | | | +| proposalId | string | | filled by API automatically if missing | #### Additional fields for type="derived" -| field | type | must | comment | -|--------------------|---------------|------|---------| -| investigator | string | m | | -| inputDatasets | Array[string] | m | | -| usedSoftware | string | m | | -| jobParameters | object | | | -| jobLogData | string | | | -| scientificMetadata | object | | | +| field | type | required | comment | +|--------------------|---------------|-----------|---------| +| investigator | string | x | | +| inputDatasets | Array[string] | x | | +| usedSoftware | string | x | | +| jobParameters | object | | | +| jobLogData | string | | | +| scientificMetadata | object | | | ### About Scientific Values and Units