Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

api

package

Go to main page

Versions in this module

v1

v1.12.0

Aug 20, 2026

Changes in this version

+ type Type struct

+ Element *Type

+ Kind TypeKind

+ Name string

+ Types []Type

+ func ParseType(input string) (Type, error)

+ type TypeKind string

+ const TypeKindList

+ const TypeKindNamed

+ const TypeKindUnion

v1.11.0

Aug 17, 2026

v1.10.0

Aug 16, 2026

v1.9.0

Aug 11, 2026

Changes in this version

+ const IndexSchemaV1

+ const IndexSchemaVersion

+ func ValidateIndex(index *Index) error

+ type Index struct

+ Latest string

+ SchemaVersion int

+ Versions []IndexVersion

+ func ParseIndex(data []byte) (*Index, error)

+ type IndexVersion struct

+ Href string

+ Version string

v1.8.0

Aug 10, 2026

v1.7.0

Aug 10, 2026

Changes in this version

+ const SchemaV1

+ const SchemaVersion

+ func Validate(reference *Reference) error

+ type Documentation struct

+ Deprecated string

+ Description string

+ Parameters []Parameter

+ Return *Return

+ Throws []Throw

+ func ParseDocumentation(text string) (Documentation, error)

+ type DocumentationError struct

+ Annotation string

+ Detail string

+ Kind DocumentationErrorKind

+ Line int

+ func (e *DocumentationError) Error() string

+ type DocumentationErrorKind string

+ const DocumentationErrorDuplicateParameter

+ const DocumentationErrorMalformedAnnotation

+ const DocumentationErrorMultipleDeprecations

+ const DocumentationErrorMultipleReturns

+ type Function struct

+ Name string

+ Signatures []Signature

+ type Namespace struct

+ Functions []Function

+ Name string

+ type Parameter struct

+ Description string

+ Name string

+ Type string

+ type Reference struct

+ ID string

+ Namespaces []Namespace

+ SchemaVersion int

+ Version string

+ func Parse(data []byte) (*Reference, error)

+ type Return struct

+ Description string

+ Type string

+ type Signature struct

+ Deprecated string

+ Description string

+ Parameters []Parameter

+ Return *Return

+ Throws []Throw

+ Variadic bool

+ type Throw struct

+ Description string

+ Error string

+ type UnsupportedVersionError struct

+ Version int

+ func (e *UnsupportedVersionError) Error() string