README
¶
Vault
A warehouse of data which stores multiple formats from multiple surveys and exposes them all through a simple RESTful and/or GraphQL API
Iterations
- Read only plus ingest
- Query
- Read only summaries with manual add
- Write summaries and auth
Documentation
¶
Overview ¶
Vault is a tool for managing organized stores of data.
It allows storing data sets in an organized hierarchy of sources. Questions can be of complex types (list, object, ...) as well as simple types (int, string, ...). Complex questions are represented by hierarchical questions. Answers are linked to responses, and responses to both surveys and respondents. All of this is made accessible via a simple JSON API.
[adjective][species], Ltd. is an organization striving to explore the furry subculture through data. Vault is designed to be project-agnostic, however, and may find use cases far beyond [a][s], and is thus licensed under the MIT license.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
util
Package util holds various utilities used in the API.
|
Package util holds various utilities used in the API. |
|
v1
Package v1 represents the entirety of the first version of the HTTP API for Vault.
|
Package v1 represents the entirety of the first version of the HTTP API for Vault. |
|
v1/apiparams
Package apiparams holds the various structs for marshaling/unmarshaling the JSON requests and responses to the v1 API.
|
Package apiparams holds the various structs for marshaling/unmarshaling the JSON requests and responses to the v1 API. |
|
cmd
|
|
|
vault/commands
Package commands manages the command line Vault tool.
|
Package commands manages the command line Vault tool. |
|
vault/commands/add
Package add provides Vault subcommands for adding/importing data to the database.
|
Package add provides Vault subcommands for adding/importing data to the database. |
|
vault/commands/command
Package command manages the basics of subcommands.
|
Package command manages the basics of subcommands. |
|
vault/commands/hierarchy
Package hierarchy holds the Vault subcommands for managing the hierarchy of data, sources, and summaries.
|
Package hierarchy holds the Vault subcommands for managing the hierarchy of data, sources, and summaries. |
|
vault/commands/serve
Package serve hosts the `vault serve` subcommand.
|
Package serve hosts the `vault serve` subcommand. |
|
Package config stores the configuration required for running Vault.
|
Package config stores the configuration required for running Vault. |
|
Package db manages database connections and object relational models.
|
Package db manages database connections and object relational models. |
|
Package logging provides logging infrastructure to Vault.
|
Package logging provides logging infrastructure to Vault. |
|
Package server manages creating the HTTP server for Vault.
|
Package server manages creating the HTTP server for Vault. |