1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
# 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**
Running the web server is documented in [guix script](./web/.guix-shell).
```
curl http://127.0.0.1:8091/version
"4.0.0"
```
```sh
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
```
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:**
```bash
curl -G -d "file_path=test.md" localhost:8091/edit
```
**Expected Success Response:**
```json
{
"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):**
```json
{
"error": <error_type>,
"msg": <error_reason>
}
```
## Commit (POST)
This is a POST request to commit changes to a file.
**Request URL:**
```bash
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:**
```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
|
