Skip to content
Baumbart logo Baumbart Documentation

qanary-component-helpers/api

This page is auto-generated from TSDoc output. Edit the source file, not this Markdown.

qanary-component-helpers/api

Section titled “qanary-component-helpers/api”
  • Package: @leipzigtreechat/qanary-component-helpers
  • Source file: packages/qanary-component-helpers/src/api.ts

Summary

Section titled “Summary”

The meta data that will be provided to the Spring Boot Admin

IQanaryComponentAbout

Functions

Section titled “Functions”

QanaryServiceControllerApiAxiosParamCreator

Section titled “QanaryServiceControllerApiAxiosParamCreator”
function QanaryServiceControllerApiAxiosParamCreator(configuration: Configuration): void

QanaryServiceControllerApi - axios parameter creator

Parameters

  • configuration (Configuration) Defined at: line 148

QanaryServiceControllerApiFp

Section titled “QanaryServiceControllerApiFp”
function QanaryServiceControllerApiFp(configuration: Configuration): void

QanaryServiceControllerApi - functional programming interface

Parameters

  • configuration (Configuration) Defined at: line 245

QanaryServiceControllerApiFactory

Section titled “QanaryServiceControllerApiFactory”
function QanaryServiceControllerApiFactory(configuration: Configuration, basePath: string, axios: AxiosInstance): void

QanaryServiceControllerApi - factory interface

Parameters

  • configuration (Configuration)
  • basePath (string)
  • axios (AxiosInstance) Defined at: line 293

Interfaces

Section titled “Interfaces”

IQanaryComponentAbout

Section titled “IQanaryComponentAbout”
interface IQanaryComponentAbout

The meta data that will be provided to the Spring Boot Admin

IQanaryComponentAbout

Properties

  • name (string): The name of the qanary component string IQanaryComponentAbout
  • description (string): The description of the qanary component string IQanaryComponentAbout
  • version (string): The version of the qanary component string IQanaryComponentAbout Defined at: line 33

IQanaryComponentError

Section titled “IQanaryComponentError”
interface IQanaryComponentError

Bad Request when request body is invalid

IQanaryComponentError

Properties

  • timestamp (string): A timestamp when the error has occurred string IQanaryComponentError
  • status (number): The status code of the error number IQanaryComponentError
  • error (string): The error message string IQanaryComponentError
  • path (string): The endpoint where error has occurred string IQanaryComponentError Defined at: line 58

IQanaryComponentHealth

Section titled “IQanaryComponentHealth”
interface IQanaryComponentHealth

An object describing the overall status of the service

IQanaryComponentHealth

Properties

  • status (IQanaryComponentHealthStatusEnum): The overall status of the service string IQanaryComponentHealth Defined at: line 89

IQanaryMessage

Section titled “IQanaryMessage”
interface IQanaryMessage

The qanary message that is received/send by the component

IQanaryMessage

Properties

  • values ({ [key: string]: string }): Additional values [key: string]: string; IQanaryMessage
  • inGraph (string): The graph uri of the knowledge graph that contains information for the incoming request string IQanaryMessage
  • endpoint (string): The sparql endpoint as url string IQanaryMessage
  • outGraph (string): The graph uri of the knowledge graph that contains information for the outgoing response string IQanaryMessage
  • question (string): The url of the stored question string IQanaryMessage Defined at: line 111

Types

Section titled “Types”

IQanaryComponentHealthStatusEnum

Section titled “IQanaryComponentHealthStatusEnum”
type IQanaryComponentHealthStatusEnum = (typeof IQanaryComponentHealthStatusEnum)[keyof typeof IQanaryComponentHealthStatusEnum]

Defined at: line 103

Constants

Section titled “Constants”

IQanaryComponentHealthStatusEnum

Section titled “IQanaryComponentHealthStatusEnum”
const IQanaryComponentHealthStatusEnum: unknown

Defined at: line 98

In qanary-component-helpers

Section titled “In qanary-component-helpers”