@@ -983,6 +983,27 @@ \subsection{The Base Resource Type}
983983minimally compliant resource description; this requirement is enforced
984984by the VOResource schema definition.
985985
986+ \begin {admonition }{Note}
987+ The VOResource \xmlel {status} attribute in the \xmlel {vr:Resource} type
988+ somewhat overlaps with OAI-PMH's idea of the record's life cycle. In
989+ particular, at least when VOResource metadata is consumed through
990+ RegTAP, there is no difference between setting \xmlel {status} to
991+ \verb |deleted | over publishing an \xmlel {oai:deletedRecord} for the
992+ identifer; the former will let you keep publish VOResource metadata
993+ \emph {through OAI-PMH }, which the latter does not because
994+ \xmlel {oai:deletedRecords} do not admit \xmlel {oai:metadata}
995+ elements. However, there is no use case for that in the current VO, and
996+ hence publishers should exclusively use deleted records on the OAI-PMH
997+ level rather than set \xmlel {status} to \verb |deleted |.
998+
999+ Having a \xmlel {status} of \verb |inactive | will again purge the metadata
1000+ from RegTAP instances and hence will be indistinguishable from deletion to
1001+ the VO public. Operators may want to use that status code internally,
1002+ however, to temporarily hide malfunctioning services without deleting
1003+ their records from internal metadata stores.
1004+
1005+ \end {admonition }
1006+
9861007\goodbreak
9871008
9881009% GENERATED: !schemadoc VOResource-v1.3.xsd Resource
@@ -1071,14 +1092,23 @@ \subsection{The Base Resource Type}
10711092
10721093\item [Allowed Values]\hfil
10731094\begin {longtermsdescription }\item [active]
1074- resource is believed to be currently maintained, and its
1075- description is up to date (default).
1095+ The resource is available and maintained by the
1096+ publisher (default).
10761097
10771098\item [inactive]
1078- resource is apparently not being maintained at the present.
1099+ The resource is temporarily offline but is expected to
1100+ resume operations at some later date; publishers in this
1101+ case could publish an estimate when that will happen in a
1102+ date element with a role of Available. Note that inactive
1103+ resources do not show up in RegTAP searchable registries.
10791104
10801105\item [deleted]
1081- resource publisher has explicitly deleted the resource.
1106+ This status could be used for resources permanently
1107+ unavailable if VOResource metadata should still be
1108+ available via OAI-PMH; in the current VO, there is
1109+ probably no reason to ever do that, and deleted
1110+ records also do not show up in RegTAP searchable
1111+ registries.
10821112
10831113\end {longtermsdescription }
10841114\end {description }
0 commit comments