init
This commit is contained in:
193
openapi/docs/DoorAPI.md
Normal file
193
openapi/docs/DoorAPI.md
Normal file
@@ -0,0 +1,193 @@
|
||||
# \DoorAPI
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**OpenDoorDoorClosePut**](DoorAPI.md#OpenDoorDoorClosePut) | **Put** /door/close | Open Door
|
||||
[**OpenDoorDoorOpenPut**](DoorAPI.md#OpenDoorDoorOpenPut) | **Put** /door/open | Open Door
|
||||
[**TestAccessDoorTestPost**](DoorAPI.md#TestAccessDoorTestPost) | **Post** /door/test | Test Access
|
||||
|
||||
|
||||
|
||||
## OpenDoorDoorClosePut
|
||||
|
||||
> interface{} OpenDoorDoorClosePut(ctx).Execute()
|
||||
|
||||
Open Door
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
|
||||
)
|
||||
|
||||
func main() {
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.DoorAPI.OpenDoorDoorClosePut(context.Background()).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `DoorAPI.OpenDoorDoorClosePut``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `OpenDoorDoorClosePut`: interface{}
|
||||
fmt.Fprintf(os.Stdout, "Response from `DoorAPI.OpenDoorDoorClosePut`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiOpenDoorDoorClosePutRequest struct via the builder pattern
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**interface{}**
|
||||
|
||||
### Authorization
|
||||
|
||||
[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
|
||||
|
||||
### 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)
|
||||
|
||||
|
||||
## OpenDoorDoorOpenPut
|
||||
|
||||
> interface{} OpenDoorDoorOpenPut(ctx).Execute()
|
||||
|
||||
Open Door
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
|
||||
)
|
||||
|
||||
func main() {
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.DoorAPI.OpenDoorDoorOpenPut(context.Background()).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `DoorAPI.OpenDoorDoorOpenPut``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `OpenDoorDoorOpenPut`: interface{}
|
||||
fmt.Fprintf(os.Stdout, "Response from `DoorAPI.OpenDoorDoorOpenPut`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiOpenDoorDoorOpenPutRequest struct via the builder pattern
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**interface{}**
|
||||
|
||||
### Authorization
|
||||
|
||||
[OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
|
||||
|
||||
### 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)
|
||||
|
||||
|
||||
## TestAccessDoorTestPost
|
||||
|
||||
> interface{} TestAccessDoorTestPost(ctx).Input(input).Execute()
|
||||
|
||||
Test Access
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
|
||||
)
|
||||
|
||||
func main() {
|
||||
input := "input_example" // string |
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.DoorAPI.TestAccessDoorTestPost(context.Background()).Input(input).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `DoorAPI.TestAccessDoorTestPost``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `TestAccessDoorTestPost`: interface{}
|
||||
fmt.Fprintf(os.Stdout, "Response from `DoorAPI.TestAccessDoorTestPost`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiTestAccessDoorTestPostRequest struct via the builder pattern
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**input** | **string** | |
|
||||
|
||||
### Return type
|
||||
|
||||
**interface{}**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### 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)
|
||||
|
||||
Reference in New Issue
Block a user