mirror of
https://github.com/advplyr/audiobookshelf.git
synced 2026-05-30 23:40:40 +02:00
[PR #3094] [CLOSED] Openapi middleware validation #3861
Assignees
adam (Adam Melkus)
Clear assignees
adam (Adam Melkus)
No Assignees
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: starred/audiobookshelf#3861
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
📋 Pull Request Information
Original PR: https://github.com/advplyr/audiobookshelf/pull/3094
Author: @nichwall
Created: 6/22/2024
Status: ❌ Closed
Base:
master← Head:openapi_middleware_validation_2📝 Commits (10+)
89685b6Add:express-openapi-validatorto package file327ddd8Initial OpenApiValidator middleware0a4d24fAdd:formatandunknownFormatsf5d7a71Fix: allow comma in Author query62fbae6Revert "Add:express-openapi-validatorto package file"0122f88Add:express-openapi-validatorto dev dependenciesac4bd0aChange: OpenApiValidator to only be created in dev7613580Update spec path inServer.js86cb504Update bundled specfaa3147Update: some library parameters📊 Changes
7 files changed (+902 additions, -266 deletions)
View changed files
📝
docs/controllers/AuthorController.yaml(+19 -11)📝
docs/controllers/LibraryController.yaml(+94 -71)📝
docs/openapi.json(+307 -181)📝
docs/schemas.yaml(+9 -0)📝
package-lock.json(+438 -3)📝
package.json(+1 -0)📝
server/Server.js(+34 -0)📄 Description
This PR adds
openapi-openapi-validatorto compare API requests and responses against the OpenAPI specification located indocs. I am only adding this as a dev dependency because if the request/response does not match the spec, the web client may render incorrectly (I ran into issues with the "edit library item" modal sometimes presenting a blank tab when the spec was not met).An example of errors given to help identify how a request or response does not match the spec:
This PR also updates some of the
requestBodytoparametersand creates some genericparameters in response to changes made in https://github.com/advplyr/audiobookshelf/commit/d6438590d7010e9e9f512ecfdbf4cd7f0d149407🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.