client

package
v0.0.2 Latest Latest
Warning

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

 Go to latest Published: Nov 16, 2022 License: MIT Imports: 22 Imported by: 0

README

Go API client for client

STACKIT API Manager API

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
  • Package version: 1.0.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/oauth2
go get golang.org/x/net/context

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

import client "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 sw.ContextServerIndex of type int.

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

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

ctx := context.WithValue(context.Background(), client.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 sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

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

Documentation for API Endpoints

All URIs are relative to https://api-manager.api.stackit.cloud

Class Method HTTP request Description
APIManagerServiceApi APIManagerServicePublish Post /v1/projects/{metadata.project_id}/api/{metadata.identifier} Publish API Endpoint
APIManagerServiceApi APIManagerServiceRetire Delete /v1/projects/{metadata.project_id}/api/{metadata.identifier} Retire API Endpoint

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

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

Author

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKeys takes a string apikey as authentication for the request
	ContextAPIKeys = contextKey("apiKeys")

	// ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
	ContextHttpSignatureAuth = contextKey("httpsignature")

	// 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 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 {
	APIManagerServiceApi *APIManagerServiceApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the api-manager-api API v1.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 APIManagerServiceApiService 

type APIManagerServiceApiService service

APIManagerServiceApiService APIManagerServiceApi service

func (*APIManagerServiceApiService) APIManagerServicePublish 

func (a *APIManagerServiceApiService) APIManagerServicePublish(ctx context.Context, metadataProjectId string, metadataIdentifier string) ApiAPIManagerServicePublishRequest

APIManagerServicePublish Publish API Endpoint

Publish a new API for a dedicated service by providing the OpenApiSpec for it 

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

func (*APIManagerServiceApiService) APIManagerServicePublishExecute 

func (a *APIManagerServiceApiService) APIManagerServicePublishExecute(r ApiAPIManagerServicePublishRequest) (*PublishResponse, *http.Response, error)

Execute executes the request 

@return PublishResponse

func (*APIManagerServiceApiService) APIManagerServiceRetire 

func (a *APIManagerServiceApiService) APIManagerServiceRetire(ctx context.Context, metadataProjectId string, metadataIdentifier string) ApiAPIManagerServiceRetireRequest

APIManagerServiceRetire Retire API Endpoint

Retire an already existing API for a dedicated service by providing its Identifier 

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

func (*APIManagerServiceApiService) APIManagerServiceRetireExecute 

func (a *APIManagerServiceApiService) APIManagerServiceRetireExecute(r ApiAPIManagerServiceRetireRequest) (map[string]interface{}, *http.Response, error)

Execute executes the request 

@return map[string]interface{}

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 ApiAPIManagerServicePublishRequest 

type ApiAPIManagerServicePublishRequest struct {
	ApiService *APIManagerServiceApiService
	// contains filtered or unexported fields
}

func (ApiAPIManagerServicePublishRequest) Execute 

func (r ApiAPIManagerServicePublishRequest) Execute() (*PublishResponse, *http.Response, error)

func (ApiAPIManagerServicePublishRequest) PublishRequest added in v0.0.2 

func (r ApiAPIManagerServicePublishRequest) PublishRequest(publishRequest PublishRequest) ApiAPIManagerServicePublishRequest

type ApiAPIManagerServiceRetireRequest 

type ApiAPIManagerServiceRetireRequest struct {
	ApiService *APIManagerServiceApiService
	// contains filtered or unexported fields
}

func (ApiAPIManagerServiceRetireRequest) Execute 

func (r ApiAPIManagerServiceRetireRequest) Execute() (map[string]interface{}, *http.Response, error)

func (ApiAPIManagerServiceRetireRequest) RetireRequest added in v0.0.2 

func (r ApiAPIManagerServiceRetireRequest) RetireRequest(retireRequest RetireRequest) ApiAPIManagerServiceRetireRequest

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 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 GoogleProtobufAny added in v0.0.2 

type GoogleProtobufAny struct {
	// The type of the serialized message.
	Type                 *string `json:"@type,omitempty"`
	AdditionalProperties map[string]interface{}
}

GoogleProtobufAny Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

func NewGoogleProtobufAny added in v0.0.2 

func NewGoogleProtobufAny() *GoogleProtobufAny

NewGoogleProtobufAny instantiates a new GoogleProtobufAny 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 NewGoogleProtobufAnyWithDefaults added in v0.0.2 

func NewGoogleProtobufAnyWithDefaults() *GoogleProtobufAny

NewGoogleProtobufAnyWithDefaults instantiates a new GoogleProtobufAny 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 (*GoogleProtobufAny) GetType added in v0.0.2 

func (o *GoogleProtobufAny) GetType() string

GetType returns the Type field value if set, zero value otherwise.

func (*GoogleProtobufAny) GetTypeOk added in v0.0.2 

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

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

func (*GoogleProtobufAny) HasType added in v0.0.2 

func (o *GoogleProtobufAny) HasType() bool

HasType returns a boolean if a field has been set.

func (GoogleProtobufAny) MarshalJSON added in v0.0.2 

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

func (*GoogleProtobufAny) SetType added in v0.0.2 

func (o *GoogleProtobufAny) SetType(v string)

SetType gets a reference to the given string and assigns it to the Type field.

func (*GoogleProtobufAny) UnmarshalJSON added in v0.0.2 

func (o *GoogleProtobufAny) UnmarshalJSON(bytes []byte) (err error)

type Metadata added in v0.0.2 

type Metadata struct {
	Identifier *string `json:"identifier,omitempty"`
	ProjectId  *string `json:"projectId,omitempty"`
	Stage      *string `json:"stage,omitempty"`
}

Metadata struct for Metadata

func NewMetadata added in v0.0.2 

func NewMetadata() *Metadata

NewMetadata instantiates a new Metadata 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 NewMetadataWithDefaults added in v0.0.2 

func NewMetadataWithDefaults() *Metadata

NewMetadataWithDefaults instantiates a new Metadata 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 (*Metadata) GetIdentifier added in v0.0.2 

func (o *Metadata) GetIdentifier() string

GetIdentifier returns the Identifier field value if set, zero value otherwise.

func (*Metadata) GetIdentifierOk added in v0.0.2 

func (o *Metadata) GetIdentifierOk() (*string, bool)

GetIdentifierOk returns a tuple with the Identifier field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Metadata) GetProjectId added in v0.0.2 

