Skip to content

TrifectaDB wiki

Ojas Gupta edited this page Aug 16, 2023 · 1 revision

Introduction to TrifectaDB API

TrifectaDB is a powerful REST API that allows you to manage and organize your data efficiently. This API provides various endpoints for user authentication and managing tree structures with customizable branches, leaves, fruits, and flowers.

Explore the GitHub repository for TrifectaDB.

API Endpoints

TrifectaDB offers the following API endpoints:

Sign In

URL Endpoint: /signin (POST)

Request Data:

  • email (string, required): The user's email address.
  • password (string, required): The user's password.

Response:

{
  "svid": "123456",
  "password": "123456"
}
  1. Sign Up (SignUp.md)

Sign Up

URL Endpoint: /signup (POST)

Request Data:

  • email (string, required): The user's email address.
  • password (string, required): The user's password.

Response:

{
  "svid": "123456",
  "password": "123456"
}
  1. Tree Operations (TreeOperations.md)

Tree Operations

URL Endpoint: /tree (POST)

Request Data:

  • type (string, required): The type of operation to perform.
  • svid (string, required): The user's svid.
  • password (string, required): The user's password.
  • treename (string, required): The name of the tree.
  • treepassword (string, required): The password of the tree.
  • path (string, optional): The path to the node to operate on.
  • branch (string, optional): The name of the branch to create or remove.
  • leaf (string, optional): The name of the leaf to add, get, or remove.
  • fruit (string, optional): The name of the fruit to add or execute a query on.
  • flower (string, optional): The name of the flower to add, download, or remove.

Responses:

a. If type is plant_tree: Returns true or error.

b. If type is add_branch: Returns true or error.

c. If type is remove_branch: Returns true or error.

d. If type is tree: Returns a list of contents in that branch or error.

e. If type is add_leaf: Returns true or error.

f. If type is get_leaf: Returns content or error.

g. If type is remove_leaf: Returns true or error.

h. If type is add_fruit: Returns true or error.

i. If type is execute_query: Returns content or error.

j. If type is add_flower: Returns true or error.

k. If type is download_flower: Returns base64 data with file name and true, or an error.

l. If type is remove_flower: Returns true or error.

Clone this wiki locally