{"id":552,"date":"2024-12-30T22:23:12","date_gmt":"2024-12-30T22:23:12","guid":{"rendered":"https:\/\/bendauphinee.com\/writing\/?page_id=552"},"modified":"2025-01-07T22:37:00","modified_gmt":"2025-01-07T22:37:00","slug":"technical-design","status":"publish","type":"page","link":"https:\/\/bendauphinee.com\/writing\/building-tailgunner\/project-plan\/technical-design\/","title":{"rendered":"Technical Design"},"content":{"rendered":"\n
\n

This page is for the technical documentation related to our project.<\/p>\n\n\n\n

API Endpoints<\/h2>\n\n\n\n
Action<\/th>API URL<\/th>Verb<\/th><\/tr><\/thead>
Create a template<\/td>\/api\/v1\/template<\/code><\/td>POST<\/td><\/tr>
Get template (metadata and fields)<\/td>\/api\/v1\/template<\/code>\/{id}<\/td>GET<\/td><\/tr>
Update a template (metadata and fields)<\/td>\/api\/v1\/template<\/code><\/code>\/{id}<\/td>PUT<\/td><\/tr>
Delete a template<\/td>\/api\/v1\/template<\/code><\/code>\/{id}<\/td>DELETE<\/td><\/tr>
Clone a template<\/td>\/api\/v1\/template<\/code><\/code><\/td>POST<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
\n

Action<\/strong>: Create a template<\/p>\n\n\n\n

URL \/ Verb<\/strong>: \/api\/v1\/template<\/code> : POST<\/p>\n\n\n\n

Payload<\/strong><\/p>\n\n\n\n

JSON<\/span><\/path><\/path><\/svg><\/span>
{<\/span><\/span>\n  <\/span>"name"<\/span>: <\/span>"String; The name of the template"<\/span><\/span>\n}<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Response<\/strong><\/p>\n\n\n\n
HTTP<\/span><\/path><\/path><\/svg><\/span>
Status:<\/span> <\/span>201<\/span><\/span>\nLocation:<\/span> <\/span>https:\/\/tailgunner.app\/api\/v1\/template\/{id}<\/span><\/span>\nContent-Type:<\/span> <\/span>application\/json<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
JSON<\/span><\/path><\/path><\/svg><\/span>
{<\/span><\/span>\n  <\/span>"id"<\/span>: <\/span>"Integer; The ID of the template we created"<\/span><\/span>\n}<\/span><\/span><\/code><\/pre><\/div>\n<\/div>\n\n\n\n
Data Structures<\/h2>\n\n\n\n
\n
\n
\n
Table: templates<\/strong><\/p>\n\n\n\n
Field Name<\/th>Field Type<\/th><\/tr><\/thead>
id<\/td>Primary Key<\/td><\/tr>
user_id<\/td>Foreign Key, Index<\/td><\/tr>
title<\/td>String<\/td><\/tr>
description<\/td>Text, Nullable<\/td><\/tr>
created_at<\/td>Timestamp<\/td><\/tr>
updated_at<\/td>Timestamp<\/td><\/tr>
deleted_at<\/td>Timestamp<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/div>\n<\/div>\n\n\n\n
\n
\n
Table: template_fields<\/strong><\/p>\n\n\n\n
Field Name<\/th>Field Type<\/th><\/tr><\/thead>
id<\/td>Primary Key<\/td><\/tr>
template_id<\/td>Foreign Key, Index<\/td><\/tr>
label<\/td>String<\/td><\/tr>
name<\/td>String<\/td><\/tr>
type<\/td>String<\/td><\/tr>
order<\/td>Integer<\/td><\/tr>
extended_options<\/td>Text, Nullable<\/td><\/tr>
created_at<\/td>Timestamp<\/td><\/tr>
updated_at<\/td>Timestamp<\/td><\/tr>
deleted_at<\/td>Timestamp<\/td><\/tr><\/tbody><\/table><\/figure>\n<\/div>\n<\/div>\n<\/div>\n\n\n\n
\n
System Diagrams<\/h2>\n\n\n\n
\n
\"\"<\/a>
Flowchart: Create New Template<\/figcaption><\/figure>\n<\/figure>\n<\/div>\n<\/div>\n\n\n\n
\n
Cards<\/h2>\n\n\n\n
\n
Card<\/strong>: US1-C1<\/p>\n\n\n\n
\n
\n
Title<\/h4>\n\n\n\n
Create database tables<\/p>\n<\/div>\n\n\n\n
\n
Type<\/h4>\n\n\n\n
Task<\/p>\n<\/div>\n<\/div>\n\n\n\n
Description<\/h4>\n\n\n\n
Create the database tables required to support creating a template and store their fields.<\/p>\n\n\n\n
Acceptance Criteria<\/strong><\/p>\n\n\n\n