summaryrefslogtreecommitdiffhomepage
path: root/packages/docs/api-reference
diff options
context:
space:
mode:
authorDax Raad <[email protected]>2025-12-05 16:41:35 -0500
committerDax Raad <[email protected]>2025-12-05 16:41:35 -0500
commit328188816008fde10165597f432dac4c5d1016cd (patch)
treee3230708f379c7e3451efc46e5d1c1ab66a26e20 /packages/docs/api-reference
parentc6d0ae892efcbd18652ff413ec3378099d31bc91 (diff)
downloadopencode-328188816008fde10165597f432dac4c5d1016cd.tar.gz
opencode-328188816008fde10165597f432dac4c5d1016cd.zip
ignore: docs test
Diffstat (limited to 'packages/docs/api-reference')
-rw-r--r--packages/docs/api-reference/endpoint/create.mdx4
-rw-r--r--packages/docs/api-reference/endpoint/delete.mdx4
-rw-r--r--packages/docs/api-reference/endpoint/get.mdx4
-rw-r--r--packages/docs/api-reference/endpoint/webhook.mdx4
-rw-r--r--packages/docs/api-reference/introduction.mdx33
5 files changed, 49 insertions, 0 deletions
diff --git a/packages/docs/api-reference/endpoint/create.mdx b/packages/docs/api-reference/endpoint/create.mdx
new file mode 100644
index 000000000..5689f1b65
--- /dev/null
+++ b/packages/docs/api-reference/endpoint/create.mdx
@@ -0,0 +1,4 @@
+---
+title: 'Create Plant'
+openapi: 'POST /plants'
+---
diff --git a/packages/docs/api-reference/endpoint/delete.mdx b/packages/docs/api-reference/endpoint/delete.mdx
new file mode 100644
index 000000000..657dfc871
--- /dev/null
+++ b/packages/docs/api-reference/endpoint/delete.mdx
@@ -0,0 +1,4 @@
+---
+title: 'Delete Plant'
+openapi: 'DELETE /plants/{id}'
+---
diff --git a/packages/docs/api-reference/endpoint/get.mdx b/packages/docs/api-reference/endpoint/get.mdx
new file mode 100644
index 000000000..56aa09ec1
--- /dev/null
+++ b/packages/docs/api-reference/endpoint/get.mdx
@@ -0,0 +1,4 @@
+---
+title: 'Get Plants'
+openapi: 'GET /plants'
+---
diff --git a/packages/docs/api-reference/endpoint/webhook.mdx b/packages/docs/api-reference/endpoint/webhook.mdx
new file mode 100644
index 000000000..329134020
--- /dev/null
+++ b/packages/docs/api-reference/endpoint/webhook.mdx
@@ -0,0 +1,4 @@
+---
+title: 'New Plant'
+openapi: 'WEBHOOK /plant/webhook'
+---
diff --git a/packages/docs/api-reference/introduction.mdx b/packages/docs/api-reference/introduction.mdx
new file mode 100644
index 000000000..c835b78b5
--- /dev/null
+++ b/packages/docs/api-reference/introduction.mdx
@@ -0,0 +1,33 @@
+---
+title: 'Introduction'
+description: 'Example section for showcasing API endpoints'
+---
+
+<Note>
+ If you're not looking to build API reference documentation, you can delete
+ this section by removing the api-reference folder.
+</Note>
+
+## Welcome
+
+There are two ways to build API documentation: [OpenAPI](https://mintlify.com/docs/api-playground/openapi/setup) and [MDX components](https://mintlify.com/docs/api-playground/mdx/configuration). For the starter kit, we are using the following OpenAPI specification.
+
+<Card
+ title="Plant Store Endpoints"
+ icon="leaf"
+ href="https://github.com/mintlify/starter/blob/main/api-reference/openapi.json"
+>
+ View the OpenAPI specification file
+</Card>
+
+## Authentication
+
+All API endpoints are authenticated using Bearer tokens and picked up from the specification file.
+
+```json
+"security": [
+ {
+ "bearerAuth": []
+ }
+]
+```