Page MenuHomeSoftware Heritage

create and publish xml schema for the specific swh-deposit metadata
Closed, MigratedEdits Locked

Description

In the metadata-only spec a TODO reside with the following action:
publish schema at https://www.softwareheritage.org/schema/2018/deposit

which is followed with this example:

<?xml version="1.0"?>
  <entry xmlns="http://www.w3.org/2005/Atom"
           xmlns:codemeta="https://doi.org/10.5063/SCHEMA/CODEMETA-2.0"
           xmlns:swh="https://www.softwareheritage.org/schema/2018/deposit">
      <author>
        <name>HAL</name>
        <email>hal@ccsd.cnrs.fr</email>
      </author>
      <client>hal</client>
      <external_identifier>hal-01243573</external_identifier>
      <codemeta:name>The assignment problem</codemeta:name>
      <codemeta:url>https://hal.archives-ouvertes.fr/hal-01243573</codemeta:url>
      <codemeta:identifier>other identifier, DOI, ARK</codemeta:identifier>
      <codemeta:applicationCategory>Domain</codemeta:applicationCategory>
      <codemeta:description>description</codemeta:description>
      <codemeta:author>
          <codemeta:name> author1 </codemeta:name>
          <codemeta:affiliation> Inria </codemeta:affiliation>
          <codemeta:affiliation> UPMC </codemeta:affiliation>
      </codemeta:author>
      <codemeta:author>
          <codemeta:name> author2 </codemeta:name>
          <codemeta:affiliation> Inria </codemeta:affiliation>
          <codemeta:affiliation> UPMC </codemeta:affiliation>
      </codemeta:author>
      <swh:deposit>
        <swh:reference>
          <swh:origin url='https://github.com/user/repo'/>
        </swh:reference>
      </swh:deposit>
  </entry>

We should choose a better url for the schema.
I think there is a draft for that somewhere, but not sure where.

Note to change example in docs/specs/spec-meta-deposit.rst.

Related Objects

Event Timeline

@vlorentz can you take this task ?
It is not a high priority, but you have a good eye with xml and metadata.

Oops, sorry, I missed your comment.

IMO this URI is fine (and we are already using it afaik), we just need to redirect it to a different page to be "self-documenting"

vlorentz changed the task status from Open to Work in Progress.Dec 7 2020, 4:09 PM

Specification is enough to reference than a .xsd file.

vlorentz renamed this task from create and publish xmlns schema for the specific swh-deposit metadata to create and publish xml schema for the specific swh-deposit metadata.Apr 7 2021, 11:30 AM