Skip to content

Commit 5dca0e5

Browse files
committed
Update docs
1 parent 6b48b04 commit 5dca0e5

File tree

5 files changed

+50
-38
lines changed

5 files changed

+50
-38
lines changed

doc/change-log.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ __Fixes__
1313
## 2.0.0-beta9
1414

1515
__Fixes__
16-
* Return BadRequest in TriggerControllerBase instead of simply calling it
16+
* Return BadRequest in TriggerControllerBase instead of simply calling it.
1717

1818
## 2.0.0-beta8
1919

@@ -26,10 +26,10 @@ __Chores__
2626
* DRYout Web API and Repository Layer.
2727
* DRYout IntegrationEngine.Client.
2828
* Refactor ConsoleClient internals.
29-
* Use generics for repo item id.
29+
* Use generic type argument for repo item Id parameters.
3030

3131
__Fixes__
32-
* TCPClient issues with mail server health check.
32+
* Resolve TCPClient issues with mail server health check.
3333

3434
## 2.0.0-beta7
3535

doc/console-client.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@ currentMenu: console-client
55

66
# Console Client
77

8-
The console client is a Windows program that allows CLI access to the __Web API__.
8+
The console client is a Windows program that allows CLI access to the [Web API](web-api/cron-trigger.html).
99
It uses the [InEngine.NET Client](client-library.html) library to accomplish.

doc/couscous.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,6 @@ webApiMenu:
6464
simple-trigger:
6565
text: SimpleTrigger
6666
relativeUrl: web-api/simple-trigger.html
67-
time-zone:
68-
text: TimeZone
69-
relativeUrl: web-api/time-zone.html
67+
log-event:
68+
text: LogEvent
69+
relativeUrl: web-api/log-event.html

doc/web-api/log-event.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
layout: web-api
3+
currentMenu: web-api
4+
currentSubMenu: log-event
5+
---
6+
7+
## LogEvent Endpoint
8+
9+
The LogEvent endpoint allows for the retrieval of log events.
10+
11+
### Parameters
12+
13+
<div class="table-responsive">
14+
<table class="table table-bordered">
15+
<thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead>
16+
<tbody>
17+
<tr>
18+
<td>Id</td>
19+
<td><span class="label label-info">string</span></td></td>
20+
<td>A unique, auto-generated identifier for the log event.</td>
21+
</tr>
22+
<tr>
23+
<td>StartTimeUtc</td><td><a href="http://msdn.microsoft.com/en-us/library/system.datetimeoffset%28v=vs.110%29.aspx">System.DateTimeOffset</a></td>
24+
<td>The time at which the log event was created.</td>
25+
</tr>
26+
<tr>
27+
<td>Level</td>
28+
<td><span class="label label-info">string</span></td></td>
29+
<td>The <a href="http://en.wikipedia.org/wiki/Log4j#Log4j_1_Log_level">level</a> of the log event.</td>
30+
</tr>
31+
<tr>
32+
<td>Message</td>
33+
<td><span class="label label-info">string</span></td></td>
34+
<td>The textual message body of the log event.</td>
35+
</tr>
36+
</tbody>
37+
</table>
38+
</div>
39+
### Get a List of TimeZones
40+
GET api/LogEvent
41+
```sh
42+
curl http://localhost:9001/api/LogEvent
43+
```

doc/web-api/time-zone.md

Lines changed: 0 additions & 31 deletions
This file was deleted.

0 commit comments

Comments
 (0)