Skip to content

Latest commit

 

History

History
107 lines (77 loc) · 4.39 KB

GLOSSARY.md

File metadata and controls

107 lines (77 loc) · 4.39 KB

LDaCA API

Serves RO-Crates from OCFL storage through the arocapi API, and controls access to them by licence.

Language

arocapi's terms, such as Record, Metadata, Content and Row, mean what arocapi's glossary says.

Crates and indexes

Crate: One RO-Crate, stored as one OCFL object in the repository. The unit of import, indexing and admin actions. A collection, object or file belongs to exactly one crate. Avoid: OCFL object (the storage), collection (what a crate may describe)

Shared entity: A person, organisation or software entity that more than one crate may describe. The index keeps one copy of it (ADR 0006). Avoid: Duplicate (a collection, object or file in two crates, which is an error)

Import: Bringing RO-Crates from a directory into the OCFL repository (pnpm crates:import). Avoid: Seed, deposit

Deposit: A crate sent through the deposit API, which writes it to the OCFL repository and indexes it. Avoid: Import, upload

Index: Building the database index and the search index from the repository, for one crate or all of them. A crate whose current version is already indexed is left alone. Both indexes can be deleted and rebuilt at any time. Avoid: Import

Reindex: Deleting a crate's indexes and building them again, whether or not its current version is already indexed. Avoid: Force index, refresh

Index job: A request, waiting or running, to index or reindex one crate or to delete its indexes. Indexing several crates is one index job for each. Avoid: Task, index run

Worker: The process that runs index jobs, separate from the API (ADR 0005). Avoid: Indexer (the code that builds the indexes)

Database index: The Entity and File rows that arocapi reads, written by the indexer (arocapi's Rows). Avoid: Structural index

Search index: The search documents in arocapi's search backend, one per entity that has a row. Avoid: OpenSearch index (one backend's storage)

Index state: What is known about a crate's indexes: not indexed, queued, indexing, deleting, indexed or failed. One state covers both indexes. Avoid: Status

Indexed version: The OCFL version of a crate that its indexes were built from. Avoid: Head version (the latest in the repository, which may be newer)

Virtual crate: The Metadata served for one entity: an RO-Crate with that entity as its root and everything it links to (ADR 0004). Never the crate as deposited. Avoid: Entity crate, exploded crate

Metadata-only crate: A crate that describes files the repository doesn't hold. Its File entities are indexed and visible, but have no Content. Avoid: Damaged crate (one that can't be read)

Shared entity: An entity that more than one crate describes under the same absolute IRI, indexed as one entity. Avoid: Duplicate entity

Aggregates: What Oni shows about an entity and everything below it: how many collections, objects and files are below it, and which languages, communication modes and media types it and they have. A collection's aggregates take in members held in other crates. Avoid: Counts (one part of them), summaries, facets (a search result's)

Authentication

Upstream provider: The one external identity provider, set by configuration, that users sign in at. Avoid: IdP, CILogon (one instance of it), login provider

User: A person who has signed in at the upstream provider, identified by that provider's subject identifier. REMS knows the same person by the same identifier. Avoid: Account, member

Access

Visibility: Whether an entity exists for a request at all. Every entity is visible to everyone (ADR 0003). Avoid: Access

Access: What a request may read of a visible entity, decided by its metadata and content licences. Avoid: Visibility, permissions

Access control: How Oni tells users they can get an entity's content: Public when its content licence is open, otherwise AuthorizationByApplication (apply in REMS). The indexer decides it and stores it with the entity; it describes the licence, not what a particular request may read. Avoid: Access, access level

Admin

Admin: A user who can use the admin pages, currently one whose sub is in ADMIN_USERS. Avoid: Administrator, superuser, staff

Admin pages: The server-rendered admin UI at /admin/ on the admin origin (ADMIN_ORIGIN). Avoid: Portal, admin API