mirror of
https://github.com/sst/opencode.git
synced 2025-12-23 10:11:41 +00:00
sync
This commit is contained in:
parent
c9b1bb0285
commit
68daadcb56
6 changed files with 2 additions and 65 deletions
|
|
@ -1,4 +0,0 @@
|
|||
---
|
||||
title: "Create Plant"
|
||||
openapi: "POST /plants"
|
||||
---
|
||||
|
|
@ -1,4 +0,0 @@
|
|||
---
|
||||
title: "Delete Plant"
|
||||
openapi: "DELETE /plants/{id}"
|
||||
---
|
||||
|
|
@ -1,4 +0,0 @@
|
|||
---
|
||||
title: "Get Plants"
|
||||
openapi: "GET /plants"
|
||||
---
|
||||
|
|
@ -1,4 +0,0 @@
|
|||
---
|
||||
title: "New Plant"
|
||||
openapi: "WEBHOOK /plant/webhook"
|
||||
---
|
||||
|
|
@ -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": []
|
||||
}
|
||||
]
|
||||
```
|
||||
|
|
@ -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": {
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue