Skip to content

IndexerApi.md

Latest commit

 

History

History
323 lines (168 loc) · 8.49 KB

IndexerApi.md

File metadata and controls

323 lines (168 loc) · 8.49 KB

\IndexerApi

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

Method HTTP request Description
create_indexer POST /api/v3/indexer
create_indexer_action_by_name POST /api/v3/indexer/action/{name}
delete_indexer DELETE /api/v3/indexer/{id}
delete_indexer_bulk DELETE /api/v3/indexer/bulk
get_indexer_by_id GET /api/v3/indexer/{id}
list_indexer GET /api/v3/indexer
list_indexer_schema GET /api/v3/indexer/schema
put_indexer_bulk PUT /api/v3/indexer/bulk
test_indexer POST /api/v3/indexer/test
testall_indexer POST /api/v3/indexer/testall
update_indexer PUT /api/v3/indexer/{id}

create_indexer

models::IndexerResource create_indexer(force_save, indexer_resource)

Parameters

Name Type Description Required Notes
force_save Option<bool> [default to false]
indexer_resource Option<IndexerResource>

Return type

models::IndexerResource

Authorization

apikey, X-Api-Key

HTTP request headers

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

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

create_indexer_action_by_name

create_indexer_action_by_name(name, indexer_resource)

Parameters

Name Type Description Required Notes
name String [required]
indexer_resource Option<IndexerResource>

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

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

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

delete_indexer

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

delete_indexer_bulk

delete_indexer_bulk(indexer_bulk_resource)

Parameters

Name Type Description Required Notes
indexer_bulk_resource Option<IndexerBulkResource>

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

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

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

get_indexer_by_id

models::IndexerResource get_indexer_by_id(id)

Parameters

Name Type Description Required Notes
id i32 [required]

Return type

models::IndexerResource

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_indexer

Vecmodels::IndexerResource list_indexer()

Parameters

This endpoint does not need any parameter.

Return type

Vecmodels::IndexerResource

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_indexer_schema

Vecmodels::IndexerResource list_indexer_schema()

Parameters

This endpoint does not need any parameter.

Return type

Vecmodels::IndexerResource

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]

put_indexer_bulk

models::IndexerResource put_indexer_bulk(indexer_bulk_resource)

Parameters

Name Type Description Required Notes
indexer_bulk_resource Option<IndexerBulkResource>

Return type

models::IndexerResource

Authorization

apikey, X-Api-Key

HTTP request headers

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

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

test_indexer

test_indexer(force_test, indexer_resource)

Parameters

Name Type Description Required Notes
force_test Option<bool> [default to false]
indexer_resource Option<IndexerResource>

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

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

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

testall_indexer

testall_indexer()

Parameters

This endpoint does not need any parameter.

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]

update_indexer

models::IndexerResource update_indexer(id, force_save, indexer_resource)

Parameters

Name Type Description Required Notes
id i32 [required]
force_save Option<bool> [default to false]
indexer_resource Option<IndexerResource>

Return type

models::IndexerResource

Authorization

apikey, X-Api-Key

HTTP request headers

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

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