From 539ea6a7d80b38d117b984e2e4bc905757fe446d Mon Sep 17 00:00:00 2001 From: semantic-release-bot Date: Thu, 20 Aug 2020 02:52:46 +0000 Subject: [PATCH] chore(release): 0.57.0 [skip ci] # [0.57.0](https://github.com/gotson/komga/compare/v0.56.1...v0.57.0) (2020-08-20) ### Features * **webui:** read lists ([27edf17](https://github.com/gotson/komga/commit/27edf17424ff7a53ccfb272b877cf452c95f1158)), closes [#106](https://github.com/gotson/komga/issues/106) * read lists ([f0c864f](https://github.com/gotson/komga/commit/f0c864f4eba8c70bdac8f92171bfb03edabcea53)), closes [#106](https://github.com/gotson/komga/issues/106) --- CHANGELOG.md | 8 + gradle.properties | 2 +- komga/docs/openapi.json | 592 ++++++++++++++++++++++++++++++++++++---- 3 files changed, 544 insertions(+), 58 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7dc1c32ac..670585876 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,11 @@ +# [0.57.0](https://github.com/gotson/komga/compare/v0.56.1...v0.57.0) (2020-08-20) + + +### Features + +* **webui:** read lists ([27edf17](https://github.com/gotson/komga/commit/27edf17424ff7a53ccfb272b877cf452c95f1158)), closes [#106](https://github.com/gotson/komga/issues/106) +* read lists ([f0c864f](https://github.com/gotson/komga/commit/f0c864f4eba8c70bdac8f92171bfb03edabcea53)), closes [#106](https://github.com/gotson/komga/issues/106) + ## [0.56.1](https://github.com/gotson/komga/compare/v0.56.0...v0.56.1) (2020-08-16) diff --git a/gradle.properties b/gradle.properties index 524339a0c..65745eeed 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1 +1 @@ -version=0.56.1 +version=0.57.0 diff --git a/komga/docs/openapi.json b/komga/docs/openapi.json index 63f36dfb1..fb2ebb11e 100644 --- a/komga/docs/openapi.json +++ b/komga/docs/openapi.json @@ -144,6 +144,20 @@ } } }, + "ReadListUpdateDto": { + "type": "object", + "properties": { + "bookIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "name": { + "type": "string" + } + } + }, "OpdsEntry": { "type": "object", "properties": { @@ -383,6 +397,9 @@ "importEpubSeries": { "type": "boolean" }, + "importComicInfoReadList": { + "type": "boolean" + }, "importComicInfoSeries": { "type": "boolean" }, @@ -418,6 +435,9 @@ "importEpubSeries": { "type": "boolean" }, + "importComicInfoReadList": { + "type": "boolean" + }, "importComicInfoSeries": { "type": "boolean" }, @@ -638,6 +658,34 @@ } } }, + "ReadListDto": { + "type": "object", + "properties": { + "createdDate": { + "format": "date-time", + "type": "string" + }, + "filtered": { + "type": "boolean" + }, + "bookIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "lastModifiedDate": { + "format": "date-time", + "type": "string" + }, + "name": { + "type": "string" + }, + "id": { + "type": "string" + } + } + }, "CollectionDto": { "type": "object", "properties": { @@ -682,6 +730,52 @@ } } }, + "PageReadListDto": { + "type": "object", + "properties": { + "number": { + "format": "int32", + "type": "integer" + }, + "last": { + "type": "boolean" + }, + "numberOfElements": { + "format": "int32", + "type": "integer" + }, + "size": { + "format": "int32", + "type": "integer" + }, + "totalPages": { + "format": "int32", + "type": "integer" + }, + "pageable": { + "$ref": "#/components/schemas/Pageable" + }, + "sort": { + "$ref": "#/components/schemas/Sort" + }, + "first": { + "type": "boolean" + }, + "content": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ReadListDto" + } + }, + "totalElements": { + "format": "int64", + "type": "integer" + }, + "empty": { + "type": "boolean" + } + } + }, "UserCreationDto": { "type": "object", "required": [ @@ -753,6 +847,24 @@ } } }, + "ReadListCreationDto": { + "type": "object", + "required": [ + "bookIds", + "name" + ], + "properties": { + "bookIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "name": { + "type": "string" + } + } + }, "LibraryCreationDto": { "type": "object", "required": [ @@ -763,6 +875,9 @@ "importEpubSeries": { "type": "boolean" }, + "importComicInfoReadList": { + "type": "boolean" + }, "importComicInfoSeries": { "type": "boolean" }, @@ -1038,36 +1153,6 @@ ], "openapi": "3.0.1", "paths": { - "/opds/v1.2/search": { - "get": { - "operationId": "getSearch", - "responses": { - "200": { - "description": "OK", - "content": { - "application/xml": { - "schema": { - "$ref": "#/components/schemas/OpenSearchDescription" - } - }, - "application/atom+xml": { - "schema": { - "$ref": "#/components/schemas/OpenSearchDescription" - } - }, - "text/xml": { - "schema": { - "$ref": "#/components/schemas/OpenSearchDescription" - } - } - } - } - }, - "tags": [ - "opds-controller" - ] - } - }, "/opds/v1.2/series/latest": { "get": { "operationId": "getLatestSeries_1", @@ -1098,6 +1183,36 @@ ] } }, + "/opds/v1.2/search": { + "get": { + "operationId": "getSearch", + "responses": { + "200": { + "description": "OK", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/OpenSearchDescription" + } + }, + "application/atom+xml": { + "schema": { + "$ref": "#/components/schemas/OpenSearchDescription" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/OpenSearchDescription" + } + } + } + } + }, + "tags": [ + "opds-controller" + ] + } + }, "/api/v1/books/{bookId}/next": { "get": { "operationId": "getBookSiblingNext", @@ -1369,6 +1484,36 @@ ] } }, + "/opds/v1.2/readlists": { + "get": { + "operationId": "getReadLists", + "responses": { + "200": { + "description": "OK", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/OpdsFeed" + } + }, + "application/atom+xml": { + "schema": { + "$ref": "#/components/schemas/OpdsFeed" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/OpdsFeed" + } + } + } + } + }, + "tags": [ + "opds-controller" + ] + } + }, "/api/v1/libraries/{libraryId}": { "get": { "operationId": "getOne", @@ -1813,7 +1958,7 @@ }, "required": true }, - "operationId": "addOne_2", + "operationId": "addOne_3", "responses": { "201": { "description": "Created", @@ -1831,7 +1976,7 @@ ] }, "get": { - "operationId": "getAll_2", + "operationId": "getAll_3", "responses": { "200": { "description": "OK", @@ -2245,6 +2390,46 @@ ] } }, + "/opds/v1.2/readlists/{id}": { + "get": { + "operationId": "getOneReadList", + "responses": { + "200": { + "description": "OK", + "content": { + "application/xml": { + "schema": { + "$ref": "#/components/schemas/OpdsFeed" + } + }, + "application/atom+xml": { + "schema": { + "$ref": "#/components/schemas/OpdsFeed" + } + }, + "text/xml": { + "schema": { + "$ref": "#/components/schemas/OpdsFeed" + } + } + } + } + }, + "parameters": [ + { + "schema": { + "type": "string" + }, + "in": "path", + "name": "id", + "required": true + } + ], + "tags": [ + "opds-controller" + ] + } + }, "/api/v1/libraries/{libraryId}/scan": { "post": { "operationId": "scan", @@ -2298,6 +2483,70 @@ ] } }, + "/api/v1/books/{bookId}/readlists": { + "get": { + "operationId": "getAllReadListsByBook", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ReadListDto" + } + } + } + } + } + }, + "parameters": [ + { + "schema": { + "type": "string" + }, + "in": "path", + "name": "bookId", + "required": true + } + ], + "tags": [ + "book-controller" + ] + } + }, + "/api/v1/readlists/{id}/thumbnail": { + "get": { + "operationId": "getReadListThumbnail", + "responses": { + "default": { + "description": "default response", + "content": { + "image/jpeg": { + "schema": { + "format": "binary", + "type": "string" + } + } + } + } + }, + "parameters": [ + { + "schema": { + "type": "string" + }, + "in": "path", + "name": "id", + "required": true + } + ], + "tags": [ + "read-list-controller" + ] + } + }, "/opds/v1.2/series": { "get": { "operationId": "getAllSeries_1", @@ -2692,6 +2941,99 @@ ] } }, + "/api/v1/readlists": { + "post": { + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReadListCreationDto" + } + } + }, + "required": true + }, + "operationId": "addOne_2", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReadListDto" + } + } + } + } + }, + "tags": [ + "read-list-controller" + ] + }, + "get": { + "operationId": "getAll_2", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PageReadListDto" + } + } + } + } + }, + "parameters": [ + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "search", + "required": false + }, + { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "in": "query", + "name": "library_id", + "required": false + }, + { + "schema": { + "type": "boolean" + }, + "in": "query", + "name": "unpaged", + "required": false + }, + { + "schema": { + "type": "integer" + }, + "in": "query", + "name": "page", + "description": "Zero-based page index (0..N)" + }, + { + "schema": { + "type": "integer" + }, + "in": "query", + "name": "size", + "description": "The size of the page to be returned" + } + ], + "tags": [ + "read-list-controller" + ] + } + }, "/api/v1/books": { "get": { "operationId": "getAllBooks", @@ -3034,6 +3376,88 @@ ] } }, + "/api/v1/readlists/{id}": { + "patch": { + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReadListUpdateDto" + } + } + }, + "required": true + }, + "operationId": "updateOne_2", + "responses": { + "204": { + "description": "No Content" + } + }, + "parameters": [ + { + "schema": { + "type": "string" + }, + "in": "path", + "name": "id", + "required": true + } + ], + "tags": [ + "read-list-controller" + ] + }, + "get": { + "operationId": "getOne_2", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReadListDto" + } + } + } + } + }, + "parameters": [ + { + "schema": { + "type": "string" + }, + "in": "path", + "name": "id", + "required": true + } + ], + "tags": [ + "read-list-controller" + ] + }, + "delete": { + "operationId": "deleteOne_2", + "responses": { + "204": { + "description": "No Content" + } + }, + "parameters": [ + { + "schema": { + "type": "string" + }, + "in": "path", + "name": "id", + "required": true + } + ], + "tags": [ + "read-list-controller" + ] + } + }, "/api/v1/filesystem": { "post": { "requestBody": { @@ -3191,6 +3615,60 @@ ] } }, + "/api/v1/readlists/{id}/books": { + "get": { + "operationId": "getBooksForReadList", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PageBookDto" + } + } + } + } + }, + "parameters": [ + { + "schema": { + "type": "string" + }, + "in": "path", + "name": "id", + "required": true + }, + { + "schema": { + "type": "boolean" + }, + "in": "query", + "name": "unpaged", + "required": false + }, + { + "schema": { + "type": "integer" + }, + "in": "query", + "name": "page", + "description": "Zero-based page index (0..N)" + }, + { + "schema": { + "type": "integer" + }, + "in": "query", + "name": "size", + "description": "The size of the page to be returned" + } + ], + "tags": [ + "read-list-controller" + ] + } + }, "/api/v1/authors": { "get": { "operationId": "getAuthors", @@ -3265,19 +3743,22 @@ ] } }, - "/api/v1/books/{bookId}": { - "get": { - "operationId": "getOneBook", - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BookDto" - } + "/api/v1/books/{bookId}/metadata": { + "patch": { + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BookMetadataUpdateDto" } } + }, + "required": true + }, + "operationId": "updateMetadata", + "responses": { + "204": { + "description": "No Content" } }, "parameters": [ @@ -3295,22 +3776,19 @@ ] } }, - "/api/v1/books/{bookId}/metadata": { - "patch": { - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BookMetadataUpdateDto" + "/api/v1/books/{bookId}": { + "get": { + "operationId": "getOneBook", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BookDto" + } } } - }, - "required": true - }, - "operationId": "updateMetadata", - "responses": { - "204": { - "description": "No Content" } }, "parameters": [