spec

package
v0.5.0 Latest Latest
Warning

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

 Go to latest Published: Jul 4, 2026 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Register 

func Register(c Comment)

Register registers a comment to the default registry.

Types

type Comment 

type Comment interface {
	Tag() string
	Usage() string
	ParseInto(c string, s *openapi.Extendable[openapi.OpenAPI]) error
}

type ExternalDocsDescriptionComment 

type ExternalDocsDescriptionComment struct{}

func (*ExternalDocsDescriptionComment) ParseInto 

func (c *ExternalDocsDescriptionComment) ParseInto(line string, s *openapi.Extendable[openapi.OpenAPI]) error

ParseInto implements Comment.

func (*ExternalDocsDescriptionComment) Tag 

func (c *ExternalDocsDescriptionComment) Tag() string

Tag implements Comment.

func (*ExternalDocsDescriptionComment) Usage 

func (c *ExternalDocsDescriptionComment) Usage() string

Usage implements Comment.

type ExternalDocsURLComment 

type ExternalDocsURLComment struct{}

func (*ExternalDocsURLComment) ParseInto 

func (c *ExternalDocsURLComment) ParseInto(line string, s *openapi.Extendable[openapi.OpenAPI]) error

ParseInto implements Comment.

func (*ExternalDocsURLComment) Tag 

func (c *ExternalDocsURLComment) Tag() string

Tag implements Comment.

func (*ExternalDocsURLComment) Usage 

func (c *ExternalDocsURLComment) Usage() string

Usage implements Comment.

type InfoContactEmailComment 

type InfoContactEmailComment struct{}

func (*InfoContactEmailComment) ParseInto 

func (c *InfoContactEmailComment) ParseInto(line string, s *openapi.Extendable[openapi.OpenAPI]) error

ParseInto implements Comment.

func (*InfoContactEmailComment) Tag 

func (c *InfoContactEmailComment) Tag() string

Tag implements Comment.

func (*InfoContactEmailComment) Usage 

func (c *InfoContactEmailComment) Usage() string

Usage implements Comment.

type InfoContactNameComment 

type InfoContactNameComment struct{}

func (*InfoContactNameComment) ParseInto 

func (c *InfoContactNameComment) ParseInto(line string, s *openapi.Extendable[openapi.OpenAPI]) error

ParseInto implements Comment.

func (*InfoContactNameComment) Tag 

func (c *InfoContactNameComment) Tag() string

Tag implements Comment.

func (*InfoContactNameComment) Usage 

func (c *InfoContactNameComment) Usage() string

Usage implements Comment.

type InfoContactURLComment 

type InfoContactURLComment struct{}

func (*InfoContactURLComment) ParseInto 

func (c *InfoContactURLComment) ParseInto(line string, s *openapi.Extendable[openapi.OpenAPI]) error

ParseInto implements Comment.

func (*InfoContactURLComment) Tag 

func (c *InfoContactURLComment) Tag() string

Tag implements Comment.

func (*InfoContactURLComment) Usage 

func (c *InfoContactURLComment) Usage() string

Usage implements Comment.

type InfoDescriptionComment 

type InfoDescriptionComment struct{}

func (*InfoDescriptionComment) ParseInto 

func (c *InfoDescriptionComment) ParseInto(line string, s *openapi.Extendable[openapi.OpenAPI]) error

ParseInto implements Comment.

func (*InfoDescriptionComment) Tag 

func (c *InfoDescriptionComment) Tag() string

Tag implements Comment.

func (*InfoDescriptionComment) Usage 

func (c *InfoDescriptionComment) Usage() string

Usage implements Comment.

type InfoLicenseIdentifierComment 

type InfoLicenseIdentifierComment struct{}

func (*InfoLicenseIdentifierComment) ParseInto 

func (c *InfoLicenseIdentifierComment) ParseInto(line string, s *openapi.Extendable[openapi.OpenAPI]) error

ParseInto implements Comment.

func (*InfoLicenseIdentifierComment) Tag 

func (c *InfoLicenseIdentifierComment) Tag() string

Tag implements Comment.

func (*InfoLicenseIdentifierComment) Usage 

func (c *InfoLicenseIdentifierComment) Usage() string

