• Wallot
  • Testing the APIs:
    • REST API
  • Architecture:
  • User Experience:
  • Key Terms:

Wallot

Testing the APIs:

REST API

bash functions/rest-api/smoke-tests/test-health-endpoints.sh test local
bash functions/rest-api/smoke-tests/test-health-endpoints.sh test cloud-functions
bash functions/rest-api/smoke-tests/test-health-endpoints.sh test primary

Architecture:

erDiagram
	%% Mirror Relationships

	BANK_ACCOUNT ||--o| ALPACA_ACH_RELATIONSHIP : "mirrors"
	MODEL ||--|| OPEN_AI_MODEL : "mirrors"
	POSITION ||--o| ALPACA_POSITION : "mirrors"
	USER ||--o| ALPACA_ACCOUNT : "mirrors"

	%% Ownership Relationships
	ASSET ||--|| ALPACA_ASSET_ID : "owns"
  ASSET ||--|| ALPHA_VANTAGE_COMPANY_NAME : "owns"
  ASSET_ORDER ||--o| ALPACA_ORDER_ID : "owns"
  BANK_ACCOUNT ||--|| STRIPE_FINANCIAL_CONNECTIONS_ACCOUNT_ID : "owns"
  BANK_ACCOUNT ||--|| STRIPE_PAYMENT_METHOD_ID : "owns"
	INVOICE ||--|| STRIPE_INVOICE_ID : "owns"
	LICENSE ||--o| STRIPE_SUBSCRIPTION_ID : "owns"
	MODEL_FAMILY ||--o{ MODEL : "owns"
	OPEN_AI_MODEL_FAMILY ||--o{ OPEN_AI_MODEL : "owns"
	ORDER ||--o{ ASSET_ORDER : "owns"
	RECOMMENDATION ||--|{ OPEN_AI_API_REQUEST_IDS : "owns"
	USER ||--o{ IDENTITY_VERIFICATION_DOCUMENT : "owns"
	USER ||--|| LICENSE : "owns"
	USER ||--o{ ORDER : "owns"
	USER ||--o{ PAYMENT_METHOD : "owns"
	USER ||--o{ POSITION : "owns"
	USER ||--o{ RECOMMENDATION : "owns"
  USER ||--|| STRIPE_CUSTOMER_ID : "owns"

	%% Production Relationships
	MODEL ||--o{ RECOMMENDATION : "produces"
	RECOMMENDATION }o--|{ ASSET_ORDER : "factors_into"
	STRIPE_FINANCIAL_CONNECTIONS_SESSION_FLOW ||--o{ STRIPE_FINANCIAL_CONNECTIONS_ACCOUNT_LINK : "produces"

	%% Similarity Relationships
	MODEL_FAMILY }o--o{ PARAMETER : "caters_to"
	USER ||--o{ PARAMETER : "fits"

	%% Computation Relationships
	BANK_ACCOUNT ||--o{ ACH_TRANSFER : "derives_from_the_computation_of"
	POSITION |o--o{ ASSET_ORDER : "derives_from_the_computation_of"
	RECOMMENDATION }|--|{ NEWS_REPORT : "derives_from_the_computation_of"
	RECOMMENDATION }|--|{ ASSET_PRICE : "derives_from_the_computation_of"

	%% Transaction Relationships
	INVOICE }|--|| PAYMENT_METHOD : "charges"
	LICENSE ||--o{ INVOICE : "bills"
	ORDER }|--o| BANK_ACCOUNT : "debits_or_credits"

	%% Proxy Relationships
	PAYMENT_METHOD ||--|| BANK_ACCOUNT : "represents"
	POSITION ||--|| ASSET : "represents"
	ASSET_ORDER ||--|| ASSET : "represents"
	ASSET_PRICE }|--|| ASSET : "represents"

	%% Entity Definitions
	ACH_TRANSFER {
    string bank_account FK "min(1)"
  }
  ASSET {
    string alpaca_asset_id UK "min(1)"
    string alpha_vantage_company_Name UK "min(1)"
  }
  ASSET_ORDER {
    string alpaca_order_id FK "nullable"
    string asset FK "min(1)"
    string order FK "min(1)"
    string position FK "min(1)"
    string[] recommendations FK "nullable"
  }
  ASSET_PRICE {
    string asset FK "min(1)"
  }
  BANK_ACCOUNT {
    string alpaca_ach_relationship_id UK "nullable"
    string stripe_financial_connections_account_id UK "min(1)"
    string stripe_payment_method_id UK "min(1)"
  }
  INVOICE {
    string bank_account FK "min(1)"
    string license FK "min(1)"
    string stripe_invoice_id FK "min(1)"
  }
  LICENSE {
    string stripe_subscription_id UK "nullable"
    string user FK "min(1)"
  }
  MODEL {
    string model_family FK "min(1)"
    string open_ai_model FK "min(1)"
  }
  MODEL_FAMILY {
    string open_ai_model_family FK "min(1)"
    string[] parameters FK "min(1)"
  }
  ORDER {
    string bank_account FK "min(1)"
    string user FK "min(1)"
  }
  POSITION {
    string asset FK "min(1)"
    string user FK "min(1)"
  }
  RECOMMENDATION {
    string[] asset_prices FK "min(1)"
    string model FK "min(1)"
    string[] news_reports FK "min(1)"
    string[] open_ai_api_request_ids "min(1)"
    string user FK "nullable"
  }
  USER {
    string alpaca_account_id UK "nullable"
    string[] parameters FK "nullable"
    string stripe_customer_id UK "min(1)"
  }

Loading

User Experience:

@kamarmack - replace this placeholder image with a screenshot of the user experience

Key Terms:

@kamarmack - add a list of key terms and the explanations for each terms