Estimated Reading Time: 25 minutes
Since this role requires interacting with several OneStop components, you are encouraged to start with the brief architectural overview to get your bearings.
- Creating Metadata
- Loading Metadata into OneStop
- OneStop Python Clients - OneStop clients for interfacing with OneStop.
- Registry API - CRUD operations (Create, Read, Update, and Delete) on metadata.
- Kafka - Underlying way that Registry communicates when operations happen on metadata.
- Searching OneStop for Metadata - How to find your metadata within OneStop.
- References
If you need to create your metadata manually here are some useful, external, guides and templates for metadata. Questions specific to these documents should be directed to the NCEI Metadata WG at [email protected].
Keep in mind that however your data is getting into OneStop it supports the metadata formats of either JSON or ISO-19115-2 XML.
For a better OneStop discovery experience please be mindful of what fields are in your metadata.
If your metadata isn't automatically being loading into OneStop (some applications already automatically send metadata to OneStop), there are a few ways to do that:
The OneStop Clients repo has a python client that is useful for searching OneStop for metadata.
Metadata can be published into OneStop via the Registry API. The Registry application has a RESTful interface that allows for CRUD (Create, Read, Update, and Delete) actions on metadata.
Keep in mind the Registry REST API is secured via CAS authentication, more detail within the OneStop Registry Security documentation.
There's a little more information in Upload Test Metadata
Perhaps you've loaded your metadata through an external tool that pushes its output to OneStop. On the other hand, you might be directly pushing metadata to OneStop via the Registry API.
No matter how your metadata gets into OneStop, however, you'll probably be curious about what you can do to take full advantage of the OneStop search functionality.
- Indexed ISO Metadata Fields
- Search Query Syntax
- Search Fields Requiring An Exact Match With An Inexact Query - This lists an endpoint
For the purpose of search engines be able to find the data in OneStop we iterate over every collection within OneStop and pull out important fields that end up in a sitemap file that search engines such as Google can use as an index for OneStop's content.
- Architectural Overview - In-depth overview of the metadata flow and architecture of OneStop.
- OneStop API - All the OneStop available APIs(Application Program Interfaces). For example: Create, Read, Update, and Delete(CRUD) metadata.
- Public User Documentation
- External Developer Navigation Guide - Information pertaining to programmatically sending data from your software to OneStop.
- NOAA NCEI Metadata Homepage