Merge pull request #50 from Rooyca/v2

BREAKING CHANGE: complete rebuild of plugin

README.es.md

@@ -5,8 +5,8 @@
 [![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/rooyca/obsidian-api-request?logo=github&color=ee8449&style=flat-square)](https://github.com/rooyca/obsidian-api-request/releases/latest)
 <img alt="GitHub Release" src="https://img.shields.io/github/downloads/rooyca/obsidian-api-request/total?logo=github&&color=ee8449&style=flat-square">
 
-[![Inglés](https://img.shields.io/badge/Inglés-8A2BE2)](README.md)
-[![Chino](https://img.shields.io/badge/Chino-8A2BE2)](README.zh.md)
+[![English](https://img.shields.io/badge/English-8A2BE2)](README.md)
+[![中文](https://img.shields.io/badge/中文-8A2BE2)](README.zh.md)
 
 Este plugin para [Obsidian](https://obsidian.md/) permite a los usuarios realizar solicitudes HTTP desde sus notas y mostrar la respuesta en un bloque de código, una ventana modal o pegarla directamente en su documento actual.
 
@@ -34,14 +34,9 @@ Este plugin se puede instalar desde Obsidian.
 
 - [x] Añadir más tipos de solicitudes (POST, PUT, DELETE)
 - [x] Añadir soporte para autenticación
-- [x] Añadir personalización para la salida modal
 - [x] Guardar la respuesta en un archivo
 - [x] Eliminar uno a uno del localStorage
-- [x] Traducir la documentación
-- [ ] Consultas inline de la respuesta de una solicitud
-- [ ] Solicitudes predefinidas
-- [ ] GUI para bloques de código
-- [ ] Añadir la bandera `render` a los bloques de código
+- [ ] Traducir la documentación
 
 ## ❤️ Patrocinadores
 

README.md

@@ -5,13 +5,11 @@
 [![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/rooyca/obsidian-api-request?logo=github&color=ee8449&style=flat-square)](https://github.com/rooyca/obsidian-api-request/releases/latest)
 <img alt="GitHub Release" src="https://img.shields.io/github/downloads/rooyca/obsidian-api-request/total?logo=github&&color=ee8449&style=flat-square">
 
-[![Spanish](https://img.shields.io/badge/Spanish-8A2BE2)](README.es.md)
-[![中文](https://img.shields.io/badge/Chinese-8A2BE2)](README.zh.md)
+[![Español](https://img.shields.io/badge/Español-8A2BE2)](README.es.md)
+[![中文](https://img.shields.io/badge/中文-8A2BE2)](README.zh.md)
 
 
-This [Obsidian](https://obsidian.md/) plugin enables users to make HTTP requests directly within their notes and display the response in a code-block, modal window, or paste it into their active document.
-
-![req_img](showcase_1.gif)
+This [Obsidian](https://obsidian.md/) plugin enables users to make API requests directly within their notes and display the response in a code-block.
 
 ## 🚀 Installation
 
@@ -27,24 +25,18 @@ The plugin can be installed from within Obsidian.
 
 ## 🛠️ Usage
 
-### [Read the docs](https://rooyca.github.io/obsidian-api-request/)
-
-![showcase](showcase_2.gif)
+### [Read documentation here](https://rooyca.github.io/obsidian-api-request/)
 
 ## ✅ To-do
 
-- [x] Add more request types (POST, PUT, DELETE)
-- [x] Add support for authentication
-- [x] Add customization for modal output
-- [x] Save response to a file
-- [x] Remove one by one from localStorage
-- [x] Translate documentation
-- [x] Add `render` flag to code-blocks
-- [ ] Inline query from response
-- [ ] Predefined requests
-- [ ] GUI for code-blocks
+> Check all changes on [TODOS-v2.md](TODOS-v2.md)
 
-## ❤️ Sponsors
+- [ ] Translate (& update) documentation
+- [x] Data re-usage (`{{ls.UUID>JSONPath}}` syntax, where `ls` stands for `localStorage`)
+- [x] Support for comments using `#` or `//` syntax 
+- [ ] Inline query from response
+- [ ] Add tests (!!!)
+- [ ] Re-implement `repeat` flag (repeat requests X times or every X seconds)
 
 <a href="https://github.com/tlwt"><img src="https://github.com/tlwt.png" width="40px" /></a>
 

README.zh.md

@@ -5,15 +5,13 @@
 [![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/rooyca/obsidian-api-request?logo=github&color=ee8449&style=flat-square)](https://github.com/rooyca/obsidian-api-request/releases/latest)
 <img alt="GitHub Release" src="https://img.shields.io/github/downloads/rooyca/obsidian-api-request/total?logo=github&&color=ee8449&style=flat-square">
 
-[![Spanish](https://img.shields.io/badge/Spanish-8A2BE2)](README.es.md)
+[![Español](https://img.shields.io/badge/Español-8A2BE2)](README.es.md)
 [![English](https://img.shields.io/badge/English-8A2BE2)](README.md)
 
 
 这个[Obsidian](https://obsidian.md/)插件能让用户直接在笔记中进行 HTTP 请求，并在代码块、模式窗口中显示响应，或直接将其粘贴到活动文档中。
 
 
-![req_img](showcase_1.gif)
-
 ## 🚀 Installation
 
 The plugin can be installed from within Obsidian.
@@ -30,18 +28,15 @@ The plugin can be installed from within Obsidian.
 
 ### [Read the docs](https://rooyca.github.io/obsidian-api-request/)
 
-![showcase](showcase_2.gif)
-
 ## ✅ To-do
 
-- [x] Add more request types (POST, PUT, DELETE)
-- [x] Add support for authentication
-- [x] Add customization for modal output
-- [x] Save response to a file
+- [ ] Translate documentation
+- [x] Data re-usage (`{{ls.UUID>JSONPath}}` syntax, where `ls` stands for `localStorage`)
+- [x] Support for comments using `#` or `//` syntax 
 - [ ] Inline query from response
-- [ ] Predefined requests
-- [ ] GUI for code-blocks
-- [x] Remove one by one from localStorage
+- [ ] Add tests (!!!)
+- [ ] Re-implement `repeat` flag (repeat requests X times or every X seconds)
+- [ ] Re-implement `properties` flag (specifies the frontmatter properties to update with the response)
 
 ## ❤️ Sponsors
 

TODOS-v2.md

@@ -0,0 +1,35 @@
+# APIRequest v2: Feature Overview
+
+## Features to Retain
+
+- [x] Support for standard HTTP methods: `GET, POST, PUT, DELETE`
+- [x] Headers and Body configuration  
+  - [x] Fix quotation marks to support formats beyond double quotes
+- [x] Customizable response output using the `jsonpath-plus` library  
+  - [x] Display strings when arrays contain a single element
+- [ ] Properties configuration (pending implementation)
+- [ ] Support for repeated requests (e.g., at fixed intervals or multiple iterations)
+- [x] Single-request execution
+- [x] Save responses to a file  
+  - [x] Automatically save responses upon each code block execution
+- [x] Integration with `frontmatter` variables using `{{this.VARNAME}}` syntax
+- [x] Global variables (Key/Value pairs) managed via settings
+
+## Features to Remove
+
+- [x] Modals (removed for streamlined functionality)
+- [x] `res-type` flag (removed)
+- [x] `notify-if` flag (removed to reduce complexity)
+- [x] `render` flag (removed to focus on core functionality)
+- [x] `maketable` (removed to simplify output)
+- [x] `format` flag (removed for streamlined functionality)
+- [x] Support for non-JSON formats (e.g., MD, XML) — JSON remains the primary focus
+
+## Features to Add
+
+- [ ] `hide` flag ~do we actually want this?~
+- [x] `auto-update` flag
+- [x] Unique request identifiers (`req-uuid`) (save it in local storage and use it for subsequent requests unless user use the flag `auto-update`)
+- [-] Inline queries (rendered exclusively in "read mode")
+- [x] Data re-usage (`{{ls.UUID>JSONPath}}` syntax, where `ls` stands for `localStorage`)
+- [x] Support for comments using `#` or `//` syntax