Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

openapi

package

Go to main page

Versions in this module

v2

v2.2.0

Sep 3, 2021

v2.1.0

Jul 15, 2021

v2.1.0-alpha.1

May 28, 2021

v2.0.6

Jun 11, 2021

v2.0.5

Apr 7, 2021

Changes in this version

type SpecSchemaDefinitionProperty

+ func (s *SpecSchemaDefinitionProperty) IsOptionalComputedWithDefault() bool

v2.0.4

Apr 7, 2021

v2.0.3

Mar 29, 2021

v2.0.2

Mar 17, 2021

v2.0.1

Feb 22, 2021

v2.0.0

Jan 27, 2021

Changes in this version

+ const OpenAPIPluginConfigurationFileName

+ const TypeBool

+ const TypeFloat

+ const TypeInt

+ const TypeList

+ const TypeObject

+ const TypeString

+ type ClientOpenAPI interface

+ Delete func(resource SpecResource, id string, parentIDs ...string) (*http.Response, error)

+ Get func(resource SpecResource, id string, responsePayload interface{}, ...) (*http.Response, error)

+ GetTelemetryHandler func() TelemetryHandler

+ List func(resource SpecResource, responsePayload interface{}, parentIDs ...string) (*http.Response, error)

+ Post func(resource SpecResource, requestPayload interface{}, responsePayload interface{}, ...) (*http.Response, error)

+ Put func(resource SpecResource, id string, requestPayload interface{}, ...) (*http.Response, error)

+ type MetricSubmitter func() error

+ type ParentResourceInfo struct

+ func (info *ParentResourceInfo) GetParentPropertiesNames() []string

+ func (info *ParentResourceInfo) SetParentResourceNames(parentResourceNames []string)

+ type PluginConfigSchema interface

+ GetAllServiceConfigurations func() (ServiceConfigurations, error)

+ GetServiceConfig func(providerName string) (ServiceConfiguration, error)

+ GetVersion func() (string, error)

+ Marshal func() ([]byte, error)

+ Validate func() error

+ type PluginConfigSchemaV1 struct

+ Services map[string]*ServiceConfigV1

+ Version string

+ func NewPluginConfigSchemaV1(services map[string]*ServiceConfigV1) *PluginConfigSchemaV1

+ func (p *PluginConfigSchemaV1) GetAllServiceConfigurations() (ServiceConfigurations, error)

+ func (p *PluginConfigSchemaV1) GetServiceConfig(providerName string) (ServiceConfiguration, error)

+ func (p *PluginConfigSchemaV1) GetVersion() (string, error)

+ func (p *PluginConfigSchemaV1) Marshal() ([]byte, error)

+ func (p *PluginConfigSchemaV1) Validate() error

+ type PluginConfiguration struct

+ Configuration io.Reader

+ ProviderName string

+ func NewPluginConfiguration(providerName string) (*PluginConfiguration, error)

+ type ProviderClient struct

+ func (o *ProviderClient) Delete(resource SpecResource, id string, parentIDs ...string) (*http.Response, error)

+ func (o *ProviderClient) Get(resource SpecResource, id string, responsePayload interface{}, ...) (*http.Response, error)

+ func (o *ProviderClient) GetTelemetryHandler() TelemetryHandler

+ func (o *ProviderClient) List(resource SpecResource, responsePayload interface{}, parentIDs ...string) (*http.Response, error)

+ func (o *ProviderClient) Post(resource SpecResource, requestPayload interface{}, responsePayload interface{}, ...) (*http.Response, error)

+ func (o *ProviderClient) Put(resource SpecResource, id string, requestPayload interface{}, ...) (*http.Response, error)

+ type ProviderOpenAPI struct

+ ProviderName string

+ func (p *ProviderOpenAPI) CreateSchemaProvider() (*schema.Provider, error)

+ func (p *ProviderOpenAPI) CreateSchemaProviderFromServiceConfiguration(serviceConfiguration ServiceConfiguration) (*schema.Provider, error)

+ type ServiceConfigStub struct

+ Err error

+ InsecureSkipVerify bool

+ PluginVersion string

+ SchemaConfiguration []*ServiceSchemaPropertyConfigurationStub

+ SwaggerURL string

+ Telemetry TelemetryProvider

+ func (s *ServiceConfigStub) GetPluginVersion() string

+ func (s *ServiceConfigStub) GetSwaggerURL() string

+ func (s *ServiceConfigStub) IsInsecureSkipVerifyEnabled() bool

+ func (s *ServiceConfigStub) Validate(runningPluginVersion string) error

