mapper

Documentation

Overview

Package mapper includes the types and methods for mapping provider, resource, and data source types (explorer package) from an OpenAPI specification into Provider Code Specification.

Index

• func NewDataSourceRequestMapper(datasource explorer.DataSource, name string, cfg config.Config) datasourceRequestMapper
• func NewResourceRequestMapper(resource explorer.Resource, name string, cfg config.Config) resourceRequestMapper
• type CRUDParameters
• type DataSourceMapper
  • func NewDataSourceMapper(dataSources map[string]explorer.DataSource, cfg config.Config) DataSourceMapper
• type DetailDataSourceInfo
• type DetailResourceInfo
• type DetailedRequestType
• type NcloudCommonRequestType
• type NcloudRequestBody
• type ProviderMapper
  • func NewProviderMapper(exploredProvider explorer.Provider, cfg config.Config) ProviderMapper
• type ProviderWithEndpoint
• type RequestMapper
• type RequestParameterAttributes
• type RequestParameters
• type ResourceMapper
  • func NewResourceMapper(resources map[string]explorer.Resource, cfg config.Config) ResourceMapper

Functions

func NewDataSourceRequestMapper

func NewDataSourceRequestMapper(datasource explorer.DataSource, name string, cfg config.Config) datasourceRequestMapper

func NewResourceRequestMapper

func NewResourceRequestMapper(resource explorer.Resource, name string, cfg config.Config) resourceRequestMapper

Types

type CRUDParameters

type CRUDParameters struct {
	Create *NcloudCommonRequestType   `json:"create,omitempty"`
	Read   *NcloudCommonRequestType   `json:"read,omitempty"`
	Update []*NcloudCommonRequestType `json:"update,omitempty"`
	Delete *NcloudCommonRequestType   `json:"delete,omitempty"`
}

type DataSourceMapper

type DataSourceMapper interface {
	MapToIR(*slog.Logger) ([]DetailDataSourceInfo, error)
}

func NewDataSourceMapper

func NewDataSourceMapper(dataSources map[string]explorer.DataSource, cfg config.Config) DataSourceMapper

type DetailDataSourceInfo

type DetailDataSourceInfo struct {
	datasource.DataSource
	CRUDParameters      CRUDParameters `json:"crud_parameters"`
	RefreshObjectName   string         `json:"refresh_object_name"`
	ImportStateOverride string         `json:"import_state_override"`
	Id                  string         `json:"id"`
}

type DetailResourceInfo

type DetailResourceInfo struct {
	resource.Resource
	CRUDParameters      CRUDParameters `json:"crud_parameters"`
	RefreshObjectName   string         `json:"refresh_object_name"`
	ImportStateOverride string         `json:"import_state_override"`
	Id                  string         `json:"id"`
}

type DetailedRequestType

type DetailedRequestType struct {
	spec.RequestType
	Parameters  *RequestParameters `json:"parameters,omitempty"`
	RequestBody *NcloudRequestBody `json:"request_body,omitempty"`
}

type NcloudCommonRequestType

type NcloudCommonRequestType struct {
	DetailedRequestType
	Method string `json:"method,omitempty"`
	Path   string `json:"path,omitempty"`
}

type NcloudRequestBody

type NcloudRequestBody struct {
	spec.RequestBody
	Required []*RequestParameterAttributes `json:"required,omitempty"`
	Optional []*RequestParameterAttributes `json:"optional,omitempty"`
}

type ProviderMapper

type ProviderMapper interface {
	MapToIR(*slog.Logger) (*ProviderWithEndpoint, error)
}

func NewProviderMapper

func NewProviderMapper(exploredProvider explorer.Provider, cfg config.Config) ProviderMapper

type ProviderWithEndpoint

type ProviderWithEndpoint struct {
	provider.Provider
	Endpoint string `json:"endpoint"`
}

type RequestMapper

type RequestMapper interface {
	MapToIR(*slog.Logger) (CRUDParameters, error)
}

type RequestParameterAttributes

type RequestParameterAttributes struct {
	Name   string `json:"name,omitempty"`
	Type   string `json:"type,omitempty"`
	Format string `json:"format,omitempty"`
}

type RequestParameters

type RequestParameters struct {
	Required []*RequestParameterAttributes `json:"required,omitempty"`
	Optional []*RequestParameterAttributes `json:"optional,omitempty"`
}

type ResourceMapper

type ResourceMapper interface {
	MapToIR(*slog.Logger) ([]DetailResourceInfo, error)
}

func NewResourceMapper

func NewResourceMapper(resources map[string]explorer.Resource, cfg config.Config) ResourceMapper