Skip to content

DM-50405: Create service descriptor for hoverdrive endpoints #338

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
jonathansick wants to merge 4 commits into
base: main
Choose a base branch
from
Open

DM-50405: Create service descriptor for hoverdrive endpoints #338

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
298f294
Create service descriptor for hoverdrive endpoints
jonathansick Apr 22, 2025
9f0bf27
Refocus with Column/TableDocumentationRedirect
jonathansick May 5, 2025
03c872c
Map column names to service descriptor
jonathansick May 16, 2025
da461f4
Split hoverdrive SD based on column dependencies
jonathansick May 16, 2025
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
4 changes: 3 additions & 1 deletion datalink/datalink-manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,7 @@
"dp02_object_to_fs_timeseries": ["dp02_dc2_catalogs_Object_objectId"],
"dp02_diaobject_to_dias_timeseries": ["dp02_dc2_catalogs_DiaObject_diaObjectId"],
"dp02_diaobject_to_diafs_timeseries": ["dp02_dc2_catalogs_DiaObject_diaObjectId"],
"obscore_links": ["ivoa_ObsCore_access_url"]
"obscore_links": ["ivoa_ObsCore_access_url"],
"tap_schema_column_docs": ["tap_schema_columns_table_name", "tap_schema_columns_column_name"],
"tap_schema_table_docs": ["tap_schema_columns_table_name"]
}
26 changes: 26 additions & 0 deletions datalink/tap_schema_column_docs.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<?xml version="1.0" encoding="UTF-8"?>
<VOTABLE xmlns="http://www.ivoa.net/xml/VOTable/v1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.2">

<INFO name="$tap_schema_columns_table_name$" ID="$tap_schema_columns_table_name$" value="this will be dropped..." />
<INFO name="$tap_schema_columns_column_name$" ID="$tap_schema_columns_column_name$" value="this will be dropped..." />

<RESOURCE type="meta" utype="adhoc:service" name="ColumnDocumentationRedirect">
<DESCRIPTION>
Redirect to the most relevant documentation link for a column.
</DESCRIPTION>
<PARAM name="accessURL" datatype="char" arraysize="*"
value="$baseUrl$/api/hoverdrive/column-docs-redirect"/>
<GROUP name="inputParams">
<PARAM name="table" datatype="char" arraysize="*" ref="$tap_schema_columns_table_name$" value="">
<DESCRIPTION>The name of the table.</DESCRIPTION>
</PARAM>
<PARAM name="column" datatype="char" arraysize="*" ref="$tap_schema_columns_column_name$" value="">
<DESCRIPTION>The name of the column.</DESCRIPTION>
</PARAM>
</GROUP>
<PARAM name="exampleURL" datatype="char" arraysize="*"
value="$baseUrl$/api/hoverdrive/column-docs-redirect?table=dp02_dc2_catalogs.Object&amp;column=detect_isPrimary">
<DESCRIPTION>Example request to redirect to the documentation for the 'detect_isPrimary' column in the 'dp02_dc2_catalogs.Object' table.</DESCRIPTION>
</PARAM>
</RESOURCE>
</VOTABLE>
22 changes: 22 additions & 0 deletions datalink/tap_schema_table_docs.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<?xml version="1.0" encoding="UTF-8"?>
<VOTABLE xmlns="http://www.ivoa.net/xml/VOTable/v1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.2">

<INFO name="$tap_schema_columns_table_name$" ID="$tap_schema_columns_table_name$" value="this will be dropped..." />

<RESOURCE type="meta" utype="adhoc:service" name="TableDocumentationRedirect">
<DESCRIPTION>
Redirect to the most relevant documentation link for a table.
</DESCRIPTION>
<PARAM name="accessURL" datatype="char" arraysize="*"
value="$baseUrl$/api/hoverdrive/table-docs-redirect"/>
<GROUP name="inputParams">
<PARAM name="table" datatype="char" arraysize="*" ref="$tap_schema_columns_table_name$" value="">
<DESCRIPTION>The name of the table.</DESCRIPTION>
</PARAM>
</GROUP>
<PARAM name="exampleURL" datatype="char" arraysize="*"
value="$baseUrl$/api/hoverdrive/table-docs-redirect?table=dp02_dc2_catalogs.Object">
<DESCRIPTION>Example request to redirect to the documentation for the 'dp02_dc2_catalogs.Object' table.</DESCRIPTION>
</PARAM>
</RESOURCE>
</VOTABLE>
1 change: 1 addition & 0 deletions docs/changes/DM-50405.misc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Added service descriptors for Hoverdrive endpoints.
Loading