+ func (s ServiceConfigStub) GetSchemaPropertyConfiguration(schemaPropertyName string) ServiceSchemaPropertyConfiguration

+ func (s ServiceConfigStub) GetTelemetryConfiguration() TelemetryProvider

+ type ServiceConfigV1 struct

+ InsecureSkipVerify bool

+ PluginVersion string

+ SchemaConfigurationV1 []ServiceSchemaPropertyConfigurationV1

+ SwaggerURL string

+ TelemetryConfig *TelemetryConfig

+ func NewServiceConfigV1(swaggerURL string, insecureSkipVerifyEnabled bool, ...) *ServiceConfigV1

+ func (s *ServiceConfigV1) GetPluginVersion() string

+ func (s *ServiceConfigV1) GetSchemaPropertyConfiguration(schemaPropertyName string) ServiceSchemaPropertyConfiguration

+ func (s *ServiceConfigV1) GetSwaggerURL() string

+ func (s *ServiceConfigV1) GetTelemetryConfiguration() TelemetryProvider

+ func (s *ServiceConfigV1) IsInsecureSkipVerifyEnabled() bool

+ func (s *ServiceConfigV1) Validate(runningPluginVersion string) error

+ type ServiceConfiguration interface

+ GetPluginVersion func() string

+ GetSchemaPropertyConfiguration func(schemaPropertyName string) ServiceSchemaPropertyConfiguration

+ GetSwaggerURL func() string

+ GetTelemetryConfiguration func() TelemetryProvider

+ IsInsecureSkipVerifyEnabled func() bool

+ Validate func(runningPluginVersion string) error

+ type ServiceConfigurations map[string]ServiceConfiguration

+ type ServiceSchemaPropertyConfiguration interface

+ ExecuteCommand func() error

+ GetDefaultValue func() (string, error)

+ type ServiceSchemaPropertyConfigurationStub struct

+ DefaultValue string

+ Err error

+ ExecuteCommandCalled bool

+ GetDefaultValueFunc func() (string, error)

+ SchemaPropertyName string

+ func (s *ServiceSchemaPropertyConfigurationStub) ExecuteCommand() error

+ func (s *ServiceSchemaPropertyConfigurationStub) GetDefaultValue() (string, error)

+ type ServiceSchemaPropertyConfigurationV1 struct

+ Command []string

+ CommandTimeout int

+ DefaultValue string

+ ExternalConfiguration ServiceSchemaPropertyExternalConfigurationV1

+ SchemaPropertyName string

+ func (s ServiceSchemaPropertyConfigurationV1) ExecuteCommand() error

+ func (s ServiceSchemaPropertyConfigurationV1) GetDefaultValue() (string, error)

+ type ServiceSchemaPropertyExternalConfigurationV1 struct

+ ContentType string

+ File string

+ KeyName string

+ type SpecAnalyser interface

+ GetAPIBackendConfiguration func() (SpecBackendConfiguration, error)

+ GetAllHeaderParameters func() SpecHeaderParameters

+ GetSecurity func() SpecSecurity

+ GetTerraformCompliantDataSources func() []SpecResource

+ GetTerraformCompliantResources func() ([]SpecResource, error)

+ func CreateSpecAnalyser(specAnalyserVersion SpecAnalyserVersion, openAPIDocumentURL string) (SpecAnalyser, error)

+ type SpecAnalyserVersion string

+ type SpecBackendConfiguration interface

+ GetDefaultRegion func([]string) (string, error)

+ IsMultiRegion func() (bool, string, []string, error)

+ type SpecHeaderParam struct

+ IsRequired bool

+ Name string

+ TerraformName string

+ func (h SpecHeaderParam) GetHeaderTerraformConfigurationName() string

+ type SpecHeaderParameters []SpecHeaderParam

+ type SpecResource interface

+ GetParentResourceInfo func() *ParentResourceInfo

+ GetResourceName func() string

+ GetResourceSchema func() (*SpecSchemaDefinition, error)

+ ShouldIgnoreResource func() bool

+ type SpecSchemaDefinition struct

+ Properties SpecSchemaDefinitionProperties

+ func (s *SpecSchemaDefinition) ConvertToDataSourceSpecSchemaDefinition() *SpecSchemaDefinition

+ type SpecSchemaDefinitionProperties []*SpecSchemaDefinitionProperty

+ type SpecSchemaDefinitionProperty struct

+ ArrayItemsType schemaDefinitionPropertyType

+ Computed bool

+ Default interface{}

+ Description string

+ ForceNew bool

