1 stable release
| 1.9.2 | Jan 14, 2024 |
|---|
#318 in HTTP client
495KB
8K
SLoC
Rust API Client for OpenAPI
Description
Komga is a free and open source comics/mangas server. It allows you to host your own library and to read your comics on your favorite devices. These Rust Client bindings have been generated from the OpenAPI spec with only some minor changes to make it compile.
This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.
Overview
Komga offers 2 APIs: REST and OPDS.
Both APIs are secured using HTTP Basic Authentication.
- API version: v1.0
- Package version: v1.0
- Build package:
org.openapitools.codegen.languages.RustClientCodegen
Documentation for API Endpoints
All URIs are relative to http://localhost:25600
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AnnouncementControllerApi | get_announcements | GET /api/v1/announcements | |
| AnnouncementControllerApi | mark_announcements_read | PUT /api/v1/announcements | |
| BookControllerApi | add_user_uploaded_book_thumbnail | POST /api/v1/books/{bookId}/thumbnails | |
| BookControllerApi | analyze3 | POST /api/v1/books/{bookId}/analyze | |
| BookControllerApi | delete_book | DELETE /api/v1/books/{bookId}/file | |
| BookControllerApi | delete_read_progress | DELETE /api/v1/books/{bookId}/read-progress | |
| BookControllerApi | delete_user_uploaded_book_thumbnail | DELETE /api/v1/books/{bookId}/thumbnails/{thumbnailId} | |
| BookControllerApi | get_all_books | GET /api/v1/books | |
| BookControllerApi | get_all_read_lists_by_book | GET /api/v1/books/{bookId}/readlists | |
| BookControllerApi | get_book_file | GET /api/v1/books/{bookId}/file | |
| BookControllerApi | get_book_file1 | GET /api/v1/books/{bookId}/file/* | |
| BookControllerApi | get_book_page | GET /api/v1/books/{bookId}/pages/{pageNumber} | |
| BookControllerApi | get_book_page_raw | GET /api/v1/books/{bookId}/pages/{pageNumber}/raw | |
| BookControllerApi | get_book_page_thumbnail | GET /api/v1/books/{bookId}/pages/{pageNumber}/thumbnail | |
| BookControllerApi | get_book_pages | GET /api/v1/books/{bookId}/pages | |
| BookControllerApi | get_book_resource | GET /api/v1/books/{bookId}/resource/{resource} | |
| BookControllerApi | get_book_sibling_next1 | GET /api/v1/books/{bookId}/next | |
| BookControllerApi | get_book_sibling_previous1 | GET /api/v1/books/{bookId}/previous | |
| BookControllerApi | get_book_thumbnail | GET /api/v1/books/{bookId}/thumbnail | |
| BookControllerApi | get_book_thumbnail_by_id | GET /api/v1/books/{bookId}/thumbnails/{thumbnailId} | |
| BookControllerApi | get_book_thumbnails | GET /api/v1/books/{bookId}/thumbnails | |
| BookControllerApi | get_books_on_deck | GET /api/v1/books/ondeck | |
| BookControllerApi | get_duplicate_books | GET /api/v1/books/duplicates | |
| BookControllerApi | get_latest_books | GET /api/v1/books/latest | |
| BookControllerApi | get_one_book | GET /api/v1/books/{bookId} | |
| BookControllerApi | get_positions | GET /api/v1/books/{bookId}/positions | |
| BookControllerApi | get_progression | GET /api/v1/books/{bookId}/progression | |
| BookControllerApi | get_web_pub_manifest | GET /api/v1/books/{bookId}/manifest | |
| BookControllerApi | get_web_pub_manifest_divina | GET /api/v1/books/{bookId}/manifest/divina | |
| BookControllerApi | get_web_pub_manifest_epub | GET /api/v1/books/{bookId}/manifest/epub | |
| BookControllerApi | get_web_pub_manifest_pdf | GET /api/v1/books/{bookId}/manifest/pdf | |
| BookControllerApi | import_books | POST /api/v1/books/import | |
| BookControllerApi | mark_progression | PUT /api/v1/books/{bookId}/progression | |
| BookControllerApi | mark_read_progress | PATCH /api/v1/books/{bookId}/read-progress | |
| BookControllerApi | mark_selected_book_thumbnail | PUT /api/v1/books/{bookId}/thumbnails/{thumbnailId}/selected | |
| BookControllerApi | refresh_metadata2 | POST /api/v1/books/{bookId}/metadata/refresh | |
| BookControllerApi | regenerate_thumbnails | PUT /api/v1/books/thumbnails | |
| BookControllerApi | update_batch_metadata | PATCH /api/v1/books/metadata | |
| BookControllerApi | update_metadata1 | PATCH /api/v1/books/{bookId}/metadata | |
| ClaimControllerApi | claim_admin | POST /api/v1/claim | |
| ClaimControllerApi | get_claim_status | GET /api/v1/claim | |
| FileSystemControllerApi | get_directory_listing | POST /api/v1/filesystem | |
| HistoricalEventControllerApi | get_all3 | GET /api/v1/history | |
| LibraryControllerApi | add_one2 | POST /api/v1/libraries | |
| LibraryControllerApi | analyze2 | POST /api/v1/libraries/{libraryId}/analyze | |
| LibraryControllerApi | delete_one1 | DELETE /api/v1/libraries/{libraryId} | |
| LibraryControllerApi | empty_trash | POST /api/v1/libraries/{libraryId}/empty-trash | |
| LibraryControllerApi | get_all2 | GET /api/v1/libraries | |
| LibraryControllerApi | get_one1 | GET /api/v1/libraries/{libraryId} | |
| LibraryControllerApi | patch_one | PATCH /api/v1/libraries/{libraryId} | |
| LibraryControllerApi | refresh_metadata1 | POST /api/v1/libraries/{libraryId}/metadata/refresh | |
| LibraryControllerApi | scan | POST /api/v1/libraries/{libraryId}/scan | |
| LibraryControllerApi | update_one | PUT /api/v1/libraries/{libraryId} | |
| LoginControllerApi | header_to_cookie | GET /api/v1/login/set-cookie | |
| OAuth2ControllerApi | get_providers | GET /api/v1/oauth2/providers | |
| OAuth2ControllerApi | get_providers1 | HEAD /api/v1/oauth2/providers | |
| OAuth2ControllerApi | get_providers2 | POST /api/v1/oauth2/providers | |
| OAuth2ControllerApi | get_providers3 | PUT /api/v1/oauth2/providers | |
| OAuth2ControllerApi | get_providers4 | PATCH /api/v1/oauth2/providers | |
| OAuth2ControllerApi | get_providers5 | DELETE /api/v1/oauth2/providers | |
| OAuth2ControllerApi | get_providers6 | OPTIONS /api/v1/oauth2/providers | |
| PageHashControllerApi | create_or_update_known_page_hash | PUT /api/v1/page-hashes | |
| PageHashControllerApi | delete_single_match | POST /api/v1/page-hashes/{pageHash}/delete-match | |
| PageHashControllerApi | get_known_page_hash_thumbnail | GET /api/v1/page-hashes/{pageHash}/thumbnail | |
| PageHashControllerApi | get_known_page_hashes | GET /api/v1/page-hashes | |
| PageHashControllerApi | get_page_hash_matches | GET /api/v1/page-hashes/{pageHash} | |
| PageHashControllerApi | get_unknown_page_hash_thumbnail | GET /api/v1/page-hashes/unknown/{pageHash}/thumbnail | |
| PageHashControllerApi | get_unknown_page_hashes | GET /api/v1/page-hashes/unknown | |
| PageHashControllerApi | perform_delete | POST /api/v1/page-hashes/{pageHash}/delete-all | |
| ReadListControllerApi | add_one1 | POST /api/v1/readlists | |
| ReadListControllerApi | add_user_uploaded_read_list_thumbnail | POST /api/v1/readlists/{id}/thumbnails | |
| ReadListControllerApi | delete_one | DELETE /api/v1/readlists/{id} | |
| ReadListControllerApi | delete_user_uploaded_read_list_thumbnail | DELETE /api/v1/readlists/{id}/thumbnails/{thumbnailId} | |
| ReadListControllerApi | get_all1 | GET /api/v1/readlists | |
| ReadListControllerApi | get_book_sibling_next | GET /api/v1/readlists/{id}/books/{bookId}/next | |
| ReadListControllerApi | get_book_sibling_previous | GET /api/v1/readlists/{id}/books/{bookId}/previous | |
| ReadListControllerApi | get_books_for_read_list | GET /api/v1/readlists/{id}/books | |
| ReadListControllerApi | get_one | GET /api/v1/readlists/{id} | |
| ReadListControllerApi | get_read_list_file | GET /api/v1/readlists/{id}/file | |
| ReadListControllerApi | get_read_list_thumbnail | GET /api/v1/readlists/{id}/thumbnail | |
| ReadListControllerApi | get_read_list_thumbnail_by_id | GET /api/v1/readlists/{id}/thumbnails/{thumbnailId} | |
| ReadListControllerApi | get_read_list_thumbnails | GET /api/v1/readlists/{id}/thumbnails | |
| ReadListControllerApi | get_read_progress | GET /api/v1/readlists/{id}/read-progress/tachiyomi | |
| ReadListControllerApi | mark_read_progress_tachiyomi | PUT /api/v1/readlists/{id}/read-progress/tachiyomi | |
| ReadListControllerApi | mark_selected_read_list_thumbnail | PUT /api/v1/readlists/{id}/thumbnails/{thumbnailId}/selected | |
| ReadListControllerApi | match_from_comic_rack_list | POST /api/v1/readlists/match/comicrack | |
| ReadListControllerApi | update_one1 | PATCH /api/v1/readlists/{id} | |
| ReferentialControllerApi | get_age_ratings | GET /api/v1/age-ratings | |
| ReferentialControllerApi | get_authors | GET /api/v2/authors | |
| ReferentialControllerApi | get_authors_names | GET /api/v1/authors/names | |
| ReferentialControllerApi | get_authors_roles | GET /api/v1/authors/roles | |
| ReferentialControllerApi | get_authors_v1 | GET /api/v1/authors | |
| ReferentialControllerApi | get_book_tags | GET /api/v1/tags/book | |
| ReferentialControllerApi | get_genres | GET /api/v1/genres | |
| ReferentialControllerApi | get_languages | GET /api/v1/languages | |
| ReferentialControllerApi | get_publishers | GET /api/v1/publishers | |
| ReferentialControllerApi | get_series_release_dates | GET /api/v1/series/release-dates | |
| ReferentialControllerApi | get_series_tags | GET /api/v1/tags/series | |
| ReferentialControllerApi | get_sharing_labels | GET /api/v1/sharing-labels | |
| ReferentialControllerApi | get_tags | GET /api/v1/tags | |
| SeriesCollectionControllerApi | add_one3 | POST /api/v1/collections | |
| SeriesCollectionControllerApi | add_user_uploaded_collection_thumbnail | POST /api/v1/collections/{id}/thumbnails | |
| SeriesCollectionControllerApi | delete_one2 | DELETE /api/v1/collections/{id} | |
| SeriesCollectionControllerApi | delete_user_uploaded_collection_thumbnail | DELETE /api/v1/collections/{id}/thumbnails/{thumbnailId} | |
| SeriesCollectionControllerApi | get_all4 | GET /api/v1/collections | |
| SeriesCollectionControllerApi | get_collection_thumbnail | GET /api/v1/collections/{id}/thumbnail | |
| SeriesCollectionControllerApi | get_collection_thumbnail_by_id | GET /api/v1/collections/{id}/thumbnails/{thumbnailId} | |
| SeriesCollectionControllerApi | get_collection_thumbnails | GET /api/v1/collections/{id}/thumbnails | |
| SeriesCollectionControllerApi | get_one2 | GET /api/v1/collections/{id} | |
| SeriesCollectionControllerApi | get_series_for_collection | GET /api/v1/collections/{id}/series | |
| SeriesCollectionControllerApi | mark_selected_collection_thumbnail | PUT /api/v1/collections/{id}/thumbnails/{thumbnailId}/selected | |
| SeriesCollectionControllerApi | update_one2 | PATCH /api/v1/collections/{id} | |
| SeriesControllerApi | analyze1 | POST /api/v1/series/{seriesId}/analyze | |
| SeriesControllerApi | delete_series | DELETE /api/v1/series/{seriesId}/file | |
| SeriesControllerApi | delete_user_uploaded_series_thumbnail | DELETE /api/v1/series/{seriesId}/thumbnails/{thumbnailId} | |
| SeriesControllerApi | get_all_books_by_series | GET /api/v1/series/{seriesId}/books | |
| SeriesControllerApi | get_all_collections_by_series | GET /api/v1/series/{seriesId}/collections | |
| SeriesControllerApi | get_all_series | GET /api/v1/series | |
| SeriesControllerApi | get_alphabetical_groups | GET /api/v1/series/alphabetical-groups | |
| SeriesControllerApi | get_latest_series | GET /api/v1/series/latest | |
| SeriesControllerApi | get_new_series | GET /api/v1/series/new | |
| SeriesControllerApi | get_one_series | GET /api/v1/series/{seriesId} | |
| SeriesControllerApi | get_read_progress_tachiyomi_v2 | GET /api/v2/series/{seriesId}/read-progress/tachiyomi | |
| SeriesControllerApi | get_series_default_thumbnail | GET /api/v1/series/{seriesId}/thumbnail | |
| SeriesControllerApi | get_series_file | GET /api/v1/series/{seriesId}/file | |
| SeriesControllerApi | get_series_thumbnail_by_id | GET /api/v1/series/{seriesId}/thumbnails/{thumbnailId} | |
| SeriesControllerApi | get_series_thumbnails | GET /api/v1/series/{seriesId}/thumbnails | |
| SeriesControllerApi | get_updated_series | GET /api/v1/series/updated | |
| SeriesControllerApi | mark_as_read | POST /api/v1/series/{seriesId}/read-progress | |
| SeriesControllerApi | mark_as_unread | DELETE /api/v1/series/{seriesId}/read-progress | |
| SeriesControllerApi | mark_read_progress_tachiyomi_v2 | PUT /api/v2/series/{seriesId}/read-progress/tachiyomi | |
| SeriesControllerApi | post_mark_selected_series_thumbnail | PUT /api/v1/series/{seriesId}/thumbnails/{thumbnailId}/selected | |
| SeriesControllerApi | post_user_uploaded_series_thumbnail | POST /api/v1/series/{seriesId}/thumbnails | |
| SeriesControllerApi | refresh_metadata | POST /api/v1/series/{seriesId}/metadata/refresh | |
| SeriesControllerApi | update_metadata | PATCH /api/v1/series/{seriesId}/metadata | |
| SettingsControllerApi | get_settings | GET /api/v1/settings | |
| SettingsControllerApi | update_settings | PATCH /api/v1/settings | |
| TaskControllerApi | empty_task_queue | DELETE /api/v1/tasks | |
| TransientBooksControllerApi | analyze | POST /api/v1/transient-books/{id}/analyze | |
| TransientBooksControllerApi | get_source_page | GET /api/v1/transient-books/{id}/pages/{pageNumber} | |
| TransientBooksControllerApi | scan_for_transient_books | POST /api/v1/transient-books | |
| UserControllerApi | add_one | POST /api/v2/users | |
| UserControllerApi | delete | DELETE /api/v2/users/{id} | |
| UserControllerApi | get_all | GET /api/v2/users | |
| UserControllerApi | get_authentication_activity | GET /api/v2/users/authentication-activity | |
| UserControllerApi | get_latest_authentication_activity_for_user | GET /api/v2/users/{id}/authentication-activity/latest | |
| UserControllerApi | get_me | GET /api/v2/users/me | |
| UserControllerApi | get_my_authentication_activity | GET /api/v2/users/me/authentication-activity | |
| UserControllerApi | update_my_password | PATCH /api/v2/users/me/password | |
| UserControllerApi | update_password | PATCH /api/v2/users/{id}/password | |
| UserControllerApi | update_user | PATCH /api/v2/users/{id} |
Documentation For Models
- AgeRestrictionDto
- AgeRestrictionUpdateDto
- AlternateTitleDto
- AlternateTitleUpdateDto
- AuthenticationActivityDto
- AuthorDto
- AuthorUpdateDto
- BookDto
- BookImportBatchDto
- BookImportDto
- BookMetadataAggregationDto
- BookMetadataDto
- BookMetadataUpdateDto
- ClaimStatus
- CollectionCreationDto
- CollectionDto
- CollectionUpdateDto
- DirectoryListingDto
- DirectoryRequestDto
- GroupCountDto
- HistoricalEventDto
- ItemDto
- JsonFeedDto
- KomgaExtensionDto
- LibraryCreationDto
- LibraryDto
- LibraryUpdateDto
- Location
- MediaDto
- MediaType
- OAuth2ClientDto
- PageAuthenticationActivityDto
- PageAuthorDto
- PageBookDto
- PageCollectionDto
- PageDto
- PageHashCreationDto
- PageHashKnownDto
- PageHashMatchDto
- PageHashUnknownDto
- PageHistoricalEventDto
- PagePageHashKnownDto
- PagePageHashMatchDto
- PagePageHashUnknownDto
- PageReadListDto
- PageSeriesDto
- PageableObject
- PasswordUpdateDto
- PathDto
- PostUserUploadedSeriesThumbnailRequest
- R2Device
- R2Locator
- R2Positions
- R2Progression
- ReadListCreationDto
- ReadListDto
- ReadListMatchDto
- ReadListRequestBookDto
- ReadListRequestBookMatchBookDto
- ReadListRequestBookMatchDto
- ReadListRequestBookMatchSeriesDto
- ReadListRequestBookMatchesDto
- ReadListRequestMatchDto
- ReadListUpdateDto
- ReadProgressDto
- ReadProgressUpdateDto
- ScanRequestDto
- SeriesDto
- SeriesMetadataDto
- SeriesMetadataUpdateDto
- SettingMultiSourceInteger
- SettingMultiSourceString
- SettingsDto
- SettingsUpdateDto
- SharedLibrariesUpdateDto
- SortObject
- TachiyomiReadProgressDto
- TachiyomiReadProgressUpdateDto
- TachiyomiReadProgressUpdateV2Dto
- TachiyomiReadProgressV2Dto
- Text
- ThumbnailBookDto
- ThumbnailReadListDto
- ThumbnailSeriesCollectionDto
- ThumbnailSeriesDto
- TransientBookDto
- UserCreationDto
- UserDto
- UserUpdateDto
- ValidationErrorResponse
- Violation
- WebLinkDto
- WebLinkUpdateDto
- WpBelongsToDto
- WpContributorDto
- WpLinkDto
- WpMetadataDto
- WpPublicationDto
To get access to the crate's generated documentation, use:
cargo doc --open
Author
Aaron Spiegel @spiegela
Dependencies
~5–16MB
~224K SLoC