From 9603b3bdbb4f90b34d2ea90d3a9a0829d188ee8e Mon Sep 17 00:00:00 2001 From: hieu-jan <150573299+hieu-jan@users.noreply.github.com> Date: Sun, 19 Nov 2023 12:09:17 +0900 Subject: [PATCH] docs: resolve feedback --- docs/docusaurus.config.js | 6 +-- docs/openapi/OpenAPISpec.json | 74 ----------------------------------- 2 files changed, 1 insertion(+), 79 deletions(-) delete mode 100644 docs/openapi/OpenAPISpec.json diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 4c76686ed..7aef1d93a 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -104,13 +104,9 @@ const config = { "redocusaurus", { specs: [ - { - spec: "openapi/OpenAPISpec.json", - route: "/api" - }, { spec: "openapi/OpenAIAPI.yaml", // can be local file, url, or parsed json object - route: "/api/openai", + route: "/api-reference", // path where to render docs }, ], theme: { diff --git a/docs/openapi/OpenAPISpec.json b/docs/openapi/OpenAPISpec.json deleted file mode 100644 index c8b20eb65..000000000 --- a/docs/openapi/OpenAPISpec.json +++ /dev/null @@ -1,74 +0,0 @@ -{ - "openapi": "3.0.0", - "info": { - "description": "Jan.ai api reference documentation.", - "title": "Rest Endpoints", - "version": "" - }, - "paths": { - "/api/rest/myquery": { - "get": { - "summary": "MyQuery", - "description": "***\nThe GraphQl query for this endpoint is:\n``` graphql\nquery MyQuery {\n collections {\n id\n name\n slug\n }\n}\n```", - "parameters": [ - { - "description": "Your x-hasura-admin-secret will be used for authentication of the API request.", - "in": "header", - "name": "x-hasura-admin-secret", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "collections": { - "items": { - "description": "columns and relationships of \"collections\"", - "nullable": false, - "properties": { - "id": { - "$ref": "#/components/schemas/uuid!" - }, - "name": { - "nullable": false, - "title": "String", - "type": "string" - }, - "slug": { - "nullable": false, - "title": "String", - "type": "string" - } - }, - "title": "collections", - "type": "object" - }, - "nullable": false, - "type": "array" - } - } - } - } - }, - "description": "Responses for GET /api/rest/myquery" - } - } - } - } - }, - "components": { - "schemas": { - "uuid!": { - "nullable": false, - "pattern": "[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}", - "title": "uuid", - "type": "string" - } - } - } - } \ No newline at end of file