mirror of
https://github.com/GlueOps/autoglue.git
synced 2026-02-13 12:50:05 +01:00
feat: adding background jobs, Dockerfile
This commit is contained in:
allanice001
156
sdk/go/docs/AnnotationsAPI.md
Normal file
156
sdk/go/docs/AnnotationsAPI.md
Normal file
@@ -0,0 +1,156 @@
|
||||
# \AnnotationsAPI
|
||||
|
||||
All URIs are relative to *http://localhost:8080/api/v1*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**GetAnnotation**](AnnotationsAPI.md#GetAnnotation) | **Get** /annotations/{id} | Get annotation by ID (org scoped)
|
||||
[**ListAnnotations**](AnnotationsAPI.md#ListAnnotations) | **Get** /annotations | List annotations (org scoped)
|
||||
|
||||
|
||||
|
||||
## GetAnnotation
|
||||
|
||||
> DtoAnnotationResponse GetAnnotation(ctx, id).XOrgID(xOrgID).Include(include).Execute()
|
||||
|
||||
Get annotation by ID (org scoped)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "github.com/glueops/autoglue-sdk-go"
|
||||
)
|
||||
|
||||
func main() {
|
||||
id := "id_example" // string | Annotation ID (UUID)
|
||||
xOrgID := "xOrgID_example" // string | Organization UUID (optional)
|
||||
include := "include_example" // string | Optional: node_pools (optional)
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.AnnotationsAPI.GetAnnotation(context.Background(), id).XOrgID(xOrgID).Include(include).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `AnnotationsAPI.GetAnnotation``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `GetAnnotation`: DtoAnnotationResponse
|
||||
fmt.Fprintf(os.Stdout, "Response from `AnnotationsAPI.GetAnnotation`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**id** | **string** | Annotation ID (UUID) |
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiGetAnnotationRequest struct via the builder pattern
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
**xOrgID** | **string** | Organization UUID |
|
||||
**include** | **string** | Optional: node_pools |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DtoAnnotationResponse**](DtoAnnotationResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### 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)
|
||||
|
||||
|
||||
## ListAnnotations
|
||||
|
||||
> []DtoAnnotationResponse ListAnnotations(ctx).XOrgID(xOrgID).Name(name).Value(value).Q(q).Execute()
|
||||
|
||||
List annotations (org scoped)
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "github.com/glueops/autoglue-sdk-go"
|
||||
)
|
||||
|
||||
func main() {
|
||||
xOrgID := "xOrgID_example" // string | Organization UUID (optional)
|
||||
name := "name_example" // string | Exact name (optional)
|
||||
value := "value_example" // string | Exact value (optional)
|
||||
q := "q_example" // string | name contains (case-insensitive) (optional)
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.AnnotationsAPI.ListAnnotations(context.Background()).XOrgID(xOrgID).Name(name).Value(value).Q(q).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `AnnotationsAPI.ListAnnotations``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `ListAnnotations`: []DtoAnnotationResponse
|
||||
fmt.Fprintf(os.Stdout, "Response from `AnnotationsAPI.ListAnnotations`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiListAnnotationsRequest struct via the builder pattern
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**xOrgID** | **string** | Organization UUID |
|
||||
**name** | **string** | Exact name |
|
||||
**value** | **string** | Exact value |
|
||||
**q** | **string** | name contains (case-insensitive) |
|
||||
|
||||
### Return type
|
||||
|
||||
[**[]DtoAnnotationResponse**](DtoAnnotationResponse.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[OrgKeyAuth](../README.md#OrgKeyAuth), [OrgSecretAuth](../README.md#OrgSecretAuth), [BearerAuth](../README.md#BearerAuth)
|
||||
|
||||
### 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)
|
||||
|
||||
186
sdk/go/docs/DtoAnnotationResponse.md
Normal file
186
sdk/go/docs/DtoAnnotationResponse.md
Normal file
@@ -0,0 +1,186 @@
|
||||
# DtoAnnotationResponse
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**CreatedAt** | Pointer to **string** | | [optional]
|
||||
**Id** | Pointer to **string** | | [optional]
|
||||
**Key** | Pointer to **string** | | [optional]
|
||||
**OrganizationId** | Pointer to **string** | | [optional]
|
||||
**UpdatedAt** | Pointer to **string** | | [optional]
|
||||
**Value** | Pointer to **string** | | [optional]
|
||||
|
||||
## Methods
|
||||
|
||||
### NewDtoAnnotationResponse
|
||||
|
||||
`func NewDtoAnnotationResponse() *DtoAnnotationResponse`
|
||||
|
||||
NewDtoAnnotationResponse instantiates a new DtoAnnotationResponse object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewDtoAnnotationResponseWithDefaults
|
||||
|
||||
`func NewDtoAnnotationResponseWithDefaults() *DtoAnnotationResponse`
|
||||
|
||||
NewDtoAnnotationResponseWithDefaults instantiates a new DtoAnnotationResponse object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetCreatedAt
|
||||
|
||||
`func (o *DtoAnnotationResponse) GetCreatedAt() string`
|
||||
|
||||
GetCreatedAt returns the CreatedAt field if non-nil, zero value otherwise.
|
||||
|
||||
### GetCreatedAtOk
|
||||
|
||||
`func (o *DtoAnnotationResponse) GetCreatedAtOk() (*string, bool)`
|
||||
|
||||
GetCreatedAtOk returns a tuple with the CreatedAt field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetCreatedAt
|
||||
|
||||
`func (o *DtoAnnotationResponse) SetCreatedAt(v string)`
|
||||
|
||||
SetCreatedAt sets CreatedAt field to given value.
|
||||
|
||||
### HasCreatedAt
|
||||
|
||||
`func (o *DtoAnnotationResponse) HasCreatedAt() bool`
|
||||
|
||||
HasCreatedAt returns a boolean if a field has been set.
|
||||
|
||||
### GetId
|
||||
|
||||
`func (o *DtoAnnotationResponse) GetId() string`
|
||||
|
||||
GetId returns the Id field if non-nil, zero value otherwise.
|
||||
|
||||
### GetIdOk
|
||||
|
||||
`func (o *DtoAnnotationResponse) GetIdOk() (*string, bool)`
|
||||
|
||||
GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetId
|
||||
|
||||
`func (o *DtoAnnotationResponse) SetId(v string)`
|
||||
|
||||
SetId sets Id field to given value.
|
||||
|
||||
### HasId
|
||||
|
||||
`func (o *DtoAnnotationResponse) HasId() bool`
|
||||
|
||||
HasId returns a boolean if a field has been set.
|
||||
|
||||
### GetKey
|
||||
|
||||
`func (o *DtoAnnotationResponse) GetKey() string`
|
||||
|
||||
GetKey returns the Key field if non-nil, zero value otherwise.
|
||||
|
||||
### GetKeyOk
|
||||
|
||||
`func (o *DtoAnnotationResponse) GetKeyOk() (*string, bool)`
|
||||
|
||||
GetKeyOk returns a tuple with the Key field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetKey
|
||||
|
||||
`func (o *DtoAnnotationResponse) SetKey(v string)`
|
||||
|
||||
SetKey sets Key field to given value.
|
||||
|
||||
### HasKey
|
||||
|
||||
`func (o *DtoAnnotationResponse) HasKey() bool`
|
||||
|
||||
HasKey returns a boolean if a field has been set.
|
||||
|
||||
### GetOrganizationId
|
||||
|
||||
`func (o *DtoAnnotationResponse) GetOrganizationId() string`
|
||||
|
||||
GetOrganizationId returns the OrganizationId field if non-nil, zero value otherwise.
|
||||
|
||||
### GetOrganizationIdOk
|
||||
|
||||
`func (o *DtoAnnotationResponse) GetOrganizationIdOk() (*string, bool)`
|
||||
|
||||
GetOrganizationIdOk returns a tuple with the OrganizationId field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetOrganizationId
|
||||
|
||||
`func (o *DtoAnnotationResponse) SetOrganizationId(v string)`
|
||||
|
||||
SetOrganizationId sets OrganizationId field to given value.
|
||||
|
||||
### HasOrganizationId
|
||||
|
||||
`func (o *DtoAnnotationResponse) HasOrganizationId() bool`
|
||||
|
||||
HasOrganizationId returns a boolean if a field has been set.
|
||||
|
||||
### GetUpdatedAt
|
||||
|
||||
`func (o *DtoAnnotationResponse) GetUpdatedAt() string`
|
||||
|
||||
GetUpdatedAt returns the UpdatedAt field if non-nil, zero value otherwise.
|
||||
|
||||
### GetUpdatedAtOk
|
||||
|
||||
`func (o *DtoAnnotationResponse) GetUpdatedAtOk() (*string, bool)`
|
||||
|
||||
GetUpdatedAtOk returns a tuple with the UpdatedAt field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetUpdatedAt
|
||||
|
||||
`func (o *DtoAnnotationResponse) SetUpdatedAt(v string)`
|
||||
|
||||
SetUpdatedAt sets UpdatedAt field to given value.
|
||||
|
||||
### HasUpdatedAt
|
||||
|
||||
`func (o *DtoAnnotationResponse) HasUpdatedAt() bool`
|
||||
|
||||
HasUpdatedAt returns a boolean if a field has been set.
|
||||
|
||||
### GetValue
|
||||
|
||||
`func (o *DtoAnnotationResponse) GetValue() string`
|
||||
|
||||
GetValue returns the Value field if non-nil, zero value otherwise.
|
||||
|
||||
### GetValueOk
|
||||
|
||||
`func (o *DtoAnnotationResponse) GetValueOk() (*string, bool)`
|
||||
|
||||
GetValueOk returns a tuple with the Value field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetValue
|
||||
|
||||
`func (o *DtoAnnotationResponse) SetValue(v string)`
|
||||
|
||||
SetValue sets Value field to given value.
|
||||
|
||||
### HasValue
|
||||
|
||||
`func (o *DtoAnnotationResponse) HasValue() bool`
|
||||
|
||||
HasValue returns a boolean if a field has been set.
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
56
sdk/go/docs/HandlersHealthStatus.md
Normal file
56
sdk/go/docs/HandlersHealthStatus.md
Normal file
@@ -0,0 +1,56 @@
|
||||
# HandlersHealthStatus
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Status** | Pointer to **string** | | [optional]
|
||||
|
||||
## Methods
|
||||
|
||||
### NewHandlersHealthStatus
|
||||
|
||||
`func NewHandlersHealthStatus() *HandlersHealthStatus`
|
||||
|
||||
NewHandlersHealthStatus instantiates a new HandlersHealthStatus object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewHandlersHealthStatusWithDefaults
|
||||
|
||||
`func NewHandlersHealthStatusWithDefaults() *HandlersHealthStatus`
|
||||
|
||||
NewHandlersHealthStatusWithDefaults instantiates a new HandlersHealthStatus object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetStatus
|
||||
|
||||
`func (o *HandlersHealthStatus) GetStatus() string`
|
||||
|
||||
GetStatus returns the Status field if non-nil, zero value otherwise.
|
||||
|
||||
### GetStatusOk
|
||||
|
||||
`func (o *HandlersHealthStatus) GetStatusOk() (*string, bool)`
|
||||
|
||||
GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetStatus
|
||||
|
||||
`func (o *HandlersHealthStatus) SetStatus(v string)`
|
||||
|
||||
SetStatus sets Status field to given value.
|
||||
|
||||
### HasStatus
|
||||
|
||||
`func (o *HandlersHealthStatus) HasStatus() bool`
|
||||
|
||||
HasStatus returns a boolean if a field has been set.
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
70
sdk/go/docs/HealthAPI.md
Normal file
70
sdk/go/docs/HealthAPI.md
Normal file
@@ -0,0 +1,70 @@
|
||||
# \HealthAPI
|
||||
|
||||
All URIs are relative to *http://localhost:8080/api/v1*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**HealthCheckOperationId**](HealthAPI.md#HealthCheckOperationId) | **Get** /healthz | Basic health check
|
||||
|
||||
|
||||
|
||||
## HealthCheckOperationId
|
||||
|
||||
> HandlersHealthStatus HealthCheckOperationId(ctx).Execute()
|
||||
|
||||
Basic health check
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "github.com/glueops/autoglue-sdk-go"
|
||||
)
|
||||
|
||||
func main() {
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.HealthAPI.HealthCheckOperationId(context.Background()).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `HealthAPI.HealthCheckOperationId``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `HealthCheckOperationId`: HandlersHealthStatus
|
||||
fmt.Fprintf(os.Stdout, "Response from `HealthAPI.HealthCheckOperationId`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiHealthCheckOperationIdRequest struct via the builder pattern
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
[**HandlersHealthStatus**](HandlersHealthStatus.md)
|
||||
|
||||
### 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