utils

Documentation

Index

• func ApplyPatch(input []byte, patchFiles []PatchConfig) ([]byte, error)
• func ApplyPatchFromRawJSON(input []byte, patchFiles []PatchConfig) ([]byte, error)
• func ApplyPatchToHTTPSchema(input *schema.NDCHttpSchema, patchFiles []PatchConfig) (*schema.NDCHttpSchema, error)
• func MarshalSchema(content any, format schema.SchemaFileFormat) ([]byte, error)
• func ReadFileFromPath(filePath string) ([]byte, error)
• func RemoveYAMLSpecialCharacters(input []byte) []byte
• func ResolveFilePath(dir string, filePath string) string
• func SliceUnorderedEqual[T cmp.Ordered](a []T, b []T) bool
• func SplitStringsAndTrimSpaces(input string, sep string) []string
• func StringSliceToCamelCase(inputs []string) string
• func StringSliceToConstantCase(inputs []string) string
• func StringSliceToPascalCase(inputs []string) string
• func StringSliceToSnakeCase(inputs []string) string
• func StripHTMLTags(str string) string
• func ToCamelCase(input string) string
• func ToConstantCase(input string) string
• func ToPascalCase(input string) string
• func ToSnakeCase(input string) string
• func WalkFiles(filePath string, callback func(data []byte) error) error
• func WriteSchemaFile(outputPath string, content any) error
• type PatchConfig
• type PatchStrategy

Functions

func ApplyPatch

func ApplyPatch(input []byte, patchFiles []PatchConfig) ([]byte, error)

ApplyPatch applies patches to the raw bytes input

func ApplyPatchFromRawJSON

func ApplyPatchFromRawJSON(input []byte, patchFiles []PatchConfig) ([]byte, error)

ApplyPatchFromRawJSON applies patches to the raw JSON bytes input without validation request

func ApplyPatchToHTTPSchema

func ApplyPatchToHTTPSchema(input *schema.NDCHttpSchema, patchFiles []PatchConfig) (*schema.NDCHttpSchema, error)

ApplyPatchToHTTPSchema applies JSON patches to NDC HTTP schema and validate the output

func MarshalSchema

func MarshalSchema(content any, format schema.SchemaFileFormat) ([]byte, error)

MarshalSchema encodes the NDC HTTP schema to bytes

func ReadFileFromPath

func ReadFileFromPath(filePath string) ([]byte, error)

ReadFileFromPath read file content from either file path or URL

func RemoveYAMLSpecialCharacters

func RemoveYAMLSpecialCharacters(input []byte) []byte

RemoveYAMLSpecialCharacters remote special characters to avoid YAML unmarshaling error

func ResolveFilePath

func ResolveFilePath(dir string, filePath string) string

ResolveFilePath resolves file path with directory

func SliceUnorderedEqual

func SliceUnorderedEqual[T cmp.Ordered](a []T, b []T) bool

SliceUnorderedEqual compares if both slices are equal with unordered positions

func SplitStringsAndTrimSpaces

func SplitStringsAndTrimSpaces(input string, sep string) []string

SplitStrings wrap strings.Split with all leading and trailing white space removed

func StringSliceToCamelCase

func StringSliceToCamelCase(inputs []string) string

StringSliceToCamelCase convert a slice of strings to camelCase

func StringSliceToConstantCase

func StringSliceToConstantCase(inputs []string) string

StringSliceToConstantCase convert a slice of string to CONSTANT_CASE

func StringSliceToPascalCase

func StringSliceToPascalCase(inputs []string) string

StringSliceToPascalCase convert a slice of string to PascalCase

func StringSliceToSnakeCase

func StringSliceToSnakeCase(inputs []string) string

StringSliceToSnakeCase convert a slice of string to snake_case

func StripHTMLTags

func StripHTMLTags(str string) string

StripHTMLTags aggressively strips HTML tags from a string. It will only keep anything between `>` and `<`.

func ToCamelCase

func ToCamelCase(input string) string

ToCamelCase convert a string to camelCase

func ToConstantCase

func ToConstantCase(input string) string

ToConstantCase converts string to CONSTANT_CASE

func ToPascalCase

func ToPascalCase(input string) string

ToPascalCase convert a string to PascalCase

func ToSnakeCase

func ToSnakeCase(input string) string

ToSnakeCase converts string to snake_case

func WalkFiles

func WalkFiles(filePath string, callback func(data []byte) error) error

WalkFiles read one file or many files in a folder if the file path is a directory

func WriteSchemaFile

func WriteSchemaFile(outputPath string, content any) error

WriteSchemaFile writes the NDC HTTP schema to file

Types

type PatchConfig

type PatchConfig struct {
	Path     string        `json:"path"     yaml:"path"`
	Strategy PatchStrategy `json:"strategy" jsonschema:"enum=merge,enum=json6902" yaml:"strategy"`
}

PatchConfig the configuration for JSON patch

type PatchStrategy

type PatchStrategy string

PatchStrategy represents the patch strategy enum

const (
	// PatchStrategyMerge the merge strategy enum for [RFC 7396] specification
	//
	// [RFC 7396]: https://datatracker.ietf.org/doc/html/rfc7396
	PatchStrategyMerge PatchStrategy = "merge"
	// PatchStrategyJSON6902 the patch strategy enum for [RFC 6902] specification
	//
	// [RFC 6902]: https://datatracker.ietf.org/doc/html/rfc6902
	PatchStrategyJSON6902 PatchStrategy = "json6902"
)