func (o *Metadata) GetProjectId() string

GetProjectId returns the ProjectId field value if set, zero value otherwise.

func (*Metadata) GetProjectIdOk added in v0.0.2 

func (o *Metadata) GetProjectIdOk() (*string, bool)

GetProjectIdOk returns a tuple with the ProjectId field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Metadata) GetStage added in v0.0.2 

func (o *Metadata) GetStage() string

GetStage returns the Stage field value if set, zero value otherwise.

func (*Metadata) GetStageOk added in v0.0.2 

func (o *Metadata) GetStageOk() (*string, bool)

GetStageOk returns a tuple with the Stage field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Metadata) HasIdentifier added in v0.0.2 

func (o *Metadata) HasIdentifier() bool

HasIdentifier returns a boolean if a field has been set.

func (*Metadata) HasProjectId added in v0.0.2 

func (o *Metadata) HasProjectId() bool

HasProjectId returns a boolean if a field has been set.

func (*Metadata) HasStage added in v0.0.2 

func (o *Metadata) HasStage() bool

HasStage returns a boolean if a field has been set.

func (Metadata) MarshalJSON added in v0.0.2 

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

func (*Metadata) SetIdentifier added in v0.0.2 

func (o *Metadata) SetIdentifier(v string)

SetIdentifier gets a reference to the given string and assigns it to the Identifier field.

func (*Metadata) SetProjectId added in v0.0.2 

func (o *Metadata) SetProjectId(v string)

SetProjectId gets a reference to the given string and assigns it to the ProjectId field.

func (*Metadata) SetStage added in v0.0.2 

func (o *Metadata) SetStage(v string)

SetStage gets a reference to the given string and assigns it to the Stage field.

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 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 NullableGoogleProtobufAny added in v0.0.2 

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

func NewNullableGoogleProtobufAny added in v0.0.2 

func NewNullableGoogleProtobufAny(val *GoogleProtobufAny) *NullableGoogleProtobufAny

func (NullableGoogleProtobufAny) Get added in v0.0.2 

