v1

Documentation

Index

• type Router
  • func (r *Router) Route(router fiber.Router)
  • func (r *Router) SetContainer(container di.Container)

Types

type Router

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

func (*Router) Route

func (r *Router) Route(router fiber.Router)

Route registrar.

@title shinpuru main API @version 1.0 @description The shinpuru main REST API.

@Tag.Name Etc @tag.Description General root API functionalities.

@Tag.Name Utilities @tag.Description General utility functionalities.

@Tag.Name Authorization @tag.Description Authorization endpoints.

@Tag.Name OTA @tag.Description One Time Auth token endpoints.

@Tag.Name Public @tag.Description Public API endpoints.

@Tag.Name Search @tag.Description Search endpoints.

@Tag.Name Tokens @tag.Description API token endpoints.

@Tag.Name Global Settings @tag.Description Global bot settings endpoints.

@Tag.Name Reports @tag.Description General reports endpoints.

@Tag.Name Guilds @tag.Description Guild specific endpoints.

@Tag.Name Guild Settings @Tag.Description Guild specific settings endpoints.

@Tag.Name Guild Backups @tag.Description Guild backup endpoints.

@Tag.Name Unban Requests @tag.Description Unban requests endpoints.

@Tag.Name User Settings @tag.Description User specific settings endpoints.

@Tag.Name Member Reporting @tag.Description Member reporting endpoints.

@Tag.Name Members @tag.Description Members specific endpoints.

@Tag.Name Channels @tag.Description Channels specific endpoints.

@Tag.Name Verification @tag.Description User verification endpoints.

@BasePath /api/v1

func (*Router) SetContainer

func (r *Router) SetContainer(container di.Container)