summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorFlorian Pritz <bluewind@xinu.at>2016-06-07 18:16:46 +0200
committerFlorian Pritz <bluewind@xinu.at>2016-06-07 18:16:46 +0200
commit7495e134240190e9699b8da9530d057edd0e93e6 (patch)
treef73d88ae12fa680357607eb293a99357cad42b2c /doc
parent8ce6afc4ac0014de6e4235579abb8c1168d7cff0 (diff)
doc/api.md: Add TOC
Signed-off-by: Florian Pritz <bluewind@xinu.at>
Diffstat (limited to 'doc')
-rw-r--r--doc/api.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/api.md b/doc/api.md
index 8728f3b8f..37e3e2937 100644
--- a/doc/api.md
+++ b/doc/api.md
@@ -1,5 +1,18 @@
# API
+**Table of Contents**
+
+- [General notes](#general-notes)
+ - [URLs](#urls)
+ - [Compatibility](#compatibility)
+ - [Unless stated otherwise ...](#unless-stated-otherwise-)
+ - [Access levels](#access-levels)
+- [General response structure](#general-response-structure)
+ - [Error handling](#error-handling)
+- [General errors](#general-errors)
+- [Endpoints](#endpoints)
+ - [Examples](#examples)
+
The API provides programmatic access to upload, delete files, view the
currently uploaded ones and combine them to multipastes, as well as functions
to manage api keys. Responses are available in JSON.