Add README

api_server/README.md

@@ -0,0 +1,42 @@
+# API Server
+
+`api_server.py` is a Flask script that loads and executes Flask blueprints from the `blueprints` directory.
+
+
+Currently it's intended to combine oggit and ogrepository.
+
+
+# Usage
+
+## Ubuntu 24.04
+
+     sudo apt install -y python3-flask python3-paramiko opengnsys-flask-executor opengnsys-flask-restx
+
+The  `opengnsys-flask-executor` and `opengnsys-flask-restx` packages are available on the OpenGnsys package server.
+
+Run with:
+
+    ./api_server.py
+
+
+# Operation
+
+## Requirements
+
+The gitapi is designed to run within an existing opengnsys environment. It should be installed in an ogrepository.
+
+
+## API Examples
+
+### Get list of branches
+
+    $ curl -L http://localhost:5000/repositories/linux/branches
+    {
+        "branches": [
+            "master"
+        ]
+    }
+
+### Synchronize with remote repository
+
+    curl --header "Content-Type: application/json" --data  '{"remote_repository":"foobar"}' -X POST -L http://localhost:5000/repositories/linux/sync