chioas

May 8, 2024

Changes in this version

type RapidocOptions

+ BodyScript template.JS

+ HeadScript template.JS

type RedocOptions

+ BodyScript template.JS

+ HeadScript template.JS

+ HeaderHtml template.HTML

type SwaggerOptions

+ BodyScript template.JS

+ HeadScript template.JS

+ HeaderHtml template.HTML

May 5, 2024

Changes in this version

+ type DisablerFunc func() bool

+ type FavIcons map[int]string

+ type OptionsWithFavIcons interface

+ GetFavIcons func() FavIcons

type Path

+ Disabled DisablerFunc

type RapidocOptions

+ AdditionalAttributes map[string]string

+ FavIcons FavIcons

+ HeaderColor string

+ InnerHtml template.HTML

+ LogoSrc string

+ MonoFont string

+ PrimaryColor string

+ RegularFont string

+ SchemaExpandLevel uint

+ func (o RapidocOptions) GetFavIcons() FavIcons

type RedocOptions

+ FavIcons FavIcons

+ func (o RedocOptions) GetFavIcons() FavIcons

type SwaggerOptions

+ FavIcons FavIcons

+ func (o SwaggerOptions) GetFavIcons() FavIcons

Apr 27, 2024

Changes in this version

+ type AlternateUIDoc struct

+ AsJson bool

+ DocIndexPage string

+ DocTemplate string

+ Middlewares chi.Middlewares

+ NoCache bool

+ RapidocOptions any

+ RedocJsUrl string

+ RedocOptions any

+ SpecName string

+ StylesOverride string

+ SupportFiles http.Handler

+ SupportFilesStripPrefix bool

+ SwaggerOptions any

+ Title string

+ TryJsUrl string

+ UIStyle UIStyle

+ type AlternateUIDocs map[string]AlternateUIDoc

type DocOptions

+ AlternateUIDocs AlternateUIDocs

Apr 21, 2024

Changes in this version

type DocOptions

+ RapidocOptions any

+ type RapidocOptions struct

+ AllowAdvancedSearch bool

+ AllowSearch bool

+ AllowServerSelection bool

+ AllowSpecFileLoad bool

+ AllowSpecUrlLoad bool

+ DisallowAuthentication bool

+ DisallowSpecDownload bool

+ DisallowTry bool

+ HeadingText string

+ HideInfo bool

+ MatchType string

+ NoPersistAuth bool

+ RenderStyle string

+ SchemaStyle string

+ ShowComponents bool

+ ShowHeader bool

+ ShowMethodInNavBar bool

+ Theme string

+ UpdateRoute bool

+ UsePathInNavBar bool

+ func (o *RapidocOptions) ToMap() map[string]any

type UIStyle

+ const Rapidoc

Dec 2, 2023

Changes in this version

+ type AdditionalOasProperties map[string]any

+ func (ap AdditionalOasProperties) Write(on any, w yaml.Writer)

type Schema

+ Format string

Nov 23, 2023

Changes in this version

type Definition

+ OptionsMethodPayloadBuilder OptionsMethodPayloadBuilder

+ RootAutoOptionsMethod bool

+ type OptionsMethodPayloadBuilder interface

+ BuildPayload func(path string, pathDef *Path, def *Definition) (data []byte, headers map[string]string)

+ func NewRootOptionsMethodPayloadBuilder() OptionsMethodPayloadBuilder

type Path

+ AutoOptionsMethod bool

Nov 22, 2023

Changes in this version

type Definition

+ AutoMethodNotAllowed bool

Nov 22, 2023

Changes in this version

type Definition

+ AutoOptionsMethods bool

type DocOptions

+ HideAutoOptionsMethods bool

Nov 6, 2023

Changes in this version

type Components

+ Examples Examples

type ContentType

+ Examples Examples

+ type Discriminator struct

+ Additional Additional

+ Comment string

+ Extensions Extensions

+ Mapping map[string]string

+ PropertyName string

+ type Example struct

+ Additional Additional

+ Comment string

+ Description string

+ ExampleRef string

+ Extensions Extensions

+ Name string

+ Summary string

+ Value any

+ type Examples []Example

+ type OfRef string

+ func (o OfRef) IsRef() bool

+ func (o OfRef) Ref() string

+ func (o OfRef) Schema() *Schema

