Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also compare across forks.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also compare across forks.
base fork: dydra/docs.dydra.com
base: fe88be269a
...
head fork: dydra/docs.dydra.com
compare: b3c5c652da
  • 2 commits
  • 1 file changed
  • 0 commit comments
  • 1 contributor
Showing with 85 additions and 85 deletions.
  1. +85 −85 docs/api/sesame.txt
View
170 docs/api/sesame.txt
@@ -4,7 +4,7 @@ Sesame API
Dydra supports Version 2 of the [Sesame HTTP
API](http://www.openrdf.org/doc/sesame2/system/ch08.html).
There are some noteable changes and additions in the Dydra
-Sesame API implmentation that have been documented below.
+Sesame API implementation that have been documented below.
## Authentication
@@ -27,21 +27,21 @@ The following RDF document formats are accepted:
The following variable binding formats are accepted:
* [SPARQL Query Results XML Format](http://www.w3.org/TR/rdf-sparql-XMLres/)
- * Mime type: application/sparql-results+xml
+ * MIME type: application/sparql-results+xml
* [SPARQL Query Results JSON Format](http://www.w3.org/TR/rdf-sparql-json-res/)
- * Mime type: application/sparql-results+json
+ * MIME type: application/sparql-results+json
_**Please note:** the binary RDF results table format is currently not supported._
The following boolean result formats are accepted:
* Plain text boolean result formats
- * Mime type: text/boolean
+ * MIME type: text/boolean
## Sesame API URL Overview
-The root dydra.com URL (`http://dydra.com`) serves as the base Sesame API
-url. This is referred to as the `<SESAME_URL>` in the original OpenRDF Sesame
+The root API URL (`http://api.dydra.com`) serves as the base Sesame API
+URL. This is referred to as the `<SESAME_URL>` in the original OpenRDF Sesame
API documentation as well as this documentation page.
Your repository ID, referred to here as `<REPO_ID>`, is a combination of your
@@ -85,9 +85,9 @@ Additionally, Dydra implements several additional API methods as documented belo
* `PUT /repositories/<REPO_ID>`
* Delete a repository
* `DELETE /repositories/<REPO_ID>`
-* Get repository Meta Data
+* Get repository metadata
* `GET /repositories/<REPO_ID>/meta`
-* Update repository Meta Data
+* Update repository metadata
* `PUT /repositories/<REPO_ID>/meta`
* Repository import status
* `GET /repositories/<REPO_ID>/status`
@@ -105,14 +105,14 @@ Additionally, Dydra implements several additional API methods as documented belo
**Curl Example: Obtaining the current protocol version**
- curl http://dydra.com/protocol
+ curl http://api.dydra.com/protocol
-**Sample Request**
+**Example Request**
GET /protocol HTTP/1.1
Host: dydra.com
-**Sample Response**
+**Example Response**
HTTP/1.1 200 OK
Content-Type: text/plain; charset=utf-8
@@ -134,15 +134,15 @@ specified. (See repository permissions document)
**Curl Example: Showing all repositories**
curl -H 'Accept: application/sparql-results+xml' \
- http://dydra.com/repositories
+ http://api.dydra.com/repositories
-**Sample Request**
+**Example Request**
GET /repositories HTTP/1.1
Host: dydra.com
Accept: application/sparql-results+xml
-**Sample Response**
+**Example Response**
HTTP/1.1 200 OK
Transfer-Encoding: chunked
@@ -160,7 +160,7 @@ specified. (See repository permissions document)
<results ordered='false' distinct='false'>
<result>
<binding name='uri'>
- <uri>http://dydra.com/jhacker/foaf</uri>
+ <uri>http://api.dydra.com/jhacker/foaf</uri>
</binding>
<binding name='id'>
<literal>jhacker/foaf</literal>
@@ -181,15 +181,15 @@ specified. (See repository permissions document)
**Curl Example: Showing repositories for one account**
curl -H 'Accept: application/sparql-results+xml' \
- http://dydra.com/repositories/jhacker
+ http://api.dydra.com/repositories/jhacker
-**Sample Request**
+**Example Request**
GET /repositories/jhacker HTTP/1.1
Host: dydra.com
Accept: application/sparql-results+xml
-**Sample Response**
+**Example Response**
HTTP/1.1 200 OK
Transfer-Encoding: chunked
@@ -214,9 +214,9 @@ this method._
curl -H 'Accept: application/sparql-results+xml' \
-d 'query=select * where {?s ?p ?o}' \
- http://dydra.com/repositories/jhacker/foaf
+ http://api.dydra.com/repositories/jhacker/foaf
-**Sample Request**
+**Example Request**
POST /repositories/jhacker/foaf HTTP/1.1
Host: dydra.com
@@ -224,7 +224,7 @@ this method._
query=select%20*%20where%20%7B%3Fs%20%3Fp%20%3Fo%7D
-**Sample Response**
+**Example Response**
HTTP/1.1 200 OK
Transfer-Encoding: chunked
@@ -265,15 +265,15 @@ documentation is not supported on Dydra.
**Curl Example: Fetching all statements from a repository as N-Triples**
curl -H 'Accept: text/plain' \
- http://dydra.com/repositories/jhacker/foaf/statements
+ http://api.dydra.com/repositories/jhacker/foaf/statements
-**Sample Request**
+**Example Request**
GET /repositories/jhacker/foaf/statements HTTP/1.1
Host: dydra.com
Accept: text/plain
-**Sample Response**
+**Example Response**
HTTP/1.1 200 OK
Transfer-Encoding: chunked
@@ -285,9 +285,9 @@ documentation is not supported on Dydra.
curl -H 'Content-Type: text/plain' \
-d '<http://example.org#jhacker> <http://xmlns.com/foaf/0.1/nick> "jhuckabee" .' \
- http://dydra.com/repositories/jhacker/foaf/statements
+ http://api.dydra.com/repositories/jhacker/foaf/statements
-**Sample Request**
+**Example Request**
POST /repositories/jhacker/foaf/statements HTTP/1.1
Host: dydra.com
@@ -295,16 +295,16 @@ documentation is not supported on Dydra.
<http://example.org#jhacker> <http://xmlns.com/foaf/0.1/nick> "jhuckabee" .
-**Sample Response**
+**Example Response**
HTTP/1.1 204 NO CONTENT
**Curl Example: Adding N-Triples statements to a repository via file upload**
curl -F "file=@data.nt" \
- http://dydra.com/repositories/jhacker/foaf/statements
+ http://api.dydra.com/repositories/jhacker/foaf/statements
-**Sample Request**
+**Example Request**
POST /repositories/jhacker/foaf/statements HTTP/1.1
Host: dydra.com
@@ -317,16 +317,16 @@ documentation is not supported on Dydra.
... contents of data.nt ...
--AaB03x--
-**Sample Response**
+**Example Response**
HTTP/1.1 204 NO CONTENT
**Curl Example: Adding N-Triples statements to a repository via URL**
curl -d "url=http://datagraph.org/jhacker/foaf.nt" \
- http://dydra.com/repositories/jhacker/foaf/statements
+ http://api.dydra.com/repositories/jhacker/foaf/statements
-**Sample Request**
+**Example Request**
POST /repositories/jhacker/foaf/statements HTTP/1.1
Host: dydra.com
@@ -334,7 +334,7 @@ documentation is not supported on Dydra.
url=http%3A%2F%2Fdatagraph.org%2Fjhacker%2Ffoaf.nt
-**Sample Response**
+**Example Response**
HTTP/1.1 204 NO CONTENT
@@ -348,15 +348,15 @@ documentation is not supported on Dydra.
**Curl Example: Obtaining all contexts in a repository**
curl -H 'Accept: application/sparql-results+xml' \
- http://dydra.com/repositories/jhacker/foaf/contexts
+ http://api.dydra.com/repositories/jhacker/foaf/contexts
-**Sample Request**
+**Example Request**
GET /repositories/jhacker/foaf/contexts HTTP/1.1
Host: dydra.com
Content-Type: application/sparql-results+xml
-**Sample Response**
+**Example Response**
HTTP/1.1 200 OK
Transfer-Encoding: cunked
@@ -379,7 +379,7 @@ documentation is not supported on Dydra.
## Namespace declaration lists (8.7)
_**Please note:** In addition to repository level namespace definitions, Dydra
-also supports account level namespace definitions which apply across all repositories
+also supports account-level namespace definitions which apply across all repositories
belonging to that account. The namespace API methods mentioned here and in section 8.8
refer only to those namespaces declared on the repository. See the
[namespace prefixes](/namespace-prefixes) documentation for more details._
@@ -394,15 +394,15 @@ refer only to those namespaces declared on the repository. See the
**Curl Example, obtaining all namespaces defined for a given repository**
curl -H 'Accept: application/sparql-results+xml' \
- http://dydra.com/repositories/jhacker/foaf/namespaces
+ http://api.dydra.com/repositories/jhacker/foaf/namespaces
-**Sample Request**
+**Example Request**
GET /repositories/jhacker/foaf/namespaces HTTP/1.1
Host: dydra.com
Content-Type: application/sparql-results+xml
-**Sample Response**
+**Example Response**
HTTP/1.1 200 OK
Transfer-Encoding: cunked
@@ -429,14 +429,14 @@ refer only to those namespaces declared on the repository. See the
**Curl Example, clearing all namespaces in a repository**
curl -X DELETE -H 'Accept: application/sparql-results+xml' \
- http://dydra.com/repositories/jhacker/foaf/namespaces
+ http://api.dydra.com/repositories/jhacker/foaf/namespaces
-**Sample Request**
+**Example Request**
DELETE /repositories/jhacker/foaf/namespaces HTTP/1.1
Host: dydra.com
-**Sample Response**
+**Example Response**
HTTP/1.1 204 NO CONTENT
@@ -453,14 +453,14 @@ refer only to those namespaces declared on the repository. See the
**Curl Example: Obtaining the identifier for a specific namespace**
- curl http://dydra.com/repositories/jhacker/foaf/namespaces/rdf
+ curl http://api.dydra.com/repositories/jhacker/foaf/namespaces/rdf
-**Sample Request**
+**Example Request**
GET /repositories/jhacker/foaf/namespaces/rdf HTTP/1.1
Host: dydra.com
-**Sample Response**
+**Example Response**
HTTP/1.1 200 OK
Content-Type: text/plain; charset=utf-8
@@ -470,29 +470,29 @@ refer only to those namespaces declared on the repository. See the
**Curl Example: Updating or adding a namespace**
curl -X PUT -d 'http://example.org#' \
- http://dydra.com/repositories/jhacker/foaf/namespaces/example
+ http://api.dydra.com/repositories/jhacker/foaf/namespaces/example
-**Sample Request**
+**Example Request**
PUT /repositories/jhacker/foaf/namespaces/example HTTP/1.1
Host: dydra.com
http://example.org#
-**Sample Response**
+**Example Response**
HTTP/1.1 204 NO CONTENT
**Curl Example: Removing a namespace from a repository**
- curl -X DELETE http://dydra.com/repositories/jhacker/foaf/namespaces/example
+ curl -X DELETE http://api.dydra.com/repositories/jhacker/foaf/namespaces/example
-**Sample Request**
+**Example Request**
DELETE /repositories/jhacker/foaf/namespaces/example HTTP/1.1
Host: dydra.com
-**Sample Response**
+**Example Response**
HTTP/1.1 204 NO CONTENT
@@ -507,14 +507,14 @@ _**Please note:** Dydra's implementation of this method currently does not suppo
**Curl Example, Obtaining the number of triples in a repository**
- curl http://dydra.com/repositories/jhacker/foaf/size
+ curl http://api.dydra.com/repositories/jhacker/foaf/size
-**Sample Request**
+**Example Request**
GET /repositories/jhacker/foaf/size HTTP/1.1
Host: dydra.com
-**Sample Response**
+**Example Response**
HTTP/1.1 200 OK
Content-Type: text/plain
@@ -527,7 +527,7 @@ _**Please note:** Dydra's implementation of this method currently does not suppo
* `summary` (optional): A summary of the data contained within the repository.
* `homepage` (optional): A URL to the repository's home page.
-* `description` (optional): A long form description the repository. This description can contain markdown formatting.
+* `description` (optional): A long form description the repository. This description can contain Markdown formatting.
**Request path:**
@@ -538,16 +538,16 @@ _**Please note:** Dydra's implementation of this method currently does not suppo
curl -X PUT -H 'Accept: application/sparql-results+json' \
-d "summary=A test summary." \
- http://dydra.com/repositories/jhacker/foaf
+ http://api.dydra.com/repositories/jhacker/foaf
-**Sample Request**
+**Example Request**
PUT /repositories/jhacker/foaf HTTP/1.1
Host: dydra.com
summary=A%20test%20summary.
-**Sample Response**
+**Example Response**
HTTP/1.1 204 NO CONTENT
@@ -561,36 +561,36 @@ _**Please note:** Dydra's implementation of this method currently does not suppo
**Curl Example: Deleting a repository**
curl -X DELETE -H 'Accept: text/plain' \
- http://dydra.com/repositories/jhacker/xyz_repository
+ http://api.dydra.com/repositories/jhacker/xyz_repository
-**Sample Request**
+**Example Request**
DELETE /repositories/jhacker/foaf HTTP/1.1
Host: dydra.com
-**Sample Response**
+**Example Response**
HTTP/1.1 204 NO CONTENT
-## Repository Meta Data
+## Repository Metadata
**Request path:**
* `GET /repositories/<REPO_ID>/meta`
- * Obtain repository meta data
+ * Obtain repository metadata
-**Curl Example: Getting repository meta data**
+**Curl Example: Getting repository metadata**
curl -H 'Accept: application/sparql-results+xml' \
- http://dydra.com/repositories/jhacker/xyz_repository/meta
+ http://api.dydra.com/repositories/jhacker/xyz_repository/meta
-**Sample Request**
+**Example Request**
GET /repositories/jhacker/foaf/meta HTTP/1.1
Accept: application/sparql-results+xml
Host: dydra.com
-**Sample Response**
+**Example Response**
HTTP/1.1 200 OK
@@ -611,7 +611,7 @@ _**Please note:** Dydra's implementation of this method currently does not suppo
<results ordered="false" distinct="false">
<result>
<binding name="uri">
- <uri>http://dydra.com/jhacker/foaf</uri>
+ <uri>http://api.dydra.com/jhacker/foaf</uri>
</binding>
<binding name="id">
<literal>jhacker/foaf</literal>
@@ -632,7 +632,7 @@ _**Please note:** Dydra's implementation of this method currently does not suppo
<literal></literal>
</binding>
<binding name="homepage">
- <uri>http://dydra.com/jhacker/foaf</uri>
+ <uri>http://api.dydra.com/jhacker/foaf</uri>
</binding>
<binding name="triple_count">
<literal>14</literal>
@@ -644,7 +644,7 @@ _**Please note:** Dydra's implementation of this method currently does not suppo
</results>
</sparql>
-## Updating Repository Meta Data
+## Updating Repository Metadata
**Parameters:**
@@ -655,21 +655,21 @@ _**Please note:** Dydra's implementation of this method currently does not suppo
**Request path:**
* `PUT /repositories/<REPO_ID>/meta`
- * Updating repository meta data
+ * Updating repository metadata
-**Curl Example: Updating repository meta data**
+**Curl Example: Updating repository metadata**
curl -X PUT -d "summary=A test summary." \
- http://dydra.com/repositories/jhacker/xyz_repository/meta
+ http://api.dydra.com/repositories/jhacker/xyz_repository/meta
-**Sample Request**
+**Example Request**
PUT /repositories/jhacker/foaf/meta HTTP/1.1
Host: dydra.com
summary=A%20test%20summary.
-**Sample Response**
+**Example Response**
HTTP/1.1 204 NO CONTENT
@@ -682,15 +682,15 @@ _**Please note:** Dydra's implementation of this method currently does not suppo
**Curl Example, Obtaining the import status of a repository**
- curl http://dydra.com/repositories/jhacker/foaf/status
+ curl http://api.dydra.com/repositories/jhacker/foaf/status
-**Sample Request**
+**Example Request**
PUT /repositories/jhacker/foaf/status HTTP/1.1
Host: dydra.com
Accept: application/sparql-results+xml
-**Sample Response**
+**Example Response**
HTTP/1.1 200 OK
Content-Type: application/sparql-results+xml
@@ -739,15 +739,15 @@ _**Please note:** Dydra's implementation of this method currently does not suppo
**Curl Example, Obtaining a list of active operations**
curl -H 'Accept: application/sparql-results+xml' \
- http://dydra.com/ops
+ http://api.dydra.com/ops
-**Sample Request**
+**Example Request**
GET /ops HTTP/1.1
Host: dydra.com
Accept: application/sparql-results+xml
-**Sample Response**
+**Example Response**
HTTP/1.1 200 OK
Content-Type: application/sparql-results+xml
@@ -796,15 +796,15 @@ _**Please note:** Dydra's implementation of this method currently does not suppo
**Curl Example, Obtaining the status of a single operation**
curl -H 'Accept: application/sparql-results+xml' \
- http://dydra.com/repositories/ops/efa56560-5e18-012e-47b0-002332b96472
+ http://api.dydra.com/repositories/ops/efa56560-5e18-012e-47b0-002332b96472
-**Sample Request**
+**Example Request**
GET /ops/efa56560-5e18-012e-47b0-002332b96472 HTTP/1.1
Host: dydra.com
Accept: application/sparql-results+xml
-**Sample Response**
+**Example Response**
HTTP/1.1 200 OK
Content-Type: application/sparql-results+xml

No commit comments for this range

Something went wrong with that request. Please try again.