From ef67963c62156ec8d6fc940be0349d4aa23b46b7 Mon Sep 17 00:00:00 2001 From: Stevan Freeborn <65925598+StevanFreeborn@users.noreply.github.com> Date: Tue, 18 Apr 2023 20:47:29 -0500 Subject: [PATCH] docs: add property tables to save list value --- .../list_values/save_list_value/copy.md | 48 +++++++++++++++++++ .../list_values/save_list_value/example.md | 1 - 2 files changed, 48 insertions(+), 1 deletion(-) diff --git a/src/docs/version_002/resources/list_values/save_list_value/copy.md b/src/docs/version_002/resources/list_values/save_list_value/copy.md index 331c424..fd33798 100644 --- a/src/docs/version_002/resources/list_values/save_list_value/copy.md +++ b/src/docs/version_002/resources/list_values/save_list_value/copy.md @@ -6,16 +6,64 @@ This endpoint adds or updates a list value. If a list value id is provided, the {% table %} +- Property Name +- Data Type +- Description + +--- + +- `listId` +- `number` +- The id of the list to which the list value belongs. + {% /table %} ## Request Body Properties {% table %} +- Property Name +- Data Type +- Description + +--- + +- id +- `number` +- The id of the list value to update. If no id is provided, a new list value will be created. + +--- + +- name +- `string` +- The name of the list value. + +--- + +- numericValue +- `number` +- The numeric value of the list value. + +--- + +- color +- `string` +- The color of the list value. + {% /table %} ## Response Body Properties {% table %} +- Property Name +- Data Type +- Description + +--- + +- id +- `string` +- The id of the list value. + {% /table %} diff --git a/src/docs/version_002/resources/list_values/save_list_value/example.md b/src/docs/version_002/resources/list_values/save_list_value/example.md index 8514bb8..b2d5a59 100644 --- a/src/docs/version_002/resources/list_values/save_list_value/example.md +++ b/src/docs/version_002/resources/list_values/save_list_value/example.md @@ -11,7 +11,6 @@ curl --location --request PUT 'https://api.onspring.com/Lists/id/906/items' \ "name": "Not Started", "numericValue": 0, "color": "#ffffff", - "weight": 0 }' ```