feat: work on displaying more complex doc structure

This commit is contained in:
Stevan Freeborn
2023-04-11 15:52:48 -05:00
parent 7739cf2958
commit 68d6dd5f59
8 changed files with 82 additions and 11 deletions
+21
View File
@@ -17,5 +17,26 @@ export const versionTwo: DocsStructure = {
example: 'example.md',
children: [],
},
{
title: 'Resources',
folder: 'resources',
children: [
{
title: 'Records',
folder: 'resources/records',
copy: 'copy.md',
example: 'example.md',
children: [
{
title: 'Get Records by App',
folder:
'resources/records/get_records_by_app',
copy: 'copy.md',
example: 'example.md',
},
],
},
],
},
],
};
@@ -0,0 +1 @@
# The Record Object
@@ -0,0 +1 @@
# Records
@@ -0,0 +1,3 @@
# Get Records by App
Some place holder text.
@@ -0,0 +1,34 @@
{% code heading="GET /Records/appId/{appID}" language="text" %}
```curl
curl --location 'https://api.onspring.com/Records/appId/195' \
--header 'X-ApiKey: 61642d8c686f9e8747e42af8/52cae9a9-4c49-48b6-a3fe-10a48d46ac69'
```
{% /code %}
{% code heading="RESPONSE" language="json" %}
```json
{
"pageNumber": 1,
"pageSize": 1,
"totalPages": 1,
"totalRecords": 1,
"items": [
{
"appId": 195,
"recordId": 1,
"fieldData": [
{
"type": "Integer",
"fieldId": 6976,
"value": 1
}
]
}
]
}
```
{% /code %}