D.13.2.1 FIWARE OpenSpecifications R4 Data front page
From FIWARE Forge Wiki
- Project acronym: FI-Core
- Project full title: Future Internet Core
- Contract No.: 632893
- Strategic Objective: FI.ICT-2011.1.7 Technology foundation: Future Internet Core Platform
- Project Document Number: ICT-2013-FI-632893-13-D.13.2.1
- Project Document Date: 2015.11.02
- Deliverable Type and Security: Public
- Author: Santiago Martínez (TID)
- Contributors: Tali Haham (IBM), Jo Barratt (OKF), Javier López (Naevatec), Fermín Galán (TID), Francisco Romero (TID), Javier García (ATOS), Fabio Mondin (TI), Claudio Venezia (TI), Fabrizio Verroca (TI)
Executive Summary
This document describes the Generic Enablers in the Data/Media and Context Management chapter, their basic functionality and their interactions. These Generic Enablers form the core business framework of the FIWARE platform by supporting the business functionality for commercializing services.
The functionality of the framework is illustrated with several abstract use case diagrams, which show how the individual GE can be used to construct a domain-specific application environment and system architecture.
Each GE Open Specification is first described at a generic level, elaborating on the functional and non-functional properties. Then it is supplemented by a number of specifications according to the interface protocols, API and data formats that are delivered in separate individual documents, one per GE.
This document has the available Open Specifications that have been created in FIWARE as a result of the work in Release 4 of the platform.
There is a major shift in the approach of the Open Specifications in FIWARE. Whereas in the initial Releases (from Release 1 to Release 3) the Open Specification APIs were published on the wiki, from Release 4 onwards the information will be created and published in a more modern and manageable format using auxiliary tools such as apiary and github.
This document is accompanied by a set of annexes contained in separate documents, each one providing the detailed Open Specification API of each GE.
About This Document
FIWARE GE Open Specifications describe the open specifications linked to Generic Enablers GEs of the FIWARE platform (and their corresponding components) being developed in one particular chapter.
GE Open Specifications contain relevant information for users of FIWARE to consume related GE implementations and/or to build compliant products, which can work as alternative implementations of GEs developed in FIWARE. The later may even replace a GE implementation developed in FIWARE within a particular FIWARE instance. GE Open Specifications typically include, but not necessarily are limited to, information such as:
- Description of the scope, behaviour and intended use of the GE
- Terminology, definitions and abbreviations to clarify the meanings of the specification
- Legal information with the terms of use
- The Architecture document is generally included as is for the sake of completeness
- Signature and behaviour of operations linked to APIs (Application Programming Interfaces) that the GE should export. Signature may be specified in a particular language binding or through a RESTful interface interface described using API Blueprint format as per https://github.com/apiaryio/api-blueprint/blob/master/API%20Blueprint%20Specification.md.
- Description of protocols that support interoperability with other GE or third party products
- Description of non-functional features
Intended Audience
The document targets interested parties in architecture and API design, implementation and usage of FIWARE Generic Enablers from the FIWARE platform.
Structure of this Document
The document is generated out of a set of documents provided in the public FIWARE wiki. For the current version of the documents, please visit the public wiki at http://wiki.fiware.org/
The following resources were used to generate this document:
The present document has been created from the wiki using automated tools and part of the links may not work. You may occasionally find oddities in the text format that side effects of the process but they do not deter the quality of the technical contents.
Keyword list
FIWARE, FI-Core, Acceleration Programme, Accelerators, PPP, Architecture Board, Steering Board, Roadmap, Reference Architecture, Generic Enabler, Open Specifications, I2ND, Cloud, IoT, Data/Media and Context Management, Applications/Services and Data Delivery, Delivery Framework , Security, Advanced Middleware, Interfaces to Networks and Robotics, Communities, Tools , Sustainability Support Tools, ICT, es.Internet, Apiary, Github, Latin American Platform.
Changes History
| Release | Major changes description | Date | Editor |
|---|---|---|---|
| v1 | Initial version of the deliverable | 2015-11-02 | Santiago Martínez (TID) |
Table of Contents
| FIWARE WIKI editorial remark: |
| In the final deliverable, somebody would include the TOC here |
Quick Reference Table
This table contains a summary of the basic links to the detailed API on our public resources
- Open Specification: link to the Open Specification as included in http://wiki.fiware.org/Summary of FIWARE Open Specifications (in principle, it is the same one as in the "Structure of this Document" section.
- API definition source: link to the API Blueprint markdown (apib file) in GitHub. If the GE does not have a REST interface, link to alternative source if applicable.
- API Specification Document(HTML version): link to the rendered definition and published as HTML in GitHub(output of the internal automated tool FABRE or alternatively Apiary output)
- Apiary project(optional): link to the API site in apiary.io
