WIP: feat: add more OpenAPI specs #3198
Conversation
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
|
@nichwall Looks good on my site, maybe push current state it is easier small pushes as big pushes |
|
@unl0ck I’m not sure this is ready for merging just yet. I’ve encountered several issues with certain routes in my client. Additionally, I believe I added one or two routes to the OpenAPI spec for my client (if you want to take a look): openapi-spec.json. From what I recall, the search endpoint occasionally crashes. This seems to be related to the Because of these challenges, I haven’t made much progress. To be honest, given the current state, it doesn’t seem logical to move forward if there are planned route changes. I recall nichwall mentioning the idea of establishing a solid foundation before introducing new endpoints (though I could be mistaken), but I feel that approach is no longer practical. Lastly, we should avoid relying on I can help merging this into your repo so you can try plaing around with this and fix some things Also, as some types are wrong (from the current docs) you can take a look at this models I made for my client. They should use proper types (but I merged many Objects together). I only have one Series Object that can have all nullable attributes (As there are even more distinct series models returned by the api as it currently states for example): https://github.com/Vito0912/abs_flutter/tree/main/lib/api |
|
Just scraped the docs:
Generators that support
And I can say that |
|
@Vito0912 you are right swift is also an problem with oneOf and others |
|
@unl0ck I made a complete (excluding the LibraryitemController - As it should be near to impossible to do that as multiple specs fit in eachother) spec in the Discord. It has it's own issues though and will not replace the current version. This does not fix the oneOf problem though. But there should be some API changes in the future |
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.