Usage implements Comment.

type InfoLicenseNameComment 

type InfoLicenseNameComment struct{}

func (*InfoLicenseNameComment) ParseInto 

func (c *InfoLicenseNameComment) ParseInto(line string, s *openapi.Extendable[openapi.OpenAPI]) error

ParseInto implements Comment.

func (*InfoLicenseNameComment) Tag 

func (c *InfoLicenseNameComment) Tag() string

Tag implements Comment.

func (*InfoLicenseNameComment) Usage 

func (c *InfoLicenseNameComment) Usage() string

Usage implements Comment.

type InfoLicenseURLComment 

type InfoLicenseURLComment struct{}

func (*InfoLicenseURLComment) ParseInto 

func (c *InfoLicenseURLComment) ParseInto(line string, s *openapi.Extendable[openapi.OpenAPI]) error

ParseInto implements Comment.

func (*InfoLicenseURLComment) Tag 

func (c *InfoLicenseURLComment) Tag() string

Tag implements Comment.

func (*InfoLicenseURLComment) Usage 

func (c *InfoLicenseURLComment) Usage() string

Usage implements Comment.

type InfoSummaryComment 

type InfoSummaryComment struct{}

func (*InfoSummaryComment) ParseInto 

func (c *InfoSummaryComment) ParseInto(line string, s *openapi.Extendable[openapi.OpenAPI]) error

ParseInto implements Comment.

func (*InfoSummaryComment) Tag 

func (c *InfoSummaryComment) Tag() string

Tag implements Comment.

func (*InfoSummaryComment) Usage 

func (c *InfoSummaryComment) Usage() string

Usage implements Comment.

type InfoTermsOfServiceComment 

type InfoTermsOfServiceComment struct{}

func (*InfoTermsOfServiceComment) ParseInto 

func (c *InfoTermsOfServiceComment) ParseInto(line string, s *openapi.Extendable[openapi.OpenAPI]) error

ParseInto implements Comment.

func (*InfoTermsOfServiceComment) Tag 

func (c *InfoTermsOfServiceComment) Tag() string

Tag implements Comment.

func (*InfoTermsOfServiceComment) Usage 

func (c *InfoTermsOfServiceComment) Usage() string

Usage implements Comment.

type InfoTitleComment 

type InfoTitleComment struct{}

func (*InfoTitleComment) ParseInto 

func (c *InfoTitleComment) ParseInto(line string, s *openapi.Extendable[openapi.OpenAPI]) error

ParseInto implements Comment.

func (*InfoTitleComment) Tag 

func (c *InfoTitleComment) Tag() string

InfoTitleComment implements Comment.

func (*InfoTitleComment) Usage 

func (c *InfoTitleComment) Usage() string

Usage implements Comment.

type InfoVersionComment 

type InfoVersionComment struct{}

func (*InfoVersionComment) ParseInto 

func (c *InfoVersionComment) ParseInto(line string, s *openapi.Extendable[openapi.OpenAPI]) error

ParseInto implements Comment.

func (*InfoVersionComment) Tag 

func (c *InfoVersionComment) Tag() string

Tag implements Comment.

func (*InfoVersionComment) Usage 

func (c *InfoVersionComment) Usage() string

Usage implements Comment.

type Registry 

type Registry interface {
	Register(c Comment)
	Parse(line string, spec *openapi.Extendable[openapi.OpenAPI]) error
	Comments() []Comment
}

Registry allows to register and parse comments.

func Default 

func Default() Registry

func NewRegistry 

func NewRegistry() Registry

NewRegistry creates a new Registry.

type SecurityComment 

type SecurityComment struct{}

SecurityComment is a comment that updates the security of the global specification.

func (*SecurityComment) ParseInto 

func (c *SecurityComment) ParseInto(line string, s *openapi.Extendable[openapi.OpenAPI]) error

ParseInto implements Comment.

func (*SecurityComment) Tag 

func (c *SecurityComment) Tag() string

Tag implements Comment.

func (*SecurityComment) Usage 

func (c *SecurityComment) Usage() string

Usage implements Comment.

type SecuritySchemeBearerFormatComment 

type SecuritySchemeBearerFormatComment struct{}

