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

---
 src/docs/version_001/docsStructure.ts         |  6 +++
 .../reports/get_reports_by_app/copy.md        | 19 ++++++++++
 .../reports/get_reports_by_app/example.md     | 38 +++++++++++++++++++
 3 files changed, 63 insertions(+)
 create mode 100644 src/docs/version_001/resources/reports/get_reports_by_app/copy.md
 create mode 100644 src/docs/version_001/resources/reports/get_reports_by_app/example.md

diff --git a/src/docs/version_001/docsStructure.ts b/src/docs/version_001/docsStructure.ts
index 6b8539e..e34eb00 100644
--- a/src/docs/version_001/docsStructure.ts
+++ b/src/docs/version_001/docsStructure.ts
@@ -76,6 +76,12 @@ export const versionOne: DocsStructure = {
               copy: 'copy.md',
               example: 'example.md',
             },
+            {
+              title: 'Get Reports by App',
+              folder: 'get_reports_by_app',
+              copy: 'copy.md',
+              example: 'example.md',
+            },
           ],
         },
         {
diff --git a/src/docs/version_001/resources/reports/get_reports_by_app/copy.md b/src/docs/version_001/resources/reports/get_reports_by_app/copy.md
new file mode 100644
index 0000000..a8d7e3f
--- /dev/null
+++ b/src/docs/version_001/resources/reports/get_reports_by_app/copy.md
@@ -0,0 +1,19 @@
+# Get Reports by App {% #get-reports-by-app %}
+
+This endpoint returns an array of [reports](#reports) for the given app.
+
+## Query Parameters
+
+{% table %}
+
+- Parameter Name
+- Data Type
+- Description
+
+---
+
+- appId
+- `number`
+- The id of the app to retrieve reports for.
+
+{% /table %}
diff --git a/src/docs/version_001/resources/reports/get_reports_by_app/example.md b/src/docs/version_001/resources/reports/get_reports_by_app/example.md
new file mode 100644
index 0000000..1be3c70
--- /dev/null
+++ b/src/docs/version_001/resources/reports/get_reports_by_app/example.md
@@ -0,0 +1,38 @@
+# Retrieving reports for the given app
+
+{% code method="GET" heading="/Reports" defaultLanguage="bash" %}
+
+```bash
+curl --location 'https://api.onspring.com/v1/Reports?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 report in httpHelper.GetAppReports(5))
+{
+  Console.WriteLine($"{report.Id}, {report.AppId}, {report.Name}");
+}
+```
+
+{% /code %}
+
+{% code heading="RESPONSE" defaultLanguage="json" %}
+
+```json
+[
+  {
+    "AppId": 195,
+    "Id": 613,
+    "Name": "Test 1"
+  }
+]
+```
+
+{% /code %}