aboutsummaryrefslogtreecommitdiff
path: root/_www/doc
diff options
context:
space:
mode:
Diffstat (limited to '_www/doc')
l---------_www/doc1
-rw-r--r--_www/doc/CHANGELOG.adoc51
l---------_www/doc/README.md1
-rw-r--r--_www/doc/SPECS.adoc71
-rw-r--r--_www/doc/index.adoc24
5 files changed, 147 insertions, 1 deletions
diff --git a/_www/doc b/_www/doc
deleted file mode 120000
index 0ce5016..0000000
--- a/_www/doc
+++ /dev/null
@@ -1 +0,0 @@
-../_doc \ No newline at end of file
diff --git a/_www/doc/CHANGELOG.adoc b/_www/doc/CHANGELOG.adoc
new file mode 100644
index 0000000..ff751f8
--- /dev/null
+++ b/_www/doc/CHANGELOG.adoc
@@ -0,0 +1,51 @@
+// SPDX-FileCopyrightText: 2021 M. Shulhan <ms@kilabit.info>
+// SPDX-License-Identifier: GPL-3.0-or-later
+= trunks CHANGELOG
+Shulhan <ms@kilabit.info>
+:toc:
+:sectanchors:
+:sectlinks:
+
+[#v0_3_0]
+== trunks v0.3.0 (2022-08-25)
+
+This release set the minimum Go version to 1.18 and update all modules.
+
+[#v0_3_0_chores]
+=== Chores
+
+all: group all documentations under directory _doc::
++
+The _doc directory provides an entry point for all documentation.
+While at it we reformat the README to use AsciiDoc markup.
+
+example: fix the HTTP POST handler::
++
+Remove call to ParseMultipartform since the request type is
+x-www-form-urlencoded not multipart/form-data.
+
+all: remove unused field Locker in RunRequest::
+
+all: fix all linter warnings::
++
+Some linter, govet, warns about possible copied Mutex on HttpRequest.
+To fix this we implement method clone and Stringer on HttpRequest.
+
+
+[#v0_2_0]
+== trunks v0.2.0 (2022-03-13)
+
+Release trunks under GPL 3.0 or later license.
+
+See https://kilabit.info/journal/2022/gpl for more information.
+
+
+[#v0_1_0]
+== trunks v0.1.0 (2022-02-05)
+
+Module trunks is a library and HTTP service that provide web user interface
+to test HTTP service, similar to Postman, and for load testing.
+
+For the load testing we use vegeta [1] as the backend.
+
+[1] https://github.com/tsenart/vegeta
diff --git a/_www/doc/README.md b/_www/doc/README.md
new file mode 120000
index 0000000..fe84005
--- /dev/null
+++ b/_www/doc/README.md
@@ -0,0 +1 @@
+../../README.md \ No newline at end of file
diff --git a/_www/doc/SPECS.adoc b/_www/doc/SPECS.adoc
new file mode 100644
index 0000000..2b26cac
--- /dev/null
+++ b/_www/doc/SPECS.adoc
@@ -0,0 +1,71 @@
+// SPDX-FileCopyrightText: 2021 M. Shulhan <ms@kilabit.info>
+// SPDX-License-Identifier: GPL-3.0-or-later
+= Trunks
+:toc:
+:sectanchors:
+:sectlinks:
+
+Trunks is a Go library that provide HTTP service with web user interface
+to test HTTP and/or WebSocket endpoints and for load testing HTTP endpoints.
+
+For testing HTTP endpoints it use the
+https://pkg.go.dev/github.com/shuLhan/share/lib/http[lib/http^]
+package as the client, a wrapper for standard Go HTTP package.
+For testing WebSocket endpoints it use the
+https://pkg.go.dev/github.com/shuLhan/share/lib/websocket[lib/websocket^]
+package as the client.
+For the load testing we use
+https://github.com/tsenart/vegeta[vegeta^]
+as the backend.
+
+This documentation provide the development of Trunks.
+
+[#schemas]
+== Schemas
+
+[#schema_environment]
+=== Environment
+
+----
+{
+ "ListenAddress": string,
+ "MaxAttackDuration": number,
+ "MaxAttackRate": number,
+ "ResultsDir": string,
+ "ResultsSuffix": string,
+ "AttackRunning": <AttackRunning>
+}
+----
+
+
+[#http_api]
+== HTTP APIs
+
+All of HTTP APIs return a JSON object using the following response schema
+
+----
+{
+ "code": number,
+ "message": string,
+ "data": any
+}
+----
+
+* `code` field contains the HTTP status code
+* `message` field contains the error message for HTTP status 4xx or 5xx.
+* `data` field contains the actual response data.
+
+=== Get environment
+
+HTTP API to get the current Trunks environment.
+
+*Request*
+
+----
+GET /_trunks/api/environment
+----
+
+*Response*
+
+On success, it will return the
+link:#schema_environment[Environment schema].
diff --git a/_www/doc/index.adoc b/_www/doc/index.adoc
new file mode 100644
index 0000000..8247870
--- /dev/null
+++ b/_www/doc/index.adoc
@@ -0,0 +1,24 @@
+= trunks
+:toc:
+:sectanchors:
+:sectlinks:
+
+
+== Documentation
+
+link:CHANGELOG.html[CHANGELOG^]:: History of each release.
+
+link:README.html[README^]:: Manual page for trunks' users.
+
+link:SPECS.html[Specification^]:: Manual page for trunks' developers.
+
+
+== Development
+
+https://git.sr.ht/~shulhan/trunks[Repository^]:: Link to the source code.
+
+https://lists.sr.ht/~shulhan/trunks[Mailing list^]:: Link to discussion and
+where to send patches.
+
+https://todo.sr.ht/~shulhan/trunks[Issues^]:: Link to report for bug or
+feature.