+ type OfSchema interface

+ IsRef func() bool

+ Ref func() string

+ Schema func() *Schema

+ type OfType uint

+ const AllOf

+ const AnyOf

+ const OneOf

+ func (ot OfType) TagName() string

+ type Ofs struct

+ Of []OfSchema

+ OfType OfType

type Request

+ Examples Examples

type Response

+ Examples Examples

type Schema

+ Discriminator *Discriminator

+ Ofs *Ofs

+ func (s *Schema) IsRef() bool

+ func (s *Schema) Ref() string

+ func (s *Schema) Schema() *Schema

Nov 4, 2023

Changes in this version

type Property

+ Enum []any

Nov 4, 2023

Changes in this version

type DocOptions

+ SupportFilesStripPrefix bool

Nov 3, 2023

Changes in this version

type Definition

+ MethodHandlerBuilder MethodHandlerBuilder

+ type MethodHandlerBuilder interface

+ BuildHandler func(path string, method string, mdef Method, thisApi any) (http.HandlerFunc, error)

type Schema

+ SchemaRef string

+ func (s *Schema) From(sample any) (*Schema, error)

+ func (s *Schema) Must(sample any) Schema

+ func (s *Schema) MustFrom(sample any) *Schema

Oct 30, 2023

Changes in this version

type DocOptions

+ SwaggerOptions any

+ UIStyle UIStyle

+ type MappableOptions interface

+ ToMap func() map[string]any

type RedocArrow

+ func (o *RedocArrow) ToMap() map[string]any

type RedocBreakpoints

+ func (o *RedocBreakpoints) ToMap() map[string]any

type RedocCode

+ func (o *RedocCode) ToMap() map[string]any

type RedocColors

+ func (o *RedocColors) ToMap() map[string]any

type RedocFab

+ func (o *RedocFab) ToMap() map[string]any

type RedocGroupItems

+ func (o *RedocGroupItems) ToMap() map[string]any

type RedocHeadings

+ func (o *RedocHeadings) ToMap() map[string]any

type RedocLevel1Items

+ func (o *RedocLevel1Items) ToMap() map[string]any

type RedocLinks

+ func (o *RedocLinks) ToMap() map[string]any

type RedocLogo

+ func (o *RedocLogo) ToMap() map[string]any

type RedocOptions

+ func (o *RedocOptions) ToMap() map[string]any

type RedocRightPanel

+ func (o *RedocRightPanel) ToMap() map[string]any

type RedocRightPanelServers

+ func (o *RedocRightPanelServers) ToMap() map[string]any

type RedocRightPanelServersOverlay

+ func (o *RedocRightPanelServersOverlay) ToMap() map[string]any

type RedocRightPanelServersUrl

+ func (o *RedocRightPanelServersUrl) ToMap() map[string]any

type RedocSidebar

+ func (o *RedocSidebar) ToMap() map[string]any

type RedocSpacing

+ func (o *RedocSpacing) ToMap() map[string]any

type RedocTheme

+ func (o *RedocTheme) ToMap() map[string]any

type RedocTypography

+ func (o *RedocTypography) ToMap() map[string]any

+ type SwaggerOptions struct

+ DeepLinking bool

+ DefaultModelExpandDepth uint

+ DefaultModelRendering string

+ DefaultModelsExpandDepth uint

+ DisplayOperationId bool

+ DisplayRequestDuration bool

+ DocExpansion string

+ DomId string

+ Layout string

+ MaxDisplayedTags uint

+ PersistAuthorization bool

+ Plugins []SwaggerPlugin

+ Presets []SwaggerPreset

+ RequestSnippetsEnabled bool

+ ShowCommonExtensions bool

+ ShowExtensions bool

+ SupportedSubmitMethods []string

+ SyntaxHighlightTheme string

+ TryItOutEnabled bool

+ UseUnsafeMarkdown bool

+ ValidatorUrl string

+ WithCredentials bool

+ func (o *SwaggerOptions) ToMap() map[string]any

+ type SwaggerPlugin string

+ type SwaggerPreset string

+ type UIStyle uint

+ const Redoc

+ const Swagger

Oct 16, 2023

Changes in this version

type Definition

+ func (d *Definition) RefCheck(area, ref string) error

type DocOptions

+ CheckRefs bool

Oct 14, 2023

