WIP: feat: add more OpenAPI specs #3198
Draft
Conversation
This file contains 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
Vito0912
commented
Jul 28, 2024
There was a problem hiding this comment.
My language and the generator does not support the oneOf per https://github.com/OpenAPITools/openapi-generator. Therefore, I will focus on endpoints that do not use oneOf.
Added missing abridged Fixed wrong type on start of bookChapter Added missing libraryFile for LibraryItem Added missing type to id in media
* Update: formatting * Fix: libraryItemController `play` endpoint + Endpoints cannot have optional path parameters + Moved schemas to `components` section * Fix: MeController optional path parameters * Fix: Books do not have `episodeId` in `mediaProgress` * Fix: `PlaybackSession` oneOf between book and podcast * Update: bundled spec * Fix: `allowReserved` in LibraryItem include query * Add: tags to AuthController endpoints * Fix: summary of play endpoints * Update: bundled spec
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.
This PR is a work in progress and may never be "finished."
I will be updating it with commits periodically. This PR should not be merged until the last commit is ready for merging. If the last commit is not ready for merging, I am still adding new specifications. So at that time I did not tested it or generated the
OpenApi.json.I try to test everything somewhat. Please review before merging.
Contributions and suggestions for better practices are appreciated, including naming conventions, references, etc. This is my first time writing OpenAPI specs, and I am doing my best to ensure each component is unique and references existing schemas when possible.
Currently, I am testing a bit, but I wanted to open this PR to show what I am working on so others can help or contribute.