openapi

package module
v0.0.0-...-954519f Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 7, 2024 License: MIT Imports: 21 Imported by: 0

README

Go API client for openapi

API for managing feature flags.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.0.0
  • Package version: 1.0.0
  • Generator version: 7.8.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import openapi "github.com/GIT_USER_ID/GIT_REPO_ID"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value openapi.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), openapi.ContextServerIndex, 1)
Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value openapi.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), openapi.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using openapi.ContextOperationServerIndices and openapi.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), openapi.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), openapi.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.example.com/v1

Class Method HTTP request Description
APIKeysAPI ApiKeysNameDelete Delete /api-keys/{name} Delete an API key
APIKeysAPI ApiKeysNameRotatePost Post /api-keys/{name}/rotate Rotate an API key
APIKeysAPI ApiKeysPost Post /api-keys Create a new API key
FlagsAPI FlagsGet Get /flags Retrieve all feature flags
FlagsAPI FlagsKeyDelete Delete /flags/{key} Delete a feature flag
FlagsAPI FlagsKeyGet Get /flags/{key} Retrieve a single feature flag by key
FlagsAPI FlagsKeyPut Put /flags/{key} Update an existing feature flag
FlagsAPI FlagsPost Post /flags Create a new feature flag
HealthzAPI HealthzGet Get /healthz API healthcheck

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth
  • Type: API key
  • API key parameter name: X-API-KEY
  • Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: X-API-KEY and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		openapi.ContextAPIKeys,
		map[string]openapi.APIKey{
			"X-API-KEY": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	JsonCheck = regexp.MustCompile(`(?i:(?:application|text)/(?:[^;]+\+)?json)`)
	XmlCheck  = regexp.MustCompile(`(?i:(?:application|text)/(?:[^;]+\+)?xml)`)
)
View Source 
var (
	// ContextAPIKeys takes a string apikey as authentication for the request
	ContextAPIKeys = contextKey("apiKeys")

	// ContextServerIndex uses a server configuration from the index.
	ContextServerIndex = contextKey("serverIndex")

	// ContextOperationServerIndices uses a server configuration from the index mapping.
	ContextOperationServerIndices = contextKey("serverOperationIndices")

	// ContextServerVariables overrides a server configuration variables.
	ContextServerVariables = contextKey("serverVariables")

	// ContextOperationServerVariables overrides a server configuration variables using operation specific values.
	ContextOperationServerVariables = contextKey("serverOperationVariables")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

func IsNil 

func IsNil(i interface{}) bool

IsNil checks if an input is nil

func PtrBool 

func PtrBool(v bool) *bool

PtrBool is a helper routine that returns a pointer to given boolean value.

func PtrFloat32 

func PtrFloat32(v float32) *float32

PtrFloat32 is a helper routine that returns a pointer to given float value.

func PtrFloat64 

func PtrFloat64(v float64) *float64

PtrFloat64 is a helper routine that returns a pointer to given float value.

func PtrInt 

func PtrInt(v int) *int

PtrInt is a helper routine that returns a pointer to given integer value.

func PtrInt32 

func PtrInt32(v int32) *int32

PtrInt32 is a helper routine that returns a pointer to given integer value.

func PtrInt64 

func PtrInt64(v int64) *int64

PtrInt64 is a helper routine that returns a pointer to given integer value.

func PtrString 

func PtrString(v string) *string

PtrString is a helper routine that returns a pointer to given string value.

func PtrTime 

func PtrTime(v time.Time) *time.Time

PtrTime is helper routine that returns a pointer to given Time value.

Types

type APIClient 

type APIClient struct {
	APIKeysAPI *APIKeysAPIService

	FlagsAPI *FlagsAPIService

	HealthzAPI *HealthzAPIService
	// contains filtered or unexported fields
}

APIClient manages communication with the Liteflag API API v1.0.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIKeysAPIService 

type APIKeysAPIService service

APIKeysAPIService APIKeysAPI service

func (*APIKeysAPIService) ApiKeysNameDelete 

func (a *APIKeysAPIService) ApiKeysNameDelete(ctx context.Context, name string) ApiApiKeysNameDeleteRequest

ApiKeysNameDelete Delete an API key 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param name Name of the API key
@return ApiApiKeysNameDeleteRequest

func (*APIKeysAPIService) ApiKeysNameDeleteExecute 

func (a *APIKeysAPIService) ApiKeysNameDeleteExecute(r ApiApiKeysNameDeleteRequest) (*http.Response, error)

Execute executes the request

func (*APIKeysAPIService) ApiKeysNameRotatePost 

func (a *APIKeysAPIService) ApiKeysNameRotatePost(ctx context.Context, name string) ApiApiKeysNameRotatePostRequest

ApiKeysNameRotatePost Rotate an API key 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param name Name of the API key
@return ApiApiKeysNameRotatePostRequest

func (*APIKeysAPIService) ApiKeysNameRotatePostExecute 

func (a *APIKeysAPIService) ApiKeysNameRotatePostExecute(r ApiApiKeysNameRotatePostRequest) (*ApiKey, *http.Response, error)

Execute executes the request 

@return ApiKey

func (*APIKeysAPIService) ApiKeysPost 

func (a *APIKeysAPIService) ApiKeysPost(ctx context.Context) ApiApiKeysPostRequest

ApiKeysPost Create a new API key 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiApiKeysPostRequest

func (*APIKeysAPIService) ApiKeysPostExecute 

func (a *APIKeysAPIService) ApiKeysPostExecute(r ApiApiKeysPostRequest) (*ApiKey, *http.Response, error)

Execute executes the request 

@return ApiKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResponse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type ApiApiKeysNameDeleteRequest 

type ApiApiKeysNameDeleteRequest struct {
	ApiService *APIKeysAPIService
	// contains filtered or unexported fields
}

func (ApiApiKeysNameDeleteRequest) Execute 

func (r ApiApiKeysNameDeleteRequest) Execute() (*http.Response, error)

type ApiApiKeysNameRotatePostRequest 

type ApiApiKeysNameRotatePostRequest struct {
	ApiService *APIKeysAPIService
	// contains filtered or unexported fields
}

func (ApiApiKeysNameRotatePostRequest) Execute 

func (r ApiApiKeysNameRotatePostRequest) Execute() (*ApiKey, *http.Response, error)

type ApiApiKeysPostRequest 

type ApiApiKeysPostRequest struct {
	ApiService *APIKeysAPIService
	// contains filtered or unexported fields
}

func (ApiApiKeysPostRequest) ApiKeyInput 

func (r ApiApiKeysPostRequest) ApiKeyInput(apiKeyInput ApiKeyInput) ApiApiKeysPostRequest

func (ApiApiKeysPostRequest) Execute 

func (r ApiApiKeysPostRequest) Execute() (*ApiKey, *http.Response, error)

type ApiFlagsGetRequest 

type ApiFlagsGetRequest struct {
	ApiService *FlagsAPIService
	// contains filtered or unexported fields
}

func (ApiFlagsGetRequest) Execute 

func (r ApiFlagsGetRequest) Execute() ([]Flag, *http.Response, error)

type ApiFlagsKeyDeleteRequest 

type ApiFlagsKeyDeleteRequest struct {
	ApiService *FlagsAPIService
	// contains filtered or unexported fields
}

func (ApiFlagsKeyDeleteRequest) Execute 

func (r ApiFlagsKeyDeleteRequest) Execute() (*http.Response, error)

type ApiFlagsKeyGetRequest 

type ApiFlagsKeyGetRequest struct {
	ApiService *FlagsAPIService
	// contains filtered or unexported fields
}

func (ApiFlagsKeyGetRequest) Execute 

func (r ApiFlagsKeyGetRequest) Execute() (*Flag, *http.Response, error)

type ApiFlagsKeyPutRequest 

type ApiFlagsKeyPutRequest struct {
	ApiService *FlagsAPIService
	// contains filtered or unexported fields
}

func (ApiFlagsKeyPutRequest) Execute 

func (r ApiFlagsKeyPutRequest) Execute() (*Flag, *http.Response, error)

func (ApiFlagsKeyPutRequest) FlagInput 

func (r ApiFlagsKeyPutRequest) FlagInput(flagInput FlagInput) ApiFlagsKeyPutRequest

type ApiFlagsPostRequest 

type ApiFlagsPostRequest struct {
	ApiService *FlagsAPIService
	// contains filtered or unexported fields
}

func (ApiFlagsPostRequest) Execute 

func (r ApiFlagsPostRequest) Execute() (*Flag, *http.Response, error)

func (ApiFlagsPostRequest) Flag 

func (r ApiFlagsPostRequest) Flag(flag Flag) ApiFlagsPostRequest

type ApiHealthzGetRequest 

type ApiHealthzGetRequest struct {
	ApiService *HealthzAPIService
	// contains filtered or unexported fields
}

func (ApiHealthzGetRequest) Execute 

func (r ApiHealthzGetRequest) Execute() (*HealthResponse, *http.Response, error)

type ApiKey 

type ApiKey struct {
	// Unique identifier for the API key
	Name string `json:"name"`
	// The associated permissions of the key
	Role string `json:"role"`
	// The API Key
	Key string `json:"key"`
}

ApiKey struct for ApiKey

func NewApiKey 

func NewApiKey(name string, role string, key string) *ApiKey

NewApiKey instantiates a new ApiKey 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

func NewApiKeyWithDefaults 

func NewApiKeyWithDefaults() *ApiKey

NewApiKeyWithDefaults instantiates a new ApiKey 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

func (*ApiKey) GetKey 

func (o *ApiKey) GetKey() string

GetKey returns the Key field value

func (*ApiKey) GetKeyOk 

func (o *ApiKey) GetKeyOk() (*string, bool)

GetKeyOk returns a tuple with the Key field value and a boolean to check if the value has been set.

func (*ApiKey) GetName 

func (o *ApiKey) GetName() string

GetName returns the Name field value

func (*ApiKey) GetNameOk 

func (o *ApiKey) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value and a boolean to check if the value has been set.

func (*ApiKey) GetRole 

func (o *ApiKey) GetRole() string

GetRole returns the Role field value

func (*ApiKey) GetRoleOk 

func (o *ApiKey) GetRoleOk() (*string, bool)

GetRoleOk returns a tuple with the Role field value and a boolean to check if the value has been set.

func (ApiKey) MarshalJSON 

func (o ApiKey) MarshalJSON() ([]byte, error)

func (*ApiKey) SetKey 

func (o *ApiKey) SetKey(v string)

SetKey sets field value

func (*ApiKey) SetName 

func (o *ApiKey) SetName(v string)

SetName sets field value

func (*ApiKey) SetRole 

func (o *ApiKey) SetRole(v string)

SetRole sets field value

func (ApiKey) ToMap 

func (o ApiKey) ToMap() (map[string]interface{}, error)

func (*ApiKey) UnmarshalJSON 

func (o *ApiKey) UnmarshalJSON(data []byte) (err error)

type ApiKeyInput 

type ApiKeyInput struct {
	// Unique identifier for the API key
	Name string `json:"name"`
	// The associated permissions of the key
	Role string `json:"role"`
}

ApiKeyInput struct for ApiKeyInput

func NewApiKeyInput 

func NewApiKeyInput(name string, role string) *ApiKeyInput

NewApiKeyInput instantiates a new ApiKeyInput 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

func NewApiKeyInputWithDefaults 

func NewApiKeyInputWithDefaults() *ApiKeyInput

NewApiKeyInputWithDefaults instantiates a new ApiKeyInput 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

func (*ApiKeyInput) GetName 

func (o *ApiKeyInput) GetName() string

GetName returns the Name field value

func (*ApiKeyInput) GetNameOk 

func (o *ApiKeyInput) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value and a boolean to check if the value has been set.

func (*ApiKeyInput) GetRole 

func (o *ApiKeyInput) GetRole() string

GetRole returns the Role field value

func (*ApiKeyInput) GetRoleOk 

func (o *ApiKeyInput) GetRoleOk() (*string, bool)

GetRoleOk returns a tuple with the Role field value and a boolean to check if the value has been set.

func (ApiKeyInput) MarshalJSON 

func (o ApiKeyInput) MarshalJSON() ([]byte, error)

func (*ApiKeyInput) SetName 

func (o *ApiKeyInput) SetName(v string)

SetName sets field value

func (*ApiKeyInput) SetRole 

func (o *ApiKeyInput) SetRole(v string)

SetRole sets field value

func (ApiKeyInput) ToMap 

func (o ApiKeyInput) ToMap() (map[string]interface{}, error)

func (*ApiKeyInput) UnmarshalJSON 

func (o *ApiKeyInput) UnmarshalJSON(data []byte) (err error)

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration 

type Configuration struct {
	Host             string            `json:"host,omitempty"`
	Scheme           string            `json:"scheme,omitempty"`
	DefaultHeader    map[string]string `json:"defaultHeader,omitempty"`
	UserAgent        string            `json:"userAgent,omitempty"`
	Debug            bool              `json:"debug,omitempty"`
	Servers          ServerConfigurations
	OperationServers map[string]ServerConfigurations
	HTTPClient       *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration 

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerURL 

func (c *Configuration) ServerURL(index int, variables map[string]string) (string, error)

ServerURL returns URL based on server settings

func (*Configuration) ServerURLWithContext 

func (c *Configuration) ServerURLWithContext(ctx context.Context, endpoint string) (string, error)

ServerURLWithContext returns a new server URL given an endpoint

type Flag 

type Flag struct {
	// Unique identifier for the feature flag
	Key string `json:"key"`
	// Type of the flag value
	Type string `json:"type"`
	// Whether or not the flag is public.
	IsPublic bool      `json:"isPublic"`
	Value    FlagValue `json:"value"`
}

Flag struct for Flag

func NewFlag 

func NewFlag(key string, type_ string, isPublic bool, value FlagValue) *Flag

NewFlag instantiates a new Flag 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

func NewFlagWithDefaults 

func NewFlagWithDefaults() *Flag

NewFlagWithDefaults instantiates a new Flag 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

func (*Flag) GetIsPublic 

func (o *Flag) GetIsPublic() bool

GetIsPublic returns the IsPublic field value

func (*Flag) GetIsPublicOk 

func (o *Flag) GetIsPublicOk() (*bool, bool)

GetIsPublicOk returns a tuple with the IsPublic field value and a boolean to check if the value has been set.

func (*Flag) GetKey 

func (o *Flag) GetKey() string

GetKey returns the Key field value

func (*Flag) GetKeyOk 

func (o *Flag) GetKeyOk() (*string, bool)

GetKeyOk returns a tuple with the Key field value and a boolean to check if the value has been set.

func (*Flag) GetType 

func (o *Flag) GetType() string

GetType returns the Type field value

func (*Flag) GetTypeOk 

func (o *Flag) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field value and a boolean to check if the value has been set.

func (*Flag) GetValue 

func (o *Flag) GetValue() FlagValue

GetValue returns the Value field value

func (*Flag) GetValueOk 

func (o *Flag) GetValueOk() (*FlagValue, bool)

GetValueOk returns a tuple with the Value field value and a boolean to check if the value has been set.

func (Flag) MarshalJSON 

func (o Flag) MarshalJSON() ([]byte, error)

func (*Flag) SetIsPublic 

func (o *Flag) SetIsPublic(v bool)

SetIsPublic sets field value

func (*Flag) SetKey 

func (o *Flag) SetKey(v string)

SetKey sets field value

func (*Flag) SetType 

func (o *Flag) SetType(v string)

SetType sets field value

func (*Flag) SetValue 

func (o *Flag) SetValue(v FlagValue)

SetValue sets field value

func (Flag) ToMap 

func (o Flag) ToMap() (map[string]interface{}, error)

func (*Flag) UnmarshalJSON 

func (o *Flag) UnmarshalJSON(data []byte) (err error)

type FlagInput 

type FlagInput struct {
	// Whether the feature flag is public or not
	IsPublic bool `json:"isPublic"`
	// Type of the flag value
	Type  string    `json:"type"`
	Value FlagValue `json:"value"`
}

FlagInput struct for FlagInput

func NewFlagInput 

func NewFlagInput(isPublic bool, type_ string, value FlagValue) *FlagInput

NewFlagInput instantiates a new FlagInput 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

func NewFlagInputWithDefaults 

func NewFlagInputWithDefaults() *FlagInput

NewFlagInputWithDefaults instantiates a new FlagInput 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

func (*FlagInput) GetIsPublic 

func (o *FlagInput) GetIsPublic() bool

GetIsPublic returns the IsPublic field value

func (*FlagInput) GetIsPublicOk 

func (o *FlagInput) GetIsPublicOk() (*bool, bool)

GetIsPublicOk returns a tuple with the IsPublic field value and a boolean to check if the value has been set.

func (*FlagInput) GetType 

func (o *FlagInput) GetType() string

GetType returns the Type field value

func (*FlagInput) GetTypeOk 

func (o *FlagInput) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field value and a boolean to check if the value has been set.

func (*FlagInput) GetValue 

func (o *FlagInput) GetValue() FlagValue

GetValue returns the Value field value

func (*FlagInput) GetValueOk 

func (o *FlagInput) GetValueOk() (*FlagValue, bool)

GetValueOk returns a tuple with the Value field value and a boolean to check if the value has been set.

func (FlagInput) MarshalJSON 

func (o FlagInput) MarshalJSON() ([]byte, error)

func (*FlagInput) SetIsPublic 

func (o *FlagInput) SetIsPublic(v bool)

SetIsPublic sets field value

func (*FlagInput) SetType 

func (o *FlagInput) SetType(v string)

SetType sets field value

func (*FlagInput) SetValue 

func (o *FlagInput) SetValue(v FlagValue)

SetValue sets field value

func (FlagInput) ToMap 

func (o FlagInput) ToMap() (map[string]interface{}, error)

func (*FlagInput) UnmarshalJSON 

func (o *FlagInput) UnmarshalJSON(data []byte) (err error)

type FlagValue 

type FlagValue struct {
	Bool   *bool
	String *string
}

FlagValue - Value of the flag, must match the type

func BoolAsFlagValue 

func BoolAsFlagValue(v *bool) FlagValue

boolAsFlagValue is a convenience function that returns bool wrapped in FlagValue

func StringAsFlagValue 

func StringAsFlagValue(v *string) FlagValue

stringAsFlagValue is a convenience function that returns string wrapped in FlagValue

func (*FlagValue) GetActualInstance 

func (obj *FlagValue) GetActualInstance() interface{}

Get the actual instance

func (FlagValue) MarshalJSON 

func (src FlagValue) MarshalJSON() ([]byte, error)

Marshal data from the first non-nil pointers in the struct to JSON

func (*FlagValue) UnmarshalJSON 

func (dst *FlagValue) UnmarshalJSON(data []byte) error

Unmarshal JSON data into one of the pointers in the struct

type FlagsAPIService 

type FlagsAPIService service

FlagsAPIService FlagsAPI service

func (*FlagsAPIService) FlagsGet 

func (a *FlagsAPIService) FlagsGet(ctx context.Context) ApiFlagsGetRequest

FlagsGet Retrieve all feature flags 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiFlagsGetRequest

func (*FlagsAPIService) FlagsGetExecute 

func (a *FlagsAPIService) FlagsGetExecute(r ApiFlagsGetRequest) ([]Flag, *http.Response, error)

Execute executes the request 

@return []Flag

func (*FlagsAPIService) FlagsKeyDelete 

func (a *FlagsAPIService) FlagsKeyDelete(ctx context.Context, key string) ApiFlagsKeyDeleteRequest

FlagsKeyDelete Delete a feature flag 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param key Unique key of the feature flag
@return ApiFlagsKeyDeleteRequest

func (*FlagsAPIService) FlagsKeyDeleteExecute 

func (a *FlagsAPIService) FlagsKeyDeleteExecute(r ApiFlagsKeyDeleteRequest) (*http.Response, error)

Execute executes the request

func (*FlagsAPIService) FlagsKeyGet 

func (a *FlagsAPIService) FlagsKeyGet(ctx context.Context, key string) ApiFlagsKeyGetRequest

FlagsKeyGet Retrieve a single feature flag by key 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param key Unique key of the feature flag
@return ApiFlagsKeyGetRequest

func (*FlagsAPIService) FlagsKeyGetExecute 

func (a *FlagsAPIService) FlagsKeyGetExecute(r ApiFlagsKeyGetRequest) (*Flag, *http.Response, error)

Execute executes the request 

@return Flag

func (*FlagsAPIService) FlagsKeyPut 

func (a *FlagsAPIService) FlagsKeyPut(ctx context.Context, key string) ApiFlagsKeyPutRequest

FlagsKeyPut Update an existing feature flag 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param key Unique key of the feature flag
@return ApiFlagsKeyPutRequest

func (*FlagsAPIService) FlagsKeyPutExecute 

func (a *FlagsAPIService) FlagsKeyPutExecute(r ApiFlagsKeyPutRequest) (*Flag, *http.Response, error)

Execute executes the request 

@return Flag

func (*FlagsAPIService) FlagsPost 

func (a *FlagsAPIService) FlagsPost(ctx context.Context) ApiFlagsPostRequest

FlagsPost Create a new feature flag 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiFlagsPostRequest

func (*FlagsAPIService) FlagsPostExecute 

func (a *FlagsAPIService) FlagsPostExecute(r ApiFlagsPostRequest) (*Flag, *http.Response, error)

Execute executes the request 

@return Flag

type GenericOpenAPIError 

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type HealthResponse 

type HealthResponse struct {
	// Whether the database is healthy
	Database bool `json:"database"`
}

HealthResponse struct for HealthResponse

func NewHealthResponse 

func NewHealthResponse(database bool) *HealthResponse

NewHealthResponse instantiates a new HealthResponse 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

func NewHealthResponseWithDefaults 

func NewHealthResponseWithDefaults() *HealthResponse

NewHealthResponseWithDefaults instantiates a new HealthResponse 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

func (*HealthResponse) GetDatabase 

func (o *HealthResponse) GetDatabase() bool

GetDatabase returns the Database field value

func (*HealthResponse) GetDatabaseOk 

func (o *HealthResponse) GetDatabaseOk() (*bool, bool)

GetDatabaseOk returns a tuple with the Database field value and a boolean to check if the value has been set.

func (HealthResponse) MarshalJSON 

func (o HealthResponse) MarshalJSON() ([]byte, error)

func (*HealthResponse) SetDatabase 

func (o *HealthResponse) SetDatabase(v bool)

SetDatabase sets field value

func (HealthResponse) ToMap 

func (o HealthResponse) ToMap() (map[string]interface{}, error)

func (*HealthResponse) UnmarshalJSON 

func (o *HealthResponse) UnmarshalJSON(data []byte) (err error)

type HealthzAPIService 

type HealthzAPIService service

HealthzAPIService HealthzAPI service

func (*HealthzAPIService) HealthzGet 

func (a *HealthzAPIService) HealthzGet(ctx context.Context) ApiHealthzGetRequest

HealthzGet API healthcheck 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiHealthzGetRequest

func (*HealthzAPIService) HealthzGetExecute 

func (a *HealthzAPIService) HealthzGetExecute(r ApiHealthzGetRequest) (*HealthResponse, *http.Response, error)

Execute executes the request 

@return HealthResponse

type MappedNullable 

type MappedNullable interface {
	ToMap() (map[string]interface{}, error)
}

type NullableApiKey 

type NullableApiKey struct {
	// contains filtered or unexported fields
}

func NewNullableApiKey 

func NewNullableApiKey(val *ApiKey) *NullableApiKey

func (NullableApiKey) Get 

func (v NullableApiKey) Get() *ApiKey

func (NullableApiKey) IsSet 

func (v NullableApiKey) IsSet() bool

func (NullableApiKey) MarshalJSON 

func (v NullableApiKey) MarshalJSON() ([]byte, error)

func (*NullableApiKey) Set 

func (v *NullableApiKey) Set(val *ApiKey)

func (*NullableApiKey) UnmarshalJSON 

func (v *NullableApiKey) UnmarshalJSON(src []byte) error

func (*NullableApiKey) Unset 

func (v *NullableApiKey) Unset()

type NullableApiKeyInput 

type NullableApiKeyInput struct {
	// contains filtered or unexported fields
}

func NewNullableApiKeyInput 

func NewNullableApiKeyInput(val *ApiKeyInput) *NullableApiKeyInput

func (NullableApiKeyInput) Get 

func (v NullableApiKeyInput) Get() *ApiKeyInput

func (NullableApiKeyInput) IsSet 

func (v NullableApiKeyInput) IsSet() bool

func (NullableApiKeyInput) MarshalJSON 

func (v NullableApiKeyInput) MarshalJSON() ([]byte, error)

func (*NullableApiKeyInput) Set 

func (v *NullableApiKeyInput) Set(val *ApiKeyInput)

func (*NullableApiKeyInput) UnmarshalJSON 

func (v *NullableApiKeyInput) UnmarshalJSON(src []byte) error

func (*NullableApiKeyInput) Unset 

func (v *NullableApiKeyInput) Unset()

type NullableBool 

type NullableBool struct {
	// contains filtered or unexported fields
}

func NewNullableBool 

func NewNullableBool(val *bool) *NullableBool

func (NullableBool) Get 

func (v NullableBool) Get() *bool

func (NullableBool) IsSet 

func (v NullableBool) IsSet() bool

func (NullableBool) MarshalJSON 

func (v NullableBool) MarshalJSON() ([]byte, error)

func (*NullableBool) Set 

func (v *NullableBool) Set(val *bool)

func (*NullableBool) UnmarshalJSON 

func (v *NullableBool) UnmarshalJSON(src []byte) error

func (*NullableBool) Unset 

func (v *NullableBool) Unset()

type NullableFlag 

type NullableFlag struct {
	// contains filtered or unexported fields
}

func NewNullableFlag 

func NewNullableFlag(val *Flag) *NullableFlag

func (NullableFlag) Get 

func (v NullableFlag) Get() *Flag

func (NullableFlag) IsSet 

func (v NullableFlag) IsSet() bool

func (NullableFlag) MarshalJSON 

func (v NullableFlag) MarshalJSON() ([]byte, error)

func (*NullableFlag) Set 

func (v *NullableFlag) Set(val *Flag)

func (*NullableFlag) UnmarshalJSON 

func (v *NullableFlag) UnmarshalJSON(src []byte) error

func (*NullableFlag) Unset 

func (v *NullableFlag) Unset()

type NullableFlagInput 

type NullableFlagInput struct {
	// contains filtered or unexported fields
}

func NewNullableFlagInput 

func NewNullableFlagInput(val *FlagInput) *NullableFlagInput

func (NullableFlagInput) Get 

func (v NullableFlagInput) Get() *FlagInput

func (NullableFlagInput) IsSet 

func (v NullableFlagInput) IsSet() bool

func (NullableFlagInput) MarshalJSON 

func (v NullableFlagInput) MarshalJSON() ([]byte, error)

func (*NullableFlagInput) Set 

func (v *NullableFlagInput) Set(val *FlagInput)

func (*NullableFlagInput) UnmarshalJSON 

func (v *NullableFlagInput) UnmarshalJSON(src []byte) error

func (*NullableFlagInput) Unset 

func (v *NullableFlagInput) Unset()

type NullableFlagValue 

type NullableFlagValue struct {
	// contains filtered or unexported fields
}

func NewNullableFlagValue 

func NewNullableFlagValue(val *FlagValue) *NullableFlagValue

func (NullableFlagValue) Get 

func (v NullableFlagValue) Get() *FlagValue

func (NullableFlagValue) IsSet 

func (v NullableFlagValue) IsSet() bool

func (NullableFlagValue) MarshalJSON 

func (v NullableFlagValue) MarshalJSON() ([]byte, error)

func (*NullableFlagValue) Set 

func (v *NullableFlagValue) Set(val *FlagValue)

func (*NullableFlagValue) UnmarshalJSON 

func (v *NullableFlagValue) UnmarshalJSON(src []byte) error

func (*NullableFlagValue) Unset 

func (v *NullableFlagValue) Unset()

type NullableFloat32 

type NullableFloat32 struct {
	// contains filtered or unexported fields
}

func NewNullableFloat32 

func NewNullableFloat32(val *float32) *NullableFloat32

func (NullableFloat32) Get 

func (v NullableFloat32) Get() *float32

func (NullableFloat32) IsSet 

func (v NullableFloat32) IsSet() bool

func (NullableFloat32) MarshalJSON 

func (v NullableFloat32) MarshalJSON() ([]byte, error)

func (*NullableFloat32) Set 

func (v *NullableFloat32) Set(val *float32)

func (*NullableFloat32) UnmarshalJSON 

func (v *NullableFloat32) UnmarshalJSON(src []byte) error

func (*NullableFloat32) Unset 

func (v *NullableFloat32) Unset()

type NullableFloat64 

type NullableFloat64 struct {
	// contains filtered or unexported fields
}

func NewNullableFloat64 

func NewNullableFloat64(val *float64) *NullableFloat64

func (NullableFloat64) Get 

func (v NullableFloat64) Get() *float64

func (NullableFloat64) IsSet 

func (v NullableFloat64) IsSet() bool

func (NullableFloat64) MarshalJSON 

func (v NullableFloat64) MarshalJSON() ([]byte, error)

func (*NullableFloat64) Set 

func (v *NullableFloat64) Set(val *float64)

func (*NullableFloat64) UnmarshalJSON 

func (v *NullableFloat64) UnmarshalJSON(src []byte) error

func (*NullableFloat64) Unset 

func (v *NullableFloat64) Unset()

type NullableHealthResponse 

type NullableHealthResponse struct {
	// contains filtered or unexported fields
}

func NewNullableHealthResponse 

func NewNullableHealthResponse(val *HealthResponse) *NullableHealthResponse

func (NullableHealthResponse) Get 

func (v NullableHealthResponse) Get() *HealthResponse

func (NullableHealthResponse) IsSet 

func (v NullableHealthResponse) IsSet() bool

func (NullableHealthResponse) MarshalJSON 

func (v NullableHealthResponse) MarshalJSON() ([]byte, error)

func (*NullableHealthResponse) Set 

func (v *NullableHealthResponse) Set(val *HealthResponse)

func (*NullableHealthResponse) UnmarshalJSON 

func (v *NullableHealthResponse) UnmarshalJSON(src []byte) error

func (*NullableHealthResponse) Unset 

func (v *NullableHealthResponse) Unset()

type NullableInt 

type NullableInt struct {
	// contains filtered or unexported fields
}

func NewNullableInt 

func NewNullableInt(val *int) *NullableInt

func (NullableInt) Get 

func (v NullableInt) Get() *int

func (NullableInt) IsSet 

func (v NullableInt) IsSet() bool

func (NullableInt) MarshalJSON 

func (v NullableInt) MarshalJSON() ([]byte, error)

func (*NullableInt) Set 

func (v *NullableInt) Set(val *int)

func (*NullableInt) UnmarshalJSON 

func (v *NullableInt) UnmarshalJSON(src []byte) error

func (*NullableInt) Unset 

func (v *NullableInt) Unset()

type NullableInt32 

type NullableInt32 struct {
	// contains filtered or unexported fields
}

func NewNullableInt32 

func NewNullableInt32(val *int32) *NullableInt32

func (NullableInt32) Get 

func (v NullableInt32) Get() *int32

func (NullableInt32) IsSet 

func (v NullableInt32) IsSet() bool

func (NullableInt32) MarshalJSON 

func (v NullableInt32) MarshalJSON() ([]byte, error)

func (*NullableInt32) Set 

func (v *NullableInt32) Set(val *int32)

func (*NullableInt32) UnmarshalJSON 

func (v *NullableInt32) UnmarshalJSON(src []byte) error

func (*NullableInt32) Unset 

func (v *NullableInt32) Unset()

type NullableInt64 

type NullableInt64 struct {
	// contains filtered or unexported fields
}

func NewNullableInt64 

func NewNullableInt64(val *int64) *NullableInt64

func (NullableInt64) Get 

func (v NullableInt64) Get() *int64

func (NullableInt64) IsSet 

func (v NullableInt64) IsSet() bool

func (NullableInt64) MarshalJSON 

func (v NullableInt64) MarshalJSON() ([]byte, error)

func (*NullableInt64) Set 

func (v *NullableInt64) Set(val *int64)

func (*NullableInt64) UnmarshalJSON 

func (v *NullableInt64) UnmarshalJSON(src []byte) error

func (*NullableInt64) Unset 

func (v *NullableInt64) Unset()

type NullableString 

type NullableString struct {
	// contains filtered or unexported fields
}

func NewNullableString 

func NewNullableString(val *string) *NullableString

func (NullableString) Get 

func (v NullableString) Get() *string

func (NullableString) IsSet 

func (v NullableString) IsSet() bool

func (NullableString) MarshalJSON 

func (v NullableString) MarshalJSON() ([]byte, error)

func (*NullableString) Set 

func (v *NullableString) Set(val *string)

func (*NullableString) UnmarshalJSON 

func (v *NullableString) UnmarshalJSON(src []byte) error

func (*NullableString) Unset 

func (v *NullableString) Unset()

type NullableTime 

type NullableTime struct {
	// contains filtered or unexported fields
}

func NewNullableTime 

func NewNullableTime(val *time.Time) *NullableTime

func (NullableTime) Get 

func (v NullableTime) Get() *time.Time

func (NullableTime) IsSet 

func (v NullableTime) IsSet() bool

func (NullableTime) MarshalJSON 

func (v NullableTime) MarshalJSON() ([]byte, error)

func (*NullableTime) Set 

func (v *NullableTime) Set(val *time.Time)

func (*NullableTime) UnmarshalJSON 

func (v *NullableTime) UnmarshalJSON(src []byte) error

func (*NullableTime) Unset 

func (v *NullableTime) Unset()

type ServerConfiguration 

type ServerConfiguration struct {
	URL         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerConfigurations 

type ServerConfigurations []ServerConfiguration

ServerConfigurations stores multiple ServerConfiguration items

func (ServerConfigurations) URL 

func (sc ServerConfigurations) URL(index int, variables map[string]string) (string, error)

URL formats template on a index using given variables

type ServerVariable 

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.