openapi

type ClientOpenAPI interface {
	Post(resource SpecResource, requestPayload interface{}, responsePayload interface{}) (*http.Response, error)
	Put(resource SpecResource, id string, requestPayload interface{}, responsePayload interface{}) (*http.Response, error)
	Get(resource SpecResource, id string, responsePayload interface{}) (*http.Response, error)
	Delete(resource SpecResource, id string) (*http.Response, error)
}

type PluginConfigSchema interface {
	// Validate performs a check to confirm that the schema content is correct
	Validate() error
	// GetServiceConfig returns the service configuration for a given provider name
	GetServiceConfig(providerName string) (ServiceConfiguration, error)
	// GetAllServiceConfigurations returns all the service configuration
	GetAllServiceConfigurations() (ServiceConfigurations, error)
	// GetVersion returns the plugin configuration version
	GetVersion() (string, error)
	// Marshal serializes the value provided into a YAML document
	Marshal() ([]byte, error)
}

type PluginConfigSchemaV1 struct {
	Version  string                      `yaml:"version"`
	Services map[string]*ServiceConfigV1 `yaml:"services"`
}

type PluginConfiguration struct {
	// ProviderName defines the <provider_name> (should match the provider name of the terraform provider binary; terraform-provider-<provider_name>)
	ProviderName string
	// Configuration defines the reader that contains the plugin's external configuration (located at ~/.terraform.d/plugins)
	// If the plugin configuration file is not present the OTF_VAR_<provider_name>_SWAGGER_URL environment variable will
	// be required when invoking the openapi provider.
	// If at runtime both the OTF_VAR_<provider_name>_SWAGGER_URL as well as the plugin configuration file are present
	// the former takes preference. This allows the user to override the url specified in the configuration file with
	// the value provided in the OTF_VAR_<provider_name>_SWAGGER_URL
	Configuration io.Reader
}

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

type ProviderOpenAPI struct {
	ProviderName string
	// contains filtered or unexported fields
}

type ServiceConfigV1 struct {
	// SwaggerURL defines where the swagger is located
	SwaggerURL string `yaml:"swagger-url"`
	// InsecureSkipVerify defines whether the internal http client used to fetch the swagger file should verify the server cert
	// or not. This should only be used purposefully if the server is using a self-signed cert and only if the server is trusted
	InsecureSkipVerify bool `yaml:"insecure_skip_verify"`
	// SchemaConfigurationV1 represents the list of schema property configurations
	SchemaConfigurationV1 []ServiceSchemaPropertyConfigurationV1 `yaml:"schema_configuration"`
}

type ServiceConfiguration interface {
	// GetSwaggerURL returns the URL where the service swagger doc is exposed
	GetSwaggerURL() string
	// IsInsecureSkipVerifyEnabled returns true if the given provider's service configuration has InsecureSkipVerify enabled; false
	// otherwise
	IsInsecureSkipVerifyEnabled() bool
	// GetSchemaPropertyConfiguration returns the schema configuration for the given schemaPropertyName
	GetSchemaPropertyConfiguration(schemaPropertyName string) ServiceSchemaPropertyConfiguration
}

type ServiceConfigurations map[string]ServiceConfiguration

type ServiceSchemaPropertyConfiguration interface {
	GetDefaultValue() (string, error)
	ExecuteCommand() error
}

type ServiceSchemaPropertyConfigurationV1 struct {
	SchemaPropertyName    string                                       `yaml:"schema_property_name"`
	DefaultValue          string                                       `yaml:"default_value"`
	Command               []string                                     `yaml:"cmd,flow"`
	CommandTimeout        int                                          `yaml:"cmd_timeout"`
	ExternalConfiguration ServiceSchemaPropertyExternalConfigurationV1 `yaml:"schema_property_external_configuration"`
}

type ServiceSchemaPropertyExternalConfigurationV1 struct {
	// File defines the file containing the value of the schema property
	File string `yaml:"file"`
	// KeyName defines the specific key to look for within the File (only when json content type)
	KeyName string `yaml:"key_name"`
	// ContentType defines the type of content the File has
	ContentType string `yaml:"content_type"` // Currently supported types: raw, json
}

type SpecAnalyser interface {
	// GetTerraformCompliantResources defines the method that is meant to discover the paths from the OpenAPI document
	// that are considered Terraform compliant, returning a list of SpecResource or an error otherwise.
	GetTerraformCompliantResources() ([]SpecResource, error)
	// GetSecurity returns a SpecSecurity based on the security defined in the OpenAPI document
	GetSecurity() SpecSecurity
	// GetAllHeaderParameters returns SpecHeaderParameters containing all the headers defined in the OpenAPI document. This
	// enabled the OpenAPI provider to expose the headers as configurable properties available in the OpenAPI Terraform
	// provider; so users can provide values for the headers that are meant to be sent along with the operations the headers
	// are defined in.
	GetAllHeaderParameters() (SpecHeaderParameters, error)
	// GetAPIBackendConfiguration encapsulates all the information related to the backend in the OpenAPI doc
	// (e,g: host, protocols, etc) which is then used in the ProviderClient to communicate with the API as specified in
	// the configuration.
	GetAPIBackendConfiguration() (SpecBackendConfiguration, error)
}

type SpecAnalyserVersion string

type SpecBackendConfiguration interface {
	// contains filtered or unexported methods
}

type SpecHeaderParam struct {
	Name          string
	TerraformName string
}

type SpecHeaderParameters []SpecHeaderParam

type SpecResource interface {
	// contains filtered or unexported methods
}

type SpecSecurity interface {
	// GetAPIKeySecurityDefinitions returns all the OpenAPI security definitions from the OpenAPI document and translates those
	// into SpecSecurityDefinitions
	GetAPIKeySecurityDefinitions() (*SpecSecurityDefinitions, error)
	// GetGlobalSecuritySchemes returns all the global security schemes from the OpenAPI document and translates those
	// into SpecSecuritySchemes
	GetGlobalSecuritySchemes() (SpecSecuritySchemes, error)
}

type SpecSecurityDefinition interface {
	// contains filtered or unexported methods
}

type SpecSecurityDefinitions []SpecSecurityDefinition

type SpecSecurityScheme struct {
	Name string
}

type SpecSecuritySchemes []SpecSecurityScheme

type SpecV2Resource struct {
	Name   string
	Region string
	// Path contains the full relative path to the resource e,g: /v1/resource
	Path string
	// SpecSchemaDefinition definition represents the representational state (aka model) of the resource
	SchemaDefinition spec.Schema
	// RootPathItem contains info about the resource root path e,g: /resource, including the POST operation used to create instances of this resource
	RootPathItem spec.PathItem
	// InstancePathItem contains info about the resource's instance /resource/{id}, including GET, PUT and REMOVE operations if applicable
	InstancePathItem spec.PathItem

	// SchemaDefinitions contains all the definitions which might be needed in case the resource schema contains properties
	// of type object which in turn refer to other definitions
	SchemaDefinitions map[string]spec.Schema
}