Categorygithub.com/CHESSComputing/DataBookkeeping
modulepackage
0.1.6
Repository: https://github.com/chesscomputing/databookkeeping.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
23
Dependents
0
Files
479 SLOC

# README

DataBookkeeping Service

build status go report card godoc

Data Bookkeeping service

APIs

public APIs

  • /datasets get all datasets
  • /files get all files
  • /dataset/*name get dataset with given name
  • /file/*name get file with given name

Example

Here are examples of GET HTTP requests

# look-up all datasets
curl -v http://localhost:8310/datasets

# look-up concrete dataset=/x/y/z
dataset=/x/y/z
curl -v http://localhost:8310/dataset$dataset

# look-up files from a dataset
curl -v "http://localhost:8310/file?dataset=$dataset"

protected APIs

  • HTTP POST requests
    • /dataset create new dataset data
    • /file create new file data
  • HTTP PUT requests
    • /dataset update dataset data
    • /file update file data
  • HTTP DELETE requests
    • /dataset/*name delete dataset
    • /file/*name delete file

Example

Here is an example of HTTP POST request

# record.json
{
  "buckets": [
    "bucketABC"
  ],
  "did": "/a/b/c",
  "files": [
    "/path/file1.png",
    "/path/file2.png",
    "/path/file3.png"
  ],
  "processing": "glibc",
  "site": "Cornell"
}

# inject new record
curl -v -X POST -H "Authorization: Bearer $token" \
    -H "Content-type: application/json" \
    -d@./record.json \
    http://localhost:8310/dataset

# Packages

No description provided by the author

# Functions

ApiHandler represents generic API handler for GET/POST/PUT/DELETE requests of a specific API.
ChildHandler provides access to /child and /child/:name end-point.
DatasetHandler provides access to GET /datasets and /dataset/:name end-point.
DBSDeleteHandler is a generic handler to call DBS delete APIs gocyclo:ignore.
DBSGetHandler is a generic Get handler to call DBS Get APIs.
POST handler DBSPostHandler is a generic handler to call DBS Post APIs gocyclo:ignore.
DBSPutHandler is a generic handler to call DBS put APIs gocyclo:ignore.
FileHandler provides access to /files and /file/:name end-point.
ParentHandler provides access to /parent and /parent/:name end-point.
Server defines our HTTP server.

# Variables

Verbose controls verbosity level.

# Structs

HTTPError represents HTTP error structure.
No description provided by the author
ServerError represents HTTP server error structure.