214 lines
5.6 KiB
Markdown
214 lines
5.6 KiB
Markdown
# openapi_client.PatchnotesApi
|
|
|
|
All URIs are relative to *http://localhost*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**get_patchnotes**](PatchnotesApi.md#get_patchnotes) | **GET** /patchnotes |
|
|
[**patch_note_delete**](PatchnotesApi.md#patch_note_delete) | **DELETE** /patchnotes/{patchID} |
|
|
[**post_patchnotes**](PatchnotesApi.md#post_patchnotes) | **POST** /patchnotes |
|
|
|
|
|
|
# **get_patchnotes**
|
|
> List[PatchNotes] get_patchnotes(body)
|
|
|
|
|
|
|
|
returns list of all unseen Patch notes from the user
|
|
|
|
### Example
|
|
|
|
|
|
```python
|
|
import openapi_client
|
|
from openapi_client.models.patch_notes import PatchNotes
|
|
from openapi_client.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# Defining the host is optional and defaults to http://localhost
|
|
# See configuration.py for a list of all supported configuration parameters.
|
|
configuration = openapi_client.Configuration(
|
|
host = "http://localhost"
|
|
)
|
|
|
|
|
|
# Enter a context with an instance of the API client
|
|
with openapi_client.ApiClient(configuration) as api_client:
|
|
# Create an instance of the API class
|
|
api_instance = openapi_client.PatchnotesApi(api_client)
|
|
body = 'body_example' # str | last seen patchnote by the user
|
|
|
|
try:
|
|
api_response = api_instance.get_patchnotes(body)
|
|
print("The response of PatchnotesApi->get_patchnotes:\n")
|
|
pprint(api_response)
|
|
except Exception as e:
|
|
print("Exception when calling PatchnotesApi->get_patchnotes: %s\n" % e)
|
|
```
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**body** | **str**| last seen patchnote by the user |
|
|
|
|
### Return type
|
|
|
|
[**List[PatchNotes]**](PatchNotes.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
### HTTP response details
|
|
|
|
| Status code | Description | Response headers |
|
|
|-------------|-------------|------------------|
|
|
**200** | returns list of all unseen Patch notes from the user | - |
|
|
**404** | no Patch notes found | - |
|
|
**500** | Internal Server error, Failed to get Patch Notes | - |
|
|
|
|
[[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)
|
|
|
|
# **patch_note_delete**
|
|
> patch_note_delete(patch_id)
|
|
|
|
|
|
|
|
deletes one Patch note
|
|
|
|
### Example
|
|
|
|
|
|
```python
|
|
import openapi_client
|
|
from openapi_client.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# Defining the host is optional and defaults to http://localhost
|
|
# See configuration.py for a list of all supported configuration parameters.
|
|
configuration = openapi_client.Configuration(
|
|
host = "http://localhost"
|
|
)
|
|
|
|
|
|
# Enter a context with an instance of the API client
|
|
with openapi_client.ApiClient(configuration) as api_client:
|
|
# Create an instance of the API class
|
|
api_instance = openapi_client.PatchnotesApi(api_client)
|
|
patch_id = 'patch_id_example' # str |
|
|
|
|
try:
|
|
api_instance.patch_note_delete(patch_id)
|
|
except Exception as e:
|
|
print("Exception when calling PatchnotesApi->patch_note_delete: %s\n" % e)
|
|
```
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**patch_id** | **str**| |
|
|
|
|
### Return type
|
|
|
|
void (empty response body)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: Not defined
|
|
|
|
### HTTP response details
|
|
|
|
| Status code | Description | Response headers |
|
|
|-------------|-------------|------------------|
|
|
**200** | patch successfully deleted | - |
|
|
**404** | patch not found | - |
|
|
**500** | Internal Server Error, Patch not deleted | - |
|
|
|
|
[[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)
|
|
|
|
# **post_patchnotes**
|
|
> List[PatchNotes] post_patchnotes(patch_notes=patch_notes)
|
|
|
|
|
|
|
|
creates new Patch notes
|
|
|
|
### Example
|
|
|
|
|
|
```python
|
|
import openapi_client
|
|
from openapi_client.models.patch_notes import PatchNotes
|
|
from openapi_client.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# Defining the host is optional and defaults to http://localhost
|
|
# See configuration.py for a list of all supported configuration parameters.
|
|
configuration = openapi_client.Configuration(
|
|
host = "http://localhost"
|
|
)
|
|
|
|
|
|
# Enter a context with an instance of the API client
|
|
with openapi_client.ApiClient(configuration) as api_client:
|
|
# Create an instance of the API class
|
|
api_instance = openapi_client.PatchnotesApi(api_client)
|
|
patch_notes = openapi_client.PatchNotes() # PatchNotes | (optional)
|
|
|
|
try:
|
|
api_response = api_instance.post_patchnotes(patch_notes=patch_notes)
|
|
print("The response of PatchnotesApi->post_patchnotes:\n")
|
|
pprint(api_response)
|
|
except Exception as e:
|
|
print("Exception when calling PatchnotesApi->post_patchnotes: %s\n" % e)
|
|
```
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**patch_notes** | [**PatchNotes**](PatchNotes.md)| | [optional]
|
|
|
|
### Return type
|
|
|
|
[**List[PatchNotes]**](PatchNotes.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
### HTTP response details
|
|
|
|
| Status code | Description | Response headers |
|
|
|-------------|-------------|------------------|
|
|
**200** | game created | - |
|
|
|
|
[[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)
|
|
|