docs: add apps section

This commit is contained in:
Stevan Freeborn
2023-04-22 19:28:48 -05:00
parent f6bf49cb38
commit 03905ada4e
3 changed files with 44 additions and 0 deletions
+7
View File
@@ -50,6 +50,13 @@ export const versionOne: DocsStructure = {
copy: 'copy.md', copy: 'copy.md',
example: 'example.md', example: 'example.md',
}, },
{
title: 'Apps',
folder: 'apps',
copy: 'copy.md',
example: 'example.md',
children: [],
},
], ],
}, },
], ],
@@ -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 %}
@@ -0,0 +1,12 @@
# The App Object
{% code heading="APP" defaultLanguage="json" %}
```json
{
"Id": 195,
"Name": "Tasks"
}
```
{% /code %}