diff options
| author | Dhravya Shah <[email protected]> | 2025-01-30 22:27:14 -0700 |
|---|---|---|
| committer | Dhravya Shah <[email protected]> | 2025-01-30 22:27:14 -0700 |
| commit | af4c98a27c5c661337300155511eb9087a721a4f (patch) | |
| tree | 823c98bb12f04a89397efc91bac6387eab9f21ab /apps/docs/api-reference | |
| parent | redepl (diff) | |
| download | supermemory-af4c98a27c5c661337300155511eb9087a721a4f.tar.xz supermemory-af4c98a27c5c661337300155511eb9087a721a4f.zip | |
api docs
Diffstat (limited to 'apps/docs/api-reference')
| -rw-r--r-- | apps/docs/api-reference/add-new-content.mdx | 3 | ||||
| -rw-r--r-- | apps/docs/api-reference/chat-with-memory-assistant.mdx | 3 | ||||
| -rw-r--r-- | apps/docs/api-reference/create-space.mdx | 3 | ||||
| -rw-r--r-- | apps/docs/api-reference/endpoint/create.mdx | 4 | ||||
| -rw-r--r-- | apps/docs/api-reference/endpoint/delete.mdx | 4 | ||||
| -rw-r--r-- | apps/docs/api-reference/endpoint/get.mdx | 4 | ||||
| -rw-r--r-- | apps/docs/api-reference/get-current-user.mdx | 3 | ||||
| -rw-r--r-- | apps/docs/api-reference/get-user-spaces.mdx | 3 | ||||
| -rw-r--r-- | apps/docs/api-reference/import-notion-content.mdx | 3 | ||||
| -rw-r--r-- | apps/docs/api-reference/introduction.mdx | 33 | ||||
| -rw-r--r-- | apps/docs/api-reference/list-memories.mdx | 3 | ||||
| -rw-r--r-- | apps/docs/api-reference/list-spaces.mdx | 3 | ||||
| -rw-r--r-- | apps/docs/api-reference/openapi.json | 195 | ||||
| -rw-r--r-- | apps/docs/api-reference/search-content.mdx | 3 |
14 files changed, 27 insertions, 240 deletions
diff --git a/apps/docs/api-reference/add-new-content.mdx b/apps/docs/api-reference/add-new-content.mdx new file mode 100644 index 00000000..6bee3091 --- /dev/null +++ b/apps/docs/api-reference/add-new-content.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /v1/add +---
\ No newline at end of file diff --git a/apps/docs/api-reference/chat-with-memory-assistant.mdx b/apps/docs/api-reference/chat-with-memory-assistant.mdx new file mode 100644 index 00000000..2b2f7a79 --- /dev/null +++ b/apps/docs/api-reference/chat-with-memory-assistant.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /chat +---
\ No newline at end of file diff --git a/apps/docs/api-reference/create-space.mdx b/apps/docs/api-reference/create-space.mdx new file mode 100644 index 00000000..775d8786 --- /dev/null +++ b/apps/docs/api-reference/create-space.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /spaces/create +---
\ No newline at end of file diff --git a/apps/docs/api-reference/endpoint/create.mdx b/apps/docs/api-reference/endpoint/create.mdx deleted file mode 100644 index 5689f1b6..00000000 --- a/apps/docs/api-reference/endpoint/create.mdx +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: 'Create Plant' -openapi: 'POST /plants' ---- diff --git a/apps/docs/api-reference/endpoint/delete.mdx b/apps/docs/api-reference/endpoint/delete.mdx deleted file mode 100644 index 657dfc87..00000000 --- a/apps/docs/api-reference/endpoint/delete.mdx +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: 'Delete Plant' -openapi: 'DELETE /plants/{id}' ---- diff --git a/apps/docs/api-reference/endpoint/get.mdx b/apps/docs/api-reference/endpoint/get.mdx deleted file mode 100644 index 56aa09ec..00000000 --- a/apps/docs/api-reference/endpoint/get.mdx +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: 'Get Plants' -openapi: 'GET /plants' ---- diff --git a/apps/docs/api-reference/get-current-user.mdx b/apps/docs/api-reference/get-current-user.mdx new file mode 100644 index 00000000..fe057b1a --- /dev/null +++ b/apps/docs/api-reference/get-current-user.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /user +---
\ No newline at end of file diff --git a/apps/docs/api-reference/get-user-spaces.mdx b/apps/docs/api-reference/get-user-spaces.mdx new file mode 100644 index 00000000..8b91a1e0 --- /dev/null +++ b/apps/docs/api-reference/get-user-spaces.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /v1/user/spaces +---
\ No newline at end of file diff --git a/apps/docs/api-reference/import-notion-content.mdx b/apps/docs/api-reference/import-notion-content.mdx new file mode 100644 index 00000000..14ba2ba6 --- /dev/null +++ b/apps/docs/api-reference/import-notion-content.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /v1/integrations/notion/import +---
\ No newline at end of file diff --git a/apps/docs/api-reference/introduction.mdx b/apps/docs/api-reference/introduction.mdx deleted file mode 100644 index c835b78b..00000000 --- a/apps/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/apps/docs/api-reference/list-memories.mdx b/apps/docs/api-reference/list-memories.mdx new file mode 100644 index 00000000..82f2cdf7 --- /dev/null +++ b/apps/docs/api-reference/list-memories.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /memories +---
\ No newline at end of file diff --git a/apps/docs/api-reference/list-spaces.mdx b/apps/docs/api-reference/list-spaces.mdx new file mode 100644 index 00000000..23f1cee9 --- /dev/null +++ b/apps/docs/api-reference/list-spaces.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /spaces +---
\ No newline at end of file diff --git a/apps/docs/api-reference/openapi.json b/apps/docs/api-reference/openapi.json deleted file mode 100644 index b1509be0..00000000 --- a/apps/docs/api-reference/openapi.json +++ /dev/null @@ -1,195 +0,0 @@ -{ - "openapi": "3.0.1", - "info": { - "title": "OpenAPI Plant Store", - "description": "A sample API that uses a plant store as an example to demonstrate features in the OpenAPI specification", - "license": { - "name": "MIT" - }, - "version": "1.0.0" - }, - "servers": [ - { - "url": "http://sandbox.mintlify.com" - } - ], - "security": [ - { - "bearerAuth": [] - } - ], - "paths": { - "/plants": { - "get": { - "description": "Returns all plants from the system that the user has access to", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "The maximum number of results to return", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Plant response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Plant" - } - } - } - } - }, - "400": { - "description": "Unexpected error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - } - }, - "post": { - "description": "Creates a new plant in the store", - "requestBody": { - "description": "Plant to add to the store", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NewPlant" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "plant response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Plant" - } - } - } - }, - "400": { - "description": "unexpected error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - } - } - }, - "/plants/{id}": { - "delete": { - "description": "Deletes a single plant based on the ID supplied", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "ID of plant to delete", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "204": { - "description": "Plant deleted", - "content": {} - }, - "400": { - "description": "unexpected error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - } - } - } - }, - "components": { - "schemas": { - "Plant": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "description": "The name of the plant", - "type": "string" - }, - "tag": { - "description": "Tag to specify the type", - "type": "string" - } - } - }, - "NewPlant": { - "allOf": [ - { - "$ref": "#/components/schemas/Plant" - }, - { - "required": [ - "id" - ], - "type": "object", - "properties": { - "id": { - "description": "Identification number of the plant", - "type": "integer", - "format": "int64" - } - } - } - ] - }, - "Error": { - "required": [ - "error", - "message" - ], - "type": "object", - "properties": { - "error": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - } - }, - "securitySchemes": { - "bearerAuth": { - "type": "http", - "scheme": "bearer" - } - } - } -}
\ No newline at end of file diff --git a/apps/docs/api-reference/search-content.mdx b/apps/docs/api-reference/search-content.mdx new file mode 100644 index 00000000..03788e9c --- /dev/null +++ b/apps/docs/api-reference/search-content.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /v1/search +---
\ No newline at end of file |