Skip to content

Adding Recipe for Versioning #284

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
PonteIneptique wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Adding Recipe for Versioning #284

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 93 additions & 0 deletions Cookbook.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,99 @@

The cookbook is a set of recipes to help you deal with common questions about how you might want to express some things using DTS. These are not *enforced* standard practices but recommendations.

## Handling Versioning of `Resource` in DTS

### Purpose

This recipe explains one natural way to represent versioning in Distributed Text Services (DTS) Resources. Versioning is **completely optional** and should be used only when necessary for your project, because it introduces extra effort and maintenance for the data provider.

We leverage two features:

1. The ability of a `Resource` to have its own members (`member`).
2. Dublin Core terms: `isVersionOf` (pointing to previous version[s]), `hasVersion` (listing current version) and `identifier` (identifying current version).

### Design Concept

The main idea is:

- The **root Resource** represents the latest version and is described as a standard DTS `Resource`.
- Older versions are included as `member` resources.
- Links between the resources are expressed via `hasVersion` and `isVersionOf`.
- The current version is also marked using the `identifier` property, so clients know which member represents the current or canonical version.

This way, the root resource is always aligned with the current version, while historical versions remain discoverable.

### Example (JSON-LD)

```javascript
{
"@context": "https://distributed-text-services.github.io/specifications/context/1.0rc1.json",
"dtsVersion": "1.0rc1",
"@id": "https://digitallatin.org/ids/Calpurnius_Siculus-Bucolica",
"@type": "Resource",
"title": "Bucolica",
"totalParents": 1,
"totalChildren": 2,
"collection": "/api/dts/collection/?id=https://digitallatin.org/ids/Calpurnius_Siculus-Bucolica(&nav}",
"document": "/api/dts/document?resource=https://digitallatin.org/ids/Calpurnius_Siculus-Bucolica{&ref,start,end,tree,mediaType}",
"navigation": "/api/dts/navigation?resource=https://digitallatin.org/ids/Calpurnius_Siculus-Bucolica{&ref,start,end,tree}",
"dublinCore": {
"hasVersion": [
"/api/dts/collection/?id=https://digitallatin.org/ids/Calpurnius_Siculus-Bucolica_2fe456",
"/api/dts/collection/?id=https://digitallatin.org/ids/Calpurnius_Siculus-Bucolica_9a18bc"
],
"identifier": "/api/dts/collection/?id=https://digitallatin.org/ids/Calpurnius_Siculus-Bucolica_9a18bc"
},
"citationTrees": [
{
/* ... */
}
],
"member": [
{
"@id": "https://digitallatin.org/ids/Calpurnius_Siculus-Bucolica_9a18bc",
"@type": "Resource",
"title": "Bucolica",
"totalParents": 1,
"totalChildren": 0,
"collection": "/api/dts/collection/?id=https://digitallatin.org/ids/Calpurnius_Siculus-Bucolica_9a18bc(&nav}",
"document": "/api/dts/document?resource=https://digitallatin.org/ids/Calpurnius_Siculus-Bucolica_9a18bc{&ref,start,end,tree,mediaType}",
"navigation": "/api/dts/navigation?resource=https://digitallatin.org/ids/Calpurnius_Siculus-Bucolica_9a18bc{&ref,start,end,tree}",
"dublinCore": {
"isVersionOf": [
"/api/dts/collection/?id=https://digitallatin.org/ids/Calpurnius_Siculus-Bucolica"
]
},
"citationTrees": [
{
/* ... */
}
]
},
{
"@id": "https://digitallatin.org/ids/Calpurnius_Siculus-Bucolica_2fe456",
"@type": "Resource",
"title": "Bucolica",
"totalParents": 1,
"totalChildren": 0,
"collection": "/api/dts/collection/?id=https://digitallatin.org/ids/Calpurnius_Siculus-Bucolica_2fe456(&nav}",
"document": "/api/dts/document?resource=https://digitallatin.org/ids/Calpurnius_Siculus-Bucolica_2fe456{&ref,start,end,tree,mediaType}",
"navigation": "/api/dts/navigation?resource=https://digitallatin.org/ids/Calpurnius_Siculus-Bucolica_2fe456{&ref,start,end,tree}",
"dublinCore": {
"isVersionOf": [
"/api/dts/collection/?id=https://digitallatin.org/ids/Calpurnius_Siculus-Bucolica"
]
},
"citationTrees": [
{
/* ... */
}
]
}
]
}
```

## IIIF

### Link manifests to a catalog entry
Expand Down