api

Documentation

Index

• Variables
• type API
  • func New(ctx context.Context, opts ...Option) (*API, error)
  • func (a *API) GetOpenapiJson(ctx context.Context, params openapi.GetOpenapiJsonRequestObject) (openapi.GetOpenapiJsonResponseObject, error)
  • func (a API) GetProjectId(ctx context.Context, params openapi.GetProjectIdRequestObject) (openapi.GetProjectIdResponseObject, error)
  • func (a API) GetProjectProjectIdClassificationTaskId(ctx context.Context, ...) (openapi.GetProjectProjectIdClassificationTaskIdResponseObject, error)
  • func (a API) GetProjectProjectIdClassificationTaskLabelId(ctx context.Context, ...) (openapi.GetProjectProjectIdClassificationTaskLabelIdResponseObject, error)
  • func (a *API) GetProjectProjectIdClassificationTasks(ctx context.Context, ...) (openapi.GetProjectProjectIdClassificationTasksResponseObject, error)
  • func (a *API) GetProjectProjectIdPendingClassificationTasks(ctx context.Context, ...) (openapi.GetProjectProjectIdPendingClassificationTasksResponseObject, error)
  • func (a *API) GetProjects(ctx context.Context, request openapi.GetProjectsRequestObject) (openapi.GetProjectsResponseObject, error)
  • func (a API) PostProject(ctx context.Context, params openapi.PostProjectRequestObject) (openapi.PostProjectResponseObject, error)
  • func (a API) PostProjectProjectIdClassificationTask(ctx context.Context, ...) (openapi.PostProjectProjectIdClassificationTaskResponseObject, error)
  • func (a *API) PostProjectProjectIdClassificationTaskIdLabel(ctx context.Context, ...) (openapi.PostProjectProjectIdClassificationTaskIdLabelResponseObject, error)
  • func (a API) PostProjectProjectIdClassificationTaskLabel(ctx context.Context, ...) (openapi.PostProjectProjectIdClassificationTaskLabelResponseObject, error)
  • func (a *API) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Option
  • func WithConfig(cfg *config.Config) Option
  • func WithDatabase(db *storage.Database) Option
  • func WithLogging(logging bool) Option

Variables

var ErrUnableToGetURL = errors.New("unable to get URL from context")

ErrUnableToGetURL is returned when the URL cannot be retrieved from the context.

Types

type API

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

API represents an API with a handler.

func New

func New(ctx context.Context, opts ...Option) (*API, error)

New creates a new instance of the API. It returns a pointer to the API and an error, if any.

func (*API) GetOpenapiJson

func (a *API) GetOpenapiJson(
	ctx context.Context,
	params openapi.GetOpenapiJsonRequestObject,
) (openapi.GetOpenapiJsonResponseObject, error)

GetOpenapiJSON returns the OpenAPI schema as JSON.

func (API) GetProjectId

func (a API) GetProjectId(ctx context.Context, params openapi.GetProjectIdRequestObject) (openapi.GetProjectIdResponseObject, error)

GetProjectId retrieves a project by its ID. It takes a context.Context and a GetProjectIdRequestObject as input parameters. It returns a GetProjectIdResponseObject and an error. The error will be non-nil if there was an error retrieving the project.

func (API) GetProjectProjectIdClassificationTaskId

func (a API) GetProjectProjectIdClassificationTaskId(
	ctx context.Context,
	params openapi.GetProjectProjectIdClassificationTaskIdRequestObject,
) (openapi.GetProjectProjectIdClassificationTaskIdResponseObject, error)

GetProjectProjectIdClassificationTaskId retrieves a classification task by its ID for a specific project.

func (API) GetProjectProjectIdClassificationTaskLabelId

func (a API) GetProjectProjectIdClassificationTaskLabelId(
	ctx context.Context,
	params openapi.GetProjectProjectIdClassificationTaskLabelIdRequestObject,
) (openapi.GetProjectProjectIdClassificationTaskLabelIdResponseObject, error)

GetProjectProjectIdClassificationTaskLabelId retrieves a classification task label by its ID for a specific project.

func (*API) GetProjectProjectIdClassificationTasks

func (a *API) GetProjectProjectIdClassificationTasks(
	ctx context.Context,
	request openapi.GetProjectProjectIdClassificationTasksRequestObject,
) (openapi.GetProjectProjectIdClassificationTasksResponseObject, error)

GetProjectProjectIdClassificationTasks gets the project classification tasks for the given project, optionally filtered by whether they've been completed.

func (*API) GetProjectProjectIdPendingClassificationTasks

func (a *API) GetProjectProjectIdPendingClassificationTasks(
	ctx context.Context,
	request openapi.GetProjectProjectIdPendingClassificationTasksRequestObject,
) (openapi.GetProjectProjectIdPendingClassificationTasksResponseObject, error)

GetProjectProjectIdPendingClassificationTasks gets the pending classification tasks for the given project.

func (*API) GetProjects

func (a *API) GetProjects(
	ctx context.Context,
	request openapi.GetProjectsRequestObject,
) (openapi.GetProjectsResponseObject, error)

GetProjects retrieves a list of all projects.

func (API) PostProject

func (a API) PostProject(ctx context.Context, params openapi.PostProjectRequestObject) (openapi.PostProjectResponseObject, error)

PostProject creates a new project in the database based on the provided parameters. It returns the created project details in the form of a PostProjectResponseObject. If an error occurs during project creation or retrieval, it returns an error.

func (API) PostProjectProjectIdClassificationTask

func (a API) PostProjectProjectIdClassificationTask(
	ctx context.Context,
	params openapi.PostProjectProjectIdClassificationTaskRequestObject,
) (openapi.PostProjectProjectIdClassificationTaskResponseObject, error)

PostProjectProjectIdClassificationTask creates a new classification task for a specific project.

func (*API) PostProjectProjectIdClassificationTaskIdLabel

func (a *API) PostProjectProjectIdClassificationTaskIdLabel(
	ctx context.Context,
	request openapi.PostProjectProjectIdClassificationTaskIdLabelRequestObject,
) (openapi.PostProjectProjectIdClassificationTaskIdLabelResponseObject, error)

PostProjectProjectIdClassificationTaskIdLabel allows a task to be labelled with the given task.

func (API) PostProjectProjectIdClassificationTaskLabel

func (a API) PostProjectProjectIdClassificationTaskLabel(
	ctx context.Context,
	params openapi.PostProjectProjectIdClassificationTaskLabelRequestObject,
) (openapi.PostProjectProjectIdClassificationTaskLabelResponseObject, error)

PostProjectProjectIdClassificationTaskLabel is a function that handles the creation of a classification task label for a specific project. The function creates a classification task label in the database using the provided parameters and returns the created label. If an error occurs during the creation or retrieval of the label, an error is returned.

func (*API) ServeHTTP

func (a *API) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP handles the HTTP requests for the API. It delegates the request to the underlying handler.

type Option

type Option = func(a *API)

Option represents a function that can be used to configure an API instance.

func WithConfig

func WithConfig(cfg *config.Config) Option

WithConfig sets the configuration on the API.

func WithDatabase

func WithDatabase(db *storage.Database) Option

WithDatabase sets the database on the API.

func WithLogging

func WithLogging(logging bool) Option

WithLogging sets the logging enabled flag.