# Packages
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Functions
CreateSpecAnalyser is a factory method that returns the appropriate implementation of SpecAnalyser depending upon the openApiSpecAnalyserVersion passed in.
NewPluginConfigSchemaV1 creates a new PluginConfigSchemaV1 that implements PluginConfigSchema interface.
NewPluginConfiguration creates a new PluginConfiguration.
NewServiceConfigV1 creates a new instance of NewServiceConfigV1 struct with the values provided.
# Constants
OpenAPIPluginConfigurationFileName defines the file name used for the OpenAPI plugin configuration.
TelemetryResourceOperationCreate represents the create operation invocation.
TelemetryResourceOperationDelete represents the delete operation invocation.
TelemetryResourceOperationImport represents the import operation invocation.
TelemetryResourceOperationRead represents the read operation invocation.
TelemetryResourceOperationUpdate represents the update operation invocation.
TypeBool defines a schema definition property of type bool.
TypeFloat defines a schema definition property of type float.
TypeInt defines a schema definition property of type int.
TypeList defines a schema definition property of type list.
TypeObject defines a schema definition property of type object.
TypeString defines a schema definition property of type int.
# Structs
ParentResourceInfo contains the information related to the parent information.
PluginConfigSchemaV1 defines PluginConfigSchema version 1 Configuration example: version: '1' services: monitor: swagger-url: http://monitor-api.com/swagger.json plugin_version: 0.14.0 insecure_skip_verify: true cdn: swagger-url: https://cdn-api.com/swagger.json vm: swagger-url: http://vm-api.com/swagger.json.
PluginConfiguration defines the OpenAPI plugin's configuration.
ProviderClient defines a client that is configured based on the OpenAPI server side documentation The CRUD operations accept an OpenAPI operation which defines among other things the security scheme applicable to the API when making the HTTP requests.
ProviderOpenAPI defines the struct for the OpenAPI Terraform Provider.
ServiceConfigStub implements the ServiceConfiguration interface and can be used to simplify the creation of the ProviderOpenAPI provider by calling the CreateSchemaProviderWithConfiguration function passing in the stub wit the swagger URL populated with the URL where the openapi doc is hosted.
ServiceConfigV1 defines configuration for the service provider.
ServiceSchemaPropertyConfigurationStub implements the ServiceSchemaPropertyConfiguration and can be used to simplify tests that require ServiceSchemaPropertyConfiguration implemenations.
ServiceSchemaPropertyConfigurationV1 implements the ServiceSchemaPropertyConfiguration and defines the different fields supported that enable the configuration of the provider's properties via the terraform-provider-openapi.yaml plugin config file.
ServiceSchemaPropertyExternalConfigurationV1 defines the external configuration for a provider property.
SpecHeaderParam defines the properties for a Header Parameter.
SpecSchemaDefinition defines a struct for a schema definition.
SpecSchemaDefinitionProperty defines the attributes for a schema property.
SpecSecurityScheme defines a security scheme.
SpecV2Resource defines a struct that implements the SpecResource interface and it's based on OpenAPI v2 specification.
TelemetryConfig contains the configuration for the telemetry.
TelemetryProviderGraphite defines the configuration for Graphite.
TelemetryProviderHTTPEndpoint defines the configuration for HTTPEndpoint.
# Interfaces
ClientOpenAPI defines the behaviour expected to be implemented for the OpenAPI Client used in the Terraform OpenAPI Provider.
PluginConfigSchema defines the interface/expected behaviour for PluginConfigSchema implementations.
ServiceConfiguration defines the interface/expected behaviour for ServiceConfiguration implementations.
ServiceSchemaPropertyConfiguration defines the behaviour expected for the service schema property configuration.
SpecAnalyser analyses the swagger doc and provides helper methods to retrieve all the end points that can be used as terraform resources.
SpecBackendConfiguration defines the behaviour related to the OpenAPI doc backend configuration.
SpecResource defines the behaviour related to terraform compliant OpenAPI Resources.
SpecSecurity defines the behaviour related to OpenAPI security.
SpecSecurityDefinition defines the behaviour expected for security definition implementations.
TelemetryHandler is responsible for making sure that metrics are shipped to all the telemetry providers registered and also ensures that metrics submissions are configured with timeouts.
TelemetryProvider holds the behaviour expected to be implemented for the Telemetry Providers supported.
TelemetryProviderConfiguration defines the struct type that specific telemetry providers can configure based on the resource data received in GetTelemetryProviderConfiguration.
# Type aliases
MetricSubmitter is the function holding the logic that actually submits the metric.
ServiceConfigurations contains the map with all service configurations.
SpecAnalyserVersion defines the type for versions supported in the SpecAnalyser.
SpecHeaderParameters groups a list of SpecHeaderParam.
SpecSchemaDefinitionProperties defines a collection of schema definition properties.
SpecSecurityDefinitions groups a list of SpecSecurityDefinition.
SpecSecuritySchemes groups a list of SpecSecurityScheme.
TelemetryResourceOperation defines the resource operation (CRUD) to be used in the telemetry metric.