From 54893a0f4b7eb64acca22f7c56e6c7a2a6997933 Mon Sep 17 00:00:00 2001
From: Arthur Hanson <worldnomad@gmail.com>
Date: Mon, 22 Jul 2024 15:04:21 +0700
Subject: [PATCH] 7025 documentation

---
 docs/models/circuits/circuitgroup.md          | 13 +++++++++++++
 .../models/circuits/circuitgroupassignment.md | 19 +++++++++++++++++++
 mkdocs.yml                                    |  2 ++
 3 files changed, 34 insertions(+)
 create mode 100644 docs/models/circuits/circuitgroup.md
 create mode 100644 docs/models/circuits/circuitgroupassignment.md

diff --git a/docs/models/circuits/circuitgroup.md b/docs/models/circuits/circuitgroup.md
new file mode 100644
index 000000000..6d1503509
--- /dev/null
+++ b/docs/models/circuits/circuitgroup.md
@@ -0,0 +1,13 @@
+# Circuit Groups
+
+[Circuits](./circuit.md) can be arranged into administrative groups for organization. The assignment of a circuit to a group is optional.
+
+## Fields
+
+### Name
+
+A unique human-friendly name.
+
+### Slug
+
+A unique URL-friendly identifier. (This value can be used for filtering.)
diff --git a/docs/models/circuits/circuitgroupassignment.md b/docs/models/circuits/circuitgroupassignment.md
new file mode 100644
index 000000000..70915a774
--- /dev/null
+++ b/docs/models/circuits/circuitgroupassignment.md
@@ -0,0 +1,19 @@
+# Circuit Group Assignments
+
+Circuits can be assigned to [Circuit groups](./circuitgroup.md) to indicate Fallback Circuits. For instance, three circuits, each belonging to a different provider, may each be assigned to the same Circuit group. Each of these assignments would typically receive a different priority.
+
+Circuits are assigned to Circuit groups under the Circuit Group detail view.
+
+## Fields
+
+### Group
+
+The [Circuit group](./circuitgroup.md) being assigned.
+
+### Circuit
+
+The [Circuit](./circuit.md) that is being assigned to the group.
+
+### Priority
+
+A value between 0 and 255 indicating the circuit's priority for being elected as the master/primary node in the group.
diff --git a/mkdocs.yml b/mkdocs.yml
index f5819d0ea..db2763e8b 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -163,6 +163,8 @@ nav:
     - Data Model:
         - Circuits:
             - Circuit: 'models/circuits/circuit.md'
+            - CircuitGroup: 'models/circuits/circuitgroup.md'
+            - CircuitGroupAssignment: 'models/circuits/circuitgroupassignment.md'
             - Circuit Termination: 'models/circuits/circuittermination.md'
             - Circuit Type: 'models/circuits/circuittype.md'
             - Provider: 'models/circuits/provider.md'