Changes in this version

type DocOptions

+ Middlewares chi.Middlewares

+ func (d *DocOptions) SetupRoutes(def *Definition, route chi.Router) error

Oct 10, 2023

Changes in this version

type DocOptions

+ SupportFiles http.Handler

+ type SupportFiles interface

+ ServeHTTP func(http.ResponseWriter, *http.Request)

Oct 9, 2023

Changes in this version

type Definition

+ func FromJson(r io.Reader, opts *FromOptions) (result *Definition, err error)

+ func FromYaml(r io.Reader, opts *FromOptions) (result *Definition, err error)

+ type FromOptions struct

+ Api any

+ DocOptions *DocOptions

+ Handlers Handlers

+ PathMiddlewares PathMiddlewares

+ Strict bool

+ type Handlers map[string]http.HandlerFunc

+ type PathMiddlewares func(path string) chi.Middlewares

Oct 4, 2023

Changes in this version

+ type Constraints struct

+ Additional map[string]any

+ ExclusiveMaximum bool

+ ExclusiveMinimum bool

+ MaxItems uint

+ MaxLength uint

+ MaxProperties uint

+ Maximum json.Number

+ MinItems uint

+ MinLength uint

+ MinProperties uint

+ Minimum json.Number

+ MultipleOf uint

+ Nullable bool

+ Pattern string

+ UniqueItems bool

+ type ContentType struct

+ IsArray bool

+ Schema any

+ SchemaRef string

+ type ContentTypes map[string]ContentType

type Property

+ Constraints Constraints

+ Deprecated bool

+ Properties Properties

+ Required bool

type Request

+ AlternativeContentTypes ContentTypes

type Response

+ AlternativeContentTypes ContentTypes

Oct 3, 2023

Changes in this version

type Property

+ Format string

type Schema

+ Example any

Sep 29, 2023

Changes in this version

type Definition

+ func (d *Definition) AsJson() (data []byte, err error)

+ func (d *Definition) WriteJson(writer io.Writer) (err error)

type DocOptions

+ AsJson bool

Sep 20, 2023

Changes in this version

+ func SourceComment(comments ...string) string

type PathParam

+ Schema *Schema

+ SchemaRef string

Aug 6, 2023

Changes in this version

type CommonParameter

+ Comment string

type Components

+ Comment string

type Contact

+ Comment string

type Definition

+ Comment string

type ExternalDocs

+ Comment string

type Info

+ Comment string

type License

+ Comment string

type Method

+ Comment string

type Path

+ Comment string

type PathParam

+ Comment string

type Property

+ Comment string

type QueryParam

+ Comment string

type Request

+ Comment string

type Response

+ Comment string

type Schema

+ Comment string

type SecurityScheme

+ Comment string

type Server

+ Comment string

type Tag

+ Comment string

Aug 5, 2023

Changes in this version

+ type CommonParameter struct

+ Additional Additional

+ Description string

+ Example any

+ Extensions Extensions

+ In string

+ Name string

+ Required bool

+ Schema *Schema

+ SchemaRef string

+ type CommonParameters map[string]CommonParameter

type Components

+ Parameters CommonParameters

type PathParam

+ Ref string

type QueryParam

+ Ref string

Aug 5, 2023

Changes in this version

+ type CommonRequests map[string]Request

+ type CommonResponses map[string]Response

type Components

+ Requests CommonRequests

+ Responses CommonResponses

+ type Properties []Property

type Request

+ Ref string

type Response

+ Ref string

+ type SchemaConverter interface

+ ToSchema func() *Schema

+ type SchemaWriter interface

+ WriteSchema func(w yaml.Writer)

Aug 3, 2023

Changes in this version

type Components

+ Extensions Extensions

type Contact

+ Extensions Extensions

type Definition

+ Extensions Extensions

+ type Extensions map[string]any

type ExternalDocs

+ Extensions Extensions

+ type GetHandler func(path string, method string, thisApi any) (http.HandlerFunc, error)

type Info

+ Extensions Extensions

type License

+ Extensions Extensions

type Method

+ Extensions Extensions

type Path

+ Additional Additional

+ Extensions Extensions

type PathParam

+ Extensions Extensions

type Property

+ Extensions Extensions

type QueryParam

+ Extensions Extensions

type Request

+ Extensions Extensions

