Added Complete API Reference #648
Draft
Conversation
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
|
could you split this into atomic PRs? It looks to me as there are multiple changes that aren't scoped to just adding a complete API reference. I couldn't give it a thorough check yet, but it looks good so far! |
|
I'll try to do this maybe later tonight. I'm still a beginner on GitHub
processes and only learned about pull requests 3 days ago.. That's my bad
for not ever learning it, I guess I just always had my focuses elsewhere.
I've only ever managed my own repositories and mainly just for backing up
my code and being able to undo things so I never learned the full scope and
power of Git and the GitHub platform. I'm learning it now because in the
past 2 years I've become very involved in AI technologies and development,
and y'all make what I consider to be the best platform for local
development.
I wanted to contribute something back, given how much I utilize the code,
and I have been highly impressed with the speed of it's development! 😁
…On Sat, Aug 9, 2025, 3:49 PM Classic298 ***@***.***> wrote:
*Classic298* left a comment (open-webui/docs#648)
<#648 (comment)>
could you split this into atomic PRs? It looks to me as there are multiple
changes that aren't scoped to just adding a complete API reference.
I couldn't give it a thorough check yet, but it looks good so far!
—
Reply to this email directly, view it on GitHub
<#648 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/ACZBHTALTSO7NVOSVC3QTPT3MZNEHAVCNFSM6AAAAACDPZHNX6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTCNZSGA4DSMJRGY>
.
You are receiving this because you authored the thread.Message ID:
***@***.***>
|
|
Your work is much appreciated It is a good practice on github to define a clear (and narrow) scope for a PR and then work around that. If your PR's scope is to add API docs for example, you should stick to that. For other changes, create new PRs respectively :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Apologies if I was supposed to remove those other changes before opening a pull request. I've never actually done this part before, and am kind of new to the GitHub processes. I tried to follow the contribution guide. I commented this in a discussion post on the main open-webui codebase, and was encouraged to submit a PM, so this is my attempt. If I need to change something just let me know! Thanks, and hope this helps out. I know y'all have said that API documentation was not the highest priority right now, but a project I am working on had me going in circles trying to figure out the right way to do certain procedures, so I paused from that and reverse engineered the API as best as I could in a week (A few hours after work each day), and this is what I came up with. Based on the current main branch.