From 07b7aff742aa8ab5ebb63b436156f4e2023a29d1 Mon Sep 17 00:00:00 2001 From: Stevan Freeborn <65925598+StevanFreeborn@users.noreply.github.com> Date: Mon, 17 Apr 2023 23:00:51 -0500 Subject: [PATCH] docs: add list values resource section --- src/docs/version_002/docsStructure.ts | 28 +++++++++++++------ .../resources/fields/formula_field/copy.md | 2 +- .../resources/fields/list_field/copy.md | 2 +- .../list_value => list_values}/copy.md | 2 +- .../delete_list_value_by_id/copy.md | 3 ++ .../delete_list_value_by_id/example.md | 10 +++++++ .../list_value => list_values}/example.md | 0 .../list_values/save_list_value/copy.md | 21 ++++++++++++++ .../list_values/save_list_value/example.md | 28 +++++++++++++++++++ 9 files changed, 85 insertions(+), 11 deletions(-) rename src/docs/version_002/resources/{fields/list_field/list_value => list_values}/copy.md (94%) create mode 100644 src/docs/version_002/resources/list_values/delete_list_value_by_id/copy.md create mode 100644 src/docs/version_002/resources/list_values/delete_list_value_by_id/example.md rename src/docs/version_002/resources/{fields/list_field/list_value => list_values}/example.md (100%) create mode 100644 src/docs/version_002/resources/list_values/save_list_value/copy.md create mode 100644 src/docs/version_002/resources/list_values/save_list_value/example.md diff --git a/src/docs/version_002/docsStructure.ts b/src/docs/version_002/docsStructure.ts index 7b5385f..f048aff 100644 --- a/src/docs/version_002/docsStructure.ts +++ b/src/docs/version_002/docsStructure.ts @@ -127,14 +127,6 @@ export const versionTwo: DocsStructure = { folder: 'list_field', copy: 'copy.md', example: 'example.md', - children: [ - { - title: 'List Value', - folder: 'list_value', - copy: 'copy.md', - example: 'example.md', - }, - ], }, { title: 'Get Fields by App', @@ -156,6 +148,26 @@ export const versionTwo: DocsStructure = { }, ], }, + { + title: 'List Values', + folder: 'list_values', + copy: 'copy.md', + example: 'example.md', + children: [ + { + title: 'Save List Value', + folder: 'save_list_value', + copy: 'copy.md', + example: 'example.md', + }, + { + title: 'Delete List Value by Id', + folder: 'delete_list_value_by_id', + copy: 'copy.md', + example: 'example.md', + }, + ], + }, { title: 'Records', folder: 'records', diff --git a/src/docs/version_002/resources/fields/formula_field/copy.md b/src/docs/version_002/resources/fields/formula_field/copy.md index 1526ec1..337fca9 100644 --- a/src/docs/version_002/resources/fields/formula_field/copy.md +++ b/src/docs/version_002/resources/fields/formula_field/copy.md @@ -20,6 +20,6 @@ Formula fields are a special type of field that can be used to calculate values - values - `object[]` -- An array of [List Value](#list-value) objects that define the possible values of the formula field. This array will only be populated with values if the `outputType` is set to `ListValue`. +- An array of [List Value](#list-values) objects that define the possible values of the formula field. This array will only be populated with values if the `outputType` is set to `ListValue`. {% /table %} 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 9f5ed4f..bd9ca8e 100644 --- a/src/docs/version_002/resources/fields/list_field/copy.md +++ b/src/docs/version_002/resources/fields/list_field/copy.md @@ -26,6 +26,6 @@ List fields are a special type of field that allow you to define a list of value - values - `object[]` -- An array of [List Value](#list-value) objects that define the possible values of the list field. +- An array of [List Value](#list-values) objects that define the possible values of the list field. - diff --git a/src/docs/version_002/resources/fields/list_field/list_value/copy.md b/src/docs/version_002/resources/list_values/copy.md similarity index 94% rename from src/docs/version_002/resources/fields/list_field/list_value/copy.md rename to src/docs/version_002/resources/list_values/copy.md index ba90d30..bc5977e 100644 --- a/src/docs/version_002/resources/fields/list_field/list_value/copy.md +++ b/src/docs/version_002/resources/list_values/copy.md @@ -1,4 +1,4 @@ -# List Value {% #list-value %} +# 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 `ListValue` output type. diff --git a/src/docs/version_002/resources/list_values/delete_list_value_by_id/copy.md b/src/docs/version_002/resources/list_values/delete_list_value_by_id/copy.md new file mode 100644 index 0000000..09fd332 --- /dev/null +++ b/src/docs/version_002/resources/list_values/delete_list_value_by_id/copy.md @@ -0,0 +1,3 @@ +# Delete List Value by Id {% #delete-list-value-by-id %} + +This endpoint deletes a list value. When request is successful a `204` status code will be returned with no response body. diff --git a/src/docs/version_002/resources/list_values/delete_list_value_by_id/example.md b/src/docs/version_002/resources/list_values/delete_list_value_by_id/example.md new file mode 100644 index 0000000..e45bc03 --- /dev/null +++ b/src/docs/version_002/resources/list_values/delete_list_value_by_id/example.md @@ -0,0 +1,10 @@ +# Delete a list value + +{% code method="DELETE" heading="/Lists/id/{listId}/itemId/{itemId}" defaultLanguage="bash" %} + +```bash +curl --location --request DELETE 'https://api.onspring.com/Lists/id/906/itemId/e3371dbf-b557-4a31-b32f-33c0265d2a59' \ +--header 'X-ApiKey: 000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000' +``` + +{% /code %} diff --git a/src/docs/version_002/resources/fields/list_field/list_value/example.md b/src/docs/version_002/resources/list_values/example.md similarity index 100% rename from src/docs/version_002/resources/fields/list_field/list_value/example.md rename to src/docs/version_002/resources/list_values/example.md 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 new file mode 100644 index 0000000..331c424 --- /dev/null +++ b/src/docs/version_002/resources/list_values/save_list_value/copy.md @@ -0,0 +1,21 @@ +# Save List Value {% #save-list-value %} + +This endpoint adds or updates a list value. If a list value id is provided, the list value will be updated. If no list value id is provided, a new list value will be created. When request is successful a `200` status code will be returned if updating a list value or a `201` status code will be returned if creating a new list value. + +## Path Parameters + +{% table %} + +{% /table %} + +## Request Body Properties + +{% table %} + +{% /table %} + +## Response Body Properties + +{% table %} + +{% /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 new file mode 100644 index 0000000..8514bb8 --- /dev/null +++ b/src/docs/version_002/resources/list_values/save_list_value/example.md @@ -0,0 +1,28 @@ +# Add a list value + +{% code method="PUT" heading="/Lists/id/{listId}/items" defaultLanguage="bash" %} + +```bash +curl --location --request PUT 'https://api.onspring.com/Lists/id/906/items' \ +--header 'X-ApiKey: 000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000' \ +--header 'Content-Type: application/json' \ +--data '{ + "id": null, + "name": "Not Started", + "numericValue": 0, + "color": "#ffffff", + "weight": 0 +}' +``` + +{% /code %} + +{% code heading="RESPONSE" defaultLanguage="json" %} + +```json +{ + "id": "4118d53a-9121-4345-8682-07f23d606daa" +} +``` + +{% /code %}