docs: change configure for API docs

This commit is contained in:
hieu-jan 2023-11-28 05:25:35 +09:00
parent d74698a448
commit acac869652
2 changed files with 30 additions and 6 deletions

View File

@ -113,11 +113,11 @@ const config = {
primaryColor: "#1a73e8", primaryColor: "#1a73e8",
primaryColorDark: "#1a73e8", primaryColorDark: "#1a73e8",
options: { options: {
disableSearch: true,
requiredPropsFirst: true, requiredPropsFirst: true,
noAutoAuth: true noAutoAuth: true,
hideDownloadButton: true,
disableSearch: true,
}, },
// redocOptions: { hideDownloadButton: false },
}, },
}, },
], ],

View File

@ -51,6 +51,7 @@ paths:
operationId: listModels operationId: listModels
tags: tags:
- Models - Models
summary: List Models summary: List Models
description: Lists the currently available models, and provides basic information about each one such as the owner and availability. description: Lists the currently available models, and provides basic information about each one such as the owner and availability.
responses: responses:
@ -549,7 +550,27 @@ paths:
tags: tags:
- Messages - Messages
summary: List message files summary: List message files
description: Returns a list of 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: |
<a href = "https://platform.openai.com/docs/api-reference/messages/listMessages"> <button style = "color: #388434"> OpenAI Compatible </button></a>
<a href = "https://platform.openai.com/docs/api-reference/messages/listMessages"> <button style = "color: #fec928">Jan.AI Compatible </button></a>
Returns a list of message files.
<a href = "https://platform.openai.com/docs/api-reference/messages/listMessages"> <button style = "color: #388434">OpenAI Compatible </button></a>
parameters: parameters:
- in: path - in: path
name: thread_id name: thread_id
@ -564,7 +585,10 @@ paths:
schema: schema:
type: string type: string
example: msg_abc123 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.
<span style="color:#388434">Open.AI Compatible</span>
responses: responses:
"200": "200":
description: List of files retrieved successfully description: List of files retrieved successfully