Author: agruber
Date: Fri Jul 1 11:53:25 2011
New Revision: 1141908
URL: http://svn.apache.org/viewvc?rev=1141908&view=rev
Log:
added entityhub documentation draft
Added:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/entityhub.mdtext
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/index.mdtext
Added: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/entityhub.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/entityhub.mdtext?rev=1141908&view=auto
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/entityhub.mdtext
(added)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/entityhub.mdtext
Fri Jul 1 11:53:25 2011
@@ -0,0 +1,34 @@
+Title: Entityhub
+
+The Entityhub provides two main services. One allows to manage a __network of
sites__ to consume entity information and the second allows to __manage locally
used entities__. They provide the connection to external linked open data sites
as well as using indexes of them locally. The
+
+## Service Endpoints
+
+The RESTful API of the Entityhub ist structured as follows:
+
+### Entity Network ("/entityhub/site*"):
+
+- The Referenced Site Manager
[/entityhub/sites](http://localhost:8080/entityhub/sites) allows to manages
Sites and retrieve/search Entities in all sites of the Entity Network.
+- A Referenced Site @ /entityhub/site/{siteName} refers to a single site of
the Referenced Site Manager and allows to retrieve all active sites. Referenced
sites provide the same interface as the referenced site manager. Currently
active referenced sites at the demo server are available and running for
[dbpedia](http://dev.iks-project.eu:8080/entityhub/site/dbpedia/),
[dplp](http://dev.iks-project.eu:8080/entityhub/site/dblp/) and
[geonames](http://dev.iks-project.eu:8080/entityhub/site/geonames/).
+
+
+### Entityhub ("/entityhub"):
+
+- Local Entities @/entityhub/entity: Full CRUD operations on Entities managed
by the Entityhub
+- Entity Mappings @ /entityhub/mapping: Lookup mappings from local Entities to
Entities managed by a Referenced Site
+- Local Search @/entityhub/find: Find locally managed Entities by label based
search.
+- Local Query @/entityhub/query: Find locally managed Entities by parsing
queries
+- Entity Lookup @/entityhub/lookup: Lookup Entities by id. This supports also
to lookup Entities managed by Referenced Sites and the import of found Entities
to the Entityhub.
+
+
+## Usage Examples for its services
+
+(TODO: add concrete examples)
+
+- [__Referenced__](http://localhost:8080/entityhub/sites/referenced)
+
+- [__Find__](http://localhost:8080/entityhub/sites/find): Label based search
+
+- [__Query__](http://localhost:8080/entityhub/sites/query)
+
+- [__Entity__](http://localhost:8080/entityhub/sites/entity)
Modified: incubator/stanbol/site/trunk/content/stanbol/docs/trunk/index.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/index.mdtext?rev=1141908&r1=1141907&r2=1141908&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/index.mdtext
(original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/index.mdtext Fri
Jul 1 11:53:25 2011
@@ -92,7 +92,7 @@ A detailed technical documentation of it
* [Stanbol Services](services.html)
* [Enhancer](enhancer.html)
* [Enhancement Engines](engines.html)
-* Entityhub
+* [Entityhub](entityhub.html)
* Contenthub
* CMS Adapter
* Ontology Manager
