From ab2bb38f39052a7b2cfb816da14d039fa382ca63 Mon Sep 17 00:00:00 2001 From: Morten Olsen Date: Mon, 19 May 2025 09:14:47 +0200 Subject: [PATCH] docs: add road-map --- docs/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/README.md b/docs/README.md index ca1b09a..0bbd3c7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -21,6 +21,14 @@ It allows developers to create API documentation that is always accurate and up- - **Tutorials & Guides:** Build step-by-step guides where each HTTP interaction is shown with its real output. - **Rapid Prototyping:** Quickly experiment with APIs and document your findings. +## Roadmap + +- **Programmatic API** Use `http.md` inside existing scripts and pipelines +- **Environment Varaiables** Support using the runners environment variables in templates +- **JavaScript script support** Add JavaScript code blocks with execution, which will allow more advanced use-cases +- **Asserts** Add the ability to make HTTP assertions to use the document for testing +- **Templates** Write re-usable templates which can be used in documents + ## Content ::toc