From 02d3922f1b8029decf379d708b45507321625602 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Euzenat?= <Jerome.Euzenat@inria.fr>
Date: Sun, 6 Sep 2009 09:56:54 +0000
Subject: [PATCH] - updated with msgid, id in REST and expansion
---
html/rest.html | 45 +++++++++++++++++++++++----------------------
1 file changed, 23 insertions(+), 22 deletions(-)
diff --git a/html/rest.html b/html/rest.html
index e3c09f3a..601b9f7c 100644
--- a/html/rest.html
+++ b/html/rest.html
@@ -124,14 +124,14 @@ will be available at a later moment. By default, matching is
synchronous, i.e., the server answers only once the alignment process
has returned an alignment.
<br /><b>pretty:</b> a string that will name the resulting alignment.
-<br /><b>alid:</b> the URI of an initial alignment.
+<br /><b>id:</b> the URI of an initial alignment.
<br /><b>paramn<i>n</i></b> and <b>paramv<i>n</i>:</b> the name
and value of parameter <i>n</i>.
</p>
<p>Result:<br />
<div class="fragment">
<matchResponse>
- <id> MessageId </id>
+ <msgid> MessageId </msgid>
<in-reply-to> MessageId </in-reply-to>
<alid> URI </alid>
</matchResponse>
@@ -149,7 +149,7 @@ and value of parameter <i>n</i>.
<p>Result:<br />
<div class="fragment">
<findResponse>
- <id> MessageId </id>
+ <msgid> MessageId </msgid>
<in-reply-to> messageId </in-reply-to>
<alignmentList>
<alid> URI </alid>
@@ -161,10 +161,10 @@ and value of parameter <i>n</i>.
<h2>retrieve<a name="retrieve"></a></h2>
<p>Retrieves an alignment in a specific format.</p>
-<p>URL: http://aserv.inrialpes.fr/rest/ <b>retrieve</b> ? <b>alid</b> =
+<p>URL: http://aserv.inrialpes.fr/rest/ <b>retrieve</b> ? <b>id</b> =
<URI> & <b>method</b> = <classname></p>
<p>Parameters:
-<br /><b>alid:</b> the URI of the alignment to be retrieved.
+<br /><b>id:</b> the URI of the alignment to be retrieved.
<br /><b>method:</b> indicates the format in which the alignment will be
serialised this is a classname taken from those provided
by <a href="#listrenderers">listrenderers</a> request.
@@ -181,10 +181,10 @@ and value of parameter <i>n</i>.
<h2>trim<a name="trim"></a></h2>
<p>Trims an alignment with a threshhold.</p>
-<p>URL: http://aserv.inrialpes.fr/rest/ <b>trim</b> ? <b>alid</b> =
+<p>URL: http://aserv.inrialpes.fr/rest/ <b>trim</b> ? <b>id</b> =
<URI> & <b>threshold</b> = <float> & type = <label> </p>
<p>Parameters:
-<br /><b>alid:</b> the URI of the alignment to be trimmed.
+<br /><b>id:</b> the URI of the alignment to be trimmed.
<br /><b>threshold:</b> the threshold for trimming.
<br /><b>type:</b> the method used for trimming (values: hard, perc, best,
span, prop; default: hard).
@@ -192,7 +192,7 @@ span, prop; default: hard).
<p>Result:<br />
<div class="fragment">
<trimResponse>
- <id> MessageId </id>
+ <msgid> MessageId </msgid>
<in-reply-to> MessageId </in-reply-to>
<alid> URI </alid>
</trimResponse>
@@ -201,15 +201,15 @@ span, prop; default: hard).
<h2>invert<a name="invert"></a></h2>
<p>Inverts an alignment.</p>
-<p>URL: http://aserv.inrialpes.fr/rest/ <b>invert</b> ? <b>alid</b> =
+<p>URL: http://aserv.inrialpes.fr/rest/ <b>invert</b> ? <b>id</b> =
<URI> </p>
<p>Parameters:
-<br /><b>alid:</b> the URI of the alignment to be inverted.
+<br /><b>id:</b> the URI of the alignment to be inverted.
</p>
<p>Result:<br />
<div class="fragment">
<invertResponse>
- <id> MessageId </id>
+ <msgid> MessageId </msgid>
<in-reply-to> MessageId </in-reply-to>
<alid> URI </alid>
</invertResponse>
@@ -218,14 +218,14 @@ span, prop; default: hard).
<h2>store<a name="store"></a></h2>
<p>Stores an alignment on the server.</p>
-<p>URL: http://aserv.inrialpes.fr/rest/ <b>store</b> ? <b>alid</b> = <URI></p>
+<p>URL: http://aserv.inrialpes.fr/rest/ <b>store</b> ? <b>id</b> = <URI></p>
<p>Parameters:
-<br /><b>alid:</b> the URI of the alignment to be stored.
+<br /><b>id:</b> the URI of the alignment to be stored.
</p>
<p>Result:<br />
<div class="fragment">
<storeResponse>
- <id> MessageId </id>
+ <msgid> MessageId </msgid>
<in-reply-to> MessageId </in-reply-to>
<alid> URI </alid>
</storeResponse>
@@ -249,7 +249,7 @@ or
<p>Result:<br />
<div class="fragment">
<loadResponse>
- <id> MessageId </id>
+ <msgid> MessageId </msgid>
<in-reply-to> MessageId </in-reply-to>
<alid> URI </alid>
</loadResponse>
@@ -264,9 +264,9 @@ or
<h2>metadata<a name="metadata"></a></h2>
<p>Gets metadata of an alignment, i.e., avoid downloading all correspondences.</p>
-<p>URL: http://aserv.inrialpes.fr/rest/ <b>metadata</b> ? <b>alid</b> = <URI></p>
+<p>URL: http://aserv.inrialpes.fr/rest/ <b>metadata</b> ? <b>id</b> = <URI></p>
<p>Parameters:
-<br /><b>alid:</b> the URI of the alignment from which metadata is retrieved.
+<br /><b>id:</b> the URI of the alignment from which metadata is retrieved.
</p>
<p>Result:<br />
<div class="fragment">
@@ -279,9 +279,9 @@ or
<h2>translate<a name="translate"></a></h2>
<p>Translates a message (resp. a query) with regard to an alignment.</p>
-<p>URL: http://aserv.inrialpes.fr/rest/ <b>translate</b> ? <b>alid</b> = <URI></p>
+<p>URL: http://aserv.inrialpes.fr/rest/ <b>translate</b> ? <b>id</b> = <URI></p>
<p>Parameters:
-<br /><b>alid:</b> the URI of the alignment used for the translation.
+<br /><b>id:</b> the URI of the alignment used for the translation.
</p>
<p>Result:<br />
<div class="fragment">
@@ -302,7 +302,7 @@ to be matched.
<p>Result: the alignment in RDF/XML.
<div class="fragment">
<alignResponse>
- <id> MessageId </id>
+ <msgid> MessageId </msgid>
<in-reply-to> MessageId </in-reply-to>
<result> The alignment in RDF/XML </result>
</alignResponse>
@@ -354,12 +354,13 @@ and answers:
<ul>
<li>The content of <tt>classList</tt> is now <tt>classname</tt>
(instead of <tt>method</tt>, <tt>service</tt>, or <tt>renderer</tt>) (REST & SOAP);</li>
-<li><tt>id</tt> for identying alignment ids is now replaced by <tt>alid</tt> (REST);</li>
<li><tt>cut</tt> is now <tt>trim</tt> (REST & SOAP);</li>
<li><tt>method</tt> in <tt>trim</tt> is now <tt>type</tt> (REST & SOAP);</li>
<li>All primitives return <tt>in-reply-to</tt> and can
- send <tt>id</tt> (REST);</li>
+ send <tt>msgid</tt> (REST);</li>
<li><tt>listevaluators</tt> has been added (REST & SOAP);</li>
+<li>The <tt>alid</tt> parameter for identying alignment ids is now replaced by <tt>id</tt> (SOAP);</li>
+<li>The <tt>id</tt> parameter for identying messages is now replaced by <tt>msgid</tt> (SOAP);</li>
</ul>
<p>
--
GitLab