From 135a2a894c0618179ac7fc643026ad89f2a14eb5 Mon Sep 17 00:00:00 2001 From: tastytea Date: Wed, 13 Jan 2021 18:04:43 +0100 Subject: [PATCH] Improve API documentation. List the type of the properties, describe properties of the full data set. --- index.html | 48 ++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 42 insertions(+), 6 deletions(-) diff --git a/index.html b/index.html index 309de8c..15e0149 100644 --- a/index.html +++ b/index.html @@ -138,16 +138,52 @@ - - + + - - + + - - + + + +
Properties
PropertyDescriptionProperty (type)Description
instanceThe hostname of the instance.instance (string)The hostname of the instance.
urlThe location of the full data set.url (string)The location of the full data set.
+ +

The full data set is an object with these properties:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Properties
Property (type)Description
description (string)The reasons the instance is listed. Can be long. Not sanitized.
instance (string)The hostname of the instance.
receipts (array of strings)URLs to prove the claims made in the description and tags.
report_time (string)Date and time of reporting, UTC. Format: + %Y-%m-%dT%H:%M:%S.
screenshots (array of strings)The file names of the screenshots. Prepend + https://fediblock.org/blocklist/ and you have the URL.
tags (array of strings)Tags to classify the problems with the instance.