Merge pull request #76 from BlueAndi/Development

Prepare v5.0.0 (2nd round)
BlueAndi · Feb 24, 2022 · d35cc4a · d35cc4a
2 parents b54fa88 + 9ca4e5b
commit d35cc4a
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -126,7 +126,7 @@ Keyword   | Description
 
 **Note**
 - If theses keywords are used within the sourcecode they have to be prefixed with two backslashes (one additional for escaping).
-- If these keywords are used via the [REST API](REST.md) all unsafe ASCII characters must be replaced by the respective percent encoding (see also [ASCII Encoding Reference](https://www.w3schools.com/tags/ref_urlencode.ASP)).
+- If these keywords are used via the [REST API](https://app.swaggerhub.com/apis/BlueAndi/Pixelix/1.2.0) all unsafe ASCII characters must be replaced by the respective percent encoding (see also [ASCII Encoding Reference](https://www.w3schools.com/tags/ref_urlencode.ASP)).
 - The keywords can be combined.  
 
 **Examples**

diff --git a/data/plugins/DateTimePlugin.html b/data/plugins/DateTimePlugin.html
@@ -58,9 +58,13 @@ <h2 class="mt-1">REST API</h2>
                 <h2 class="mt-2">Configuration</h2>
                 <h3 class="mt-1">Get configuration about what the plugin shows.</h3>
                 <pre name="injectOrigin" class="text-light"><code>GET {{ORIGIN}}/rest/api/v1/display/uid/&lt;PLUGIN-UID&gt;/cfg</code></pre>
+                <pre name="injectOrigin" class="text-light"><code>GET {{ORIGIN}}/rest/api/v1/display/alias/&lt;PLUGIN-ALIAS&gt;/cfg</code></pre>
                 <h3 class="mt-1">Set configuration about what the plugin shall show.</h3>
                 <pre name="injectOrigin" class="text-light"><code>POST {{ORIGIN}}/rest/api/v1/display/uid/&lt;PLUGIN-UID&gt;/cfg?cfg=&lt;CFG&gt;</code></pre>
+                <pre name="injectOrigin" class="text-light"><code>POST {{ORIGIN}}/rest/api/v1/display/alias/&lt;PLUGIN-ALIAS&gt;/cfg?cfg=&lt;CFG&gt;</code></pre>
                 <ul>
+                    <li>PLUGIN-UID: The plugin unique id.</li>
+                    <li>PLUGIN-ALIAS: The plugin alias name.</li>
                     <li>CFG: Configuration id
                         <ul>
                             <li>0: Show date and time.</li>

diff --git a/data/plugins/SoundReactivePlug.html b/data/plugins/SoundReactivePlug.html
@@ -57,9 +57,13 @@ <h2 class="mt-1">REST API</h2>
                 <h2 class="mt-2">Configuration</h2>
                 <h3 class="mt-1">Get configuration about how many frequency bands are shown.</h3>
                 <pre name="injectOrigin" class="text-light"><code>GET {{ORIGIN}}/rest/api/v1/display/uid/&lt;PLUGIN-UID&gt;/cfg</code></pre>
+                <pre name="injectOrigin" class="text-light"><code>GET {{ORIGIN}}/rest/api/v1/display/alias/&lt;PLUGIN-ALIAS&gt;/cfg</code></pre>
                 <h3 class="mt-1">Set configuration about how many frequency bands shall be shown.</h3>
                 <pre name="injectOrigin" class="text-light"><code>POST {{ORIGIN}}/rest/api/v1/display/uid/&lt;PLUGIN-UID&gt;/cfg?freqBandLen=&lt;FREQ-BAND-LEN&gt;</code></pre>
+                <pre name="injectOrigin" class="text-light"><code>POST {{ORIGIN}}/rest/api/v1/display/alias/&lt;PLUGIN-ALIAS&gt;/cfg?freqBandLen=&lt;FREQ-BAND-LEN&gt;</code></pre>
                 <ul>
+                    <li>PLUGIN-UID: The plugin unique id.</li>
+                    <li>PLUGIN-ALIAS: The plugin alias name.</li>
                     <li>FREQ-BAND-LEN: Number of frequency bands to show.
                         <ul>
                             <li>8: Show 8 frequency bands.</li>