Skip to content

Commit 15a8f64

Browse files
nthnnnthnn
committed
Complete Database API documentations.
1 parent 544d526 commit 15a8f64

File tree

1 file changed

+177
-0
lines changed

1 file changed

+177
-0
lines changed

‎documentations/src/views/Database.vue

Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,183 @@
4444

4545
<h4 class="border-bottom">📡 Authentication API Calls</h4>
4646
<hr/>
47+
48+
<b class="mt-4 mb-2 d-block border-bottom fw-bold">Database: Create</b>
49+
<p>Create new JSON-based data storage database.</p>
50+
<pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=db_create</pre>
51+
52+
<p>Payload Structure:</p>
53+
<ul>
54+
<li><i>database</i> &mdash; The database name to be created. (Should be a-z or A-Z and greater than or equals to 6 characters)</li>
55+
<li><i>permissions</i> &mdash; The database mode permissions; must be only either &quot;w&quot;, &quot;r&quot;, &quot;wr&quot;, or &quot;rw&quot;. (&quot;w&quot; for writing permission and &quot;r&quot; for reading permission)</li>
56+
<li><i>data</i> &mdash; Base64 string that contains a JSON database.</li>
57+
</ul>
58+
59+
<pre class="bg-secondary border-gray border rounded p-2"><span class="text-primary">{</span>
60+
<span class="text-warning">"name"</span>: <span class="text-danger">"&lt;database&gt;"</span>,
61+
<span class="text-warning">"mode"</span>: <span class="text-danger">"&lt;permissions&gt;"</span>,
62+
<span class="text-warning">"content"</span>: <span class="text-danger">"&lt;data&gt;"</span>
63+
<span class="text-primary">}</span></pre>
64+
65+
<b class="mt-4 mb-2 d-block border-bottom fw-bold">Database: Get by Name</b>
66+
<p>Fetch database permissions and stored data content by name.</p>
67+
<pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=db_get_by_name</pre>
68+
69+
<p>Payload Structure:</p>
70+
<ul>
71+
<li><i>database</i> &mdash; The database name to be fetched. (Should be a-z or A-Z and greater than or equals to 6 characters)</li>
72+
</ul>
73+
74+
<pre class="bg-secondary border-gray border rounded p-2"><span class="text-primary">{</span>
75+
<span class="text-warning">"name"</span>: <span class="text-danger">"&lt;database&gt;"</span>
76+
<span class="text-primary">}</span></pre>
77+
78+
<b>Response Data</b>
79+
<ul>
80+
<li>
81+
<i>value</i> &mdash; This key will contain a 2D array of fetched database informations.
82+
<table class="table table-hover">
83+
<tr>
84+
<th>Array Index</th>
85+
<th>Index Content</th>
86+
</tr>
87+
<tr>
88+
<td>0</td>
89+
<td>The database mode permissions; either "w", "r", "wr", or "rw". ("w" for writing permission and "r" for reading permission)</td>
90+
</tr>
91+
<tr>
92+
<td>1</td>
93+
<td>Base64 string that contains a JSON database</td>
94+
</tr>
95+
</table>
96+
</li>
97+
</ul>
98+
99+
<b class="mt-4 mb-2 d-block border-bottom fw-bold">Database: Set Mode</b>
100+
<p>Set new permissions to a database by name.</p>
101+
<pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=db_set_mode</pre>
102+
103+
<p>Payload Structure:</p>
104+
<ul>
105+
<li><i>database</i> &mdash; The database name where the new permissions will be made. (Should be a-z or A-Z and greater than or equals to 6 characters)</li>
106+
<li><i>permissions</i> &mdash; The database mode new permissions; must be only either &quot;w&quot;, &quot;r&quot;, &quot;wr&quot;, or &quot;rw&quot;. (&quot;w&quot; for writing permission and &quot;r&quot; for reading permission)</li>
107+
</ul>
108+
109+
<pre class="bg-secondary border-gray border rounded p-2"><span class="text-primary">{</span>
110+
<span class="text-warning">"name"</span>: <span class="text-danger">"&lt;database&gt;"</span>,
111+
<span class="text-warning">"mode"</span>: <span class="text-danger">"&lt;permissions&gt;"</span>
112+
<span class="text-primary">}</span></pre>
113+
114+
<b class="mt-4 mb-2 d-block border-bottom fw-bold">Database: Get Mode</b>
115+
<p>Get designated permissions of a database by name.</p>
116+
<pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=db_get_mode</pre>
117+
118+
<p>Payload Structure:</p>
119+
<ul>
120+
<li><i>database</i> &mdash; The database name to be fetched. (Should be a-z or A-Z and greater than or equals to 6 characters)</li>
121+
</ul>
122+
123+
<pre class="bg-secondary border-gray border rounded p-2"><span class="text-primary">{</span>
124+
<span class="text-warning">"name"</span>: <span class="text-danger">"&lt;database&gt;"</span>
125+
<span class="text-primary">}</span></pre>
126+
127+
<b>Response Data</b>
128+
<ul>
129+
<li><i>value</i> &mdash; This key will contain database mode permissions of the specified database name; either "w", "r", "wr", or "rw". ("w" for writing permission and "r" for reading permission)</li>
130+
</ul>
131+
132+
<b class="mt-4 mb-2 d-block border-bottom fw-bold">Database: Read Content</b>
133+
<p>Fetch the whole stored data from a specified database name.</p>
134+
<pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=db_read</pre>
135+
136+
<p>Payload Structure:</p>
137+
<ul>
138+
<li><i>database</i> &mdash; The database name to be fetched. (Should be a-z or A-Z and greater than or equals to 6 characters)</li>
139+
</ul>
140+
141+
<pre class="bg-secondary border-gray border rounded p-2"><span class="text-primary">{</span>
142+
<span class="text-warning">"name"</span>: <span class="text-danger">"&lt;database&gt;"</span>
143+
<span class="text-primary">}</span></pre>
144+
145+
<b>Response Data</b>
146+
<ul>
147+
<li><i>value</i> &mdash; This key will contain database in JSON object form.</li>
148+
</ul>
149+
150+
<b class="mt-4 mb-2 d-block border-bottom fw-bold">Database: Write Content</b>
151+
<p>Overwrite the whole stored data contents of a specified database name.</p>
152+
<pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=db_write</pre>
153+
154+
<p>Payload Structure:</p>
155+
<ul>
156+
<li><i>database</i> &mdash; The database name to be fetched. (Should be a-z or A-Z and greater than or equals to 6 characters)</li>
157+
<li><i>data</i> &mdash; Base64 string that contains a JSON database.</li>
158+
</ul>
159+
160+
<pre class="bg-secondary border-gray border rounded p-2"><span class="text-primary">{</span>
161+
<span class="text-warning">"name"</span>: <span class="text-danger">"&lt;database&gt;"</span>,
162+
<span class="text-warning">"content"</span>: <span class="text-danger">"&lt;data&gt;"</span>
163+
<span class="text-primary">}</span></pre>
164+
165+
<b class="mt-4 mb-2 d-block border-bottom fw-bold">Database: Write Content</b>
166+
<p>Overwrite the whole stored data contents of a specified database name.</p>
167+
<pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=db_write</pre>
168+
169+
<p>Payload Structure:</p>
170+
<ul>
171+
<li><i>database</i> &mdash; The database name to be fetched. (Should be a-z or A-Z and greater than or equals to 6 characters)</li>
172+
<li><i>data</i> &mdash; Base64 string that contains a JSON database.</li>
173+
</ul>
174+
175+
<pre class="bg-secondary border-gray border rounded p-2"><span class="text-primary">{</span>
176+
<span class="text-warning">"name"</span>: <span class="text-danger">"&lt;database&gt;"</span>,
177+
<span class="text-warning">"content"</span>: <span class="text-danger">"&lt;data&gt;"</span>
178+
<span class="text-primary">}</span></pre>
179+
180+
<b class="mt-4 mb-2 d-block border-bottom fw-bold">Database: Delete</b>
181+
<p>Delete a whole database by a specified name.</p>
182+
<pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=db_write</pre>
183+
<div class="alert alert-danger">
184+
<p class="mb-0">This action cannot be reversed.</p>
185+
</div>
186+
187+
<p>Payload Structure:</p>
188+
<ul>
189+
<li><i>database</i> &mdash; The database name to be fetched. (Should be a-z or A-Z and greater than or equals to 6 characters)</li>
190+
</ul>
191+
192+
<pre class="bg-secondary border-gray border rounded p-2"><span class="text-primary">{</span>
193+
<span class="text-warning">"name"</span>: <span class="text-danger">"&lt;database&gt;"</span>
194+
<span class="text-primary">}</span></pre>
195+
196+
<b class="mt-4 mb-2 d-block border-bottom fw-bold">Database: Fetch All</b>
197+
<p>Fetch all database list of names and permissions.</p>
198+
<pre class="bg-secondary border-gray border rounded p-2">api/index.php?action=db_fetch_all</pre>
199+
200+
<b>Example Payload</b>
201+
<pre class="bg-secondary border-gray border rounded p-2"><span class="text-primary">{}</span></pre>
202+
203+
<b>Response Data</b>
204+
<ul>
205+
<li>
206+
<i>value</i> &mdash; This key will contain a 2D array of fetched database names and permissions.
207+
<table class="table table-hover">
208+
<tr>
209+
<th>Array Index</th>
210+
<th>Index Content</th>
211+
</tr>
212+
<tr>
213+
<td>0</td>
214+
<td>The name of the fetched database.</td>
215+
</tr>
216+
<tr>
217+
<td>1</td>
218+
<td>The database mode permissions; either "w", "r", "wr", or "rw". ("w" for writing permission and "r" for reading permission)</td>
219+
</tr>
220+
</table>
221+
</li>
222+
</ul>
223+
47224
<div class="row">
48225
<div class="col-6">
49226
<RouterLink to="/data-analytics" class="btn btn-primary">

0 commit comments

Comments
 (0)