From f0fd67d61ebbe616dad32efe7ed6d67a394b6305 Mon Sep 17 00:00:00 2001 From: Stevan Freeborn <65925598+StevanFreeborn@users.noreply.github.com> Date: Sun, 23 Apr 2023 17:50:23 -0500 Subject: [PATCH] docs: add list value section to value 1 --- src/docs/version_001/docsStructure.ts | 6 +++ .../resources/fields/list_values/copy.md | 43 +++++++++++++++++++ .../resources/fields/list_values/example.md | 15 +++++++ 3 files changed, 64 insertions(+) create mode 100644 src/docs/version_001/resources/fields/list_values/copy.md create mode 100644 src/docs/version_001/resources/fields/list_values/example.md diff --git a/src/docs/version_001/docsStructure.ts b/src/docs/version_001/docsStructure.ts index a915810..ff87354 100644 --- a/src/docs/version_001/docsStructure.ts +++ b/src/docs/version_001/docsStructure.ts @@ -95,6 +95,12 @@ export const versionOne: DocsStructure = { copy: 'copy.md', example: 'example.md', }, + { + title: 'List Values', + folder: 'list_values', + copy: 'copy.md', + example: 'example.md', + }, ], }, ], diff --git a/src/docs/version_001/resources/fields/list_values/copy.md b/src/docs/version_001/resources/fields/list_values/copy.md new file mode 100644 index 0000000..c5aa50f --- /dev/null +++ b/src/docs/version_001/resources/fields/list_values/copy.md @@ -0,0 +1,43 @@ +# List Values {% #list-values %} + +These are objects that represent the defined values of a [List Field](#list-field) or a [Formula Field](#formula-field) with a `List Value` output type. + +## List Value Properties + +{% table %} + +- Property Name +- Data Type +- Description + +--- + +- Id +- `string` +- The unique id of the list value. + +--- + +- Name +- `string` +- The name of the list value. + +--- + +- SortOrder +- `number` +- The sort order of the list value. + +--- + +- NumericValue +- `number` +- The numeric value of the list value. + +--- + +- Color +- `string` +- The color of the list value. + +{% /table %} diff --git a/src/docs/version_001/resources/fields/list_values/example.md b/src/docs/version_001/resources/fields/list_values/example.md new file mode 100644 index 0000000..bbfe113 --- /dev/null +++ b/src/docs/version_001/resources/fields/list_values/example.md @@ -0,0 +1,15 @@ +# The List Value Object + +{% code heading="LIST VALUE" defaultLanguage="json" %} + +```json +{ + "Id": "b235afb2-b786-4c87-bce9-fbd700e246c1", + "Name": "list_value_1", + "SortOrder": 1, + "NumericValue": 1, + "Color": "#6dcff6" +} +``` + +{% /code %}