func (v NullableGoogleProtobufAny) Get() *GoogleProtobufAny

func (NullableGoogleProtobufAny) IsSet added in v0.0.2 

func (v NullableGoogleProtobufAny) IsSet() bool

func (NullableGoogleProtobufAny) MarshalJSON added in v0.0.2 

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

func (*NullableGoogleProtobufAny) Set added in v0.0.2 

func (v *NullableGoogleProtobufAny) Set(val *GoogleProtobufAny)

func (*NullableGoogleProtobufAny) UnmarshalJSON added in v0.0.2 

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

func (*NullableGoogleProtobufAny) Unset added in v0.0.2 

func (v *NullableGoogleProtobufAny) 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 NullableMetadata added in v0.0.2 

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

func NewNullableMetadata added in v0.0.2 

func NewNullableMetadata(val *Metadata) *NullableMetadata

func (NullableMetadata) Get added in v0.0.2 

func (v NullableMetadata) Get() *Metadata

func (NullableMetadata) IsSet added in v0.0.2 

func (v NullableMetadata) IsSet() bool

func (NullableMetadata) MarshalJSON added in v0.0.2 

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

func (*NullableMetadata) Set added in v0.0.2 

func (v *NullableMetadata) Set(val *Metadata)

func (*NullableMetadata) UnmarshalJSON added in v0.0.2 

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

func (*NullableMetadata) Unset added in v0.0.2 

func (v *NullableMetadata) Unset()

type NullablePublishRequest added in v0.0.2 

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

func NewNullablePublishRequest added in v0.0.2 

func NewNullablePublishRequest(val *PublishRequest) *NullablePublishRequest

func (NullablePublishRequest) Get added in v0.0.2 

func (v NullablePublishRequest) Get() *PublishRequest

func (NullablePublishRequest) IsSet added in v0.0.2 

func (v NullablePublishRequest) IsSet() bool

func (NullablePublishRequest) MarshalJSON added in v0.0.2 

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

func (*NullablePublishRequest) Set added in v0.0.2 

func (v *NullablePublishRequest) Set(val *PublishRequest)

func (*NullablePublishRequest) UnmarshalJSON added in v0.0.2 

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

func (*NullablePublishRequest) Unset added in v0.0.2 

func (v *NullablePublishRequest) Unset()

type NullablePublishRequestOpenApi 

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

func NewNullablePublishRequestOpenApi 

func NewNullablePublishRequestOpenApi(val *PublishRequestOpenApi) *NullablePublishRequestOpenApi

func (NullablePublishRequestOpenApi) Get 

func (v NullablePublishRequestOpenApi) Get() *PublishRequestOpenApi

func (NullablePublishRequestOpenApi) IsSet 

func (v NullablePublishRequestOpenApi) IsSet() bool

func (NullablePublishRequestOpenApi) MarshalJSON 

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

func (*NullablePublishRequestOpenApi) Set 

func (v *NullablePublishRequestOpenApi) Set(val *PublishRequestOpenApi)

func (*NullablePublishRequestOpenApi) UnmarshalJSON 

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

func (*NullablePublishRequestOpenApi) Unset 

func (v *NullablePublishRequestOpenApi) Unset()

type NullablePublishRequestSpec 

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

func NewNullablePublishRequestSpec 

func NewNullablePublishRequestSpec(val *PublishRequestSpec) *NullablePublishRequestSpec

func (NullablePublishRequestSpec) Get 

func (v NullablePublishRequestSpec) Get() *PublishRequestSpec

func (NullablePublishRequestSpec) IsSet 

func (v NullablePublishRequestSpec) IsSet() bool

func (NullablePublishRequestSpec) MarshalJSON 

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

func (*NullablePublishRequestSpec) Set 

func (v *NullablePublishRequestSpec) Set(val *PublishRequestSpec)

func (*NullablePublishRequestSpec) UnmarshalJSON 

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

func (*NullablePublishRequestSpec) Unset 

func (v *NullablePublishRequestSpec) Unset()

type NullablePublishResponse added in v0.0.2 

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

func NewNullablePublishResponse added in v0.0.2 

func NewNullablePublishResponse(val *PublishResponse) *NullablePublishResponse

func (NullablePublishResponse) Get added in v0.0.2 

func (v NullablePublishResponse) Get() *PublishResponse

func (NullablePublishResponse) IsSet added in v0.0.2 

func (v NullablePublishResponse) IsSet() bool

func (NullablePublishResponse) MarshalJSON added in v0.0.2 

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

func (*NullablePublishResponse) Set added in v0.0.2 

func (v *NullablePublishResponse) Set(val *PublishResponse)

func (*NullablePublishResponse) UnmarshalJSON added in v0.0.2 

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

func (*NullablePublishResponse) Unset added in v0.0.2 

func (v *NullablePublishResponse) Unset()

type NullableRetireRequest added in v0.0.2 

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

func NewNullableRetireRequest added in v0.0.2 

func NewNullableRetireRequest(val *RetireRequest) *NullableRetireRequest

func (NullableRetireRequest) Get added in v0.0.2 

func (v NullableRetireRequest) Get() *RetireRequest

func (NullableRetireRequest) IsSet added in v0.0.2 

func (v NullableRetireRequest) IsSet() bool

func (NullableRetireRequest) MarshalJSON added in v0.0.2 

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

func (*NullableRetireRequest) Set added in v0.0.2 

func (v *NullableRetireRequest) Set(val *RetireRequest)

func (*NullableRetireRequest) UnmarshalJSON added in v0.0.2 

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

func (*NullableRetireRequest) Unset added in v0.0.2 

func (v *NullableRetireRequest) Unset()

type NullableStatus added in v0.0.2 

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

func NewNullableStatus added in v0.0.2 

func NewNullableStatus(val *Status) *NullableStatus

func (NullableStatus) Get added in v0.0.2 

func (v NullableStatus) Get() *Status

func (NullableStatus) IsSet added in v0.0.2 

func (v NullableStatus) IsSet() bool

func (NullableStatus) MarshalJSON added in v0.0.2 

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

func (*NullableStatus) Set added in v0.0.2 

func (v *NullableStatus) Set(val *Status)

func (*NullableStatus) UnmarshalJSON added in v0.0.2 

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

func (*NullableStatus) Unset added in v0.0.2 

func (v *NullableStatus) 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 PublishRequest added in v0.0.2 

type PublishRequest struct {
	Metadata *Metadata           `json:"metadata,omitempty"`
	Spec     *PublishRequestSpec `json:"spec,omitempty"`
}

PublishRequest struct for PublishRequest

func NewPublishRequest added in v0.0.2 

func NewPublishRequest() *PublishRequest

NewPublishRequest instantiates a new PublishRequest 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 NewPublishRequestWithDefaults added in v0.0.2 

func NewPublishRequestWithDefaults() *PublishRequest

NewPublishRequestWithDefaults instantiates a new PublishRequest 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 (*PublishRequest) GetMetadata added in v0.0.2 

func (o *PublishRequest) GetMetadata() Metadata

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*PublishRequest) GetMetadataOk added in v0.0.2 

func (o *PublishRequest) GetMetadataOk() (*Metadata, bool)

GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PublishRequest) GetSpec added in v0.0.2 

func (o *PublishRequest) GetSpec() PublishRequestSpec

GetSpec returns the Spec field value if set, zero value otherwise.

func (*PublishRequest) GetSpecOk added in v0.0.2 

func (o *PublishRequest) GetSpecOk() (*PublishRequestSpec, bool)

GetSpecOk returns a tuple with the Spec field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PublishRequest) HasMetadata added in v0.0.2 

func (o *PublishRequest) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (*PublishRequest) HasSpec added in v0.0.2 

func (o *PublishRequest) HasSpec() bool

HasSpec returns a boolean if a field has been set.

func (PublishRequest) MarshalJSON added in v0.0.2 

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

func (*PublishRequest) SetMetadata added in v0.0.2 

func (o *PublishRequest) SetMetadata(v Metadata)

SetMetadata gets a reference to the given Metadata and assigns it to the Metadata field.

func (*PublishRequest) SetSpec added in v0.0.2 

func (o *PublishRequest) SetSpec(v PublishRequestSpec)

SetSpec gets a reference to the given PublishRequestSpec and assigns it to the Spec field.

type PublishRequestOpenApi 

type PublishRequestOpenApi struct {
	// now the spec will be base64 string, later we might add a url to a spec file or something else
	Base64Encoded *string `json:"base64Encoded,omitempty"`
}

PublishRequestOpenApi struct for PublishRequestOpenApi

func NewPublishRequestOpenApi 

func NewPublishRequestOpenApi() *PublishRequestOpenApi

NewPublishRequestOpenApi instantiates a new PublishRequestOpenApi 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 NewPublishRequestOpenApiWithDefaults 

func NewPublishRequestOpenApiWithDefaults() *PublishRequestOpenApi

NewPublishRequestOpenApiWithDefaults instantiates a new PublishRequestOpenApi 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 (*PublishRequestOpenApi) GetBase64Encoded 

func (o *PublishRequestOpenApi) GetBase64Encoded() string

GetBase64Encoded returns the Base64Encoded field value if set, zero value otherwise.

func (*PublishRequestOpenApi) GetBase64EncodedOk 

func (o *PublishRequestOpenApi) GetBase64EncodedOk() (*string, bool)

GetBase64EncodedOk returns a tuple with the Base64Encoded field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PublishRequestOpenApi) HasBase64Encoded 

func (o *PublishRequestOpenApi) HasBase64Encoded() bool

HasBase64Encoded returns a boolean if a field has been set.

func (PublishRequestOpenApi) MarshalJSON 

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

func (*PublishRequestOpenApi) SetBase64Encoded 

func (o *PublishRequestOpenApi) SetBase64Encoded(v string)

SetBase64Encoded gets a reference to the given string and assigns it to the Base64Encoded field.

type PublishRequestSpec 

type PublishRequestSpec struct {
	OpenApi *PublishRequestOpenApi `json:"openApi,omitempty"`
}

PublishRequestSpec struct for PublishRequestSpec

func NewPublishRequestSpec 

func NewPublishRequestSpec() *PublishRequestSpec

NewPublishRequestSpec instantiates a new PublishRequestSpec 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 NewPublishRequestSpecWithDefaults 

func NewPublishRequestSpecWithDefaults() *PublishRequestSpec

NewPublishRequestSpecWithDefaults instantiates a new PublishRequestSpec 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 (*PublishRequestSpec) GetOpenApi 

func (o *PublishRequestSpec) GetOpenApi() PublishRequestOpenApi

GetOpenApi returns the OpenApi field value if set, zero value otherwise.

func (*PublishRequestSpec) GetOpenApiOk 

func (o *PublishRequestSpec) GetOpenApiOk() (*PublishRequestOpenApi, bool)

GetOpenApiOk returns a tuple with the OpenApi field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PublishRequestSpec) HasOpenApi 

func (o *PublishRequestSpec) HasOpenApi() bool

HasOpenApi returns a boolean if a field has been set.

func (PublishRequestSpec) MarshalJSON 

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

func (*PublishRequestSpec) SetOpenApi 

func (o *PublishRequestSpec) SetOpenApi(v PublishRequestOpenApi)

SetOpenApi gets a reference to the given PublishRequestOpenApi and assigns it to the OpenApi field.

type PublishResponse added in v0.0.2 

type PublishResponse struct {
	ApiUrl *string `json:"apiUrl,omitempty"`
}

PublishResponse OpenAPI specification was retired successfully

func NewPublishResponse added in v0.0.2 

func NewPublishResponse() *PublishResponse

NewPublishResponse instantiates a new PublishResponse 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 NewPublishResponseWithDefaults added in v0.0.2 

func NewPublishResponseWithDefaults() *PublishResponse

NewPublishResponseWithDefaults instantiates a new PublishResponse 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 (*PublishResponse) GetApiUrl added in v0.0.2 

func (o *PublishResponse) GetApiUrl() string

GetApiUrl returns the ApiUrl field value if set, zero value otherwise.

func (*PublishResponse) GetApiUrlOk added in v0.0.2 

func (o *PublishResponse) GetApiUrlOk() (*string, bool)

GetApiUrlOk returns a tuple with the ApiUrl field value if set, nil otherwise and a boolean to check if the value has been set.

func (*PublishResponse) HasApiUrl added in v0.0.2 

func (o *PublishResponse) HasApiUrl() bool

HasApiUrl returns a boolean if a field has been set.

func (PublishResponse) MarshalJSON added in v0.0.2 

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