type Response

+ Extensions Extensions

type Schema

+ Extensions Extensions

type SecurityScheme

+ Additional Additional

+ Extensions Extensions

type Server

+ Extensions Extensions

type Tag

+ Extensions Extensions

Jul 29, 2023

Changes in this version

type Components

+ SecuritySchemes SecuritySchemes

type Definition

+ Security SecuritySchemes

type Method

+ Deprecated bool

+ OptionalSecurity bool

+ Security SecuritySchemes

+ type SecurityScheme struct

+ Description string

+ In string

+ Name string

+ ParamName string

+ Scheme string

+ Scopes []string

+ Type string

+ type SecuritySchemes []SecurityScheme

Jul 24, 2023

Changes in this version

type RedocRightPanel

+ BackgroundColor string

+ Servers *RedocRightPanelServers

+ TextColor string

+ Width string

+ type RedocRightPanelServers struct

+ Overlay *RedocRightPanelServersOverlay

+ Url *RedocRightPanelServersUrl

+ type RedocRightPanelServersOverlay struct

+ BackgroundColor string

+ TextColor string

+ type RedocRightPanelServersUrl struct

+ BackgroundColor string

Jul 24, 2023

Changes in this version

type Response

+ NoContent bool

Jul 24, 2023

Changes in this version

type DocOptions

+ OperationIdentifier OperationIdentifier

+ RedocJsUrl string

+ TryJsUrl string

+ type OperationIdentifier func(method Method, methodName string, path string, parentTag string) string

type QueryParam

+ In string

Jul 23, 2023

Changes in this version

+ type ApplyMiddlewares func(thisApi any) chi.Middlewares

type Definition

+ ApplyMiddlewares ApplyMiddlewares

type Path

+ ApplyMiddlewares ApplyMiddlewares

Jul 23, 2023

Changes in this version

+ type RedocArrow struct

+ Color string

+ Size string

+ type RedocBreakpoints struct

+ Large string

+ Medium string

+ Small string

+ type RedocCode struct

+ BackgroundColor string

+ Color string

+ FontFamily string

+ FontSize string

+ FontWeight string

+ LineHeight string

+ Wrap bool

+ type RedocColors struct

+ TonalOffset float32

+ type RedocFab struct

+ BackgroundColor string

+ Color string

+ type RedocGroupItems struct

+ ActiveBackgroundColor string

+ ActiveTextColor string

+ TextTransform string

+ type RedocHeadings struct

+ FontFamily string

+ FontWeight string

+ LineHeight string

+ type RedocLevel1Items struct

+ ActiveBackgroundColor string

+ ActiveTextColor string

+ TextTransform string

+ type RedocLinks struct

+ Color string

+ Hover string

+ HoverTextDecoration string

+ TextDecoration string

+ Visited string

+ type RedocLogo struct

+ Gutter string

+ MaxHeight int

+ MaxWidth int

+ type RedocOptions struct

+ DisableSearch bool

+ DownloadDefinitionUrl string

+ DownloadFileName string

+ ExpandDefaultServerVariables bool

+ ExpandResponses string

+ ExpandSingleSchemaField bool

+ GeneratedPayloadSamplesMaxDepth int

+ HideDownloadButton bool

+ HideFab bool

+ HideHostname bool

+ HideLoading bool

+ HideSchemaPattern bool

+ HideSchemaTitles bool

+ HideSingleRequestSampleTab bool

+ JsonSampleExpandLevel any

+ MaxDisplayedEnumValues int

+ MenuToggle bool

+ MinCharacterLengthToInitSearch int

+ NativeScrollbars bool

+ Nonce any

+ OnlyRequiredInSamples bool

+ PathInMiddlePanel bool

+ PayloadSampleIndex int

+ RequiredPropsFirst bool

+ SchemaExpansionLevel any

+ ScrollYOffset any

+ ShowExtensions bool

+ ShowObjectSchemaExamples bool

+ ShowWebhookVerb bool

+ SideNavStyle string

+ SimpleOneOfTypeLabel bool

+ SortEnumValuesAlphabetically bool

+ SortOperationsAlphabetically bool

+ SortPropsAlphabetically bool

+ SortTagsAlphabetically bool

+ Theme *RedocTheme

+ UntrustedSpec bool

+ type RedocRightPanel struct

