From fad39f4ce538b18f14db0ba2dbb76c614181b512 Mon Sep 17 00:00:00 2001
From: Stevan Freeborn <65925598+StevanFreeborn@users.noreply.github.com>
Date: Mon, 24 Apr 2023 06:24:08 -0500
Subject: [PATCH] docs: add get fields by app section. add get apps section.

---
 src/docs/version_001/docsStructure.ts         | 15 +++++++-
 .../resources/apps/get_apps/copy.md           |  3 ++
 .../resources/apps/get_apps/example.md        | 37 +++++++++++++++++++
 .../fields/get_fields_by_app/copy.md          | 19 ++++++++++
 .../fields/get_fields_by_app/example.md       | 22 +++++++++++
 5 files changed, 95 insertions(+), 1 deletion(-)
 create mode 100644 src/docs/version_001/resources/apps/get_apps/copy.md
 create mode 100644 src/docs/version_001/resources/apps/get_apps/example.md
 create mode 100644 src/docs/version_001/resources/fields/get_fields_by_app/copy.md
 create mode 100644 src/docs/version_001/resources/fields/get_fields_by_app/example.md

diff --git a/src/docs/version_001/docsStructure.ts b/src/docs/version_001/docsStructure.ts
index cfabff4..076da65 100644
--- a/src/docs/version_001/docsStructure.ts
+++ b/src/docs/version_001/docsStructure.ts
@@ -55,7 +55,14 @@ export const versionOne: DocsStructure = {
           folder: 'apps',
           copy: 'copy.md',
           example: 'example.md',
-          children: [],
+          children: [
+            {
+              title: 'Get Apps',
+              folder: 'get_apps',
+              copy: 'copy.md',
+              example: 'example.md',
+            },
+          ],
         },
         {
           title: 'Reports',
@@ -101,6 +108,12 @@ export const versionOne: DocsStructure = {
               copy: 'copy.md',
               example: 'example.md',
             },
+            {
+              title: 'Get Fields by App',
+              folder: 'get_fields_by_app',
+              copy: 'copy.md',
+              example: 'example.md',
+            },
           ],
         },
         {
diff --git a/src/docs/version_001/resources/apps/get_apps/copy.md b/src/docs/version_001/resources/apps/get_apps/copy.md
new file mode 100644
index 0000000..4ca24d3
--- /dev/null
+++ b/src/docs/version_001/resources/apps/get_apps/copy.md
@@ -0,0 +1,3 @@
+# Get Apps {% #get-apps %}
+
+This endpoint returns an array of [apps](#apps) that the given API key can access.
diff --git a/src/docs/version_001/resources/apps/get_apps/example.md b/src/docs/version_001/resources/apps/get_apps/example.md
new file mode 100644
index 0000000..23d4682
--- /dev/null
+++ b/src/docs/version_001/resources/apps/get_apps/example.md
@@ -0,0 +1,37 @@
+# Retrieve apps accessible to the API key
+
+{% code method="GET" heading="/Apps" defaultLanguage="bash" %}
+
+```bash
+curl --location 'https://api.onspring.com/v1/Apps' \
+--header 'X-ApiKey: 000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000'
+```
+
+```csharp
+using Onspring.API.SDK.Helpers;
+
+var httpHelper = new HttpHelper(
+  config.baseUrl,
+  config.apiKey
+);
+
+foreach (var app in httpHelper.GetApps())
+{
+  Console.WriteLine($"{app.Id}, {app.Name}");
+}
+```
+
+{% /code %}
+
+{% code heading="RESPONSE" defaultLanguage="json" %}
+
+```json
+[
+  {
+    "Id": 195,
+    "Name": "Tasks"
+  }
+]
+```
+
+{% /code %}
diff --git a/src/docs/version_001/resources/fields/get_fields_by_app/copy.md b/src/docs/version_001/resources/fields/get_fields_by_app/copy.md
new file mode 100644
index 0000000..93bfc12
--- /dev/null
+++ b/src/docs/version_001/resources/fields/get_fields_by_app/copy.md
@@ -0,0 +1,19 @@
+# Get Fields by App {% #get-fields-by-app %}
+
+This endpoint returns an array of [Fields](#fields) for the given app.
+
+## Query Parameters
+
+{% table %}
+
+- Parameter Name
+- Data Type
+- Description
+
+---
+
+- appId
+- `number`
+- The id of the app to retrieve fields for.
+
+{% /table %}
diff --git a/src/docs/version_001/resources/fields/get_fields_by_app/example.md b/src/docs/version_001/resources/fields/get_fields_by_app/example.md
new file mode 100644
index 0000000..a9dd0bb
--- /dev/null
+++ b/src/docs/version_001/resources/fields/get_fields_by_app/example.md
@@ -0,0 +1,22 @@
+# Retrieve all fields for an app
+
+{% code method="GET" heading="/Fields" defaultLanguage="bash" %}
+
+```bash
+curl --location 'https://api.onspring.com/v1/Fields?appId=195' \
+--header 'X-ApiKey: 000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000'
+```
+
+```csharp
+using Onspring.API.SDK.Helpers;
+
+var httpHelper = new HttpHelper(
+  config.baseUrl,
+  config.apiKey
+);
+
+foreach (var field in httpHelper.GetAppFields(195))
+{
+  Console.WriteLine($"{field.Id}, {field.Name}");
+}
+```