diff options
| author | Dax Raad <[email protected]> | 2025-12-05 20:20:47 -0500 |
|---|---|---|
| committer | Dax Raad <[email protected]> | 2025-12-05 20:20:47 -0500 |
| commit | 68daadcb569d0776f16fe958a98880f4007908db (patch) | |
| tree | 1b1df15b3a9fea213f670ec97b8b0eba7c6dd309 | |
| parent | c9b1bb028510649b8c353a26230c029cf1282593 (diff) | |
| download | opencode-68daadcb569d0776f16fe958a98880f4007908db.tar.gz opencode-68daadcb569d0776f16fe958a98880f4007908db.zip | |
sync
| -rw-r--r-- | packages/docs/api-reference/endpoint/create.mdx | 4 | ||||
| -rw-r--r-- | packages/docs/api-reference/endpoint/delete.mdx | 4 | ||||
| -rw-r--r-- | packages/docs/api-reference/endpoint/get.mdx | 4 | ||||
| -rw-r--r-- | packages/docs/api-reference/endpoint/webhook.mdx | 4 | ||||
| -rw-r--r-- | packages/docs/api-reference/introduction.mdx | 33 | ||||
| -rw-r--r-- | packages/docs/docs.json | 18 |
6 files changed, 2 insertions, 65 deletions
diff --git a/packages/docs/api-reference/endpoint/create.mdx b/packages/docs/api-reference/endpoint/create.mdx deleted file mode 100644 index f09fb6411..000000000 --- a/packages/docs/api-reference/endpoint/create.mdx +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: "Create Plant" -openapi: "POST /plants" ---- diff --git a/packages/docs/api-reference/endpoint/delete.mdx b/packages/docs/api-reference/endpoint/delete.mdx deleted file mode 100644 index db46bde6e..000000000 --- a/packages/docs/api-reference/endpoint/delete.mdx +++ /dev/null @@ -1,4 +0,0 @@ ---- -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 deleted file mode 100644 index f7c31f092..000000000 --- a/packages/docs/api-reference/endpoint/get.mdx +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: "Get Plants" -openapi: "GET /plants" ---- diff --git a/packages/docs/api-reference/endpoint/webhook.mdx b/packages/docs/api-reference/endpoint/webhook.mdx deleted file mode 100644 index e80fc67eb..000000000 --- a/packages/docs/api-reference/endpoint/webhook.mdx +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: "New Plant" -openapi: "WEBHOOK /plant/webhook" ---- diff --git a/packages/docs/api-reference/introduction.mdx b/packages/docs/api-reference/introduction.mdx deleted file mode 100644 index 150f32e75..000000000 --- a/packages/docs/api-reference/introduction.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -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": [] - } -] -``` diff --git a/packages/docs/docs.json b/packages/docs/docs.json index 9075cf544..4ca49de58 100644 --- a/packages/docs/docs.json +++ b/packages/docs/docs.json @@ -37,22 +37,8 @@ ] }, { - "tab": "API reference", - "groups": [ - { - "group": "API documentation", - "pages": ["api-reference/introduction"] - }, - { - "group": "Endpoint examples", - "pages": [ - "api-reference/endpoint/get", - "api-reference/endpoint/create", - "api-reference/endpoint/delete", - "api-reference/endpoint/webhook" - ] - } - ] + "tab": "API Reference", + "openapi": "https://opencode.ai/openapi.json" } ], "global": { |
