openapi

package

v0.1.0 Latest Latest Go to latest Published: Nov 1, 2026 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/arkoren/arkoren

Links

Open Source Insights

Documentation ¶

Overview ¶

Package openapi exports descriptive route snapshots as OpenAPI documents. Validation applies only to the supported envelope, not schema keywords.

Index ¶

func Export(document snapshot.Document, records []snapshot.Route) ([]byte, error)
func ValidateSecurityScheme(name string, scheme map[string]any) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Export ¶

func Export(document snapshot.Document, records []snapshot.Route) ([]byte, error)

Export renders completed document settings and registration-ordered routes. Snapshot containers are read-only; inferred parameters enter detached copies.

func ValidateSecurityScheme ¶

func ValidateSecurityScheme(name string, scheme map[string]any) error

ValidateSecurityScheme supports a deliberately bounded subset with explicit required fields. Unsupported kinds are errors rather than guessed policies.

Types ¶

This section is empty.

Source Files ¶

View all Source files

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