From f7611e58e21dd23c62a6180afacfdcb78b225a95 Mon Sep 17 00:00:00 2001
From: Stevan Freeborn <65925598+StevanFreeborn@users.noreply.github.com>
Date: Sun, 23 Apr 2023 17:46:56 -0500
Subject: [PATCH] docs: add list field section to version 1

---
 src/docs/version_001/docsStructure.ts         |  6 +++
 .../resources/fields/list_field/copy.md       | 44 +++++++++++++++++++
 .../resources/fields/list_field/example.md    | 41 +++++++++++++++++
 .../resources/fields/list_field/copy.md       |  2 +-
 4 files changed, 92 insertions(+), 1 deletion(-)

diff --git a/src/docs/version_001/docsStructure.ts b/src/docs/version_001/docsStructure.ts
index 547b99d..a915810 100644
--- a/src/docs/version_001/docsStructure.ts
+++ b/src/docs/version_001/docsStructure.ts
@@ -89,6 +89,12 @@ export const versionOne: DocsStructure = {
               copy: 'copy.md',
               example: 'example.md',
             },
+            {
+              title: 'List Field',
+              folder: 'list_field',
+              copy: 'copy.md',
+              example: 'example.md',
+            },
           ],
         },
       ],
diff --git a/src/docs/version_001/resources/fields/list_field/copy.md b/src/docs/version_001/resources/fields/list_field/copy.md
index e69de29..9b34315 100644
--- a/src/docs/version_001/resources/fields/list_field/copy.md
+++ b/src/docs/version_001/resources/fields/list_field/copy.md
@@ -0,0 +1,44 @@
+# List Field {% #list-field %}
+
+List fields are a special type of field that allow you to define a list of values that can be selected for the field. These fields have the following additional properties in addition to the standard [Field](#fields) properties.
+
+## List Field Properties
+
+{% table %}
+
+- Property Name
+- Data Type
+- Description
+
+---
+
+- Multiplicity
+- `number`
+- Indicates whether the field is single or multi select. Possible values are: `0` or `1`.
+
+---
+
+- Values
+- `object[]`
+- An array of [List Value](#list-values) objects that define the possible values of the list field.
+
+{% /table %}
+
+### Multiplicity Types
+
+{% table %}
+
+- Multiplicity Type Value
+- Multiplicity Type Description
+
+---
+
+- 0
+- Indicates the reference field is single select and will only ever hold one value.
+
+---
+
+- 1
+- Indicates the reference field is multi select and can contain more than one value.
+
+{% /table %}
diff --git a/src/docs/version_001/resources/fields/list_field/example.md b/src/docs/version_001/resources/fields/list_field/example.md
index e69de29..074c379 100644
--- a/src/docs/version_001/resources/fields/list_field/example.md
+++ b/src/docs/version_001/resources/fields/list_field/example.md
@@ -0,0 +1,41 @@
+# The List Field Object
+
+{% code heading="LIST FIELD" defaultLanguage="json" %}
+
+```json
+{
+  "Multiplicity": 0,
+  "Values": [
+    {
+      "Id": "2c1af5b1-0f90-4378-b9a5-8b7e22f2bc84",
+      "Name": "list_value_1",
+      "SortOrder": 1,
+      "NumericValue": 1.0,
+      "Color": "#008e8e"
+    },
+    {
+      "Id": "0421e502-7f76-480a-9311-363aca3560bc",
+      "Name": "list_value_2",
+      "SortOrder": 2,
+      "NumericValue": 2.0,
+      "Color": "#a186be"
+    },
+    {
+      "Id": "285b91c1-5800-47cb-a030-8cf7cdd7cdf1",
+      "Name": "updated_list_value_1676840661138}",
+      "SortOrder": 3,
+      "NumericValue": 1.0,
+      "Color": "#000000"
+    }
+  ],
+  "Id": 4801,
+  "AppId": 130,
+  "Name": "single_select_list_field",
+  "Type": 400,
+  "Status": 0,
+  "IsRequired": false,
+  "IsUnique": false
+}
+```
+
+{% /code %}
diff --git a/src/docs/version_002/resources/fields/list_field/copy.md b/src/docs/version_002/resources/fields/list_field/copy.md
index bd9ca8e..8b3837c 100644
--- a/src/docs/version_002/resources/fields/list_field/copy.md
+++ b/src/docs/version_002/resources/fields/list_field/copy.md
@@ -28,4 +28,4 @@ List fields are a special type of field that allow you to define a list of value
 - `object[]`
 - An array of [List Value](#list-values) objects that define the possible values of the list field.
 
--
+{% /table %}