Directories
¶
| Path | Synopsis |
|---|---|
|
Package api contains all methodology for interacting with the persistence layer API Docs for CEREBRUM v1 Consumes: - application/json Produces: - application/json Security: - ApiKeyAuth: [] SecurityDefinitions: ApiKeyAuth: type: apiKey name: Authorization in: header
|
Package api contains all methodology for interacting with the persistence layer API Docs for CEREBRUM v1 Consumes: - application/json Produces: - application/json Security: - ApiKeyAuth: [] SecurityDefinitions: ApiKeyAuth: type: apiKey name: Authorization in: header |
|
auth
Package auth is a service for authenticating http requets
|
Package auth is a service for authenticating http requets |
|
auth/transport
Package transport contians HTTP service for authentication
|
Package transport contians HTTP service for authentication |
|
password
Package password contains the service that handles passwords
|
Package password contains the service that handles passwords |
|
store
Package store contains the components necessary for api services to interact with the database
|
Package store contains the components necessary for api services to interact with the database |
|
user
Package user contains the service for user interactions
|
Package user contains the service for user interactions |
|
user/transport
Package transport contains the HTTP service for user interactions
|
Package transport contains the HTTP service for user interactions |
|
utl
|
|
|
config
Package config is used for loading the environmental configurations
|
Package config is used for loading the environmental configurations |
|
datastore
Package datastore creates an ORM connection to the databse and persistence layer
|
Package datastore creates an ORM connection to the databse and persistence layer |
|
middleware/jsonwebtoken
Package jsonwebtoken contains logic for using JSON web tokens
|
Package jsonwebtoken contains logic for using JSON web tokens |
|
middleware/secure
Package secure contains some of the security features of the application
|
Package secure contains some of the security features of the application |
|
mock
Package mock contains logic to mock various components of the application
|
Package mock contains logic to mock various components of the application |
|
mock/mockstore
Package mockstore is used for testing purposes to mock the store package and mock a mysql db through a docker container of mysql
|
Package mockstore is used for testing purposes to mock the store package and mock a mysql db through a docker container of mysql |
|
models
Package models contains all the models for the application
|
Package models contains all the models for the application |
|
query
Package query contains support functions for making db queries
|
Package query contains support functions for making db queries |
|
rbac
Package rbac Role Based Access Control
|
Package rbac Role Based Access Control |
|
secure
Package secure contains support for application security
|
Package secure contains support for application security |
|
server
Package server contains support for the HTTP server used for the API
|
Package server contains support for the HTTP server used for the API |
|
structs
Package structs is for working with structs
|
Package structs is for working with structs |
|
support
Package support contains functions useful in various components of the application
|
Package support contains functions useful in various components of the application |
|
zlog
Package zlog contains support for zlog
|
Package zlog contains support for zlog |
Click to show internal directories.
Click to hide internal directories.