From 0b9ebcb71c4abc83435a6ebe02dc4588429e74d9 Mon Sep 17 00:00:00 2001 From: Stevan Freeborn <65925598+StevanFreeborn@users.noreply.github.com> Date: Wed, 12 Apr 2023 11:18:38 -0500 Subject: [PATCH] feat: add some content for version 1 --- src/docs/version_001/docsStructure.ts | 10 +++++++++- src/docs/version_001/introduction/copy.md | 3 +++ src/docs/version_001/introduction/example.md | 11 +++++++++++ 3 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 src/docs/version_001/introduction/copy.md create mode 100644 src/docs/version_001/introduction/example.md diff --git a/src/docs/version_001/docsStructure.ts b/src/docs/version_001/docsStructure.ts index 382a451..706f36c 100644 --- a/src/docs/version_001/docsStructure.ts +++ b/src/docs/version_001/docsStructure.ts @@ -2,5 +2,13 @@ import { DocsStructure } from '@/app/types/types'; export const versionOne: DocsStructure = { version: 'version_001', - docs: [], + docs: [ + { + title: 'Introduction', + folder: 'introduction', + copy: 'copy.md', + example: 'example.md', + children: [], + }, + ], }; diff --git a/src/docs/version_001/introduction/copy.md b/src/docs/version_001/introduction/copy.md new file mode 100644 index 0000000..606bac6 --- /dev/null +++ b/src/docs/version_001/introduction/copy.md @@ -0,0 +1,3 @@ +# Introduction {% #introduction %} + +The Onspring API is organized around REST. It enables external programs to retrieve, save, and delete data within your Onspring instance. The Onspring API does not support bulk operation for some, but not all endpoints. diff --git a/src/docs/version_001/introduction/example.md b/src/docs/version_001/introduction/example.md new file mode 100644 index 0000000..40ad31b --- /dev/null +++ b/src/docs/version_001/introduction/example.md @@ -0,0 +1,11 @@ +# Base URL + +The base url for the Onspring API will be the same for all instances regardless of whether the instances is a development, test, or production instance. + +{% code heading="BASE URL" defaultLanguage="text" %} + +```text +https://api.onspring.com/v1 +``` + +{% /code %}