From 0ba9107f21364fe3fd7247dad5d3080650763279 Mon Sep 17 00:00:00 2001
From: Stevan Freeborn <65925598+StevanFreeborn@users.noreply.github.com>
Date: Sat, 15 Apr 2023 22:37:36 -0500
Subject: [PATCH] docs: add connectivity section

---
 src/docs/version_002/docsStructure.ts         |  6 ++
 .../resources/connectivity/copy.md            |  3 +
 .../resources/connectivity/example.md         | 59 +++++++++++++++++++
 3 files changed, 68 insertions(+)
 create mode 100644 src/docs/version_002/resources/connectivity/copy.md
 create mode 100644 src/docs/version_002/resources/connectivity/example.md

diff --git a/src/docs/version_002/docsStructure.ts b/src/docs/version_002/docsStructure.ts
index a22750d..3510546 100644
--- a/src/docs/version_002/docsStructure.ts
+++ b/src/docs/version_002/docsStructure.ts
@@ -38,6 +38,12 @@ export const versionTwo: DocsStructure = {
       title: 'Resources',
       folder: 'resources',
       children: [
+        {
+          title: 'Connectivity',
+          folder: 'connectivity',
+          copy: 'copy.md',
+          example: 'example.md',
+        },
         {
           title: 'Records',
           folder: 'records',
diff --git a/src/docs/version_002/resources/connectivity/copy.md b/src/docs/version_002/resources/connectivity/copy.md
new file mode 100644
index 0000000..8d0d93c
--- /dev/null
+++ b/src/docs/version_002/resources/connectivity/copy.md
@@ -0,0 +1,3 @@
+# Connectivity {% #connectivity %}
+
+This endpoint allows you to verify that you are able to connect to the Onspring API. When successful, a `200` response will be returned with no body.
diff --git a/src/docs/version_002/resources/connectivity/example.md b/src/docs/version_002/resources/connectivity/example.md
new file mode 100644
index 0000000..dbac8bd
--- /dev/null
+++ b/src/docs/version_002/resources/connectivity/example.md
@@ -0,0 +1,59 @@
+# Checking for connection to the api
+
+{% code method="GET" heading="/Ping" defaultLanguage="bash" %}
+
+```bash
+curl --location 'https://api.onspring.com/Ping' \
+--header 'X-ApiKey: 000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000'
+```
+
+```csharp
+using Onspring.API.SDK;
+
+var onspringClient = new OnspringClient(
+  config.BaseUrl,
+  config.ApiKey
+);
+
+bool canConnect = await onspringClient.CanConnectAsync();
+
+if (canConnect == true)
+{
+  Console.WriteLine("Connected to Onspring API");
+}
+```
+
+```javascript
+import { OnspringClient } from 'onspring-api-sdk';
+
+const client = new OnspringClient(
+  process.env.BASE_URL,
+  process.env.API_KEY
+);
+
+const res = await client.canConnect();
+
+console.log(res);
+```
+
+```python
+from OnspringApiSdk.OnspringClient import OnspringClient
+from configparser import ConfigParser
+
+cfg = ConfigParser()
+cfg.read('config.ini')
+
+key = cfg['prod']['key']
+url = cfg['prod']['url']
+
+client = OnspringClient(url, key)
+
+canConnect = client.CanConnect()
+
+if canConnect:
+  print('Connected successfully')
+else:
+  print('Attempt to connect failed')
+```
+
+{% /code %}