From 1f65c60bae0eb82da184dda8baf71abb0b94df11 Mon Sep 17 00:00:00 2001 From: "Federico M. Facca" Date: Thu, 19 Nov 2020 13:04:16 +0100 Subject: [PATCH] doc improvements --- README.md | 8 ++++++-- docs/manuals/index.md | 19 ++++++++++++------- 2 files changed, 18 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index d3759357..26d3cfad 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,12 @@ [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/4394/badge)](https://bestpractices.coreinfrastructure.org/projects/4394) QuantumLeap is the first implementation of [an API](https://app.swaggerhub.com/apis/smartsdk/ngsi-tsdb) -that supports the storage of [FIWARE NGSIv2](http://docs.orioncontextbroker.apiary.io/#) +that supports the storage of [FIWARE NGSIv2](https://fiware.github.io/specifications/ngsiv2/stable/) data into a [time series database](https://en.wikipedia.org/wiki/Time_series_database). +It currently also experimentally supports the injection of +[NGSI-LD](https://www.etsi.org/deliver/etsi_gs/CIM/001_099/009/01.01.01_60/gs_CIM009v010101p.pdf) in +a backward compatible way with NGSI-v2 API. I.e. you can retrieve NGSI-LD stored data via NGSI v2 +API and retrieve data will be describe following NGSI v2 format. Want to know more? Refer to the [docs](https://quantumleap.readthedocs.io/en/latest/) or checkout the Extra Resources below. @@ -81,4 +85,4 @@ consistency. QuantumLeap is licensed under the [MIT](LICENSE) License -© 2017-2019 Martel Innovate +© 2017-2020 Martel Innovate diff --git a/docs/manuals/index.md b/docs/manuals/index.md index 92d21bbc..28eea6ae 100644 --- a/docs/manuals/index.md +++ b/docs/manuals/index.md @@ -7,7 +7,8 @@ ## Overview QuantumLeap is a REST service for storing, querying and retrieving -[NGSI v2][ngsi-spec] and [NGSI-LD][nsgi-ld-spec] spatial-temporal data. QuantumLeap converts +[NGSI v2][ngsi-spec] and [NGSI-LD][nsgi-ld-spec] (*experimental support*) +spatial-temporal data. QuantumLeap converts NGSI semi-structured data into tabular format and stores it in a [time-series database][tsdb], associating each database record with a time index and, if present in the NGSI data, a location on Earth. @@ -30,14 +31,18 @@ presently QuantumLeap supports both [CrateDB][crate] and [Timescale][timescale] as back end databases. ### NGSI-LD support -PR #373 introduced basic support for basic [NGSI-LD][nsgi-ld-spec] relying on v2 API. +PR [#373](https://github.com/smartsdk/ngsi-timeseries-api/pulls/373) +introduced basic support for basic [NGSI-LD][nsgi-ld-spec] relying on v2 API. In short this means that using the current endpoint QL can -store NGSI-LD payloads with few caveats (see #398): -* temporal attributes are not supported (#395) - what is relevant here is - that this attributes are +store NGSI-LD payloads with few caveats (see +[#398](https://github.com/smartsdk/ngsi-timeseries-api/issues/398)): +* temporal attributes are not currently supported + ([#395](https://github.com/smartsdk/ngsi-timeseries-api/issues/395)); + what is relevant here is that this attributes are used to create the time index of the series * other attributes may be added as well in future (not a priority probably, - so may not be tackled any time #396) + so may not be tackled any time + [#396](https://github.com/smartsdk/ngsi-timeseries-api/issues/396)) * context is currently not stored. * query endpoints returns NGSIv2 data types. @@ -70,7 +75,7 @@ and backward compatibility (data store as NGSI-LD can be queried as NGSIv2), implementing NGSI-LD temporal api, may not be 100% compliant with the specs. -#### Relation to STH Comet +### Relation to STH Comet Although QuantumLeap and FIWARE [STH Comet][comet] share similar goals, Comet doesn't support multiple database back ends (only MongoDB is available) and doesn't support NGSI v2 either. While