207 lines
5.2 KiB
Markdown
207 lines
5.2 KiB
Markdown
# \CardAPI
|
|
|
|
All URIs are relative to *http://localhost*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**AddCardApiV1CardsGroupIdPost**](CardAPI.md#AddCardApiV1CardsGroupIdPost) | **Post** /api/v1/cards/{group_id} | Add Card
|
|
[**DelCardApiV1CardsDeleteGet**](CardAPI.md#DelCardApiV1CardsDeleteGet) | **Get** /api/v1/cards/delete | Del Card
|
|
[**GetCardsApiV1CardsGroupIdGet**](CardAPI.md#GetCardsApiV1CardsGroupIdGet) | **Get** /api/v1/cards/{group_id} | Get Cards
|
|
|
|
|
|
|
|
## AddCardApiV1CardsGroupIdPost
|
|
|
|
> Card AddCardApiV1CardsGroupIdPost(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.AddCardApiV1CardsGroupIdPost(context.Background(), groupId).Execute()
|
|
if err != nil {
|
|
fmt.Fprintf(os.Stderr, "Error when calling `CardAPI.AddCardApiV1CardsGroupIdPost``: %v\n", err)
|
|
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
|
}
|
|
// response from `AddCardApiV1CardsGroupIdPost`: Card
|
|
fmt.Fprintf(os.Stdout, "Response from `CardAPI.AddCardApiV1CardsGroupIdPost`: %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 apiAddCardApiV1CardsGroupIdPostRequest 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)
|
|
|
|
|
|
## DelCardApiV1CardsDeleteGet
|
|
|
|
> interface{} DelCardApiV1CardsDeleteGet(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.DelCardApiV1CardsDeleteGet(context.Background()).Execute()
|
|
if err != nil {
|
|
fmt.Fprintf(os.Stderr, "Error when calling `CardAPI.DelCardApiV1CardsDeleteGet``: %v\n", err)
|
|
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
|
}
|
|
// response from `DelCardApiV1CardsDeleteGet`: interface{}
|
|
fmt.Fprintf(os.Stdout, "Response from `CardAPI.DelCardApiV1CardsDeleteGet`: %v\n", resp)
|
|
}
|
|
```
|
|
|
|
### Path Parameters
|
|
|
|
This endpoint does not need any parameter.
|
|
|
|
### Other Parameters
|
|
|
|
Other parameters are passed through a pointer to a apiDelCardApiV1CardsDeleteGetRequest 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)
|
|
|
|
|
|
## GetCardsApiV1CardsGroupIdGet
|
|
|
|
> []Card GetCardsApiV1CardsGroupIdGet(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.GetCardsApiV1CardsGroupIdGet(context.Background(), groupId).Execute()
|
|
if err != nil {
|
|
fmt.Fprintf(os.Stderr, "Error when calling `CardAPI.GetCardsApiV1CardsGroupIdGet``: %v\n", err)
|
|
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
|
}
|
|
// response from `GetCardsApiV1CardsGroupIdGet`: []Card
|
|
fmt.Fprintf(os.Stdout, "Response from `CardAPI.GetCardsApiV1CardsGroupIdGet`: %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 apiGetCardsApiV1CardsGroupIdGetRequest 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)
|
|
|