From 6c5b18844a8764a8df58f5c837de94e4bae501d8 Mon Sep 17 00:00:00 2001
From: 9Lukas5 <lukas.wiest@infinite-tech.solutions>
Date: Thu, 26 Nov 2020 10:14:59 +0100
Subject: [PATCH] refactor(docs): api: write 'index'

---
 docs/api/index.md | 68 ++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 64 insertions(+), 4 deletions(-)

diff --git a/docs/api/index.md b/docs/api/index.md
index 32aa137..463afc3 100644
--- a/docs/api/index.md
+++ b/docs/api/index.md
@@ -1,6 +1,66 @@
 # Java-API
 
-!!! todo
-    - introductional text about library usage
-    - api docs structure explanation
-    - hint about no autogenerated JavaDoc, but manually written docs
+This is the API-Documentation,
+holding detailed information for each publicly available action you can do with each class.
+Below the structure of the library is explained and some generic examples are shown.
+## library structure
+
+The library is structured into three packages:
+
+1. `de.hftstuttgart.unifiedticketing.core`
+1. `de.hftstuttgart.unifiedticketing.exceptions`
+1. `de.hftstuttgart.unifiedticketing.systems`
+
+The core package contains the classes defining the generic API,
+to be implemented by each supported system.  
+The systems package contains a sub-package per supported system,
+which then holds the implementations of the core classes.  
+The exceptions package has some own exception types,
+used throughout the lib.
+
+For each package, this documentation provides a chapter in the navigation on the left.
+
+## examples
+
+!!! info
+    These examples are not specific to a certain system.
+    Therefore they can contain placeholders for system specific parts.
+    To get these parts, you'll have to go to the dedicated API-docs part.
+
+??? example "create TicketSystem instance"
+    __from builder:__
+    ```java
+    TicketSystem ts = TicketSystem.fromBuilder()
+        .<methods specifying connection details>
+        .build();
+    ```
+
+    __from uri:__
+    ```java
+    TicketSystem ts = TicketSystem.fromUri(<uri>);
+    ```
+
+??? example "searching tickets"
+    __without filters:__
+    ```java
+    ts.find().get();
+    ```
+
+    __only open tickets and explicit pagination:__
+    ```java
+    ts.find()
+        .isOpen()
+        .setPage(1)
+        .setPageSize(10)
+        .get();
+    ```
+
+??? warning "default pagination"
+    many systems have an implicit default pagination enabled,
+    which could block you from simply getting _all_ tickets.
+
+    !!! tip
+        you can ask the `TicketSystem` object, to tell you if it uses a default pagination:
+        ```java
+        ts.hasDefaultPagination();
+        ```
-- 
GitLab