Versions in this module Expand all Collapse all v3 v3.0.0 Apr 19, 2022 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) GetSwaggerURL() string + func (s *ServiceConfigStub) IsInsecureSkipVerifyEnabled() bool + func (s *ServiceConfigStub) Validate() error + func (s ServiceConfigStub) GetSchemaPropertyConfiguration(schemaPropertyName string) ServiceSchemaPropertyConfiguration + func (s ServiceConfigStub) GetTelemetryConfiguration() TelemetryProvider + type ServiceConfigV1 struct + InsecureSkipVerify bool + SchemaConfigurationV1 []ServiceSchemaPropertyConfigurationV1 + SwaggerURL string + TelemetryConfig *TelemetryConfig + func NewServiceConfigV1(swaggerURL string, insecureSkipVerifyEnabled bool, ...) *ServiceConfigV1 + 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() error + type ServiceConfiguration interface + GetSchemaPropertyConfiguration func(schemaPropertyName string) ServiceSchemaPropertyConfiguration + GetSwaggerURL func() string + GetTelemetryConfiguration func() TelemetryProvider + IsInsecureSkipVerifyEnabled func() bool + Validate func() 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) IsOptionalComputedWithDefault() 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 + 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 Other modules containing this package github.com/dikhan/terraform-provider-openapi github.com/dikhan/terraform-provider-openapi/v2
Go to main page