Gn-Markdown

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

How to Test the APIs

Navigate to the Web Directory and Start the Server

Running the web server is documented in guix script.

curl http://127.0.0.1:8091/version
"4.0.0"

cd web
export CURRENT_REPO_PATH=<path-to-git-repo-with-files>
export CGIT_REPO_PATH=<path-to-git-bare-repo>
. .guix-shell -- guile -L .. --listen=1970 -e main ./webserver.scm 8091

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:

curl -G -d "file_path=test.md"  localhost:8091/edit

Expected Success Response:

{
"file_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):

{
"error": <error_type>,
"msg": <error_reason>
}

Commit (POST)

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

Request URL:

curl -X POST http://127.0.0.1:8091/commit \
-H 'Content-Type: application/json' \
-d '{
"content": "make test commit",
"filename": "test.md",
"email": "test@gmail.com",
"username": "test",
"commit_message": "init commit",
"prev_commit": "7cbfc40d98b49a64e98e7cd562f373053d0325bd"
}'

Expected Response for success:

{
"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:

{
"status": "200",
"message": "Nothing to commit, working tree clean",
"commit_sha": "ecd96f27c45301279150fbda411544687db1aa45"
}

Expected Error Response:

{
"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