api

package

v0.1.2 Latest Latest Go to latest Published: Mar 22, 2024 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package api contains the endpoints to manage finding tickets.

This section is empty.

This section is empty.

This section is empty.

type API struct {
	Options Options
	// contains filtered or unexported fields
}

API represents an API services and all the stuff needed to work.

func New(ticketServer tracking.TicketServer, ticketTrackerBuilder tracking.TicketTrackerBuilder,
	storage storage.Storage, options Options) *API

New instantiates a new API.

func (api *API) CreateTicket(c echo.Context) error

CreateTicket creates a ticket and returns a JSON containing the new ticket.

func (api *API) GetFindingTicket(c echo.Context) error

GetFindingTicket checks if a ticket was created and retrieves it if it is found.

func (api *API) GetTicket(c echo.Context) error

GetTicket returns a JSON containing a specific ticket.

func (api *API) Healthcheck(c echo.Context) error

Healthcheck performs a simple query and returns an OK response.

type Options struct {
	MaxSize     int
	DefaultSize int
}

Options represents size options for the API requests.