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
140

# \PatchNotesApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_patch_note**](PatchNotesApi.md#create_patch_note) | **POST** /patch-notes | Create patch note
[**delete_patch_note_by_id**](PatchNotesApi.md#delete_patch_note_by_id) | **DELETE** /patch-notes/{patchNoteId} | Delete patch note
[**get_patch_note_by_id**](PatchNotesApi.md#get_patch_note_by_id) | **GET** /patch-notes/{patchNoteId} | Get patch note
[**list_patch_notes**](PatchNotesApi.md#list_patch_notes) | **GET** /patch-notes | List patch notes



## create_patch_note

> models::PatchNote create_patch_note(target, category, title, body, author_id, images)
Create patch note

Creates a new patch note.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**target** | **String** | The target of the patch note. | [required] |
**category** | **String** | The category of the patch note. | [required] |
**title** | **String** | The title of the patch note. | [required] |
**body** | **String** | The body text of the patch note. | [required] |
**author_id** | Option<**uuid::Uuid**> | The unique identifier of the player. |  |
**images** | Option<[**Vec<std::path::PathBuf>**](Std__path__PathBuf.md)> | JPEG, PNG, GIF, or WebP image files to attach to the patch note. |  |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: multipart/form-data
- **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_patch_note_by_id

> delete_patch_note_by_id(patch_note_id)
Delete patch note

Deletes the patch note with the specified ID.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**patch_note_id** | **uuid::Uuid** | The unique identifier of the patch note. | [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_patch_note_by_id

> models::PatchNote get_patch_note_by_id(patch_note_id)
Get patch note

Returns the patch note with the specified ID.

### Parameters


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

### Return type

[**models::PatchNote**](PatchNote.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_patch_notes

> models::ListPatchNotes200Response list_patch_notes(limit, cursor, target, category)
List patch notes

Returns a list of patch notes.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**limit** | Option<**u8**> | The maximum number of patch notes to return. |  |[default to 20]
**cursor** | Option<**String**> | The cursor returned by the previous request. |  |
**target** | Option<**String**> | The target used to filter patch notes. |  |
**category** | Option<**String**> | The category used to filter patch notes. |  |

### Return type

[**models::ListPatchNotes200Response**](listPatchNotes_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)