Add open api generated components

This commit is contained in:
2026-01-01 13:14:38 +01:00
parent 2e12d0fdb5
commit e1c60fb933
40 changed files with 3335 additions and 1 deletions

View File

@@ -0,0 +1,30 @@
# ClientDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | | [optional]
**username** | **str** | | [optional]
**key** | **str** | | [optional]
## Example
```python
from openapi_client.models.client_dto import ClientDto
# TODO update the JSON string below
json = "{}"
# create an instance of ClientDto from a JSON string
client_dto_instance = ClientDto.from_json(json)
# print the JSON string representation of the object
print ClientDto.to_json()
# convert the object into a dict
client_dto_dict = client_dto_instance.to_dict()
# create an instance of ClientDto from a dict
client_dto_form_dict = client_dto.from_dict(client_dto_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@@ -0,0 +1,75 @@
# openapi_client.DefaultApi
All URIs are relative to *https://boardmate_api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create**](DefaultApi.md#create) | **POST** /client/create | POST client/create
# **create**
> ResponseBodyString create(client_dto)
POST client/create
### Example
```python
import time
import os
import openapi_client
from openapi_client.models.client_dto import ClientDto
from openapi_client.models.response_body_string import ResponseBodyString
from openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://boardmate_api
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
host = "https://boardmate_api"
)
# 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.DefaultApi(api_client)
client_dto = openapi_client.ClientDto() # ClientDto |
try:
# POST client/create
api_response = api_instance.create(client_dto)
print("The response of DefaultApi->create:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling DefaultApi->create: %s\n" % e)
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**client_dto** | [**ClientDto**](ClientDto.md)| |
### Return type
[**ResponseBodyString**](ResponseBodyString.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: */*
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK | - |
[[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)

View File

@@ -0,0 +1,30 @@
# ResponseBodyString
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | **str** | | [optional]
**message** | **str** | | [optional]
**success** | **bool** | | [optional]
## Example
```python
from openapi_client.models.response_body_string import ResponseBodyString
# TODO update the JSON string below
json = "{}"
# create an instance of ResponseBodyString from a JSON string
response_body_string_instance = ResponseBodyString.from_json(json)
# print the JSON string representation of the object
print ResponseBodyString.to_json()
# convert the object into a dict
response_body_string_dict = response_body_string_instance.to_dict()
# create an instance of ResponseBodyString from a dict
response_body_string_form_dict = response_body_string.from_dict(response_body_string_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)