feat: add openapi docs/client generation #734
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
ignores qbittorrent stuff removes invalid frombody AND fromform stuff - can't both be there and we return early if body null
also narrows types for `Update`, we onlu used the `Key` and `Value` properties, so that's all clients need to pass
# Conflicts: # server/RdtClient.Web/Controllers/AuthController.cs
accidentally removed it in the merge conflict resolution
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.
Haven't discussed this beforehand at all, so feel free to just close this if it's not the direction you want to go in.
Currently a draft until I rework the frontend to work with
ProblemsJust generates a client, doesn't actually use it - this PR (in order to try to be minimal) (mostly) only adds openapi document generation.
Both the generated client (pretty much essential) and the generated
openapi.json(not essential) have been added to git.This is in large part useful for my sveltekit rewrite (see PR onto this branch). I can draft PR this against main on request
A few endpoints have changed:
POST /Api/Torrents/VerifyRegexno longer accepts a file from a formThe only way a form can be passed is if the body is a form (that is, body is empty).
So the
requestmust benull.So passing a file to this endpoint can never work
AuthControllernow returns aProblemrather than just a stringAnd no docs are generated for the qBittorrent compatible endpoints
Browse the generated documentation (Redocly, Swagger)