init
This commit is contained in:
206
openapi/docs/CardAPI.md
Normal file
206
openapi/docs/CardAPI.md
Normal file
@@ -0,0 +1,206 @@
|
||||
# \CardAPI
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**AddCardCardsGroupIdPost**](CardAPI.md#AddCardCardsGroupIdPost) | **Post** /cards/{group_id} | Add Card
|
||||
[**DelCardCardsDeleteGet**](CardAPI.md#DelCardCardsDeleteGet) | **Get** /cards/delete | Del Card
|
||||
[**GetCardsCardsGroupIdGet**](CardAPI.md#GetCardsCardsGroupIdGet) | **Get** /cards/{group_id} | Get Cards
|
||||
|
||||
|
||||
|
||||
## AddCardCardsGroupIdPost
|
||||
|
||||
> Card AddCardCardsGroupIdPost(ctx, groupId).Execute()
|
||||
|
||||
Add Card
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
|
||||
)
|
||||
|
||||
func main() {
|
||||
groupId := int32(56) // int32 |
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.CardAPI.AddCardCardsGroupIdPost(context.Background(), groupId).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `CardAPI.AddCardCardsGroupIdPost``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `AddCardCardsGroupIdPost`: Card
|
||||
fmt.Fprintf(os.Stdout, "Response from `CardAPI.AddCardCardsGroupIdPost`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**groupId** | **int32** | |
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiAddCardCardsGroupIdPostRequest struct via the builder pattern
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
[**Card**](Card.md)
|
||||
|
||||
### 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)
|
||||
|
||||
|
||||
## DelCardCardsDeleteGet
|
||||
|
||||
> interface{} DelCardCardsDeleteGet(ctx).Execute()
|
||||
|
||||
Del Card
|
||||
|
||||
### 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.CardAPI.DelCardCardsDeleteGet(context.Background()).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `CardAPI.DelCardCardsDeleteGet``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `DelCardCardsDeleteGet`: interface{}
|
||||
fmt.Fprintf(os.Stdout, "Response from `CardAPI.DelCardCardsDeleteGet`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiDelCardCardsDeleteGetRequest 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)
|
||||
|
||||
|
||||
## GetCardsCardsGroupIdGet
|
||||
|
||||
> []Card GetCardsCardsGroupIdGet(ctx, groupId).Execute()
|
||||
|
||||
Get Cards
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
|
||||
)
|
||||
|
||||
func main() {
|
||||
groupId := int32(56) // int32 |
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.CardAPI.GetCardsCardsGroupIdGet(context.Background(), groupId).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `CardAPI.GetCardsCardsGroupIdGet``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `GetCardsCardsGroupIdGet`: []Card
|
||||
fmt.Fprintf(os.Stdout, "Response from `CardAPI.GetCardsCardsGroupIdGet`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**groupId** | **int32** | |
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiGetCardsCardsGroupIdGetRequest struct via the builder pattern
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
[**[]Card**](Card.md)
|
||||
|
||||
### 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)
|
||||
|
||||
Reference in New Issue
Block a user