Nicholai/jan
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: resolve feedback

Browse Source
This commit is contained in:
hieu-jan 2023-11-19 12:09:17 +09:00
parent 6e571e8e7f
commit 9603b3bdbb
2 changed files with 1 additions and 79 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/docusaurus.config.js
View File

@ -104,13 +104,9 @@ const config = {
"redocusaurus", "redocusaurus",
{ {
specs: [ specs: [
{
spec: "openapi/OpenAPISpec.json",
route: "/api"
},
{ {
spec: "openapi/OpenAIAPI.yaml", // can be local file, url, or parsed json object 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: { theme: {

74
docs/openapi/OpenAPISpec.json
View File

@ -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"
}
}
}
}