From 3349d3ea3a8b6a8013ca5d8b18be86333634d6c4 Mon Sep 17 00:00:00 2001 From: Rachid Flih Date: Sun, 28 Jul 2024 17:05:43 +0100 Subject: [PATCH] feat: File Storage APIs --- docs/README.md | 32 -------- docs/accounting/quickstart.mdx | 7 ++ docs/ats/overview.mdx | 10 +++ docs/catalog.mdx | 55 +++++++------ docs/crm/overview.mdx | 2 +- docs/crm/quickstart.mdx | 1 + docs/file-storage/drives/list-drives.mdx | 3 + docs/file-storage/drives/retrieve-a-drive.mdx | 3 + docs/file-storage/files/create-a-file.mdx | 3 + docs/file-storage/files/list-files.mdx | 3 + docs/file-storage/files/retrieve-a-file.mdx | 3 + docs/file-storage/groups/list-groups.mdx | 3 + docs/file-storage/groups/retrieve-a-group.mdx | 3 + docs/file-storage/olders/create-a-folder.mdx | 3 + docs/file-storage/olders/list-folders.mdx | 3 + .../file-storage/olders/retrieve-a-folder.mdx | 3 + docs/file-storage/overview.mdx | 10 +++ docs/file-storage/users/list-users.mdx | 3 + docs/file-storage/users/retrieve-a-user.mdx | 3 + docs/mint.json | 79 +++++++++++++++++-- docs/snippets/ats-catalog.mdx | 3 + docs/snippets/filestorage-catalog.mdx | 6 ++ docs/syncwithCode.sh | 13 ++- docs/ticketing/quickstart.mdx | 1 + packages/api/src/accounting/README.md | 8 ++ 25 files changed, 195 insertions(+), 68 deletions(-) delete mode 100644 docs/README.md create mode 100644 docs/ats/overview.mdx create mode 100644 docs/file-storage/drives/list-drives.mdx create mode 100644 docs/file-storage/drives/retrieve-a-drive.mdx create mode 100644 docs/file-storage/files/create-a-file.mdx create mode 100644 docs/file-storage/files/list-files.mdx create mode 100644 docs/file-storage/files/retrieve-a-file.mdx create mode 100644 docs/file-storage/groups/list-groups.mdx create mode 100644 docs/file-storage/groups/retrieve-a-group.mdx create mode 100644 docs/file-storage/olders/create-a-folder.mdx create mode 100644 docs/file-storage/olders/list-folders.mdx create mode 100644 docs/file-storage/olders/retrieve-a-folder.mdx create mode 100644 docs/file-storage/overview.mdx create mode 100644 docs/file-storage/users/list-users.mdx create mode 100644 docs/file-storage/users/retrieve-a-user.mdx create mode 100644 docs/snippets/ats-catalog.mdx create mode 100644 docs/snippets/filestorage-catalog.mdx create mode 100644 packages/api/src/accounting/README.md diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index c89c478d1..000000000 --- a/docs/README.md +++ /dev/null @@ -1,32 +0,0 @@ -# Mintlify Starter Kit - -Click on `Use this template` to copy the Mintlify starter kit. The starter kit contains examples including - -- Guide pages -- Navigation -- Customizations -- API Reference pages -- Use of popular components - -### Development - -Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command - -``` -npm i -g mintlify -``` - -Run the following command at the root of your documentation (where mint.json is) - -``` -mintlify dev -``` - -### Publishing Changes - -Install our Github App to autopropagate changes from youre repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard. - -#### Troubleshooting - -- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies. -- Page loads as a 404 - Make sure you are running in a folder with `mint.json` diff --git a/docs/accounting/quickstart.mdx b/docs/accounting/quickstart.mdx index e69de29bb..9d9d4bd59 100644 --- a/docs/accounting/quickstart.mdx +++ b/docs/accounting/quickstart.mdx @@ -0,0 +1,7 @@ +--- +title: "Quick Start" +description: "Read and write data to multiple Accounting platforms using a single API" +icon: "star" +--- + +We're releasing this API soon! Get updates [here](https://panora.co/signup). \ No newline at end of file diff --git a/docs/ats/overview.mdx b/docs/ats/overview.mdx new file mode 100644 index 000000000..a3e76d3d0 --- /dev/null +++ b/docs/ats/overview.mdx @@ -0,0 +1,10 @@ +--- +title: 'Overview' +description: '' +--- +import atsCatalog from '/snippets/ats-catalog.mdx'; + +Welcome to the reference documentation for the ATS (Applicant Tracking System) API! This API allows you to integrate with Panora and read data from or write data into the integrations authorized by your users. + +## Supported ATS Providers & Objects + \ No newline at end of file diff --git a/docs/catalog.mdx b/docs/catalog.mdx index 9a67e7700..0a3e9158f 100644 --- a/docs/catalog.mdx +++ b/docs/catalog.mdx @@ -4,19 +4,22 @@ description: "" icon: album-collection --- -## ATS - - - } horizontal> - - - - -## CRM - - + + + + + } horizontal> + + + + + Coming soon! + + + A single schema to push and pull CRM data across platforms. + } horizontal> @@ -42,31 +45,26 @@ icon: album-collection } horizontal> - - -# Ecommerce - - + + + } horizontal> - - -# File Storage - - + + + } horizontal> - -# Ticketing - - + + + } horizontal> @@ -84,4 +82,9 @@ icon: album-collection } horizontal> + + + + + diff --git a/docs/crm/overview.mdx b/docs/crm/overview.mdx index 92cdcd0af..38d5b03ea 100644 --- a/docs/crm/overview.mdx +++ b/docs/crm/overview.mdx @@ -6,5 +6,5 @@ import crmCatalog from '/snippets/crm-catalog.mdx'; Welcome to the reference documentation for the Panora Customer Relationship Management (CRM) API! This API allows you to integrate with Panora and read data from or write data into the integrations authorized by your users. -

+## Supported CRM Providers & Objects \ No newline at end of file diff --git a/docs/crm/quickstart.mdx b/docs/crm/quickstart.mdx index 3e153b9a2..c60ff75d7 100644 --- a/docs/crm/quickstart.mdx +++ b/docs/crm/quickstart.mdx @@ -1,6 +1,7 @@ --- title: "Quick Start" description: "Read and write data to multiple CRM platforms using a single API" +icon: "star" --- ## Create a contact in a crm using Panora diff --git a/docs/file-storage/drives/list-drives.mdx b/docs/file-storage/drives/list-drives.mdx new file mode 100644 index 000000000..4242159f3 --- /dev/null +++ b/docs/file-storage/drives/list-drives.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /filestorage/drives +--- \ No newline at end of file diff --git a/docs/file-storage/drives/retrieve-a-drive.mdx b/docs/file-storage/drives/retrieve-a-drive.mdx new file mode 100644 index 000000000..0080655a8 --- /dev/null +++ b/docs/file-storage/drives/retrieve-a-drive.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /filestorage/drives/{id} +--- \ No newline at end of file diff --git a/docs/file-storage/files/create-a-file.mdx b/docs/file-storage/files/create-a-file.mdx new file mode 100644 index 000000000..5cbccd202 --- /dev/null +++ b/docs/file-storage/files/create-a-file.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /filestorage/files +--- \ No newline at end of file diff --git a/docs/file-storage/files/list-files.mdx b/docs/file-storage/files/list-files.mdx new file mode 100644 index 000000000..7f4f4c9ed --- /dev/null +++ b/docs/file-storage/files/list-files.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /filestorage/files +--- \ No newline at end of file diff --git a/docs/file-storage/files/retrieve-a-file.mdx b/docs/file-storage/files/retrieve-a-file.mdx new file mode 100644 index 000000000..8fe84b313 --- /dev/null +++ b/docs/file-storage/files/retrieve-a-file.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /filestorage/files/{id} +--- \ No newline at end of file diff --git a/docs/file-storage/groups/list-groups.mdx b/docs/file-storage/groups/list-groups.mdx new file mode 100644 index 000000000..53dc032b2 --- /dev/null +++ b/docs/file-storage/groups/list-groups.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /filestorage/groups +--- \ No newline at end of file diff --git a/docs/file-storage/groups/retrieve-a-group.mdx b/docs/file-storage/groups/retrieve-a-group.mdx new file mode 100644 index 000000000..a896e7206 --- /dev/null +++ b/docs/file-storage/groups/retrieve-a-group.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /filestorage/groups/{id} +--- \ No newline at end of file diff --git a/docs/file-storage/olders/create-a-folder.mdx b/docs/file-storage/olders/create-a-folder.mdx new file mode 100644 index 000000000..29dadda7e --- /dev/null +++ b/docs/file-storage/olders/create-a-folder.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /filestorage/folders +--- \ No newline at end of file diff --git a/docs/file-storage/olders/list-folders.mdx b/docs/file-storage/olders/list-folders.mdx new file mode 100644 index 000000000..049b7deaa --- /dev/null +++ b/docs/file-storage/olders/list-folders.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /filestorage/folders +--- \ No newline at end of file diff --git a/docs/file-storage/olders/retrieve-a-folder.mdx b/docs/file-storage/olders/retrieve-a-folder.mdx new file mode 100644 index 000000000..59ef81dbd --- /dev/null +++ b/docs/file-storage/olders/retrieve-a-folder.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /filestorage/folders/{id} +--- \ No newline at end of file diff --git a/docs/file-storage/overview.mdx b/docs/file-storage/overview.mdx new file mode 100644 index 000000000..05d9ee98c --- /dev/null +++ b/docs/file-storage/overview.mdx @@ -0,0 +1,10 @@ +--- +title: 'Overview' +description: '' +--- +import filestorageCatalog from '/snippets/filestorage-catalog.mdx'; + +Welcome to the reference documentation for the Panora File Storage (CRM) API! This API allows you to integrate with Panora and read data from or write data into the integrations authorized by your users. + +## Supported File Storage Providers & Objects + \ No newline at end of file diff --git a/docs/file-storage/users/list-users.mdx b/docs/file-storage/users/list-users.mdx new file mode 100644 index 000000000..266fef47b --- /dev/null +++ b/docs/file-storage/users/list-users.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /filestorage/users +--- \ No newline at end of file diff --git a/docs/file-storage/users/retrieve-a-user.mdx b/docs/file-storage/users/retrieve-a-user.mdx new file mode 100644 index 000000000..6fccee6f7 --- /dev/null +++ b/docs/file-storage/users/retrieve-a-user.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /filestorage/users/{id} +--- \ No newline at end of file diff --git a/docs/mint.json b/docs/mint.json index 113f9f9b2..b549caaab 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -72,6 +72,10 @@ "name": "CRM", "url": "crm" }, + { + "name": "File Storage", + "url": "file-storage" + }, { "name": "Ticketing", "url": "ticketing" @@ -94,8 +98,8 @@ { "group": "", "pages": [ - "crm/overview", - "crm/quickstart" + "crm/quickstart", + "crm/overview" ] }, { @@ -168,8 +172,62 @@ } ] }, + + + { + "group": "", + "pages": [ + "file-storage/overview" + ] + }, + + { + "group": "File Storage Objects", + "pages": [ + { + "group": "Drives", + "pages": [ + "file-storage/drives/list-drives", + "file-storage/drives/retrieve-a-drive" + ] + }, + { + "group": "Files", + "pages": [ + "file-storage/files/create-a-file", + "file-storage/files/list-files", + "file-storage/files/retrieve-a-file" + ] + }, + { + "group": "Folders", + "pages": [ + "file-storage/olders/create-a-folder", + "file-storage/olders/list-folders", + "file-storage/olders/retrieve-a-folder" + ] + }, + { + "group": "Groups", + "pages": [ + "file-storage/groups/list-groups", + "file-storage/groups/retrieve-a-group" + ] + }, + { + "group": "Users", + "pages": [ + "file-storage/users/list-users", + "file-storage/users/retrieve-a-user" + ] + } + ] + }, + + + { - "group": "Accounting", + "group": "Accounting Objects", "pages": [ { "group": "Accounting Balance Sheets", @@ -339,8 +397,17 @@ } ] }, + + { + "group": "", + "pages": [ + "ats/overview" + ] + }, + + { - "group": "ATS", + "group": "ATS Objects", "pages": [ { "group": "Activities", @@ -461,8 +528,8 @@ { "group": "", "pages": [ - "ticketing/overview", - "ticketing/quickstart" + "ticketing/quickstart", + "ticketing/overview" ] }, { diff --git a/docs/snippets/ats-catalog.mdx b/docs/snippets/ats-catalog.mdx new file mode 100644 index 000000000..907a7c090 --- /dev/null +++ b/docs/snippets/ats-catalog.mdx @@ -0,0 +1,3 @@ +| | Activities | Applications | Candidates | Departments | Interviews | Jobs | Offers | Offices | Scorecard | Users | +|-------------|:----------:|:------------:|:----------:|:-----------:|:----------:|:----:|:------:|:-------:|:---------:|:-----:| +| Ashby | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | diff --git a/docs/snippets/filestorage-catalog.mdx b/docs/snippets/filestorage-catalog.mdx new file mode 100644 index 000000000..252d04ed5 --- /dev/null +++ b/docs/snippets/filestorage-catalog.mdx @@ -0,0 +1,6 @@ +| File Storage | Drives | Files | Folders | Groups | Users | Permissions | Shared Links | +|-----------------------------------------------|:--------:|:-----:|:-----:|:-----------:|:-----:|:-----:|:---------:| +| [Google Drive]() | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | | +| [Box]() | | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | +| [Dropbox]() | | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | | +| [OneDrive]() | ✔️ | ✔️ | ✔️| ✔️ | ✔️ | | | diff --git a/docs/syncwithCode.sh b/docs/syncwithCode.sh index 8fd6e5290..ad4d8bce5 100644 --- a/docs/syncwithCode.sh +++ b/docs/syncwithCode.sh @@ -2,11 +2,18 @@ # This will import integration tables from codebase # CRM -grep '^|' ./packages/api/src/crm/README.md > docs/snippets/crm-catalog.mdx -grep '^|' ./packages/api/src/crm/contact/README.md > docs/snippets/crm-contact-catalog.mdx +grep '^|' ../packages/api/src/crm/README.md > snippets/crm-catalog.mdx +grep '^|' ../packages/api/src/crm/contact/README.md > snippets/crm-contact-catalog.mdx # Ticketing -grep '^|' ./packages/api/src/ticketing/README.md > docs/snippets/ticketing-catalog.mdx +grep '^|' ../packages/api/src/ticketing/README.md > snippets/ticketing-catalog.mdx + +#ATS +grep '^|' ../packages/api/src/ats/README.md > snippets/ats-catalog.mdx + +# File Storage +grep '^|' ../packages/api/src/filestorage/README.md > snippets/filestorage-catalog.mdx npx @mintlify/scraping@latest openapi-file openapi-with-code-samples.yaml -o objects + echo "Copy Done!" \ No newline at end of file diff --git a/docs/ticketing/quickstart.mdx b/docs/ticketing/quickstart.mdx index 86c557f67..b5f69af28 100644 --- a/docs/ticketing/quickstart.mdx +++ b/docs/ticketing/quickstart.mdx @@ -1,6 +1,7 @@ --- title: "Quick Start" description: "Read and write data to multiple ticketing platforms using a single API" +icon: "star" --- ## Create a ticket in a ticketing platform using Panora diff --git a/packages/api/src/accounting/README.md b/packages/api/src/accounting/README.md new file mode 100644 index 000000000..96d6babeb --- /dev/null +++ b/packages/api/src/accounting/README.md @@ -0,0 +1,8 @@ +### Accounting +Panora supports integration with the following objects across multiple platforms: + +| | Object1 | Object2 | Object3 | Object4 | Object5 | Object6 | Object7 | Object8 | Object9 | Object10 | +|-------------|:----------:|:------------:|:----------:|:-----------:|:----------:|:----:|:------:|:-------:|:---------:|:-----:| +| Platform | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | + +Your favourite software is missing? [Ask the community to build a connector!](https://github.com/panoratech/Panora/issues/new) \ No newline at end of file