Skip to content

Latest commit

 

History

History
29 lines (19 loc) · 1.93 KB

RegistryMetadata.md

File metadata and controls

29 lines (19 loc) · 1.93 KB

Registry Metadata

Introduction

We have 3 data exchange mechanisms as described in the Architecture Principles. In as much as possible, we want to create the same metadata for each method, and expose that metadata through a common query device: The SmartAPI registry. The SmartAPI contains a metaKG that describes the edges that each service can provide. Most metadata relates to services that are going to expose information via the metaKG. Below, these methods are abbreviated as S (for SmartAPI), T (for Translator Reasoner API), and G (for Knowledge Graph Exchange).

Additionally, the registry will contain information about services, such as ARAs, that do not expose edges via the metaKG. ARAs also implement the TRAPI interface, but will not expose the same metadata as KP-related TRAPI interfaces. These ARA-style interfaces are abbreviated below as A (for ARA).

This document describes, broadly, the particular metadata that Translator data exchange methods must or should expose. The technical details of how this metadata is specified is located here for SmartAPI-type interfaces, here for Translator Reasoner APIs, here for Knowledge Graph Exchange file formats and here for the Knowledge Graph Exchange Registry.

Change Management

Changes to this document must be made via pull requests. Questions or discussion around a topic that is not easily related to a specific pull request occurs in github issues.

Provider Metadata

  1. Access information (STGA)
  2. Operations (TA)
  3. Request and Response structure (S)

Content Metadata

  1. Node types (STG)
  2. Predicates (STG)
  3. Identifier schemes (STG)
  4. Evidence / Provenance (STG)
  5. Node Properties (STG)
  6. Edge Properties (STG)
  7. Global Statistics (G)