Skip to content

Fix bug #18 #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix bug #18 #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions VOResource-v1.3.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,22 +200,31 @@ For details, see http://ivoa.net/documents/Notes/XMLVers -->
<xs:enumeration value="active">
<xs:annotation>
<xs:documentation>
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).
</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="inactive">
<xs:annotation>
<xs:documentation>
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.
</xs:documentation>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="deleted">
<xs:annotation>
<xs:documentation>
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.
Copy link
Contributor

@tsdower tsdower Apr 17, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just noting a reason to ever do that, though it is invisible to RegTAP search users: the MAST registry continues to support OAI record persistence per https://www.openarchives.org/OAI/openarchivesprotocol.html#DeletedRecords, and when marking ivo_managed local records deleted, updates their VOResource@status to such. This makes it consistently match the OAI wrapper active/deleted status throughout the xml metadata layers and history queries.

So far I am intending to keep this behavior with the rewrite.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(I had originally noted this keeps the record status matching OAI wrapper status in ListRecords responses, but checking the spec it is indeed wrong to include the whole resource there, which is an issue we addressed a while back and I had forgotten. I do still like the idea of keeping it in sync even hidden from most interfaces, but it's less pressing.)

</xs:documentation>
</xs:annotation>
</xs:enumeration>
Expand Down
38 changes: 34 additions & 4 deletions VOResource.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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}
Expand Down