simpleapidocs

package
v0.5.3 Latest Latest
Warning

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

Go to latest
Published: Feb 22, 2026 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ApiDocumentationGenerator

type ApiDocumentationGenerator struct{}

func (*ApiDocumentationGenerator) String

func (input *ApiDocumentationGenerator) String() string

type ApiOverview

type ApiOverview struct {
	Api struct {
		Name               string
		Version            string
		BaseUrl            string
		Protocol           string
		AuthType           string
		Deprecated         bool
		ReplacementVersion string
		SunsetDate         string
		Beta               bool
		StabilityLevel     string
	}
	Changelog struct {
		HasBreakingChanges bool
		BreakingChanges    string
		NewFeatures        string
		Improvements       string
		BugFixes           string
	}
	Docs struct {
		MigrationUrl string
	}
	Auth struct {
		Type         string
		Required     bool
		DashboardUrl string
		OauthFlow    string
		Scopes       string
		AuthUrl      string
		TokenUrl     string
		HasScopes    bool
		ScopeList    string
		HeaderName   string
		QueryParam   string
		RateLimits   bool
	}
	RateLimits struct {
		StandardRequests int
		StandardWindow   string
		PremiumRequests  int
		PremiumWindow    string
		HasBurst         bool
		BurstRequests    int
		BurstWindow      string
	}
}

func (*ApiOverview) String

func (input *ApiOverview) String() string

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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