0.0.2 • Published 29 days ago

ownit-api-common v0.0.2

Weekly downloads
-
License
ISC
Repository
github
Last release
29 days ago

ownit-api-common

Own It's version of maxone-api-common. Repo containing common services, libraries, and scripts.

Models

enum
  Enum Models - Reusable variable types that have a limited set of possible values.
error
  Error Models - Models that will return specific error codes and data based off the type of error.  
  Ex. Invalid Request / Not Found / Forbidden
events
  Event Models -
persistence
  Persistence Models - Data passing through to the database/elasticsearch
  is sanitized before reaching the destination.
response
  Response models - Data from database/elasticsearch sanitized and returned through these models

Persistence

daos - Data Access Object Pattern
  Direct database and elasticsearch access

Services

The meat and potatoes of this directory.  
Each service is organized by the api it is related to.  
Ex. Users / Controllables / HRV.  
Contains all api specific code and specific endpoint code used in ownit-apis.

Utils

Reusable utils/scripts across services

Libs

Wrappers with direct access to libraries