openapi

Documentation

Index

• Constants
• func BuildValidationFunc(s *openapi3.Schema) string
• func ConvertToTFSchema(name string, scope *tf.TerraformScope, s *openapi3.Schema) (*tf.TerraformSchema, error)
• func CreateTFSchemaFromOpenAPI(path string, outputFolderPath string) error
• func GetTFType(s *openapi3.Schema) (string, error)
• func GetTFValidationFunc(format string) string
• func OpenAPI3ToTerraform(filePath string) (*tf.TerraformScope, error)

Constants

const (
	TypeString  = "string"
	TypeBoolean = "boolean"
	TypeInteger = "integer"
	TypeNumber  = "number"
	TypeObject  = "object"
	TypeArray   = "array"
)

Constants for the OpenAPI types.

const (
	FormatInt64 = "int64"
)

Known Formats.

Functions

func BuildValidationFunc

func BuildValidationFunc(s *openapi3.Schema) string

BuildValidationFunc builds a Terraform validation from an OpenAPI schema.

func ConvertToTFSchema

func ConvertToTFSchema(
	name string,
	scope *tf.TerraformScope,
	s *openapi3.Schema,
) (*tf.TerraformSchema, error)

ConvertToTFSchema converts an OpenAPI schema to a Terraform schema.

func CreateTFSchemaFromOpenAPI

func CreateTFSchemaFromOpenAPI(path string, outputFolderPath string) error

func GetTFType

func GetTFType(s *openapi3.Schema) (string, error)

GetTFType returns the Terraform type that corresponds to the given OpenAPI type.

func GetTFValidationFunc

func GetTFValidationFunc(format string) string

GetTFValidationFunc returns a Terraform validation function that corresponds to the given format.

func OpenAPI3ToTerraform

func OpenAPI3ToTerraform(filePath string) (*tf.TerraformScope, error)