Author: buildbot
Date: Fri Jan 13 13:56:06 2012
New Revision: 802543
Log:
Staging update by buildbot for stanbol
Modified:
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/factstore/specification.html
Modified:
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/factstore/specification.html
==============================================================================
---
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/factstore/specification.html
(original)
+++
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/factstore/specification.html
Fri Jan 13 13:56:06 2012
@@ -59,7 +59,7 @@
<li>Query language to query for combinations of facts (reasoning)</li>
</ul>
<p>In the following, we will define the required interfaces for the FactStore
plus the required query language.</p>
-<p>''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).</p>
+<p>''Note'': Interfaces will be defined as RESTful service APIs. The payload
of service calls is specified using <a
href="http://www.json-ld.org/spec/ED/20110507/ JSON-LD">Specification version
20110507</a>.</p>
<p>''Note'': The FactStore does not provide any SPARQL endpoint so far. This
could be part of an extended version.</p>
<h2 id="store_interface">Store Interface</h2>
<p>The store interface allows clients to put new fact schemata and according
facts (instances of that schemata) to the FactStore.</p>
@@ -85,51 +85,49 @@
<p>will create the new fact schema for "employeeOf" at the given URL which is
in decoded representation:
/factstore/facts/http://iks-project.eu/ont/employeeOf</p>
<p>Instead one can use the cURL tool for this. Store the fact schema in a JSON
file and then use this command.</p>
-<p>curl
http://localhost:8080/factstore/facts/http%3A%2F%2Fiks-project.eu%2Font%2FemployeeOf
-T spec-example1.json</p>
-<p>|-
- |valign="top"|Example 2: || PUT
/factstore/facts/http%3A%2F%2Fwww.schema.org%2FEvent.attendees<br>with the
following data</p>
-<p>{
- "@context" :
- {
- "sorg" : "http://www.schema.org/";,
- "#types" :
- {
- "event" : "sorg:Event",
- "attendee" : ["sorg:Person","sorg:Organization"]
- }
- }
- }</p>
-<p><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></p>
-<p>''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]
-|}</p>
-<p>==== Get Fact Schema ====</p>
+<div class="codehilite"><pre><span class="n">curl</span> <span
class="n">http:</span><span class="sr">//</span><span
class="n">localhost:8080</span><span class="sr">/factstore/</span><span
class="n">facts</span><span class="o">/</span><span class="n">http</span><span
class="nv">%3A%2F%2Fiks</span><span class="o">-</span><span
class="n">project</span><span class="o">.</span><span class="n">eu</span><span
class="nv">%2Font%2FemployeeOf</span> <span class="o">-</span><span
class="n">T</span> <span class="n">spec</span><span class="o">-</span><span
class="n">example1</span><span class="o">.</span><span class="n">json</span>
+</pre></div>
+
+
+<p>Example 2: PUT
/factstore/facts/http%3A%2F%2Fwww.schema.org%2FEvent.attendees with the
following data</p>
+<div class="codehilite"><pre><span class="p">{</span>
+<span class="s">"@context"</span> <span class="p">:</span>
+ <span class="p">{</span>
+ <span class="s">"sorg"</span> <span class="p">:</span>
<span class="s">"http://www.schema.org/"</span><span
class="p">,</span>
+ <span class="s">"#types"</span> <span class="p">:</span>
+ <span class="p">{</span>
+ <span class="s">"event"</span> <span class="p">:</span>
<span class="s">"sorg:Event"</span><span class="p">,</span>
+ <span class="s">"attendee"</span> <span class="p">:</span>
<span class="p">[</span><span class="s">"sorg:Person"</span><span
class="p">,</span><span class="s">"sorg:Organization"</span><span
class="p">]</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+
+
+<p>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.</p>
+<p>''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.</p>
+<h3 id="get_fact_schema">Get Fact Schema</h3>
+<p>Allows clients to get the definition of an existing fact schema.</p>
+<p>Path: /factstore/facts/{fact-schema-name}</p>
+<p>Method: GET with data type application/json returns HTTP 200 on success.</p>
+<p>Data: The fact schema is returned as a JSON-LD profile.</p>
+<p>Example: GET
/factstore/facts/http%3A%2F%2Fiks-project.eu%2Font%2FemployeeOf will return the
following data:</p>
+<div class="codehilite"><pre><span class="p">{</span>
+ <span class="s">"@context"</span> <span class="p">:</span>
+ <span class="p">{</span>
+ <span class="s">"#types"</span> <span class="p">:</span>
+ <span class="p">{</span>
+ <span class="s">"person"</span> <span class="p">:</span>
<span class="s">"http://iks-project.eu/ont/person"</span><span
class="p">,</span>
+ <span class="s">"organization"</span> <span class="p">:</span>
<span class="s">"http://iks-project.eu/ont/organization"</span>
+ <span class="p">}</span>
+ <span class="p">}</span>
+<span class="p">}</span>
+</pre></div>
+
+
+<p>Status: <strong>Implemented</strong></p>
+<h3 id="publish_new_facts">Publish New Facts</h3>
<p>{|
- |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:</p>
-<p>{
- "@context" :
- {
- "#types" :
- {
- "person" : "http://iks-project.eu/ont/person";,
- "organization" : "http://iks-project.eu/ont/organization";
- }
- }
- }</p>
-<p>|-
-|Status || Implemented in [http://incubator.apache.org/stanbol/ Apache Stanbol]
-|}</p>
-<p>==== 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.
|-
|Path:||/factstore/facts
