+docs

lokalise · Nov 26, 2024 · 6c923d8 · 6c923d8
1 parent 83ada2d
commit 6c923d8
Show file tree

Hide file tree

Showing 4 changed files with 126 additions and 522 deletions.
diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock
@@ -1,7 +1,7 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.2.2)
+    activesupport (8.0.0)
       base64
       benchmark (>= 0.3)
       bigdecimal
@@ -13,21 +13,23 @@ GEM
       minitest (>= 5.1)
       securerandom (>= 0.3)
       tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
     base64 (0.2.0)
-    benchmark (0.3.0)
+    benchmark (0.4.0)
     bigdecimal (3.1.8)
     coffee-script (2.4.1)
       coffee-script-source
       execjs
     coffee-script-source (1.12.2)
     colorator (1.1.0)
-    commonmarker (0.23.10)
+    commonmarker (0.23.11)
     concurrent-ruby (1.3.4)
     connection_pool (2.4.1)
     csv (3.3.0)
-    dnsruby (1.72.2)
+    dnsruby (1.72.3)
+      base64 (~> 0.2.0)
       simpleidn (~> 0.2.1)
     drb (2.2.1)
     em-websocket (0.5.3)
@@ -37,12 +39,12 @@ GEM
       ffi (>= 1.15.0)
     eventmachine (1.2.7)
     execjs (2.10.0)
-    faraday (2.12.0)
-      faraday-net_http (>= 2.0, < 3.4)
+    faraday (2.12.1)
+      faraday-net_http (>= 2.0, < 3.5)
       json
       logger
-    faraday-net_http (3.3.0)
-      net-http
+    faraday-net_http (3.4.0)
+      net-http (>= 0.5.0)
     ffi (1.17.0-x64-mingw-ucrt)
     ffi (1.17.0-x86_64-linux-gnu)
     forwardable-extended (2.6.0)
@@ -215,7 +217,7 @@ GEM
       gemoji (>= 3, < 5)
       html-pipeline (~> 2.2)
       jekyll (>= 3.0, < 5.0)
-    json (2.7.5)
+    json (2.8.2)
     kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
@@ -230,8 +232,8 @@ GEM
       jekyll (>= 3.5, < 5.0)
       jekyll-feed (~> 0.9)
       jekyll-seo-tag (~> 2.1)
-    minitest (5.25.1)
-    net-http (0.4.1)
+    minitest (5.25.2)
+    net-http (0.5.0)
       uri
     nokogiri (1.16.7-x64-mingw-ucrt)
       racc (~> 1.4)
@@ -259,7 +261,7 @@ GEM
     sawyer (0.9.2)
       addressable (>= 2.3.5)
       faraday (>= 0.17.3, < 3)
-    securerandom (0.3.1)
+    securerandom (0.3.2)
     simpleidn (0.2.3)
     terminal-table (1.8.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
@@ -270,7 +272,7 @@ GEM
     tzinfo-data (1.2024.2)
       tzinfo (>= 1.0.0)
     unicode-display_width (1.8.0)
-    uri (0.13.1)
+    uri (1.0.2)
     wdm (0.2.0)
     webrick (1.9.0)
 
@@ -290,4 +292,4 @@ DEPENDENCIES
   webrick (~> 1.8)
 
 BUNDLED WITH
-   2.5.22
+   2.5.23
diff --git a/docs/_data/additional_items.yml b/docs/_data/additional_items.yml
@@ -5,6 +5,8 @@
   sub_paths:
     - title: API Rate Limits
       path: api-rate-limits
+- title: Configuring API host
+  path: configuring_api_host
 - title: Proxy support
   path: proxy_support
 - title: Webhook events

diff --git a/docs/additional_info/configuring_api_host.md b/docs/additional_info/configuring_api_host.md
@@ -0,0 +1,18 @@
+# Configuring API host
+
+By default, API requests are sent to the `https://api.lokalise.com/api2/` URL that acts as a host.
+
+OAuth 2 authentication requests are sent to `https://app.lokalise.com`.
+
+OTA requests are sent to `https://ota.lokalise.com`.
+
+To override the API host, use the following approach (works for all client types):
+
+```js
+const client = new LokaliseApi({
+  // other config ...
+  host: "http://example.com",
+});
+```
+
+Then use your `client` as usual.