Skip to content

Commit

Permalink
doc improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
chicco785 committed Nov 19, 2020
1 parent 4ffe326 commit 1f65c60
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 9 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -81,4 +85,4 @@ consistency.

QuantumLeap is licensed under the [MIT](LICENSE) License

© 2017-2019 Martel Innovate
© 2017-2020 Martel Innovate
19 changes: 12 additions & 7 deletions docs/manuals/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.

Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 1f65c60

Please sign in to comment.