From 11aa9eba617ae550c3d814607eb2728c66189094 Mon Sep 17 00:00:00 2001 From: Stevan Freeborn <65925598+StevanFreeborn@users.noreply.github.com> Date: Tue, 25 Apr 2023 08:02:09 -0500 Subject: [PATCH] docs: stub out file sections --- src/docs/version_001/docsStructure.ts | 15 ++++++++++++++- .../version_001/resources/files/add_file/copy.md | 1 + .../resources/files/add_file/example.md | 5 +++++ .../version_001/resources/files/get_file/copy.md | 1 + .../resources/files/get_file/example.md | 4 ++++ 5 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 src/docs/version_001/resources/files/add_file/copy.md create mode 100644 src/docs/version_001/resources/files/add_file/example.md create mode 100644 src/docs/version_001/resources/files/get_file/copy.md create mode 100644 src/docs/version_001/resources/files/get_file/example.md diff --git a/src/docs/version_001/docsStructure.ts b/src/docs/version_001/docsStructure.ts index 6a443a1..bdacbf0 100644 --- a/src/docs/version_001/docsStructure.ts +++ b/src/docs/version_001/docsStructure.ts @@ -187,7 +187,20 @@ export const versionOne: DocsStructure = { { title: 'Files', folder: 'files', - children: [], + children: [ + { + title: 'Get File', + folder: 'get_file', + copy: 'copy.md', + example: 'example.md', + }, + { + title: 'Add File', + folder: 'add_file', + copy: 'copy.md', + example: 'example.md', + }, + ], }, ], }, diff --git a/src/docs/version_001/resources/files/add_file/copy.md b/src/docs/version_001/resources/files/add_file/copy.md new file mode 100644 index 0000000..7f951f7 --- /dev/null +++ b/src/docs/version_001/resources/files/add_file/copy.md @@ -0,0 +1 @@ +# Add File {% #add-file %} diff --git a/src/docs/version_001/resources/files/add_file/example.md b/src/docs/version_001/resources/files/add_file/example.md new file mode 100644 index 0000000..54cb153 --- /dev/null +++ b/src/docs/version_001/resources/files/add_file/example.md @@ -0,0 +1,5 @@ +# Add a file to a record in an app + +{% code method="POST" heading="files/{appId}/{recordId}/ +{fieldId}" defaultLanguage="bash" } +{% /code %} diff --git a/src/docs/version_001/resources/files/get_file/copy.md b/src/docs/version_001/resources/files/get_file/copy.md new file mode 100644 index 0000000..79e5fe7 --- /dev/null +++ b/src/docs/version_001/resources/files/get_file/copy.md @@ -0,0 +1 @@ +# Get File {% #get-file %} diff --git a/src/docs/version_001/resources/files/get_file/example.md b/src/docs/version_001/resources/files/get_file/example.md new file mode 100644 index 0000000..903935c --- /dev/null +++ b/src/docs/version_001/resources/files/get_file/example.md @@ -0,0 +1,4 @@ +# Retrieve a file from a record in an app + +{% code method="GET" heading="/Files/{appId}/{recordId}/{fieldId}" defaultLanguage="bash" } +{% /code %}