From acac8696522e5af33555d7908e166b930b4b26d8 Mon Sep 17 00:00:00 2001
From: hieu-jan <150573299+hieu-jan@users.noreply.github.com>
Date: Tue, 28 Nov 2023 05:25:35 +0900
Subject: [PATCH] docs: change configure for API docs
---
docs/docusaurus.config.js | 6 +++---
docs/openapi/jan.yaml | 30 +++++++++++++++++++++++++++---
2 files changed, 30 insertions(+), 6 deletions(-)
diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
index 822c2189b..7b07016d2 100644
--- a/docs/docusaurus.config.js
+++ b/docs/docusaurus.config.js
@@ -113,11 +113,11 @@ const config = {
primaryColor: "#1a73e8",
primaryColorDark: "#1a73e8",
options: {
- disableSearch: true,
requiredPropsFirst: true,
- noAutoAuth: true
+ noAutoAuth: true,
+ hideDownloadButton: true,
+ disableSearch: true,
},
- // redocOptions: { hideDownloadButton: false },
},
},
],
diff --git a/docs/openapi/jan.yaml b/docs/openapi/jan.yaml
index c1bd48143..36132f1f0 100644
--- a/docs/openapi/jan.yaml
+++ b/docs/openapi/jan.yaml
@@ -51,6 +51,7 @@ paths:
operationId: listModels
tags:
- Models
+
summary: List Models
description: Lists the currently available models, and provides basic information about each one such as the owner and availability.
responses:
@@ -548,8 +549,28 @@ paths:
operationId: listMessageFiles
tags:
- Messages
- summary: List message files
- description: Returns a list of message files.
+ summary: List message files
+ securitySchemes:
+ petstore_auth:
+ description: |
+ Get access to data while protecting your account credentials.
+ OAuth2 is also a safer and more secure way to give you access.
+ type: oauth2
+ flows:
+ implicit:
+ authorizationUrl: 'http://petstore.swagger.io/api/oauth/dialog'
+ scopes:
+ 'write:pets': modify pets in your account
+ 'read:pets': read your pets
+ description: |
+
+
+
+ Returns a list of message files.
+
+
+
+
parameters:
- in: path
name: thread_id
@@ -564,7 +585,10 @@ paths:
schema:
type: string
example: msg_abc123
- description: The ID of the message whose files are to be listed.
+ description: |
+ The ID of the message whose files are to be listed.
+
+ Open.AI Compatible
responses:
"200":
description: List of files retrieved successfully