Forgot to join deps
This commit is contained in:
75
api-customer/api-resources/auth-components/docs/AuthApi.md
Normal file
75
api-customer/api-resources/auth-components/docs/AuthApi.md
Normal file
@@ -0,0 +1,75 @@
|
||||
# board_mate.auth.AuthApi
|
||||
|
||||
All URIs are relative to *https://boardmate_api*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**login**](AuthApi.md#login) | **POST** /authenticate | POST authenticate
|
||||
|
||||
|
||||
# **login**
|
||||
> ResponseBodyAuthResponseDto login(auth_request_dto)
|
||||
|
||||
POST authenticate
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import time
|
||||
import os
|
||||
import board_mate.auth
|
||||
from board_mate.auth.models.auth_request_dto import AuthRequestDto
|
||||
from board_mate.auth.models.response_body_auth_response_dto import ResponseBodyAuthResponseDto
|
||||
from board_mate.auth.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 = board_mate.auth.Configuration(
|
||||
host = "https://boardmate_api"
|
||||
)
|
||||
|
||||
|
||||
# Enter a context with an instance of the API client
|
||||
with board_mate.auth.ApiClient(configuration) as api_client:
|
||||
# Create an instance of the API class
|
||||
api_instance = board_mate.auth.AuthApi(api_client)
|
||||
auth_request_dto = board_mate.auth.AuthRequestDto() # AuthRequestDto |
|
||||
|
||||
try:
|
||||
# POST authenticate
|
||||
api_response = api_instance.login(auth_request_dto)
|
||||
print("The response of AuthApi->login:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling AuthApi->login: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**auth_request_dto** | [**AuthRequestDto**](AuthRequestDto.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ResponseBodyAuthResponseDto**](ResponseBodyAuthResponseDto.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)
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
# AuthRequestDto
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**username** | **str** | | [optional]
|
||||
**key** | **str** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from board_mate.auth.models.auth_request_dto import AuthRequestDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AuthRequestDto from a JSON string
|
||||
auth_request_dto_instance = AuthRequestDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print AuthRequestDto.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
auth_request_dto_dict = auth_request_dto_instance.to_dict()
|
||||
# create an instance of AuthRequestDto from a dict
|
||||
auth_request_dto_form_dict = auth_request_dto.from_dict(auth_request_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
# AuthResponseDto
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**client_id** | **str** | | [optional]
|
||||
**name** | **str** | | [optional]
|
||||
**username** | **str** | | [optional]
|
||||
**auth_token** | **str** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from board_mate.auth.models.auth_response_dto import AuthResponseDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of AuthResponseDto from a JSON string
|
||||
auth_response_dto_instance = AuthResponseDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print AuthResponseDto.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
auth_response_dto_dict = auth_response_dto_instance.to_dict()
|
||||
# create an instance of AuthResponseDto from a dict
|
||||
auth_response_dto_form_dict = auth_response_dto.from_dict(auth_response_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)
|
||||
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
# ResponseBodyAuthResponseDto
|
||||
|
||||
|
||||
## Properties
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**data** | **object** | | [optional]
|
||||
**message** | **str** | | [optional]
|
||||
**success** | **bool** | | [optional]
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from board_mate.auth.models.response_body_auth_response_dto import ResponseBodyAuthResponseDto
|
||||
|
||||
# TODO update the JSON string below
|
||||
json = "{}"
|
||||
# create an instance of ResponseBodyAuthResponseDto from a JSON string
|
||||
response_body_auth_response_dto_instance = ResponseBodyAuthResponseDto.from_json(json)
|
||||
# print the JSON string representation of the object
|
||||
print ResponseBodyAuthResponseDto.to_json()
|
||||
|
||||
# convert the object into a dict
|
||||
response_body_auth_response_dto_dict = response_body_auth_response_dto_instance.to_dict()
|
||||
# create an instance of ResponseBodyAuthResponseDto from a dict
|
||||
response_body_auth_response_dto_form_dict = response_body_auth_response_dto.from_dict(response_body_auth_response_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)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user