Skip to content

HistoryApi.md

Latest commit

 

History

History
139 lines (79 loc) · 4.33 KB

HistoryApi.md

File metadata and controls

139 lines (79 loc) · 4.33 KB
Raw

\HistoryApi

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

Method HTTP request Description
create_history_failed_by_id POST /api/v1/history/failed/{id}
get_history GET /api/v1/history
list_history_author GET /api/v1/history/author
list_history_since GET /api/v1/history/since

create_history_failed_by_id

create_history_failed_by_id(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]

get_history

models::HistoryResourcePagingResource get_history(page, page_size, sort_key, sort_direction, include_author, include_book, event_type, book_id, download_id)

Parameters

Name Type Description Required Notes
page Option<i32> [default to 1]
page_size Option<i32> [default to 10]
sort_key Option<String>
sort_direction Option<SortDirection>
include_author Option<bool>
include_book Option<bool>
event_type Option<Vec>
book_id Option<i32>
download_id Option<String>

Return type

models::HistoryResourcePagingResource

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]

list_history_author

Vecmodels::HistoryResource list_history_author(author_id, book_id, event_type, include_author, include_book)

Parameters

Name Type Description Required Notes
author_id Option<i32>
book_id Option<i32>
event_type Option<EntityHistoryEventType>
include_author Option<bool> [default to false]
include_book Option<bool> [default to false]

Return type

Vecmodels::HistoryResource

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]

list_history_since

Vecmodels::HistoryResource list_history_since(date, event_type, include_author, include_book)

Parameters

Name Type Description Required Notes
date Option<chrono::DateTimechrono::FixedOffset>
event_type Option<EntityHistoryEventType>
include_author Option<bool> [default to false]
include_book Option<bool> [default to false]

Return type

Vecmodels::HistoryResource

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]