# GN4 Guile Webservice

This directory provides a Guile web service incl. the new REST API. It is used in conjunction with the Python web services and (very much) WIP.

# Documentation

Start with this file and then the documentation in [doc](./doc/gn-guile.md).

# Development

The current repository lives at

```sh
git clone tux02.genenetwork.org:/home/git/public/gn-guile
```

GNU Guile allows you to develop against a live running web server using emacs-geiser. To try this fire up the web server from the `web` directory as

```sh
cd web
unset GUIX_PROFILE
. .guix-shell -- guile -L .. --listen=1970 -e main ./webserver.scm 8091
```

Note the leading dot. The .guix-shell is defined in `gn-guile/web` and loads required packages using GNU Guix.
If you are on Debian you may need to unset GUIX_PROFILE first.

Next fire up emacs with `emacs-geiser-guile` and connect to the running web server with `M-x geiser-connect` and the port `1970`. Now you can not only inspect procedures, but also update any prodedure on the live server using `C-M-x` and get updated output from the webserver!

# Tools

Some tooling and scripts that run independently are stored in `./scripts`.

Here’s the entire markdown content combined into a single, copyable file:


# Gn-Markdown

Gn-Markdown is an API endpoint to edit, parse, and commit markdown files for gn-docs.

## How to Test the APIs

1. **Navigate to the Web Directory and Start the Server**

    ```sh
    cd web
    . .guix-shell -- guile -L .. --listen=1970 -e main ./webserver.scm 8091
    ```

2. **Test Endpoints**

    The main endpoints provided are `/edit` and `/commit`. More endpoints may be added in the future.

## Edit (GET)

This is a GET request to retrieve a file's details. Make sure you pass a valid file_path as search_query (the path should be relative to the repo)

**Request Example:**

```
localhost:8091/edit?file_path=test.md

```

**Expected Success Response:**

```json
{
    "path": "test.md",
    "content": "Test for new user\n test 2 for line\n test 3 for new line\n ## real markdown two test\n",
    "hash": "ecd96f27c45301279150fbda411544687db1aa45"
}
```

**Expected Error Response (Status 400):**

```json
{
    "error": "file-error",
    "msg": "The file path /home/kabui/test_repo/test.md does not exist"
}
```

## Commit (POST)

This is a POST request to commit changes to a file.

**Request URL:**

```
localhost:8091/commit
```

**Request Body Example:**

```json
{
    "content": "Test for new user\n test 2 for line\n test 3 for new line\n ## real markdown two test\n",
    "prev_commit"  : "ecd96f27c45301279150fbda411544687db1aa45",
    "filename": "./test.md",
    "username": "genetics",
    "email": "genetics@gmail.com",
    "commit_message": "commit by genetics"
}
```

**Expected Success Response:**

```json
{
    "status": "201",
    "message": "Committed file successfully",
    "content": "Test for new user\n test 2 for line\n test 3 for new line\n ## real markdown two test\n",
    "commit-sha": "47df3b7f13a935d50cc8b40e98ca9e513cba104c",
    "commit-message": "commit by genetics"
}
```

**If No Changes to File:**

```json
{
    "status": "200",
    "message": "Nothing to commit, working tree clean",
    "commit-sha": "ecd96f27c45301279150fbda411544687db1aa45"
}
```

**Expected Error Response:**

```json
{
    "error": "system-error",
    "msg": "Commits do not match. Please pull in the latest changes for the current commit *ecd96f27c45301279150fbda411544687db1aa45* and previous commits."
}
```

## Notes 

This is meant to be used as api endpoint only to edit any local repo; Clients are expected to handle other service e.g User Interface, authentication 

# Development

```
git remote add gn git.genenetwork.org:/home/git/public/gn-guile
```

# LICENSE

This software is published by the GeneNetwork team under the AGPL3. See [LICENSE](LICENSE.txt).