Skip to content

Commit

Permalink
docs(*) docs updated for release 1.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
hishamhm committed Feb 13, 2020
1 parent 7e744b3 commit 0254a5e
Show file tree
Hide file tree
Showing 5 changed files with 52 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ <h2>Topics</h2>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-12-19 16:55:23 </i>
<i style="float:right;">Last updated 2020-02-13 13:06:44 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
37 changes: 36 additions & 1 deletion docs/modules/resty.healthcheck.html
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,10 @@ <h2><a href="#Health_management">Health management </a></h2>
<td class="summary">Report a timeout failure.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#checker:set_all_target_statuses_for_hostname">checker:set_all_target_statuses_for_hostname (hostname, port, is_healthy)</a></td>
<td class="summary">Sets the current status of all targets with the given hostname and port.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#checker:set_target_status">checker:set_target_status (ip, port, hostname, is_healthy)</a></td>
<td class="summary">Sets the current status of the target.</td>
</tr>
Expand Down Expand Up @@ -554,6 +558,37 @@ <h3>Returns:</h3>



</dd>
<dt>
<a name = "checker:set_all_target_statuses_for_hostname"></a>
<strong>checker:set_all_target_statuses_for_hostname (hostname, port, is_healthy)</strong>
</dt>
<dd>
Sets the current status of all targets with the given hostname and port.


<h3>Parameters:</h3>
<ul>
<li><span class="parameter">hostname</span>
hostname being checked.
</li>
<li><span class="parameter">port</span>
the port being checked against
</li>
<li><span class="parameter">is_healthy</span>
boolean: <code>true</code> for healthy, <code>false</code> for unhealthy
</li>
</ul>

<h3>Returns:</h3>
<ol>

<code>true</code> on success, or <code>nil + error</code> on failure.
</ol>




</dd>
<dt>
<a name = "checker:set_target_status"></a>
Expand Down Expand Up @@ -699,7 +734,7 @@ <h3>Returns:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-12-19 16:55:23 </i>
<i style="float:right;">Last updated 2020-02-13 13:06:44 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/resty.healthcheck.utils.html
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ <h3>Returns:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-12-19 16:55:23 </i>
<i style="float:right;">Last updated 2020-02-13 13:06:44 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
9 changes: 8 additions & 1 deletion docs/topics/readme.md.html
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,13 @@ <h2>History</h2>

<p>Versioning is strictly based on <a href="https://semver.org/">Semantic Versioning</a></p>

<h3>1.2.0 (13-Feb-2020)</h3>

<ul>
<li>Adds <code>set_all_target_statuses_for_hostname</code>, which sets the targets for
all entries with a given hostname at once.</li>
</ul>

<h3>1.1.2 (19-Dec-2019)</h3>

<ul>
Expand Down Expand Up @@ -273,7 +280,7 @@ <h2>Copyright and License</h2>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2019-12-19 16:55:23 </i>
<i style="float:right;">Last updated 2020-02-13 13:06:44 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
7 changes: 6 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,11 @@ for the complete API.

Versioning is strictly based on [Semantic Versioning](https://semver.org/)

### 1.2.0 (13-Feb-2020)

* Adds `set_all_target_statuses_for_hostname`, which sets the targets for
all entries with a given hostname at once.

### 1.1.2 (19-Dec-2019)

* Fix: when `ngx.sleep` API is not available (e.g. in the log phase) it is not
Expand All @@ -107,7 +112,7 @@ Versioning is strictly based on [Semantic Versioning](https://semver.org/)
* Add support for setting the custom `Host` header to be used for active checks.
* Fix: log error on SSL Handshake failure
[#28](https://github.com/Kong/lua-resty-healthcheck/pull/28);

### 1.0.0 (05-Jul-2019)

* BREAKING: all API functions related to hosts require a `hostname` argument
Expand Down

0 comments on commit 0254a5e

Please sign in to comment.