From 47beb76cc500c62a227feb4c20b56890a8cef1a7 Mon Sep 17 00:00:00 2001 From: Markus Demleitner Date: Thu, 17 Apr 2025 14:10:37 +0200 Subject: [PATCH] Clarifying the use of inactive and deleted in Resource/@status. This is supposed to fix bug #18. --- VOResource-v1.3.xsd | 17 +++++++++++++---- VOResource.tex | 38 ++++++++++++++++++++++++++++++++++---- 2 files changed, 47 insertions(+), 8 deletions(-) diff --git a/VOResource-v1.3.xsd b/VOResource-v1.3.xsd index f08ca07..052f85d 100644 --- a/VOResource-v1.3.xsd +++ b/VOResource-v1.3.xsd @@ -200,22 +200,31 @@ For details, see http://ivoa.net/documents/Notes/XMLVers --> - resource is believed to be currently maintained, and its - description is up to date (default). + The resource is available and maintained by the + publisher (default). - resource is apparently not being maintained at the present. + The resource is temporarily offline but is expected to + resume operations at some later date; publishers in this + case could publish an estimate when that will happen in a + date element with a role of Available. Note that inactive + resources do not show up in RegTAP searchable registries. - resource publisher has explicitly deleted the resource. + This status could be used for resources permanently + unavailable if VOResource metadata should still be + available via OAI-PMH; in the current VO, there is + probably no reason to ever do that, and deleted + records also do not show up in RegTAP searchable + registries. diff --git a/VOResource.tex b/VOResource.tex index 5677512..9c0bdfd 100644 --- a/VOResource.tex +++ b/VOResource.tex @@ -983,6 +983,27 @@ \subsection{The Base Resource Type} minimally compliant resource description; this requirement is enforced by the VOResource schema definition. +\begin{admonition}{Note} +The VOResource \xmlel{status} attribute in the \xmlel{vr:Resource} type +somewhat overlaps with OAI-PMH's idea of the record's life cycle. In +particular, at least when VOResource metadata is consumed through +RegTAP, there is no difference between setting \xmlel{status} to +\verb|deleted| over publishing an \xmlel{oai:deletedRecord} for the +identifer; the former will let you keep publish VOResource metadata +\emph{through OAI-PMH}, which the latter does not because +\xmlel{oai:deletedRecords} do not admit \xmlel{oai:metadata} +elements. However, there is no use case for that in the current VO, and +hence publishers should exclusively use deleted records on the OAI-PMH +level rather than set \xmlel{status} to \verb|deleted|. + +Having a \xmlel{status} of \verb|inactive| will again purge the metadata +from RegTAP instances and hence will be indistinguishable from deletion to +the VO public. Operators may want to use that status code internally, +however, to temporarily hide malfunctioning services without deleting +their records from internal metadata stores. + +\end{admonition} + \goodbreak % GENERATED: !schemadoc VOResource-v1.3.xsd Resource @@ -1071,14 +1092,23 @@ \subsection{The Base Resource Type} \item[Allowed Values]\hfil \begin{longtermsdescription}\item[active] - resource is believed to be currently maintained, and its - description is up to date (default). + The resource is available and maintained by the + publisher (default). \item[inactive] - resource is apparently not being maintained at the present. + The resource is temporarily offline but is expected to + resume operations at some later date; publishers in this + case could publish an estimate when that will happen in a + date element with a role of Available. Note that inactive + resources do not show up in RegTAP searchable registries. \item[deleted] - resource publisher has explicitly deleted the resource. + This status could be used for resources permanently + unavailable if VOResource metadata should still be + available via OAI-PMH; in the current VO, there is + probably no reason to ever do that, and deleted + records also do not show up in RegTAP searchable + registries. \end{longtermsdescription} \end{description}