New protocol buffer for topology data (#12)

## Description new protocol buffer for topology data ## Changes Made new protocol buffer for topology data ## Related Issues Fixes #10 ## Checklist - [x] I have used a PR title that is descriptive enough for a release note. - [x] I have tested these changes locally. - [x] I have added appropriate tests or updated existing tests. - [ ] I have tested these changes on a dedicated VM or a customer VM [name of the VM] - [x] I have added appropriate documentation or updated existing documentation. --------- Co-authored-by: Bot <[email protected]>
zaphiro-technologies · Nov 8, 2023 · a3998ef · a3998ef
1 parent 3543e23
commit a3998ef
Show file tree

Hide file tree

Showing 8 changed files with 1,457 additions and 19 deletions.
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -4,6 +4,7 @@
 
 ### Features
 
+- New protocol buffer for topology data (PR #12 by @chicco785)
 - Notification message: support Trigger requirements (PR #6 by @chicco785)
 - Add protocol buffer to describe faults (PR #3 by @chicco785)
 

diff --git a/docs/task.proto.md b/docs/task.proto.md
@@ -98,7 +98,14 @@ class Parameter {
 classDiagram
 direction LR
 
-%% A task message. Headers used in rabbitMQ: * `id`: id of the `Task` * `type`: always `Task` * `producerId`: the id of the producer (e.g. a PMU) linked to the notification. * `timestampId`: related measurement Unix msec timestamp (if any) * `taskType`: The textual representation of the task type.
+%% A task message.
+%% Headers used in rabbitMQ:
+%% * `id`: id of the `Task`
+%% * `type`: always `Task`
+%% * `producerId`: the id of the producer (e.g. a PMU) linked to the notification.
+%% * `timestampId`: related measurement Unix msec timestamp (if any)
+%% * `taskType`: The textual representation of the task type.
+%% 
 
 class Task {
   + int64 createdAt
@@ -115,7 +122,14 @@ Task --> `TaskType`
 classDiagram
 direction LR
 
-%% A notification message. Headers used in rabbitMQ: * `id`: id of the `Notification` * `type`: always `Notification` * `producerId`: the id of the producer (e.g. a PMU) linked to the notification. * `timestampId`: related measurement Unix msec timestamp (if any) * `notificationType`: The textual representation of the notification type.
+%% A notification message.
+%% Headers used in rabbitMQ:
+%% * `id`: id of the `Notification`
+%% * `type`: always `Notification`
+%% * `producerId`: the id of the producer (e.g. a PMU) linked to the notification.
+%% * `timestampId`: related measurement Unix msec timestamp (if any)
+%% * `notificationType`: The textual representation of the notification type.
+%% 
 
 class Notification {
   + int64 createdAt
@@ -142,7 +156,7 @@ Notification --> `Parameter`
 ## Message: Task
 <div style="font-size: 12px; margin-top: -10px;" class="fqn">FQN: platform.v1.Task</div>
 
-<div class="comment"><span>A task message. Headers used in rabbitMQ: * `id`: id of the `Task` * `type`: always `Task` * `producerId`: the id of the producer (e.g. a PMU) linked to the notification. * `timestampId`: related measurement Unix msec timestamp (if any) * `taskType`: The textual representation of the task type.</span><br/></div>
+<div class="comment"><span>A task message.</span><br/><span>Headers used in rabbitMQ:</span><br/><span>* `id`: id of the `Task`</span><br/><span>* `type`: always `Task`</span><br/><span>* `producerId`: the id of the producer (e.g. a PMU) linked to the notification.</span><br/><span>* `timestampId`: related measurement Unix msec timestamp (if any)</span><br/><span>* `taskType`: The textual representation of the task type.</span><br/><span></span><br/></div>
 
 | Field      | Ordinal | Type      | Label    | Description                               |
 |------------|---------|-----------|----------|-------------------------------------------|
@@ -154,7 +168,7 @@ Notification --> `Parameter`
 ## Message: Notification
 <div style="font-size: 12px; margin-top: -10px;" class="fqn">FQN: platform.v1.Notification</div>
 
-<div class="comment"><span>A notification message. Headers used in rabbitMQ: * `id`: id of the `Notification` * `type`: always `Notification` * `producerId`: the id of the producer (e.g. a PMU) linked to the notification. * `timestampId`: related measurement Unix msec timestamp (if any) * `notificationType`: The textual representation of the notification type.</span><br/></div>
+<div class="comment"><span>A notification message.</span><br/><span>Headers used in rabbitMQ:</span><br/><span>* `id`: id of the `Notification`</span><br/><span>* `type`: always `Notification`</span><br/><span>* `producerId`: the id of the producer (e.g. a PMU) linked to the notification.</span><br/><span>* `timestampId`: related measurement Unix msec timestamp (if any)</span><br/><span>* `notificationType`: The textual representation of the notification type.</span><br/><span></span><br/></div>
 
 | Field            | Ordinal | Type             | Label    | Description                                                                          |
 |------------------|---------|------------------|----------|--------------------------------------------------------------------------------------|

diff --git a/docs/topology.proto.md b/docs/topology.proto.md
@@ -0,0 +1,57 @@
+# Package: grid.v1
+
+<div class="comment"><span><!-- markdownlint-disable --></span><br/><span>Messages to support topology data exchange in the platform.</span><br/><span></span><br/></div>
+
+## Imports
+
+| Import | Description |
+|--------|-------------|
+
+
+
+## Options
+
+| Name       | Value     | Description |
+|------------|-----------|-------------|
+| go_package | ./grid/v1 |             |
+
+
+
+
+### Topology Diagram
+
+```mermaid
+classDiagram
+direction LR
+
+%% A topology computed information.
+%% Headers used in rabbitMQ:
+%% * `id`: id of the `Topology`
+%% * `type`: always `Topology`
+%% * `producerId`: the id of the producer (e.g. a PMU) linked to the dataset.
+%% * `timestampId`: related measurement Unix msec timestamp (if any)
+%% * `subnetworkId`: the sub network id for which the topology was computed
+%% 
+
+class Topology {
+  + uint64 createdAt
+  + bytes tp
+}
+
+```
+
+## Message: Topology
+<div style="font-size: 12px; margin-top: -10px;" class="fqn">FQN: grid.v1.Topology</div>
+
+<div class="comment"><span>A topology computed information.</span><br/><span>Headers used in rabbitMQ:</span><br/><span>* `id`: id of the `Topology`</span><br/><span>* `type`: always `Topology`</span><br/><span>* `producerId`: the id of the producer (e.g. a PMU) linked to the dataset.</span><br/><span>* `timestampId`: related measurement Unix msec timestamp (if any)</span><br/><span>* `subnetworkId`: the sub network id for which the topology was computed</span><br/><span></span><br/></div>
+
+| Field     | Ordinal | Type   | Label | Description                                                       |
+|-----------|---------|--------|-------|-------------------------------------------------------------------|
+| createdAt | 1       | uint64 |       | The time of creation of the topology data (Unix msec timestamp).  |
+| tp        | 2       | bytes  |       | The TP profile file serialized as bytes.                          |
+
+
+
+
+<!-- Created by: Proto Diagram Tool -->
+<!-- https://github.com/GoogleCloudPlatform/proto-gen-md-diagrams -->