Author: fchrist
Date: Fri Jan 13 13:56:00 2012
New Revision: 1231068
URL: http://svn.apache.org/viewvc?rev=1231068&view=rev
Log:
STANBOL-456 Incrementally moving FactStore specification from IKS Wiki
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/factstore/specification.mdtext
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/factstore/specification.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/factstore/specification.mdtext?rev=1231068&r1=1231067&r2=1231068&view=diff
==============================================================================
---
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/factstore/specification.mdtext
(original)
+++
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/factstore/specification.mdtext
Fri Jan 13 13:56:00 2012
@@ -10,7 +10,7 @@ In the following, we will refer to seman
In the following, we will define the required interfaces for the FactStore
plus the required query language.
-''Note'': Interfaces will be defined as RESTful service APIs. The payload of
service calls is specified using [http://www.json-ld.org/spec/ED/20110507/
JSON-LD] (Specification version 20110507).
+''Note'': Interfaces will be defined as RESTful service APIs. The payload of
service calls is specified using [Specification version
20110507](http://www.json-ld.org/spec/ED/20110507/ JSON-LD).
''Note'': The FactStore does not provide any SPARQL endpoint so far. This
could be part of an extended version.
@@ -46,59 +46,53 @@ will create the new fact schema for "emp
Instead one can use the cURL tool for this. Store the fact schema in a JSON
file and then use this command.
- curl
http://localhost:8080/factstore/facts/http%3A%2F%2Fiks-project.eu%2Font%2FemployeeOf
-T spec-example1.json
+ curl
http://localhost:8080/factstore/facts/http%3A%2F%2Fiks-project.eu%2Font%2FemployeeOf
-T spec-example1.json
- |-
- |valign="top"|Example 2: || PUT
/factstore/facts/http%3A%2F%2Fwww.schema.org%2FEvent.attendees<br>with the
following data
+Example 2: PUT /factstore/facts/http%3A%2F%2Fwww.schema.org%2FEvent.attendees
with the following data
- {
- "@context" :
- {
- "sorg" : "http://www.schema.org/";,
- "#types" :
- {
- "event" : "sorg:Event",
- "attendee" : ["sorg:Person","sorg:Organization"]
- }
- }
- }
+ {
+ "@context" :
+ {
+ "sorg" : "http://www.schema.org/";,
+ "#types" :
+ {
+ "event" : "sorg:Event",
+ "attendee" : ["sorg:Person","sorg:Organization"]
+ }
+ }
+ }
-<nowiki>will create the new fact schema for "attendees" at the given URL which
is in decoded representation:
/factstore/facts/http://www.schema.org/Event.attendees.</nowiki>
+will create the new fact schema for "attendees" at the given URL which is in
decoded representation: /factstore/facts/http://www.schema.org/Event.attendees.
-''Note'': <nowiki>That this fact schema uses the ability to define more than
one possible type for a role. The role 'attendee' can be of type
http://www.schema.org/Person or http://www.schema.org/Organization.</nowiki>
-|-
-|Status || Implemented in [http://incubator.apache.org/stanbol/ Apache Stanbol]
-|}
+''Note'': This fact schema uses the ability to define more than one possible
type for a role. The role 'attendee' can be of type
http://www.schema.org/Person or http://www.schema.org/Organization.
-==== Get Fact Schema ====
+### Get Fact Schema ###
-{|
- |valign="top"|Description: || Allows clients to get the definition of an
existing fact schema.
- |-
- |Path: || /factstore/facts/{fact-schema-name}
- |-
- |Method: || GET with data type application/json returns HTTP 200 on success.
- |-
- |valign="top"|Data: || The fact schema is returned as a JSON-LD profile.
- |-
- |valign="top"|Example: || GET
/factstore/facts/http%3A%2F%2Fiks-project.eu%2Font%2FemployeeOf<br>will return
the following data:
+Allows clients to get the definition of an existing fact schema.
- {
- "@context" :
- {
- "#types" :
- {
- "person" : "http://iks-project.eu/ont/person";,
- "organization" : "http://iks-project.eu/ont/organization";
- }
- }
- }
+Path: /factstore/facts/{fact-schema-name}
-|-
-|Status || Implemented in [http://incubator.apache.org/stanbol/ Apache Stanbol]
-|}
+Method: GET with data type application/json returns HTTP 200 on success.
+
+Data: The fact schema is returned as a JSON-LD profile.
+
+Example: GET /factstore/facts/http%3A%2F%2Fiks-project.eu%2Font%2FemployeeOf
will return the following data:
+
+ {
+ "@context" :
+ {
+ "#types" :
+ {
+ "person" : "http://iks-project.eu/ont/person";,
+ "organization" : "http://iks-project.eu/ont/organization";
+ }
+ }
+ }
+
+Status: **Implemented**
+
+### Publish New Facts ###
-==== Publish New Facts ====
{|
|valign="top"|Description:||Allows clients to publish a new facts according
to a defined fact schema that was previously published to the FactStore. Each
new fact is an n-tuple according to its schema where each tuple element
identifies an entity using its unique IRI.
|-
