diff options
| author | Dax Raad <[email protected]> | 2025-12-05 16:41:35 -0500 |
|---|---|---|
| committer | Dax Raad <[email protected]> | 2025-12-05 16:41:35 -0500 |
| commit | 328188816008fde10165597f432dac4c5d1016cd (patch) | |
| tree | e3230708f379c7e3451efc46e5d1c1ab66a26e20 /packages/docs/api-reference/introduction.mdx | |
| parent | c6d0ae892efcbd18652ff413ec3378099d31bc91 (diff) | |
| download | opencode-328188816008fde10165597f432dac4c5d1016cd.tar.gz opencode-328188816008fde10165597f432dac4c5d1016cd.zip | |
ignore: docs test
Diffstat (limited to 'packages/docs/api-reference/introduction.mdx')
| -rw-r--r-- | packages/docs/api-reference/introduction.mdx | 33 |
1 files changed, 33 insertions, 0 deletions
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": [] + } +] +``` |
