Skip to content

feat: Add apps proxy documentation #336

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions _data/navigation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,12 @@ items:
- url: /extend/publish/checklist/
title: Checklist

- url: /extend/apps
title: Create data and inspect data apps
items:
- url: /extend/apps/proxy
title: Apps proxy API

- url: /integrate/
title: Integration
items:
Expand Down
27 changes: 27 additions & 0 deletions extend/apps/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: Apps
permalink: /extend/apps/
---

Data Apps are simple web apps used to work with data and have an easy to use, accessible UI that enables data-driven decision making.

They could be written in any language, but for starters we want to support [Streamlit language](https://streamlit.io/), which enables rapid development of these apps.

To understand how the applications communicate to your application go to the [proxy](/extend/apps/proxy/) page.

{% comment %}

- gdwriter

- Storage
- API
- Curl
- Commandline
- Transformation
- API
- IO Mapping
- Sandbox
- Extractors
- ...
- Writers
{% endcomment %}
10 changes: 10 additions & 0 deletions extend/apps/proxy/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Proxy API
permalink: /extend/apps/proxy/
---

* TOC
{:toc}



1 change: 1 addition & 0 deletions overview/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ The main APIs for our components are:

| API | Description |
|---|---|
| [Apps Proxy API](https://hub.keboola.com/_proxy/api/v1/documentation/) | The Keboola Application proxy server for Data Applications. |
| [Keboola Storage API](https://keboola.docs.apiary.io/) | [Storage](/integrate/storage/) is the main Keboola component storing all data. |
| [Keboola Management API](https://keboolamanagementapi.docs.apiary.io/) | API managing Keboola projects and users (and notifications and features). |
| [Encryption API](https://keboolaencryption.docs.apiary.io/#) | Provides [Encryption](/overview/encryption/). |
Expand Down
Loading