Skip to content

Latest commit

 

History

History
298 lines (155 loc) · 7.13 KB

LibraryControllerApi.md

File metadata and controls

298 lines (155 loc) · 7.13 KB
Raw

\LibraryControllerApi

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

Method HTTP request Description
add_one2 POST /api/v1/libraries
analyze2 POST /api/v1/libraries/{libraryId}/analyze
delete_one1 DELETE /api/v1/libraries/{libraryId}
empty_trash POST /api/v1/libraries/{libraryId}/empty-trash
get_all2 GET /api/v1/libraries
get_one1 GET /api/v1/libraries/{libraryId}
patch_one PATCH /api/v1/libraries/{libraryId}
refresh_metadata1 POST /api/v1/libraries/{libraryId}/metadata/refresh
scan POST /api/v1/libraries/{libraryId}/scan
update_one PUT /api/v1/libraries/{libraryId}

add_one2

crate::models::LibraryDto add_one2(library_creation_dto)

Parameters

Name Type Description Required Notes
library_creation_dto LibraryCreationDto [required]

Return type

crate::models::LibraryDto

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: /, application/json

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

analyze2

analyze2(library_id)

Parameters

Name Type Description Required Notes
library_id String [required]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

delete_one1

delete_one1(library_id)

Parameters

Name Type Description Required Notes
library_id String [required]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

empty_trash

empty_trash(library_id)

Parameters

Name Type Description Required Notes
library_id String [required]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

get_all2

Veccrate::models::LibraryDto get_all2()

Parameters

This endpoint does not need any parameter.

Return type

Veccrate::models::LibraryDto

Authorization

No authorization required

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_one1

crate::models::LibraryDto get_one1(library_id)

Parameters

Name Type Description Required Notes
library_id String [required]

Return type

crate::models::LibraryDto

Authorization

No authorization required

HTTP request headers

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

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

patch_one

patch_one(library_id, library_update_dto)

Parameters

Name Type Description Required Notes
library_id String [required]
library_update_dto LibraryUpdateDto [required]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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

refresh_metadata1

refresh_metadata1(library_id)

Parameters

Name Type Description Required Notes
library_id String [required]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

scan

scan(library_id, deep)

Parameters

Name Type Description Required Notes
library_id String [required]
deep Option<bool>

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

update_one

update_one(library_id, library_update_dto)

Parameters

Name Type Description Required Notes
library_id String [required]
library_update_dto LibraryUpdateDto [required]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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