The model, or application profile, defines the aspects of the conceptual model, ontologies and vocabulary terms that are used by Linked Art. It is not defined with respect to any specific technical method of interaction, for retrieving, updating, harvesting, searching or browsing, allowing many different possible implementations.
This section of the website documents the web-based API, or Application Programming Interface, by which applications can interact with the data from a conforming publisher. This API has been designed with several design principles in mind to ensure that it is as usable as possible for software developers. The documentation is divided into several sections, separating protocol interactions over HTTP from format decisions about the structure of the JSON returned and the links between different JSON endpoints. The endpoints are split up by the core entities of the model, with shared constructs such as Names and Identifiers being described separately.
We follow the notion of Semantic Versioning, with a structure of Major.Minor.Patch in the version numbers. All minor releases are backwards compatible with their major version, but may add new features or clarify technical aspects that were not well defined. Patch releases are only for documentation changes that do not affect functionality, and will be made in-place without a change to the documentation's URI. Major releases are reserved for backwards incompatible changes, and will be made sparingly.
The current version is 0.8.0
Versions before 1.0 are considered to be unstable. This means that any changes may be made at any time, without concern for compatibility. Version 0.9 is reserved for implementation feedback, and is considered as a release candidate for 1.0.
Version 1.0 is expected by the end of calendar year 2021 (delayed due to COVID and other related circumstances).
The Linked Art API
- Design Principles - The underlying principles guiding decisions for the design of the API
- Protocol - The use of HTTP for interacting with the API over the web
- API Format
- JSON-LD Considerations - Core JSON and JSON-LD details
- Shared Constructs - Constructions that are used by many endpoints
- Entity Endpoints - The entities of interest, exposed at JSON-LD endpoints
- JSON Schema - JSON Schema for the API, and derived alternate documentation
- Ecosystem Endpoints - Functional APIs to promote discovery, harvesting and other cross-system interactions
- Class Reference - Which ontology class is which end point?