hooks

package
v0.1.1 Latest Latest
Warning

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

Go to latest
Published: Jul 30, 2025 License: MIT Imports: 3 Imported by: 0

Documentation

Overview

Interfaces that users may implement to expand the documentation.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type HasDescription

type HasDescription = doc.HasDescription

Implement this to add a description to all instances of a type.

type HasEnum

type HasEnum = schema.IsEnum

Implement this on enums of constants to let gousset list all the possibilities.

type HasExample

type HasExample = example.HasExample

Implement this to add an example without comments to all instances of a type.

type HasExamples

type HasExamples = example.HasExamples

Implement this to add a examples with comments to all instances of a type.

type HasExternalDocs

type HasExternalDocs = doc.HasExternalDocs

Implement this to add external docs to all instances of a type.

type HasFormat

type HasFormat = schema.HasFormat

Implement this on numbers or strings to restrict to a specific format.

type HasMax

type HasMax = schema.HasMax

Implement this to mark a maximal value for a number.

type HasMaxArrayLength

type HasMaxArrayLength = schema.HasMaxArrayLength

Implement this to mark a maximal length for an array.

type HasMaxMapLength

type HasMaxMapLength = schema.HasMaxMapLength

Implement this to mark a maximal length for an array.

type HasMaxStringLength

type HasMaxStringLength = schema.HasMaxStringLength

Implement this to mark a maximal length for a string.

type HasMin

type HasMin = schema.HasMin

Implement this to mark a minimal value for a number.

type HasMinArrayLength

type HasMinArrayLength = schema.HasMinArrayLength

Implement this to mark a minimal length for an array.

type HasMinMapLength

type HasMinMapLength = schema.HasMinMapLength

Implement this to mark a minimal length for an array.

type HasMinStringLength

type HasMinStringLength = schema.HasMinStringLength

Implement this to mark a minimal length for a string.

type HasSchema

type HasSchema = schema.HasSchema

Implement this to override the schema that gousset infers for a type.

type HasSummary

type HasSummary = doc.HasSummary

Implement this to add a summary to all instances of a type.

Jump to

Keyboard shortcuts

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