diff --git a/src/docs/version_001/docsStructure.ts b/src/docs/version_001/docsStructure.ts index ff8abd6..78431e9 100644 --- a/src/docs/version_001/docsStructure.ts +++ b/src/docs/version_001/docsStructure.ts @@ -50,6 +50,13 @@ export const versionOne: DocsStructure = { copy: 'copy.md', example: 'example.md', }, + { + title: 'Apps', + folder: 'apps', + copy: 'copy.md', + example: 'example.md', + children: [], + }, ], }, ], diff --git a/src/docs/version_001/resources/apps/copy.md b/src/docs/version_001/resources/apps/copy.md index e69de29..aa2d893 100644 --- a/src/docs/version_001/resources/apps/copy.md +++ b/src/docs/version_001/resources/apps/copy.md @@ -0,0 +1,25 @@ +# Apps {% #apps %} + +These are objects that represent apps and/or surveys in an Onspring instance. You can retrieve a list of apps that the given [API Key](#authentication) has access to. + +## App Properties + +{% table %} + +- Property Name +- Data Type +- Description + +--- + +- Id +- `number` +- The id of the app. + +--- + +- Name +- `string` +- The name of the app. + +{% /table %} diff --git a/src/docs/version_001/resources/apps/example.md b/src/docs/version_001/resources/apps/example.md index e69de29..4ae0414 100644 --- a/src/docs/version_001/resources/apps/example.md +++ b/src/docs/version_001/resources/apps/example.md @@ -0,0 +1,12 @@ +# The App Object + +{% code heading="APP" defaultLanguage="json" %} + +```json +{ + "Id": 195, + "Name": "Tasks" +} +``` + +{% /code %}