Skip to content
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

docs(ark): Document ARK URLs for projects #1408

Merged
merged 4 commits into from
Aug 30, 2019
Merged

docs(ark): Document ARK URLs for projects #1408

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
82f7f9c
docs(ark): Document ARKs for projects.
Aug 29, 2019
4dc0e6c
docs(ark): Fix typo.
Aug 29, 2019
098d331
docs(ark): Clarify some things.
Aug 29, 2019
a9ce9df
Merge branch 'develop' into wip/1407-project-ark-doc
Aug 30, 2019
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
17 changes: 17 additions & 0 deletions docs/src/paradox/03-apis/api-v2/permalinks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,23 @@ A Knora ARK URL is intended to be resolved by the [Knora ARK resolver](https://g

For details, see @ref:[Archival Resource Key (ARK) Identifiers](../../05-internals/design/api-v2/ark.md).

### ARK URLs for Projects

The format of a Knora project ARK URL is as follows:

```
http://HOST/ark:/NAAN/VERSION/PROJECT
```

For example, given a project with ID `0001`, and using the DaSCH's ARK resolver
hostname and NAAN, the ARK URL for the project itself is:

```
http://ark.dasch.swiss/ark:/72163/1/0001
```

This could redirect to a page describing the project.

### ARK URLs for Resources

The format of a Knora resource ARK URL is as follows:
Expand Down
12 changes: 9 additions & 3 deletions docs/src/paradox/05-internals/design/api-v2/ark.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,9 +84,15 @@ The `RESOURCE_UUID` and `VALUE_UUID` are processed as follows:
2. Any `-` characters in the resulting string are replaced with `=`, because
`base64url` encoding uses `-`, which is a reserved character in ARK URLs.

For example, given the Knora resource IRI `http://rdfh.ch/0001/0C-0L1kORryKzJAJxxRyRQ`,
and using the DaSCH's ARK resolver hostname and NAAN, the corresponding
ARK URL without a timestamp is:
For example, given a project with ID `0001`, and using the DaSCH's ARK resolver
hostname and NAAN, the ARK URL for the project itself is:

```
http://ark.dasch.swiss/ark:/72163/1/0001
```

Given the Knora resource IRI `http://rdfh.ch/0001/0C-0L1kORryKzJAJxxRyRQ`,
the corresponding ARK URL without a timestamp is:

```
http://ark.dasch.swiss/ark:/72163/1/0001/0C=0L1kORryKzJAJxxRyRQY
Expand Down