SecuritySchemeBearerFormatComment is a comment that updates the 'bearerFormat' property of a security scheme.

func (*SecuritySchemeBearerFormatComment) ParseInto 

func (c *SecuritySchemeBearerFormatComment) ParseInto(line string, s *openapi.Extendable[openapi.OpenAPI]) error

ParseInto implements Comment.

func (*SecuritySchemeBearerFormatComment) Tag 

func (c *SecuritySchemeBearerFormatComment) Tag() string

Tag implements Comment.

func (*SecuritySchemeBearerFormatComment) Usage 

func (c *SecuritySchemeBearerFormatComment) Usage() string

Usage implements Comment.

type SecuritySchemeComment 

type SecuritySchemeComment struct{}

SecuritySchemeComment is a comment that adds a security scheme to the specification.

func (*SecuritySchemeComment) ParseInto 

func (c *SecuritySchemeComment) ParseInto(line string, s *openapi.Extendable[openapi.OpenAPI]) error

ParseInto implements Comment.

func (*SecuritySchemeComment) Tag 

func (c *SecuritySchemeComment) Tag() string

Tag implements Comment.

func (*SecuritySchemeComment) Usage 

func (c *SecuritySchemeComment) Usage() string

Usage implements Comment.

type SecuritySchemeInComment 

type SecuritySchemeInComment struct{}

SecuritySchemeInComment is a comment that updates the 'in' property of a security scheme.

func (*SecuritySchemeInComment) ParseInto 

func (c *SecuritySchemeInComment) ParseInto(line string, s *openapi.Extendable[openapi.OpenAPI]) error

ParseInto implements Comment.

func (*SecuritySchemeInComment) Tag 

func (c *SecuritySchemeInComment) Tag() string

Tag implements Comment.

func (*SecuritySchemeInComment) Usage 

func (c *SecuritySchemeInComment) Usage() string

Usage implements Comment.

type SecuritySchemeNameComment 

type SecuritySchemeNameComment struct{}

SecuritySchemeNameComment is a comment that updates the name of a security scheme.

func (*SecuritySchemeNameComment) ParseInto 

func (c *SecuritySchemeNameComment) ParseInto(line string, s *openapi.Extendable[openapi.OpenAPI]) error

ParseInto implements Comment.

func (*SecuritySchemeNameComment) Tag 

func (c *SecuritySchemeNameComment) Tag() string

Tag implements Comment.

func (*SecuritySchemeNameComment) Usage 

func (c *SecuritySchemeNameComment) Usage() string

Usage implements Comment.

type SecuritySchemeSchemeComment 

type SecuritySchemeSchemeComment struct{}

SecuritySchemeSchemeComment is a comment that updates the 'scheme' property of a security scheme.

func (*SecuritySchemeSchemeComment) ParseInto 

func (c *SecuritySchemeSchemeComment) ParseInto(line string, s *openapi.Extendable[openapi.OpenAPI]) error

ParseInto implements Comment.

func (*SecuritySchemeSchemeComment) Tag 

func (c *SecuritySchemeSchemeComment) Tag() string

Tag implements Comment.

func (*SecuritySchemeSchemeComment) Usage 

func (c *SecuritySchemeSchemeComment) Usage() string

Usage implements Comment.

type ServerDescriptionComment 

type ServerDescriptionComment struct{}

ServerDescriptionComment is a comment that updates the description of the last added server.

func (*ServerDescriptionComment) ParseInto 

func (c *ServerDescriptionComment) ParseInto(line string, s *openapi.Extendable[openapi.OpenAPI]) error

ParseInto implements Comment.

func (*ServerDescriptionComment) Tag 

func (c *ServerDescriptionComment) Tag() string

Tag implements Comment.

func (*ServerDescriptionComment) Usage 

func (c *ServerDescriptionComment) Usage() string

Usage implements Comment.

type ServerURLComment 

type ServerURLComment struct{}

ServerURLComment is a comment that adds a new server to the global specification.

func (*ServerURLComment) ParseInto 

func (c *ServerURLComment) ParseInto(line string, s *openapi.Extendable[openapi.OpenAPI]) error

ParseInto implements Comment.

func (*ServerURLComment) Tag 

func (c *ServerURLComment) Tag() string

