Get all versions of a record

[fxprunayre]

Quite often datasets are updated on a regular basis and new versions are released and past ones are flagged as superseded/deprecated/archived. Some users have a need of being able to get an overview of all versions of a datasets.

So far, one way to get that overview was to group all versions in a collection but that adds extra work to encode and organize the collection properly eg. https://sdi.eea.europa.eu/catalogue/srv/eng/catalog.search#/metadata/3ccf2fe3-40e3-4968-a54c-5a59510fa5a3

The catalogue is also able to navigate to the next revision of record when a revisionOf association is created between 2 records. eg. https://sdi.eea.europa.eu/catalogue/srv/eng/catalog.search#/metadata/607a6413-b3bf-456f-9ed2-6537006c4771

The main goal is to be able to list for a dataset all versions and more easily navigate to next/previous versions using the API. first/next/previous/last are also concept used in DCAT3 so this can help on the mapping.

AI/LLM tools were used in this contribution.

API for navigating in versions

The API provide an endpoint for retrieving verions:

• GET /records/{metadataUuid}/associated?type=versions returns all past and more recent versions
• GET /records/{metadataUuid}/associated?type=next
• GET /records/{metadataUuid}/associated?type=previous

Those associations can also be retrieved when searching using relatedType parameter.

Encoding of revision

In ISO19115-3, associated resource can link to revision using the association type revisionOf link. Encoding is made using:

<mri:associatedResource>
  <mri:MD_AssociatedResource>
    <mri:associationType>
      <mri:DS_AssociationTypeCode codeListValue="revisionOf"/>
    </mri:associationType>
    <mri:metadataReference uuidref="65d546c6-3577-4938-8322-5d95188779a1"/>
  </mri:MD_AssociatedResource>
</mri:associatedResource>

In the index, this information is stored in agg_associated_revisionOf.

So versions are only supported in ISO19115-3.

Versions navigation

The record view allows to navigate from version to version (as before)

and also display the full list in the lineage section:

Test data

See related-versions-test.zip

Corner cases

Dealing with record privileges

if v3 revisionOf v2 revisionOf v1 and v2 is not public, versions will not list v2 if anonymous but the relationship will be resolved. It is recommended to have all versions in the same publication status.

Remote records

The catalogue allows to link to remote records using a URL. Those are ignored in the version resolution (because it would require to have parsable record where revision can be extracted which is usually not the case. Most of remote records link are pointing to HTML document).

Related work

• Other tool provide similar features eg. zenodo https://zenodo.org/records/18211765

Checklist

• I have read the contribution guidelines
• Pull request provided for main branch, backports managed with label
• Good housekeeping of code, cleaning up comments, tests, and documentation
• Clean commit history broken into understandable chucks, avoiding big commits with hundreds of files, cautious of reformatting and whitespace changes
• Clean commit messages, longer verbose messages are encouraged
• API Changes are identified in commit messages
• Testing provided for features or enhancements using automatic tests
• User documentation provided for new features or enhancements in manual
• Build documentation provided for development instructions in README.md files
• Library management using pom.xml dependency management. Update build documentation with intended library use and library tutorials or documentation

Funded by Ifremer

[sonarqubecloud]

Quality Gate failed

Failed conditions
0.0% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube Cloud