VOSpace version 2.1 Proposed Erratum 1: Example incorrect 6.3.1 (fix example)

Author: Brian Major, Gregory Mantelet

Date last changed: 2020-05-19

Rationale

In the process of developing a new VOSpace implementation, it has been found an error in the example in 6.3.1 (pp 53-54) (see VOSpace issue #1). The error consists in the fact that in the example the XML elements <vos:properties>, <vos:accepts>, <vos:provides> and <vos:capabilities> should not be returned when detail=min is specified. Moreover, the XML element is not correctly terminated.

Erratum Content

This Erratum proposes to replace, in 6.3.1 of VOSpace - Version 2.1 the response part of the example:

> GET /vospace/nodes/mydir?detail=min&uri=vos://example.com!vospace/mydir/file3401 HTTP/1.1
>
< HTTP/1.1 200 OK
< Content-Type: text/xml
<
<?xml version="1.0" encoding="UTF-8"?>
<vos:node xmlns:vos="http://www.ivoa.net/xml/VOSpace/v2.0" version="2.1" xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" uri="vos://example.com!vospace/mydir" xsi:type="vos:ContainerNode">
  <vos:properties>
    <vos:property uri="ivo://ivoa.net/vospace/core#description">My award winning images</property>
  </vos:properties>
  <vos:accepts>
    <vos:view uri="ivo://ivoa.net/vospace/core#anyview"/>
  </vos:accepts>
  <vos:provides>
    <vos:view uri="ivo://ivoa/net/vospace/core#defaultview"/>
  </vos:provides>
  <vos:capabilities/>
  <vos:nodes>
    <vos:node uri="vos://example.com!vospace/mydir/file3401" xsi:type="vos:DataNode"/>
    <vos:node uri="vos://example.com!vospace/mydir/file3406" xsi:type="vos:DataNode"/>
    <vos:node uri="vos://example.com!vospace/mydir/file3532" xsi:type="vos:DataNode"/>
  </vos:nodes>

with the following one:

> GET /vospace/nodes/mydir?detail=min&uri=vos://example.com!vospace/mydir/file3401 HTTP/1.1
>
< HTTP/1.1 200 OK
< Content-Type: text/xml
<
<?xml version="1.0" encoding="UTF-8"?>
<vos:node xmlns:vos="http://www.ivoa.net/xml/VOSpace/v2.0" version="2.1" xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" uri="vos://example.com!vospace/mydir" xsi:type="vos:ContainerNode">
  <vos:nodes>
    <vos:node uri="vos://example.com!vospace/mydir/file3401" xsi:type="vos:DataNode"/>
    <vos:node uri="vos://example.com!vospace/mydir/file3406" xsi:type="vos:DataNode"/>
    <vos:node uri="vos://example.com!vospace/mydir/file3532" xsi:type="vos:DataNode"/>
  </vos:nodes>
</vos:node>

Impact Assessment

The proposed change doesn't impact any part of VOSpace implementations since it simply amends an example fixing it.


Topic revision: r2 - 2020-06-03 - GiulianoTaffoni
 
This site is powered by the TWiki collaboration platformCopyright © 2008-2020 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback