Enhance OpenAPI interface with title, version, and security schema#13841
Open
sirj0k3r wants to merge 1 commit intoinfiniflow:mainfrom
Open
Enhance OpenAPI interface with title, version, and security schema#13841sirj0k3r wants to merge 1 commit intoinfiniflow:mainfrom
sirj0k3r wants to merge 1 commit intoinfiniflow:mainfrom
Conversation
…eb interface; + Added security schema to allow for API testing within endpoints from the SDK API
dosubot
bot
added
size:M
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What problem does this PR solve?
This PR mainly aims to provide the security schema for the endpoints on the SDK API.
It will allow developers to test the API by setting their API key as an header.
For full API testing you might want to consider the work done in #13767 to allow for the requests' schema to be present as an example.
Despite not being its primary objective, this PR also includes the specification for the API's title and version, changing it from the default
api.appsto something more specific such asRagflow API, while keeping the version's value at0.1.0Type of change