openapi

package

v1.42.0 Latest Latest Go to latest Published: Sep 16, 2026 License: Apache-2.0 Imports: 15 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/device-management-toolkit/console

Links

Open Source Insights

Documentation ¶

Index ¶

type AuthorizeRedirectionResponse
type DeleteCertificateResponse
type DeviceRedirectStatusResponse
type DomainCountResponse
type ErrorResponse
type FuegoAdapter
- func NewFuegoAdapter(usecases usecase.Usecases, log logger.Interface) *FuegoAdapter
type Generator
- func NewGenerator(usecases usecase.Usecases, log logger.Interface) *Generator
- func (g *Generator) GenerateSpec() ([]byte, error)
- func (g *Generator) SaveSpec(spec []byte, filePath string) error
type LogoutResponse
type NoContentResponse

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type AuthorizeRedirectionResponse ¶ added in v1.24.2

type AuthorizeRedirectionResponse struct {
	Token string `json:"token"`
}

type DeleteCertificateResponse ¶ added in v1.24.2

type DeleteCertificateResponse struct {
	Message string `json:"message" example:"Certificate deleted successfully"`
}

type DeviceRedirectStatusResponse ¶ added in v1.24.2

type DeviceRedirectStatusResponse struct {
	IsSOLConnected  bool `json:"isSOLConnected"`
	IsIDERConnected bool `json:"isIDERConnected"`
}

type DomainCountResponse ¶ added in v1.24.2

type DomainCountResponse struct {
	Count int          `json:"totalCount"`
	Data  []dto.Domain `json:"data"`
}

type ErrorResponse ¶ added in v1.37.2

type ErrorResponse struct {
	Error   string `json:"error,omitempty" example:"invalid credentials"`
	Message string `json:"message,omitempty" example:"Incorrect username or password"`
}

ErrorResponse models error responses with error and message fields.

type FuegoAdapter ¶

type FuegoAdapter struct {
	// contains filtered or unexported fields
}

func NewFuegoAdapter ¶

func NewFuegoAdapter(usecases usecase.Usecases, log logger.Interface) *FuegoAdapter

func (*FuegoAdapter) AddToGinRouter ¶

func (f *FuegoAdapter) AddToGinRouter(router *gin.Engine)

Adds Fuego-generated OpenAPI endpoints to existing Gin router.

func (*FuegoAdapter) GetOpenAPISpec ¶

func (f *FuegoAdapter) GetOpenAPISpec() ([]byte, error)

Generates OpenAPI specification as JSON.

func (*FuegoAdapter) RegisterCIRACertRoutes ¶ added in v1.24.2

func (f *FuegoAdapter) RegisterCIRACertRoutes()

func (*FuegoAdapter) RegisterCIRAConfigRoutes ¶

func (f *FuegoAdapter) RegisterCIRAConfigRoutes()

func (*FuegoAdapter) RegisterDeviceManagementRoutes ¶ added in v1.13.0

func (f *FuegoAdapter) RegisterDeviceManagementRoutes()

func (*FuegoAdapter) RegisterDeviceRoutes ¶

func (f *FuegoAdapter) RegisterDeviceRoutes()

func (*FuegoAdapter) RegisterDomainRoutes ¶ added in v1.24.2

func (f *FuegoAdapter) RegisterDomainRoutes()

func (*FuegoAdapter) RegisterIEEE8021xConfigRoutes ¶

func (f *FuegoAdapter) RegisterIEEE8021xConfigRoutes()

func (*FuegoAdapter) RegisterProfileRoutes ¶

func (f *FuegoAdapter) RegisterProfileRoutes()

func (*FuegoAdapter) RegisterRoutes ¶

func (f *FuegoAdapter) RegisterRoutes()

Registers API routes with Fuego for automatic OpenAPI generation.

func (*FuegoAdapter) RegisterServerRoutes ¶ added in v1.31.0

func (f *FuegoAdapter) RegisterServerRoutes()

func (*FuegoAdapter) RegisterWirelessConfigRoutes ¶

func (f *FuegoAdapter) RegisterWirelessConfigRoutes()

type Generator ¶

type Generator struct {
	// contains filtered or unexported fields
}

Generator handles OpenAPI specification generation.

func NewGenerator ¶

func NewGenerator(usecases usecase.Usecases, log logger.Interface) *Generator

NewGenerator creates a new OpenAPI generator.

func (*Generator) GenerateSpec ¶

func (g *Generator) GenerateSpec() ([]byte, error)

GenerateSpec generates OpenAPI 3.1.0 specification with compliance fixes.

func (*Generator) SaveSpec ¶

func (g *Generator) SaveSpec(spec []byte, filePath string) error

SaveSpec saves the OpenAPI specification to a file using restrictive permissions.

type LogoutResponse ¶ added in v1.40.1

type LogoutResponse struct {
	Message string `json:"message" example:"logged out"`
}

LogoutResponse acknowledges that the session cookie was expired.

type NoContentResponse ¶ added in v1.24.2

type NoContentResponse struct{}

NoContentResponse models endpoints that intentionally return HTTP 204.

Source Files ¶

View all Source files

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