Skip to content
This repository was archived by the owner on Oct 6, 2023. It is now read-only.

Commit 80846e9

Browse files
authored
Update Metadata.md
Test md changes.
1 parent 2371e07 commit 80846e9

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

Metadata.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ Send JSON metadata to be persisted in the back-end. This service persists the d
208208
> ```
209209
210210
<p id='metadata-save-upload-via-api'>
211-
*When uploading a file or container via the API, it must be provided as a "file" or "container" multipart form parameter. File uploads should be a compressed file of type: .zip, .tar, .tar.gz, or .tar.bz2. Container uploads should be Docker or Singularity image files of type: .tar, or .simg*
211+
*When uploading a file or container via the API, it must be provided as a "file" or "container" multipart form parameter. File uploads should be a compressed file of type: .zip, .tar, .tgz, .tar.gz, or .tar.bz2. Container uploads should be Docker or Singularity image files of type: .tar, or .simg*
212212
</p>
213213
214214
### submit
@@ -273,7 +273,7 @@ Validation rules are:
273273
* software type is required:
274274
* "S" (Scientific)
275275
* "B" (Business), also requires at least one sponsoring organization
276-
* If project type is Closed Source, OSTI Hosted ("CO"), a file upload is required. *When uploading a file or container via the API, it must be provided as a "file" or "container" multipart form parameter. File uploads should be a compressed file of type: .zip, .tar, .tar.gz, or .tar.bz2. Container uploads should be Docker or Singularity image files of type: .tar, or .simg*
276+
* If project type is Closed Source, OSTI Hosted ("CO"), a file upload is required. *When uploading a file or container via the API, it must be provided as a "file" or "container" multipart form parameter. File uploads should be a compressed file of type: .zip, .tar, .tgz, .tar.gz, or .tar.bz2. Container uploads should be Docker or Singularity image files of type: .tar, or .simg*
277277
278278
279279
@@ -333,7 +333,7 @@ be announced to DOE. Workflow status remains *Submitted* for this operation. Ad
333333
* email must be valid
334334
* phone number must be valid
335335
* organization name is required
336-
* If project type is not Open Source ("OS"), a file upload is required. *When uploading a file or container via the API, it must be provided as a "file" or "container" multipart form parameter. File uploads should be a compressed file of type: .zip, .tar, .tar.gz, or .tar.bz2. Container uploads should be Docker or Singularity image files of type: .tar, or .simg*
336+
* If project type is not Open Source ("OS"), a file upload is required. *When uploading a file or container via the API, it must be provided as a "file" or "container" multipart form parameter. File uploads should be a compressed file of type: .zip, .tar, .tgz, .tar.gz, or .tar.bz2. Container uploads should be Docker or Singularity image files of type: .tar, or .simg*
337337
338338
339339
@@ -375,24 +375,25 @@ Upon approval, any DOI related identifiers of the type "IsNewVersionOf" or "IsPr
375375
DOE CODE Metadata
376376
===============
377377
A DOE CODE metadata Object is expressed as a JSON entity. Each of the fields making up the entity are defined below, and an example record is provided in JSON format.
378-
A full JSON example is [provided below.](#json_example)
378+
A full JSON example is [provided below](#json_example).
379379
380380
## Metadata Field Information
381381
382382
| Field Name | Description |
383383
| --- | --- |
384384
| code_id | The unique value given to a particular DOE CODE Project record once stored. Should be *null* or not provided for new entries, and will be returned once a record is saved or submitted successfully. |
385385
| accessibility | This refers to how the source of the project type is accessed; must be one of "OS" (open source), "ON" (open source, not public), "CS" (closed source, site hosted), or "CO" (closed source, OSTI hosted) |
386-
| repository_link | If the software project is available via public hosting service, such as github.com, bitbucket.org, etc. the public repository URL should be provided here. |
386+
| repository_link | If the software project is available via public hosting service, such as github.com, bitbucket.org, etc. the public repository URL should be provided here. DOE CODE does not currently support the submission of individual branch URL paths, so this must be a primary or base URL for the repository. |
387387
| landing_page | If the project is not available via open source hosting site, provide a URL describing the project and contact information for obtaining binary or source |
388-
| developers | An array of Objects, providing information about a project's developers or creators. Array order determines display order. Fields are [specified below.](#persons_fields) |
389-
| contributors | An array of information about project contributors. Fields are [specified below.](#persons_fields). Contributors must specify a [type of contribution](#contributor_types) made to the project. |
390-
| sponsoring_organizations | (Array) Information about the project sponsoring organizations, including any funding identifier information. Fields are [specified below.](#organization_fields) |
391-
| contributing_organizations | (Array) Information about any contributing organizations providing support for the software project. Fields are [specified below.](#organization_fields) As with contributors, organizations must specify a [type of contribution](#contributor_types). |
392-
| research_organizations | (Array) Information about organizations providing research information for the project. Fields are [specified below.](#organization_fields) |
388+
| developers | An array of Objects, providing information about a project's developers or creators. Array order determines display order. Fields are [specified below](#persons_fields). |
389+
| contributors | An array of information about project contributors. Fields are [specified below](#persons_fields). Contributors must specify a [type of contribution](#contributor_types) made to the project. |
390+
| sponsoring_organizations | (Array) Information about the project sponsoring organizations, including any funding identifier information. Fields are [specified below](#organization_fields). |
391+
| contributing_organizations | (Array) Information about any contributing organizations providing support for the software project. Fields are [specified below](#organization_fields). As with contributors, organizations must specify a [type of contribution](#contributor_types). |
392+
| research_organizations | (Array) Information about organizations providing research information for the project. Fields are [specified below](#organization_fields). |
393393
| related_identifiers | (Array) Any related links, such as DOIs to published works, additional versions, or documentation information relevant to the software project. |
394394
| description | An abstract about the software project. |
395395
| programming_languages | (Array) Any programming language used on the software project. |
396+
| keywords | Words or phrases that describe the project as summarized in the report/product. Keywords aide in the online search and discovery of information about the project. |
396397
| version_number | The version of the software project. |
397398
| documentation_url | URL providing available documentation for the software project. |
398399
| licenses | Any software licenses or rights information about the software project, may have multiple values, such as the ones at the following <a href='/doecodeapi/services/docs/types#doecode-types-api-valid-types-information-licenses'>endpoint</a>. |

0 commit comments

Comments
 (0)