data-catalog-services/gitea-pages
0
0
Fork 0
Code Issues Pull Requests 1 Actions Activity

fix: review required fields
All checks were successful
Build and deploy documentation / build-docs (pull_request) Successful in 5s
Details
Lint markdown files / run-markdownlint (pull_request) Successful in 4s
Details
Build and deploy documentation / deploy-docs (pull_request) Has been skipped
Details

Browse Source
This commit is contained in:
minotti_c
2025-12-05 10:36:22 +01:00
parent 779a652f77
commit 93b596b67e
1 changed files with 39 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

80
docs/ingestorManual.md
View File

@@ -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