chore: regenerate documentation

Author: NTBBloodbath

doc/rest-nvim.txt

@@ -15,7 +15,7 @@ CONTENTS                                                   *rest-nvim-contents*
         4. Environment Variables........|rest-nvim-usage-environment-variables|
         5. Dynamic Variables................|rest-nvim-usage-dynamic-variables|
         6. Script Variables..................|rest-nvim-usage-script-variables|
-        6. Callbacks................................|rest-nvim-usage-callbacks|
+        7. Hooks........................................|rest-nvim-usage-hooks|
     6. License..............................................|rest-nvim-license|
     7. Contributing....................................|rest-nvim-contributing|
 
@@ -64,6 +64,7 @@ function, it looks like this by default:
         stay_in_current_window_after_split = true,
       },
       behavior = {
+        decode_url = true,
         show_info = {
           url = true,
           headers = true,
@@ -301,19 +302,24 @@ You can extend or overwrite built-in dynamic variables, with the config key
 
 
 ===============================================================================
-CALLBACKS                                             *rest-nvim-usage-callbacks*
+HOOKS                                                   *rest-nvim-usage-hooks*
 
 `rest.nvim` fires different events upon requests:
-   - a User `RestStartRequest` event when launching the request
-   - a User `RestStopRequest` event when the requests finishes or errors out
+   - a User `RestStartRequest` event when launching the request.
+   - a User `RestStopRequest` event when the requests finishes.
 
 >lua
   vim.api.nvim_create_autocmd("User", {
     pattern = "RestStartRequest",
-    once = true,
-    callback = function(opts)
-      print("IT STARTED")
-      vim.pretty_print(opts)
+    once = true, -- This is optional, only if you want the hook to run once
+    callback = function()
+      print("Started request")
+      -- You can access and modify the request data (body, headers, etc) by
+      -- using the following temporal global variable
+      vim.print(_G._rest_nvim_req_data)
+      -- You can also access environment variables from both your current
+      -- shell session and your environment file by using 'vim.env'
+      _G._rest_nvim_req_data.headers["USER"] = vim.env.USERNAME
     end,
   })
 <

doc/tags

@@ -57,11 +57,11 @@ rest-nvim-license	rest-nvim.txt	/*rest-nvim-license*
 rest-nvim-quick-start	rest-nvim.txt	/*rest-nvim-quick-start*
 rest-nvim-script-variables	rest-nvim.txt	/*rest-nvim-script-variables*
 rest-nvim-usage	rest-nvim.txt	/*rest-nvim-usage*
-rest-nvim-usage-callbacks	rest-nvim.txt	/*rest-nvim-usage-callbacks*
 rest-nvim-usage-commands	rest-nvim.txt	/*rest-nvim-usage-commands*
 rest-nvim-usage-dynamic-variables	rest-nvim.txt	/*rest-nvim-usage-dynamic-variables*
 rest-nvim-usage-environment-variables	rest-nvim.txt	/*rest-nvim-usage-environment-variables*
 rest-nvim-usage-external-files	rest-nvim.txt	/*rest-nvim-usage-external-files*
+rest-nvim-usage-hooks	rest-nvim.txt	/*rest-nvim-usage-hooks*
 rest-nvim-usage-requests	rest-nvim.txt	/*rest-nvim-usage-requests*
 rest-nvim.api	rest-nvim-api.txt	/*rest-nvim.api*
 rest-nvim.client.curl	rest-nvim-curl.txt	/*rest-nvim.client.curl*
@@ -84,6 +84,7 @@ result.get_or_create_buf	rest-nvim-api.txt	/*result.get_or_create_buf*
 result.write_block	rest-nvim-api.txt	/*result.write_block*
 result.write_res	rest-nvim-api.txt	/*result.write_res*
 script_vars.load	rest-nvim-parser.txt	/*script_vars.load*
+utils.escape	rest-nvim-api.txt	/*utils.escape*
 utils.file_exists	rest-nvim-api.txt	/*utils.file_exists*
 utils.highlight	rest-nvim-api.txt	/*utils.highlight*
 utils.read_file	rest-nvim-api.txt	/*utils.read_file*