announcements

package
v0.18.1 Latest Latest
Warning

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

Go to latest
Published: Feb 24, 2025 License: AGPL-3.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source
const BasePath = "/v1/announcements"

BasePath is the base path for this api module, excluding the api prefix

Variables

This section is empty.

Functions

This section is empty.

Types

type Module

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

func New

func New(processor *processing.Processor) *Module

func (*Module) AnnouncementsGETHandler

func (m *Module) AnnouncementsGETHandler(c *gin.Context)

AnnouncementsGETHandler swagger:operation GET /api/v1/announcements announcementsGet

Get an array of currently active announcements.

THIS ENDPOINT IS CURRENTLY NOT FULLY IMPLEMENTED: it will always return an empty array.

---
tags:
- announcements

produces:
- application/json

security:
- OAuth2 Bearer:
	- read:announcements

responses:
	'200':
		schema:
			type: array
			items:
				type: object
			maxItems: 0
	'400':
		description: bad request
	'401':
		description: unauthorized
	'406':
		description: not acceptable
	'500':
		description: internal server error

func (*Module) Route

func (m *Module) Route(attachHandler func(method string, path string, f ...gin.HandlerFunc) gin.IRoutes)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
JackTT - Gopher 🇻🇳