+ type RedocSidebar struct

+ ActiveTextColor string

+ Arrow *RedocArrow

+ BackgroundColor string

+ GroupItems *RedocGroupItems

+ Level1Items *RedocLevel1Items

+ TextColor string

+ Width string

+ type RedocSpacing struct

+ SectionHorizontal int

+ SectionVertical int

+ Unit int

+ type RedocTheme struct

+ Breakpoints *RedocBreakpoints

+ Colors *RedocColors

+ Fab *RedocFab

+ Logo *RedocLogo

+ RightPanel *RedocRightPanel

+ Sidebar *RedocSidebar

+ Spacing *RedocSpacing

+ Typography *RedocTypography

+ type RedocTypography struct

+ Code *RedocCode

+ FontFamily string

+ FontSize string

+ FontWeightBold string

+ FontWeightLight string

+ FontWeightRegular string

+ Headings *RedocHeadings

+ LineHeight string

+ Links *RedocLinks

+ OptimizeSpeed bool

+ Smoothing string

Jul 23, 2023

Changes in this version

type Definition

+ AutoHeadMethods bool

type DocOptions

+ HideHeadMethods bool

type Method

+ HideDocs bool

type Path

+ HideDocs bool

Jul 22, 2023

Changes in this version

+ var MethodsOrder = []string

+ var OasVersion = "3.0.3"

+ type Additional interface

+ Write func(on any, w yaml.Writer)

+ type Components struct

+ Additional Additional

+ Schemas Schemas

+ type Contact struct

+ Email string

+ Name string

+ Url string

+ type Definition struct

+ Additional Additional

+ Components *Components

+ DocOptions DocOptions

+ Info Info

+ Methods Methods

+ Middlewares chi.Middlewares

+ Paths Paths

+ Servers Servers

+ Tags Tags

+ func (d *Definition) AsYaml() ([]byte, error)

+ func (d *Definition) SetupRoutes(router chi.Router, thisApi any) error

+ func (d *Definition) WriteYaml(w io.Writer) error

+ type DocOptions struct

+ Context string

+ DefaultResponses Responses

+ DocIndexPage string

+ DocTemplate string

+ NoCache bool

+ Path string

+ RedocOptions map[string]any

+ ServeDocs bool

+ SpecName string

+ StylesOverride string

+ Title string

+ type ExternalDocs struct

+ Description string

+ Url string

+ type Info struct

+ Additional Additional

+ Contact *Contact

+ Description string

+ ExternalDocs *ExternalDocs

+ License *License

+ TermsOfService string

+ Title string

+ Version string

+ type License struct

+ Name string

+ Url string

+ type Method struct

+ Additional Additional

+ Description string

+ Handler any

+ OperationId string

+ QueryParams QueryParams

+ Request *Request

+ Responses Responses

+ Summary string

+ Tag string

+ type Methods map[string]Method

+ type Path struct

+ Methods Methods

+ Middlewares chi.Middlewares

+ PathParams PathParams

+ Paths Paths

+ Tag string

+ type PathParam struct

+ Additional Additional

+ Description string

+ Example any

+ type PathParams map[string]PathParam

+ type Paths map[string]Path

+ type Property struct

+ Additional Additional

+ Description string

+ Example any

+ ItemType string

+ Name string

+ SchemaRef string

+ Type string

+ type QueryParam struct

+ Additional Additional

+ Description string

+ Example any

+ Name string

+ Required bool

+ Schema *Schema

+ SchemaRef string

+ type QueryParams []QueryParam

+ type Request struct

+ Additional Additional

+ ContentType string

+ Description string

+ IsArray bool

+ Required bool

+ Schema any

+ SchemaRef string

+ type Response struct

+ Additional Additional

+ ContentType string

+ Description string

+ IsArray bool

+ Schema any

+ SchemaRef string

+ type Responses map[int]Response

+ type Schema struct

+ Additional Additional

+ Default any

+ Description string

+ Enum []any

+ Name string

+ Properties []Property

+ RequiredProperties []string

+ Type string

+ type Schemas []Schema

+ type Server struct

+ Additional Additional

+ Description string

+ type Servers map[string]Server

+ type Tag struct

+ Additional Additional

+ Description string

+ ExternalDocs *ExternalDocs

+ Name string

+ type Tags []Tag