OneStop

distributed, scalable, event-driven database and search engine for environmental data.
Explore OneStop docs »

Report bug · Request feature

Table of contents

• Project Overview
• Navigating The Documentation
  • API Documentation
  • User Type
    • Public User
    • Metadata Manager
    • Operator
    • External Developer
    • Internal Developer
• External Documentation
  • Search API
  • Registry API
• Further Issues or Questions

Project Overview

OneStop is an open-sourced metadata storage, management, and discovery system built by CIRES researchers on a grant from the NOAA National Centers for Environmental Information. As data volume increases year after year, OneStop’s adherence to cloud native design principles alleviates concerns with scalability and access.

The project is composed of four high level “components”:

• An event stream/database for receiving, storing, and enabling flexible downstream use of metadata
• A feature-rich RESTful Search API built from the raw event stream metadata
• A state-of-the-art browser-based User Interface (UI) that has accessibility built into every feature, and,
• A command line interface (CLI) enabling more efficient script and algorithm execution when reliant on information retrieved from the Search API

With these RESTful APIs:

• Registry API
• Search API

If you’re interested in learning about the finer details of the “components” described above, head over to our API page or the Architectural Overview to begin your deep-dive journey.

You can check out OneStop in action while exploring NOAA’s Earth science data offerings at NOAA’s OneStop search portal. If the latest features in progress are what you’re after, however, take a peek at our test host. Keep in mind the latter could be broken at any time as it represents what’s currently under development.

Navigating The Documentation

OneStop has an enormous amount to offer, but it can be difficult to know how and where to get started with a project that has so many moving parts. With that in mind, we have laid out some navigational paths through our documentation based on the user type and project component.

Visit the API Documentation for information on the OneStop RESTful interfaces.

Additional information on the OneStop can be found in the Architectural Overview.

User Types

What’s important to you when using OneStop varies significantly based on what you need to accomplish. Select the role below that most closely represents you to get started.

• Public User

  • You’re using the UI, API, or CLI in order to find data

• Metadata Manager

  • You’re responsible for metadata records that end up in OneStop, and are in search of info on loading, maintaining, or troubleshooting the records

• Operator

  • You’re deploying, upgrading, or maintaining an instance of OneStop in a production setting

• External Developer

  • You’re developing external software that needs to interact with a running OneStop deployment

• Internal Developer

  • You’re contributing to the OneStop code or even just trying to run a local instance on your personal machine

External Documentation

Our OpenAPI docs are available on SwaggerHub for most of our APIs. They list the supported endpoints and parameters for each API.

Search API SwaggerHub Docs

• 3.0.0-RC1
• 2.4.0

Registry API SwaggerHub Docs

• 3.0.0-RC1

Further Issues or Questions

If you have any questions, comments, or have spotted an issue with the code or docs, please open an issue via Github Issues on our Feedback repository. This repository is issue-only and intentionally meant to prevent external feedback from being lost in our day to day tasks.

Feel free to peruse the OneStop issues as well to stay informed of our work in progress and issues we’re aware of.