config

package
v0.1.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 11, 2023 License: MIT Imports: 0 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GenerationConfig

type GenerationConfig struct {
	Specs []Spec `json:"specs"`
}

GenerationConfig configures the generation of the Terraform provider.

type ResourceConfig

type ResourceConfig struct {
	TypeNameSuffix      string `json:"type_name_suffix"`
	Description         string `json:"description"`
	MarkdownDescription string `json:"markdown_description"`
	OpenapiSchema       string `json:"openapi_schema"`
	RestCollectionPath  string `json:"rest_collection_path"`
	RestResourcePath    string `json:"rest_resource_path"`
	// Map path param names (e.g. "id") to the name of the OpenAPI schema
	// property whose value should be used to replace the path param in URLs.
	// Schema property names should be lower_snake_case
	PathParamsToSchemaProperty map[string]string `json:"path_params_to_schema_property"`
}

ResourceConfig describes a resource that should be generated.

type Spec

type Spec struct {
	File                 string           `json:"file"`
	GeneratedFilePackage string           `json:"generated_file_package"`
	Resources            []ResourceConfig `json:"resources"`
}

Spec configures the generation of resources from a single OpenAPI spec.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL