RIWSDLCorrection < IVOA

<small>Jumps:  IvoaResReg :: [[http://www.ivoa.net/forum/registry/][registry mail archive]] :: RegistryMetadata :: VOResourceV10 :: RegUpgradeSummer2006
<br> Meetings:  InterOpMay2006ResReg :: InterOpSep2006ResReg </small>


---+ Adapting to Corrections to the Registry Interface WSDL

Author:  RayPlante

This is draft version of a note to be submitted to the [[http://www.ivoa.net/Documents/][IVOA Document Repository]].  

---+++ Abstract


Prior to 24 September 2008, an inconsistency was discovered in the
IVOA Registry Interface standards document (v1.00) between the text
and the actual WSDL document included in the appendix and provided on
the IVOA web site
(via <a href="http://www.ivoa.net/xml/">http://www.ivoa.net/wsdl/</a>).
The Registry Working Group plans to change the WSDL to match the
text.  Consequently, this has implications for current registries that
are compliant with the uncorrected WSDL.  This document describes how
the WSDL is being changed as well as how we can provide backward
compatible support for currently deployed registries.  In particular,
we will correct the official WSDL without changing the namespace.  We describe how registry providers should indicate which versions of the WSDL are supported, how clients can learn which interface is supported, and how registries and clients may choose to support both the corrected and uncorrected interface.

%TOC{title="Contents"}%

---++ 1. Introduction:  the Problem

The <a href="http://www.ivoa.net/Documents/cover/RegistryInterface-20061107.html">Registry Interface v1.00</a> (RI) contains an inconsistency in the description of the keyword search interface between the text provided in section 2.1.3 and the WSDL spelled out in Appendix A.1.  In the text description, the 3rd and 4th arguments to the *KeywordSearch* operation, =from= and =max=, respectively, control which sequence of matched records are returned.  The =from= parameter indicates "the minimum position in the complete set of matched records of the range of records to be returned", and =max= indicates "the maximum number of matched records to return".  Thus the position of the last record returned is =from+max-1=.  When a client uses this to page through a large number of matched records, the value of =from= for the next query will be =from+max=.

In the WSDL document, the 3rd and 4th parameters controling the range of matches are called =from= and =to=.  The intended meaning of =from= is the same as described above, but =to= indicated the position last record to display.  When paging, the value of =to= for the next query would be =to+1=.  

As of 24 September 2008, the copy of the WSDL as given in the appendix has been also available on the IVOA Web site (via 
<a href="http://www.ivoa.net/wsdl">http://www.ivoa.net/wsdl</a>).  Consequently, this is typically been the basis for implementations up to that date.  

The discrepancy presumably resulted from an incomplete edit to the RI document.  In an earlier version, both the *Search* and the *KeywordSearch* operations took the =from= and =to= argument parameters.  After review by the working group, it was decided to change it to =from= and =max= for both of the operations.  While the text was updated in both places, the WSDL was only updated for the *Search* operation.  

---++ Correcting the Standard and Impact on Existing Implementations

As =from= and =to= represent the intention of the working group review, the next version of the RI document will change the WSDL to match the description in the text of section 2.1.3.  To minimize the disruption to existing deployed registries and clients, the namespace for the WSDL document will __not__ be changed.


<br/>
<!--
      * Set ALLOWTOPICRENAME = %MAINWEB%.TWikiAdminGroup
-->
This topic: IVOA > WebHome > IvoaResReg > RegistryInterface > RIWSDLCorrection
Topic revision: r3 - 2008-09-24 - RayPlante