func (*PublishResponse) SetApiUrl added in v0.0.2 

func (o *PublishResponse) SetApiUrl(v string)

SetApiUrl gets a reference to the given string and assigns it to the ApiUrl field.

type RetireRequest added in v0.0.2 

type RetireRequest struct {
	Metadata *Metadata `json:"metadata,omitempty"`
}

RetireRequest struct for RetireRequest

func NewRetireRequest added in v0.0.2 

func NewRetireRequest() *RetireRequest

NewRetireRequest instantiates a new RetireRequest 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 NewRetireRequestWithDefaults added in v0.0.2 

func NewRetireRequestWithDefaults() *RetireRequest

NewRetireRequestWithDefaults instantiates a new RetireRequest 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 (*RetireRequest) GetMetadata added in v0.0.2 

func (o *RetireRequest) GetMetadata() Metadata

GetMetadata returns the Metadata field value if set, zero value otherwise.

func (*RetireRequest) GetMetadataOk added in v0.0.2 

func (o *RetireRequest) GetMetadataOk() (*Metadata, bool)

GetMetadataOk returns a tuple with the Metadata field value if set, nil otherwise and a boolean to check if the value has been set.

func (*RetireRequest) HasMetadata added in v0.0.2 

func (o *RetireRequest) HasMetadata() bool

HasMetadata returns a boolean if a field has been set.

func (RetireRequest) MarshalJSON added in v0.0.2 

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

func (*RetireRequest) SetMetadata added in v0.0.2 

func (o *RetireRequest) SetMetadata(v Metadata)

SetMetadata gets a reference to the given Metadata and assigns it to the Metadata field.

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

type Status added in v0.0.2 

type Status struct {
	// The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
	Code *int32 `json:"code,omitempty"`
	// A list of messages that carry the error details.  There is a common set of message types for APIs to use.
	Details []GoogleProtobufAny `json:"details,omitempty"`
	// A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
	Message *string `json:"message,omitempty"`
}

Status The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).

func NewStatus added in v0.0.2 

func NewStatus() *Status

NewStatus instantiates a new Status 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 NewStatusWithDefaults added in v0.0.2 

func NewStatusWithDefaults() *Status

NewStatusWithDefaults instantiates a new Status 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 (*Status) GetCode added in v0.0.2 

func (o *Status) GetCode() int32

GetCode returns the Code field value if set, zero value otherwise.

func (*Status) GetCodeOk added in v0.0.2 

func (o *Status) GetCodeOk() (*int32, bool)

GetCodeOk returns a tuple with the Code field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Status) GetDetails added in v0.0.2 

func (o *Status) GetDetails() []GoogleProtobufAny

GetDetails returns the Details field value if set, zero value otherwise.

func (*Status) GetDetailsOk added in v0.0.2 

func (o *Status) GetDetailsOk() ([]GoogleProtobufAny, bool)

GetDetailsOk returns a tuple with the Details field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Status) GetMessage added in v0.0.2 

func (o *Status) GetMessage() string

GetMessage returns the Message field value if set, zero value otherwise.

func (*Status) GetMessageOk added in v0.0.2 

func (o *Status) GetMessageOk() (*string, bool)

GetMessageOk returns a tuple with the Message field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Status) HasCode added in v0.0.2 

func (o *Status) HasCode() bool

HasCode returns a boolean if a field has been set.

func (*Status) HasDetails added in v0.0.2 

func (o *Status) HasDetails() bool

HasDetails returns a boolean if a field has been set.

func (*Status) HasMessage added in v0.0.2 

func (o *Status) HasMessage() bool

HasMessage returns a boolean if a field has been set.

func (Status) MarshalJSON added in v0.0.2 

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

func (*Status) SetCode added in v0.0.2 

func (o *Status) SetCode(v int32)

SetCode gets a reference to the given int32 and assigns it to the Code field.

func (*Status) SetDetails added in v0.0.2 

func (o *Status) SetDetails(v []GoogleProtobufAny)

SetDetails gets a reference to the given []GoogleProtobufAny and assigns it to the Details field.

func (*Status) SetMessage added in v0.0.2 

func (o *Status) SetMessage(v string)

SetMessage gets a reference to the given string and assigns it to the Message field.

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.