FediBlock
/
website
Archived
4
0
Fork 0
Code Issues Pull Requests 1 Releases Activity

Improve API documentation. 

List the type of the properties, describe properties of the full data
set.
This commit is contained in:
tastytea 2021-01-13 18:04:43 +01:00
parent e199aa736d
commit 135a2a894c
Signed by: tastytea
GPG Key ID: CFC39497F1B26E07
1 changed files with 42 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
index.html
View File

@ -138,16 +138,52 @@
<table>
<caption>Properties</caption>
<tr>
<td id="property">Property</td>
<td id="description">Description</td>
<td id="list_property">Property (type)</td>
<td id="list_description">Description</td>
</tr>
<tr>
<td headers="property">instance</td>
<td headers="description">The hostname of the instance.</td>
<td headers="list_property">instance (string)</td>
<td headers="list_description">The hostname of the instance.</td>
</tr>
<tr>
<td headers="property">url</td>
<td headers="description">The location of the full data set.</td>
<td headers="list_property">url (string)</td>
<td headers="list_description">The location of the full data set.</td>
</tr>
</table>
<p>The full data set is an object with these properties:</p>
<table>
<caption>Properties</caption>
<tr>
<td id="data_property">Property (type)</td>
<td id="data_description">Description</td>
</tr>
<tr>
<td headers="data_property">description (string)</td>
<td headers="data_description">The reasons the instance is listed. Can be long. Not sanitized.</td>
</tr>
<tr>
<td headers="data_property">instance (string)</td>
<td headers="data_description">The hostname of the instance.</td>
</tr>
<tr>
<td headers="data_property">receipts (array of strings)</td>
<td headers="data_description">URLs to prove the claims made in the description and tags.</td>
</tr>
<tr>
<td headers="data_property">report_time (string)</td>
<td headers="data_description">Date and time of reporting, UTC. Format:
<a href="https://man7.org/linux/man-pages/man3/strftime.3.html">%Y-%m-%dT%H:%M:%S</a>.</td>
</tr>
<tr>
<td headers="data_property">screenshots (array of strings)</td>
<td headers="data_description">The file names of the screenshots. Prepend
<code>https://fediblock.org/blocklist/</code> and you have the URL.</td>
</tr>
<tr>
<td headers="data_property">tags (array of strings)</td>
<td headers="data_description">Tags to classify the problems with the instance.</td>
</tr>
</table>