8152045e38
Move UML/ directory and Architecture.md from Docs/ to docs/. Rename Architecture.md to UML_ARCHITECTURE.md to avoid collision with existing docs/ARCHITECTURE.md (docs organization file). Update all references in README.md, CONTRIBUTING.md, CLAUDE.md, and the architecture file itself. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
480 lines
8.6 KiB
HTML
480 lines
8.6 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<title>Notifier</title>
|
|
<link href='http://fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,700,300italic,400italic,700italic|Source+Code+Pro:300,400,700' rel='stylesheet' type='text/css'>
|
|
<link rel="stylesheet" href="../assets/css/bootstrap.css">
|
|
<link rel="stylesheet" href="../assets/css/jquery.bonsai.css">
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
<link rel="stylesheet" href="../assets/icon-font/icons.css">
|
|
<script type="text/javascript" src="../assets/js/jquery-2.1.0.min.js"></script>
|
|
<script type="text/javascript" src="../assets/js/bootstrap.js"></script>
|
|
<script type="text/javascript" src="../assets/js/jquery.bonsai.js"></script>
|
|
<script type="text/javascript" src="../assets/js/imageMapResizer.min.js"></script>
|
|
|
|
</head>
|
|
<body>
|
|
<div>
|
|
|
|
<!-- Name Title -->
|
|
|
|
<h1>Notifier</h1>
|
|
|
|
<!-- Type and Stereotype -->
|
|
|
|
<section style="margin-top: .5em;">
|
|
<span class="alert alert-info">
|
|
<span class="node-icon staruml-icon icon-UMLClass"></span>
|
|
UMLClass
|
|
</span>
|
|
|
|
</section>
|
|
|
|
<!-- Path -->
|
|
|
|
<section style="margin-top: 10px">
|
|
|
|
|
|
|
|
|
|
<span class="label label-info"><a href='cf9c8b720f3815adeccaf3ef6e48c6c4.html'><span class='node-icon staruml-icon icon-Project'></span>Skill Seekers</a></span>
|
|
|
|
<span>::</span>
|
|
<span class="label label-info"><a href='6a4361334e8b649314ed681b9e6798c3.html'><span class='node-icon staruml-icon icon-UMLModel'></span>skill_seekers</a></span>
|
|
|
|
<span>::</span>
|
|
<span class="label label-info"><a href='8d93060f6d7a7c6803e67fc2ec0f4522.html'><span class='node-icon staruml-icon icon-UMLPackage'></span>Sync</a></span>
|
|
|
|
<span>::</span>
|
|
<span class="label label-info"><a href='3127b5e8b9afcd79148641d02039a191.html'><span class='node-icon staruml-icon icon-UMLClass'></span>Notifier</a></span>
|
|
|
|
</section>
|
|
|
|
<!-- Diagram -->
|
|
|
|
|
|
|
|
<!-- Description -->
|
|
|
|
|
|
<section>
|
|
<h3>Description</h3>
|
|
<div>
|
|
|
|
<p>Sends notifications about sync events. Supports: Webhook (HTTP POST), Slack (via webhook), Email (SMTP - TODO), Console (stdout).</p>
|
|
|
|
</div>
|
|
</section>
|
|
|
|
|
|
<!-- Specification -->
|
|
|
|
|
|
|
|
<!-- Directed Relationship -->
|
|
|
|
|
|
|
|
<!-- Undirected Relationship -->
|
|
|
|
|
|
|
|
<!-- Classifier -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- Interface -->
|
|
|
|
|
|
|
|
<!-- Component -->
|
|
|
|
|
|
|
|
<!-- Node -->
|
|
|
|
|
|
|
|
<!-- Actor -->
|
|
|
|
|
|
|
|
<!-- Use Case -->
|
|
|
|
|
|
|
|
<!-- Template Parameters -->
|
|
|
|
|
|
|
|
<!-- Literals -->
|
|
|
|
|
|
|
|
<!-- Attributes -->
|
|
|
|
|
|
<section>
|
|
<h3>Attributes</h3>
|
|
<table class="table table-striped table-bordered">
|
|
<tr>
|
|
<th>Visibility</th>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>public</td>
|
|
<td><a href="978c1ca118f58de306058615dc949190.html">webhook_url</a></td>
|
|
<td>str | None </td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>public</td>
|
|
<td><a href="d0a69d1dc59a0db4ec018956c9559c42.html">slack_webhook</a></td>
|
|
<td>str | None </td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>public</td>
|
|
<td><a href="07dacffc54f86475400204d093091588.html">email_recipients</a></td>
|
|
<td>list[str] </td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>public</td>
|
|
<td><a href="64299856471ab520366cf7d225abf189.html">console</a></td>
|
|
<td>bool </td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</section>
|
|
|
|
|
|
<!-- Operations -->
|
|
|
|
|
|
<section>
|
|
<h3>Operations</h3>
|
|
<table class="table table-striped table-bordered">
|
|
<tr>
|
|
<th>Visibility</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>public</td>
|
|
<td><a href="59d253aad5f03a2f7a5b11c6552d2d2c.html">notify()</a></td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>public</td>
|
|
<td><a href="3a83252ee8ba5d75a9ab198e9ccca190.html">send(payload: WebhookPayload)()</a></td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>private</td>
|
|
<td><a href="55a7b61dc2eba15c3f98ed730658067d.html">_send_console(payload: WebhookPayload)()</a></td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>private</td>
|
|
<td><a href="e1c985d472242469a922d7c392aa3d83.html">_send_webhook(payload: WebhookPayload)()</a></td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>private</td>
|
|
<td><a href="e7d6066343819ac598675113b7c4bf5c.html">_send_slack(payload: WebhookPayload)()</a></td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>private</td>
|
|
<td><a href="ef8f3e0c6a50fd5473f6db4d4f63b54a.html">_send_email(payload: WebhookPayload)()</a></td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</section>
|
|
|
|
|
|
<!-- Receptions -->
|
|
|
|
|
|
|
|
<!-- Extension Points -->
|
|
|
|
|
|
|
|
<!-- Parameters -->
|
|
|
|
|
|
|
|
<!-- Diagrams -->
|
|
|
|
|
|
|
|
|
|
<!-- Behavior -->
|
|
|
|
|
|
|
|
<!-- Action -->
|
|
|
|
|
|
|
|
<!-- Interaction -->
|
|
|
|
|
|
|
|
<!-- CombinedFragment -->
|
|
|
|
|
|
|
|
<!-- Activity -->
|
|
|
|
|
|
|
|
<!-- State Machine -->
|
|
|
|
|
|
|
|
<!-- State Machine -->
|
|
|
|
|
|
|
|
<!-- State -->
|
|
|
|
|
|
|
|
<!-- Vertex -->
|
|
|
|
|
|
|
|
<!-- Transition -->
|
|
|
|
|
|
|
|
<!-- Data Model (ERD) -->
|
|
|
|
|
|
|
|
<!-- Columns (ERD) -->
|
|
|
|
|
|
|
|
<!-- Related Entities (ERD) -->
|
|
|
|
|
|
|
|
<!-- Data Flows (DFD) -->
|
|
|
|
|
|
|
|
<!-- Flows (Flowchart) -->
|
|
|
|
|
|
|
|
<!-- Properties -->
|
|
|
|
<section>
|
|
<h3>Properties</h3>
|
|
|
|
<table class="table table-striped table-bordered">
|
|
<tr>
|
|
<th width="50%">Name</th>
|
|
<th width="50%">Value</th>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
<td>name</td>
|
|
<td>Notifier</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
<td>stereotype</td>
|
|
<td><span class='label label-info'>null</span></td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
<td>visibility</td>
|
|
<td>public</td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
<td>isAbstract</td>
|
|
<td><span class='label label-info'>false</span></td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
<td>isFinalSpecialization</td>
|
|
<td><span class='label label-info'>false</span></td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
<td>isLeaf</td>
|
|
<td><span class='label label-info'>false</span></td>
|
|
</tr>
|
|
|
|
|
|
|
|
|
|
|
|
<tr>
|
|
<td>isActive</td>
|
|
<td><span class='label label-info'>false</span></td>
|
|
</tr>
|
|
|
|
|
|
|
|
</table>
|
|
|
|
</section>
|
|
|
|
<!-- Tags -->
|
|
|
|
|
|
|
|
<!-- Constraints, Dependencies, Dependants -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section class="element-list">
|
|
<h3>Dependants</h3>
|
|
<ul class="nav nav-list">
|
|
|
|
<li><a href='b981ba669c0e879541c2cf16c5fc41b1.html'><span class='node-icon staruml-icon icon-UMLClass'></span>SyncMonitor</a></li>
|
|
|
|
</ul>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
<!-- Relationships -->
|
|
|
|
|
|
|
|
<section class="element-list">
|
|
<h3>Relationships</h3>
|
|
<ul class="nav nav-list">
|
|
|
|
<li><a href='eb4115159c79a0701a3de3dec0f6e6b1.html'><span class='node-icon staruml-icon icon-UMLDependency'></span>(SyncMonitor→Notifier)</a></li>
|
|
|
|
</ul>
|
|
</section>
|
|
|
|
|
|
|
|
<!-- Owned Elements -->
|
|
|
|
|
|
|
|
|
|
|
|
<!-- Diagrams -->
|
|
|
|
|
|
|
|
<section class="element-list">
|
|
<h3>Diagrams</h3>
|
|
<ul class="nav nav-list">
|
|
|
|
<li><a href='9c77d89de8418c23e57114f6d0c155a3.html'><span class='node-icon staruml-icon icon-UMLClassDiagram'></span>Sync</a></li>
|
|
|
|
</ul>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
<!-- Image Map Resizer (https://github.com/davidjbradshaw/image-map-resizer) -->
|
|
<script>
|
|
imageMapResize();
|
|
</script>
|
|
</div>
|
|
</body>
|
|
</html>
|