Skip to content

BookApi.md

Latest commit

 

History

History
217 lines (115 loc) · 5.85 KB

BookApi.md

File metadata and controls

217 lines (115 loc) · 5.85 KB

\BookApi

All URIs are relative to http://localhost:8787

Method HTTP request Description
create_book POST /api/v1/book
delete_book DELETE /api/v1/book/{id}
get_book_by_id GET /api/v1/book/{id}
get_book_overview GET /api/v1/book/{id}/overview
list_book GET /api/v1/book
put_book_monitor PUT /api/v1/book/monitor
update_book PUT /api/v1/book/{id}

create_book

models::BookResource create_book(book_resource)

Parameters

Name Type Description Required Notes
book_resource Option<BookResource>

Return type

models::BookResource

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_book

delete_book(id, delete_files, add_import_list_exclusion)

Parameters

Name Type Description Required Notes
id i32 [required]
delete_files Option<bool> [default to false]
add_import_list_exclusion Option<bool> [default to false]

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_book_by_id

models::BookResource get_book_by_id(id)

Parameters

Name Type Description Required Notes
id i32 [required]

Return type

models::BookResource

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_book_overview

get_book_overview(id)

Parameters

Name Type Description Required Notes
id i32 [required]

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_book

Vecmodels::BookResource list_book(author_id, book_ids, title_slug, include_all_author_books)

Parameters

Name Type Description Required Notes
author_id Option<i32>
book_ids Option<Vec>
title_slug Option<String>
include_all_author_books Option<bool> [default to false]

Return type

Vecmodels::BookResource

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

put_book_monitor

put_book_monitor(books_monitored_resource)

Parameters

Name Type Description Required Notes
books_monitored_resource Option<BooksMonitoredResource>

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_book

models::BookResource update_book(id, book_resource)

Parameters

Name Type Description Required Notes
id String [required]
book_resource Option<BookResource>

Return type

models::BookResource

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]