Difference: VOSIV1RFC (2 vs. 3)

Revision 32010-04-23 - BobHanisch

 

IVOA Support Interfaces (VOSI) RFC (Version 1.0)

This document is a "Request for Comment" (RFC) for the Proposed Recommendation "IVOA Support Interfaces V1.0" (also known as VOSI). The latest version of the specification (11-03-2010) can be found at:

http://www.ivoa.net/Documents/VOSI

IVOA Review Period: 9 Apr 2010 - 14 May 2010.

This specification describes the minimum required interface to participate in the IVOA as a web service. It is an essential component of the TAP specification and so any TAP implementation also serves as a VOSI implementation.

In order to add a comment to the document, please edit this page and add your comment to the list below in the format used for the example (include your WikiName so that authors can contact you for further information). When the author(s) of the document have considered the comment, they will provide a response after the comment.

Additional discussion about any of the comments or responses can be conducted on the GWS WG mailing list, grid@ivoa.net. However, please be sure to enter your initial comments here for full consideration in any future revisions of this document


Comments from the community

Changed:
<
<
Well, this is one of the more opaque standards documents, at least to me.
>
>
Well, this is one of the more opaque standards documents, at least to me. Here are some things I think would help make this a bit more approachable and provide someone less familiar with the VO some sense of perspective.
Added:
>
>
In the Introduction, please define the acronyms and provide references to where these external standards are defined.

Delete "It is felt"; not the language of a standard.

Replace the last paragraph of the Introduction with the usual text that refers to RFC 2119.

Section 2, 1st sentence, the word "apply" seems odd here. Do interfaces apply to a service? Pertain? Invoke? With which they are associated?

In the 4th paragraph, there is a typo in "standardld". Or is this supposed to be something like standardID? (With a sans-serif font you can't tell.) The reference to Section 2.4 looks incorrect.

Final paragraph, "The client must find the appropriate URLs from the registration..."; shouldn't that be "registry"?

Section 2.1, 3rd bullet, "not fixed in". Do you mean "defined"?

Just prior to the group of two bullets, "The capability list alone...", I don't understand the sense of "alone" here. Is it that the capability list only has two uses, or that only the capability list has two uses?

Next bullet, "drive the service" sounds very colloquial. Just say "use" or "invoke".

Just below the two bullets, here is something to show my ignorance, but I do not understand what is intended by the { } notation in the root element of the URL. The text here seems to run in circles: ...a child element capability...that describes the capabilities... the capability element...is of type ... capability ... a capability element may be ...a legal subtype of ...capability ... Uggh.

In the example on the next page (sample response for SIA service) why, in xsi:schemaLocation, is each entry repeated twice? The text in this example box flows outside the box quite a lot.

Section 2.2, remove "description" from the section heading.

Add a reference to resource metadata (1st bullet), and I don't think the quotation marks are then necessary.

Section 2.3, 3rd paragraph, "If any of these check fail..." should be "checks"

Next paragraph, I don't think services "wish" or "intend" to do anything.

Just prior to Section 3.4, the paragraph "Ultimately some portals..." is not terribly relevant to defining the standard and can be dropped.

In Section 2.5, 3rd paragraph, missing "by" "after represented".

4th paragraph, missing "of" after "value".

 


<--  
-->
 
This site is powered by the TWiki collaboration platform Powered by Perl This site is powered by the TWiki collaboration platformCopyright © 2008-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback