Skip to content

v2.0: API Documentation slice up
Compare
Choose a tag to compare
@AndriusA AndriusA released this 30 Nov 23:51
· 1676 commits to main since this release
v2.0
adb5dfb

In this pre-Alpha HAT, we have the following:

  • The full relational database schema for contextualising an individual’s data in a way that it makes sense to the data owner
  • APIs for writing inbound data plugs to import the individual’s data into their HAT APIs for contextualising incoming data into the 5 categories of:
    • People (yourself and the people you interact with);
    • Things (what you use or interact with, especially those IoT devices);
    • Events (what happens to you or what you do in time);
    • Locations (where is the stuff around you is happening);
    • Organisations (what organisations or institutions these activities relate to)
  • APIs to tag (when applicable) these entities and each of their properties with Types and Units of Measurement
  • Data-bundling APIs for selecting what data can be shared with other users and organisations (without contextualisation, contextualised bundle will be available in HAT alpha release)
  • Direct Data Debit implementation to allow others to request access to the data bundles, to grant or withdraw access to data debits and to access linked data when approved.

We also included a demonstrator authentication implementation to grant correct accessibility to API clients based on their assigned privileges credentials (username and password). While you are playing with the pre-Alpha HAT, we will be busy getting the APIs in shape, including making the Data-bundling API to support contextualised data, advanced grouping of such data and to ensure compliance with the HAT Code of Practice (CoP).

The pre-Alpha HAT is written in Scala (2.11.6) and sits on the following technology stack:

  • PostgreSQL relational database (version 9.4)
  • Spray REST/HTTP toolkit (version 1.3.3)
  • Akka (version 2.3.9)
  • Slick as the database access layer (version 2.1)

Detailed configuration guides are available in the repository, including the API documentation.

Assets 2
Loading