files

Documentation

Overview

Package files provides file resolution and pattern matching for OpenAPI specs.

Index

• Variables
• func IsOpenAPIFile(path string) bool
• func MatchGlob(path, pattern string) (bool, error)
• func ResolveSpecs(args []string, recursive bool, include, exclude []string) ([]string, error)

Variables

var OpenAPIExtensions = []string{".yaml", ".yml", ".json"}

OpenAPIExtensions are file extensions that may contain OpenAPI specs.

var OpenAPIPatterns = []string{
	"openapi",
	"swagger",
	"api-spec",
	"api_spec",
}

OpenAPIPatterns are filename patterns that typically indicate OpenAPI specs.

Functions

func IsOpenAPIFile

func IsOpenAPIFile(path string) bool

IsOpenAPIFile returns true if the path looks like an OpenAPI specification.

func MatchGlob

func MatchGlob(path, pattern string) (bool, error)

MatchGlob is the exported version of matchGlob.

func ResolveSpecs

func ResolveSpecs(args []string, recursive bool, include, exclude []string) ([]string, error)

ResolveSpecs resolves file arguments to a list of OpenAPI spec files. It handles:

• Explicit file paths
• Glob patterns (e.g., "api/*.yaml")
• Directories (with recursive flag)

The include/exclude patterns filter the results.