azisaba-graph 0.1.0-rc.16

An API for connecting and sharing data across the Azisaba Network.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

# \CrawlsApi

All URIs are relative to *https://graph.azisaba.net*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_crawl**](CrawlsApi.md#create_crawl) | **POST** /crawls | Create crawl
[**delete_crawl_by_id**](CrawlsApi.md#delete_crawl_by_id) | **DELETE** /crawls/{crawlId} | Delete crawl
[**get_crawl_by_id**](CrawlsApi.md#get_crawl_by_id) | **GET** /crawls/{crawlId} | Get crawl
[**list_crawls**](CrawlsApi.md#list_crawls) | **GET** /crawls | List crawls



## create_crawl

> models::Crawl create_crawl(create_crawl_request)
Create crawl

Creates a new crawl.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_crawl_request** | [**CreateCrawlRequest**](CreateCrawlRequest.md) |  | [required] |

### Return type

[**models::Crawl**](Crawl.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_crawl_by_id

> delete_crawl_by_id(crawl_id)
Delete crawl

Deletes the crawl with the specified ID.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**crawl_id** | **uuid::Uuid** | The unique identifier of the crawl. | [required] |

### Return type

 (empty response body)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_crawl_by_id

> models::Crawl get_crawl_by_id(crawl_id)
Get crawl

Returns the crawl with the specified ID.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**crawl_id** | **uuid::Uuid** | The unique identifier of the crawl. | [required] |

### Return type

[**models::Crawl**](Crawl.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_crawls

> models::ListCrawls200Response list_crawls(limit, cursor, address, port, version, protocol_version, crawled_from, crawled_to)
List crawls

Returns a list of crawls.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**limit** | Option<**u8**> | The maximum number of crawls to return. |  |[default to 20]
**cursor** | Option<**String**> | The cursor returned by the previous request. |  |
**address** | Option<**String**> | The address used to filter crawls. |  |
**port** | Option<**u16**> | The port used to filter crawls. |  |
**version** | Option<**String**> | The version used to filter crawls. |  |
**protocol_version** | Option<**i32**> | The protocol version used to filter crawls. |  |
**crawled_from** | Option<**chrono::DateTime<chrono::FixedOffset>**> | The inclusive lower bound of the crawl date and time. |  |
**crawled_to** | Option<**chrono::DateTime<chrono::FixedOffset>**> | The exclusive upper bound of the crawl date and time. |  |

### Return type

[**models::ListCrawls200Response**](listCrawls_200_response.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth)

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)