+ IgnoreItemsOrder bool

+ Immutable bool

+ IsIdentifier bool

+ IsParentProperty bool

+ IsStatusIdentifier bool

+ Name string

+ PreferredName string

+ ReadOnly bool

+ Required bool

+ Sensitive bool

+ SpecSchemaDefinition *SpecSchemaDefinition

+ Type schemaDefinitionPropertyType

+ func (s *SpecSchemaDefinitionProperty) GetTerraformCompliantPropertyName() string

+ func (s *SpecSchemaDefinitionProperty) IsOptionalComputed() bool

+ func (s *SpecSchemaDefinitionProperty) IsRequired() bool

+ type SpecSecurity interface

+ GetAPIKeySecurityDefinitions func() (*SpecSecurityDefinitions, error)

+ GetGlobalSecuritySchemes func() (SpecSecuritySchemes, error)

+ type SpecSecurityDefinition interface

+ GetTerraformConfigurationName func() string

+ type SpecSecurityDefinitions []SpecSecurityDefinition

+ type SpecSecurityScheme struct

+ Name string

+ func (o *SpecSecurityScheme) GetTerraformConfigurationName() string

+ type SpecSecuritySchemes []SpecSecurityScheme

+ type SpecV2Resource struct

+ InstancePathItem spec.PathItem

+ Name string

+ Path string

+ Paths map[string]spec.PathItem

+ Region string

+ RootPathItem spec.PathItem

+ SchemaDefinition spec.Schema

+ SchemaDefinitions map[string]spec.Schema

+ func (o *SpecV2Resource) GetParentResourceInfo() *ParentResourceInfo

+ func (o *SpecV2Resource) GetResourceName() string

+ func (o *SpecV2Resource) GetResourceSchema() (*SpecSchemaDefinition, error)

+ func (o *SpecV2Resource) ShouldIgnoreResource() bool

+ type TelemetryConfig struct

+ Graphite *TelemetryProviderGraphite

+ HTTPEndpoint *TelemetryProviderHTTPEndpoint

+ type TelemetryHandler interface

+ SubmitPluginExecutionMetrics func()

+ SubmitResourceExecutionMetrics func(resourceName string, tfOperation TelemetryResourceOperation)

+ type TelemetryProvider interface

+ GetTelemetryProviderConfiguration func(data *schema.ResourceData) TelemetryProviderConfiguration

+ IncOpenAPIPluginVersionTotalRunsCounter func(openAPIPluginVersion string, ...) error

+ IncServiceProviderResourceTotalRunsCounter func(providerName, resourceName string, tfOperation TelemetryResourceOperation, ...) error

+ Validate func() error

+ type TelemetryProviderConfiguration interface

+ type TelemetryProviderGraphite struct

+ Host string

+ Port int

+ Prefix string

+ func (g TelemetryProviderGraphite) GetTelemetryProviderConfiguration(data *schema.ResourceData) TelemetryProviderConfiguration

+ func (g TelemetryProviderGraphite) IncOpenAPIPluginVersionTotalRunsCounter(openAPIPluginVersion string, ...) error

+ func (g TelemetryProviderGraphite) IncServiceProviderResourceTotalRunsCounter(providerName, resourceName string, tfOperation TelemetryResourceOperation, ...) error

+ func (g TelemetryProviderGraphite) Validate() error

+ type TelemetryProviderHTTPEndpoint struct

+ Prefix string

+ ProviderSchemaProperties []string

+ URL string

+ func (g TelemetryProviderHTTPEndpoint) GetTelemetryProviderConfiguration(data *schema.ResourceData) TelemetryProviderConfiguration

+ func (g TelemetryProviderHTTPEndpoint) IncOpenAPIPluginVersionTotalRunsCounter(openAPIPluginVersion string, ...) error

+ func (g TelemetryProviderHTTPEndpoint) IncServiceProviderResourceTotalRunsCounter(providerName, resourceName string, tfOperation TelemetryResourceOperation, ...) error

+ func (g TelemetryProviderHTTPEndpoint) Validate() error

+ type TelemetryResourceOperation string

+ const TelemetryResourceOperationCreate

+ const TelemetryResourceOperationDelete

+ const TelemetryResourceOperationImport

+ const TelemetryResourceOperationRead

+ const TelemetryResourceOperationUpdate

v2.0.0-alpha.2

Jan 30, 2021

v2.0.0-alpha.1

Jan 27, 2021

Other modules containing this package

github.com/dikhan/terraform-provider-openapi

github.com/dikhan/terraform-provider-openapi/v3