From ced6bc2103a434533434691624f8ed31cd53292d Mon Sep 17 00:00:00 2001
From: Kenta Kozuka <kenta.kozuka@gmail.com>
Date: Thu, 20 Jun 2024 00:52:20 +0000
Subject: [PATCH] docs: add http api page

Signed-off-by: Kenta Kozuka <kenta.kozuka@gmail.com>
---
 docs/feature-flags/api-keys.mdx |  3 +++
 docs/integration/http-api.mdx   | 33 +++++++++++++++++++++++++++++++++
 docs/integration/index.mdx      |  5 +++++
 sidebars.js                     |  1 +
 4 files changed, 42 insertions(+)
 create mode 100644 docs/integration/http-api.mdx

diff --git a/docs/feature-flags/api-keys.mdx b/docs/feature-flags/api-keys.mdx
index 404f108f..832d054b 100644
--- a/docs/feature-flags/api-keys.mdx
+++ b/docs/feature-flags/api-keys.mdx
@@ -19,6 +19,9 @@ The API key has 2 roles.
 
 - **Client SDK:** Allows all SDKs to evaluate end users on the Bucketeer server.
 - **Server SDK:** Allows the server SDK (Golang) to evaluate end users locally within the SDK.
+- **Public API(Read Only):** This role allows you to read the data in Bucketeer.
+- **Public API(Read and Write):** This role allows you to read and write the data in Bucketeer.
+- **Public API(Admin):** This role allows you to read and write the data including admin settings in Bucketeer.
 
 To generate a new API key, click the **+ Add** button on the **API Keys** page.<br />
 
diff --git a/docs/integration/http-api.mdx b/docs/integration/http-api.mdx
new file mode 100644
index 00000000..4390ba40
--- /dev/null
+++ b/docs/integration/http-api.mdx
@@ -0,0 +1,33 @@
+---
+title: Bucketeer HTTP API
+sidebar_position: 2
+slug: /integration/http-api
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CenteredImg from '@site/src/components/centered-img/CenteredImg';
+
+:::caution HTTP API (Alpha)
+
+The HTTP API is currently in its alpha stage.
+
+If you find any issues or have suggestions for improvement, feel free to open an [issue](https://github.com/bucketeer-io/bucketeer/issues).<br />
+All contributions are welcome!
+
+:::
+
+The Bucketeer HTTP API allows you to interact with the Bucketeer service programmatically. It supports operations such as creating, updating, and retrieving feature flags, managing users, and evaluating feature flags for specific users.
+
+## Authentication
+Bucketeer API uses token-based authentication. Each request must include an `authorization` header with the token:
+```http
+authorization: <your-api-key>
+```
+
+[API Key](/feature-flags/api-keys) can be created in the Bucketeer dashboard.
+
+## API specification
+
+API specification is available [here](https://github.com/bucketeer-io/bucketeer/blob/main/api-description/service.swagger.json).
+
diff --git a/docs/integration/index.mdx b/docs/integration/index.mdx
index d43354ae..8919345c 100644
--- a/docs/integration/index.mdx
+++ b/docs/integration/index.mdx
@@ -15,3 +15,8 @@ This section provides essential information for utilizing Bucketeer integration
 ## Notifications
 
 Bucketeer provide dashboard [Notifications](/integration/notifications) to alert you and your team regarding changes or events on the dashboard.
+
+## HTTP API
+
+Bucketeer provide [HTTP API](/integration/http-api) to enable you to read and write data from Bucketeer programmatically.
+```
diff --git a/sidebars.js b/sidebars.js
index 2cc1c4e6..613c0cc9 100644
--- a/sidebars.js
+++ b/sidebars.js
@@ -210,6 +210,7 @@ const sidebars = {
       items: [
         'integration/pushes',
         'integration/notifications',
+        'integration/http-api',
       ],
     },