Tag implements Comment.

func (*ServerURLComment) Usage 

func (c *ServerURLComment) Usage() string

Usage implements Comment.

type ServerVariableDefaultComment 

type ServerVariableDefaultComment struct{}

ServerVariableDefaultComment sets the default value for a server variable.

func (*ServerVariableDefaultComment) ParseInto 

func (c *ServerVariableDefaultComment) ParseInto(line string, s *openapi.Extendable[openapi.OpenAPI]) error

ParseInto implements Comment.

func (*ServerVariableDefaultComment) Tag 

func (c *ServerVariableDefaultComment) Tag() string

Tag implements Comment.

func (*ServerVariableDefaultComment) Usage 

func (c *ServerVariableDefaultComment) Usage() string

Usage implements Comment.

type ServerVariableDescriptionComment 

type ServerVariableDescriptionComment struct{}

ServerVariableDescriptionComment sets the description for a server variable.

func (*ServerVariableDescriptionComment) ParseInto 

func (c *ServerVariableDescriptionComment) ParseInto(line string, s *openapi.Extendable[openapi.OpenAPI]) error

ParseInto implements Comment.

func (*ServerVariableDescriptionComment) Tag 

func (c *ServerVariableDescriptionComment) Tag() string

Tag implements Comment.

func (*ServerVariableDescriptionComment) Usage 

func (c *ServerVariableDescriptionComment) Usage() string

Usage implements Comment.

type ServerVariableEnumComment 

type ServerVariableEnumComment struct{}

ServerVariableEnumComment sets the enum values for a server variable.

func (*ServerVariableEnumComment) ParseInto 

func (c *ServerVariableEnumComment) ParseInto(line string, s *openapi.Extendable[openapi.OpenAPI]) error

ParseInto implements Comment.

func (*ServerVariableEnumComment) Tag 

func (c *ServerVariableEnumComment) Tag() string

Tag implements Comment.

func (*ServerVariableEnumComment) Usage 

func (c *ServerVariableEnumComment) Usage() string

Usage implements Comment.

type TagDescriptionComment 

type TagDescriptionComment struct{}

func (*TagDescriptionComment) ParseInto 

func (c *TagDescriptionComment) ParseInto(line string, s *openapi.Extendable[openapi.OpenAPI]) error

ParseInto implements Comment.

func (*TagDescriptionComment) Tag 

func (c *TagDescriptionComment) Tag() string

Tag implements Comment.

func (*TagDescriptionComment) Usage 

func (c *TagDescriptionComment) Usage() string

Usage implements Comment.

type TagExternalDocsDescriptionComment 

type TagExternalDocsDescriptionComment struct{}

func (*TagExternalDocsDescriptionComment) ParseInto 

func (c *TagExternalDocsDescriptionComment) ParseInto(line string, s *openapi.Extendable[openapi.OpenAPI]) error

ParseInto implements Comment.

func (*TagExternalDocsDescriptionComment) Tag 

func (c *TagExternalDocsDescriptionComment) Tag() string

Tag implements Comment.

func (*TagExternalDocsDescriptionComment) Usage 

func (c *TagExternalDocsDescriptionComment) Usage() string

Usage implements Comment.

type TagExternalDocsURLComment 

type TagExternalDocsURLComment struct{}

func (*TagExternalDocsURLComment) ParseInto 

func (c *TagExternalDocsURLComment) ParseInto(line string, s *openapi.Extendable[openapi.OpenAPI]) error

ParseInto implements Comment.

func (*TagExternalDocsURLComment) Tag 

func (c *TagExternalDocsURLComment) Tag() string

Tag implements Comment.

func (*TagExternalDocsURLComment) Usage 

func (c *TagExternalDocsURLComment) Usage() string

Usage implements Comment.

type TagNameComment 

type TagNameComment struct{}

func (*TagNameComment) ParseInto 

func (c *TagNameComment) ParseInto(line string, s *openapi.Extendable[openapi.OpenAPI]) error

ParseInto implements Comment.

func (*TagNameComment) Tag 

func (c *TagNameComment) Tag() string

Tag implements Comment.

func (*TagNameComment) Usage 

func (c *TagNameComment) Usage() string

Usage implements Comment.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.