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,107 @@
# openapi-client
boardmate_api API
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python 3.7+
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
Then import the package:
```python
import openapi_client
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import openapi_client
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import time
import openapi_client
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 ApiException as e:
print("Exception when calling DefaultApi->create: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://boardmate_api*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**create**](docs/DefaultApi.md#create) | **POST** /client/create | POST client/create
## Documentation For Models
- [ClientDto](docs/ClientDto.md)
- [ResponseBodyString](docs/ResponseBodyString.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Endpoints do not require authorization.
## Author