Skip to content

Commit c72b282

Browse files
committed
Clarifying the use of inactive and deleted in Resource/@status.
This is supposed to fix bug #18.
1 parent 3f77597 commit c72b282

File tree

2 files changed

+47
-8
lines changed

2 files changed

+47
-8
lines changed

VOResource-v1.3.xsd

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -200,22 +200,31 @@ For details, see http://ivoa.net/documents/Notes/XMLVers -->
200200
<xs:enumeration value="active">
201201
<xs:annotation>
202202
<xs:documentation>
203-
resource is believed to be currently maintained, and its
204-
description is up to date (default).
203+
The resource is available and maintained by the
204+
publisher (default).
205205
</xs:documentation>
206206
</xs:annotation>
207207
</xs:enumeration>
208208
<xs:enumeration value="inactive">
209209
<xs:annotation>
210210
<xs:documentation>
211-
resource is apparently not being maintained at the present.
211+
The resource is temporarily offline but is expected to
212+
resume operations at some later date; publishers in this
213+
case could publish an estimate when that will happen in a
214+
date element with a role of Available. Note that inactive
215+
resources do not show up in RegTAP searchable registries.
212216
</xs:documentation>
213217
</xs:annotation>
214218
</xs:enumeration>
215219
<xs:enumeration value="deleted">
216220
<xs:annotation>
217221
<xs:documentation>
218-
resource publisher has explicitly deleted the resource.
222+
This status could be used for resources permanently
223+
unavailable if VOResource metadata should still be
224+
available via OAI-PMH; in the current VO, there is
225+
probably no reason to ever do that, and deleted
226+
records also do not show up in RegTAP searchable
227+
registries.
219228
</xs:documentation>
220229
</xs:annotation>
221230
</xs:enumeration>

VOResource.tex

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -982,6 +982,27 @@ \subsection{The Base Resource Type}
982982
minimally compliant resource description; this requirement is enforced
983983
by the VOResource schema definition.
984984

985+
\begin{admonition}{Note}
986+
The VOResource \xmlel{status} attribute in the \xmlel{vr:Resource} type
987+
somewhat overlaps with OAI-PMH's idea of the record's life cycle. In
988+
particular, at least when VOResource metadata is consumed through
989+
RegTAP, there is no difference between setting \xmlel{status} to
990+
\verb|deleted| over publishing an \xmlel{oai:deletedRecord} for the
991+
identifer; the former will let you keep publish VOResource metadata
992+
\emph{through OAI-PMH}, which the latter does not because
993+
\xmlel{oai:deletedRecords} do not admit \xmlel{oai:metadata}
994+
elements. However, there is no use case for that in the current VO, and
995+
hence publishers should exclusively use deleted records on the OAI-PMH
996+
level rather than set \xmlel{status} to \verb|deleted|.
997+
998+
Having a \xmlel{status} of \verb|inactive| will again purge the metadata
999+
from RegTAP instances and hence will be indistinguishable from deletion to
1000+
the VO public. Operators may want to use that status code internally,
1001+
however, to temporarily hide malfunctioning services without deleting
1002+
their records from internal metadata stores.
1003+
1004+
\end{admonition}
1005+
9851006
\goodbreak
9861007

9871008
% GENERATED: !schemadoc VOResource-v1.3.xsd Resource
@@ -1070,14 +1091,23 @@ \subsection{The Base Resource Type}
10701091

10711092
\item[Allowed Values]\hfil
10721093
\begin{longtermsdescription}\item[active]
1073-
resource is believed to be currently maintained, and its
1074-
description is up to date (default).
1094+
The resource is available and maintained by the
1095+
publisher (default).
10751096

10761097
\item[inactive]
1077-
resource is apparently not being maintained at the present.
1098+
The resource is temporarily offline but is expected to
1099+
resume operations at some later date; publishers in this
1100+
case could publish an estimate when that will happen in a
1101+
date element with a role of Available. Note that inactive
1102+
resources do not show up in RegTAP searchable registries.
10781103

10791104
\item[deleted]
1080-
resource publisher has explicitly deleted the resource.
1105+
This status could be used for resources permanently
1106+
unavailable if VOResource metadata should still be
1107+
available via OAI-PMH; in the current VO, there is
1108+
probably no reason to ever do that, and deleted
1109+
records also do not show up in RegTAP searchable
1110+
registries.
10811111

10821112
\end{longtermsdescription}
10831113
\end{description}

0 commit comments

Comments
 (0)