From 0f4a532c33a7c3af5b0bb13de09a008d2d75ee47 Mon Sep 17 00:00:00 2001 From: Stevan Freeborn <65925598+StevanFreeborn@users.noreply.github.com> Date: Sat, 22 Apr 2023 19:23:16 -0500 Subject: [PATCH] docs: add connectivity section to version 1 --- src/docs/version_001/docsStructure.ts | 12 +++++++++ src/docs/version_001/resources/apps/copy.md | 0 .../version_001/resources/apps/example.md | 0 .../resources/connectivity/copy.md | 3 +++ .../resources/connectivity/example.md | 25 +++++++++++++++++++ 5 files changed, 40 insertions(+) create mode 100644 src/docs/version_001/resources/apps/copy.md create mode 100644 src/docs/version_001/resources/apps/example.md create mode 100644 src/docs/version_001/resources/connectivity/copy.md create mode 100644 src/docs/version_001/resources/connectivity/example.md diff --git a/src/docs/version_001/docsStructure.ts b/src/docs/version_001/docsStructure.ts index f47a432..ff8abd6 100644 --- a/src/docs/version_001/docsStructure.ts +++ b/src/docs/version_001/docsStructure.ts @@ -40,5 +40,17 @@ export const versionOne: DocsStructure = { copy: 'copy.md', example: 'example.md', }, + { + title: 'Resources', + folder: 'resources', + children: [ + { + title: 'Connectivity', + folder: 'connectivity', + copy: 'copy.md', + example: 'example.md', + }, + ], + }, ], }; diff --git a/src/docs/version_001/resources/apps/copy.md b/src/docs/version_001/resources/apps/copy.md new file mode 100644 index 0000000..e69de29 diff --git a/src/docs/version_001/resources/apps/example.md b/src/docs/version_001/resources/apps/example.md new file mode 100644 index 0000000..e69de29 diff --git a/src/docs/version_001/resources/connectivity/copy.md b/src/docs/version_001/resources/connectivity/copy.md new file mode 100644 index 0000000..8f33cce --- /dev/null +++ b/src/docs/version_001/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 `204` response will be returned with no body. diff --git a/src/docs/version_001/resources/connectivity/example.md b/src/docs/version_001/resources/connectivity/example.md new file mode 100644 index 0000000..5f6c58a --- /dev/null +++ b/src/docs/version_001/resources/connectivity/example.md @@ -0,0 +1,25 @@ +# Checking for connection to the api + +{% code method="GET" heading="/Ping" defaultLanguage="bash" %} + +```bash +curl --location 'https://api.onspring.com/v1/Ping' \ +--header 'X-ApiKey: 000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000' +``` + +```csharp +using Onspring.API.SDK.Helpers; + +var httpHelper = new HttpHelper( + config.baseUrl, + config.apiKey +); + +if (httpHelper.CanConnect()) +{ + Console.WriteLine("Connected to Onspring API"); +} + +``` + +{% /code %}