KnowledgeOS API Reference
Preparing search index...
api/src
Module api/src
Modules
<internal>
Classes
ApiError
GraphQLTransportAdapter
InterceptorChain
MiddlewarePipeline
OperationHandlerRegistry
PublicAPI
RequestPipeline
RestTransportAdapter
TransportRegistry
Interfaces
ApiErrorOptions
ApiResponse
AuthenticationContext
AuthorizationContext
CapabilityDescriptor
ContractSchema
CreateKnowledgeObjectRequest
DeprecationEntry
DtoFieldDescription
DtoSchemaDescription
EdgeDTO
ErrorCatalogDescription
ErrorCatalogEntry
ErrorCatalogEntryDescription
ErrorFieldDetail
EventDTO
EventStatsDTO
ExecutionContext
FieldConstraints
FieldSchema
GraphDTO
GraphPathDTO
HandlerRegistration
Interceptor
InterceptorContext
InterceptorRegistration
KnowledgeObjectDTO
KnowledgeObjectFilter
MiddlewareContext
MiddlewareRegistration
NodeDTO
OperationDescriptor
OperationGroupDescription
OperationResult
PaginatedRequest
PaginatedResponse
PermissionDescription
PermissionDescriptor
PipelineConfig
PipelineEvent
PlatformDescription
PublicApiConfig
RequestContext
ResponseMetadata
SearchFilterDTO
SearchOptionsDTO
SearchRequest
SearchResponseDTO
SearchResultDTO
ServiceStatusDTO
SystemStatusDTO
TransportAdapter
TransportRequest
TransportResponse
TransportSupportDescription
TraversalRequest
TraversalResultDTO
UpdateKnowledgeObjectRequest
ValidationLayer
ValidationProfile
ValidationProfileDescription
ValidationResult
ValidationRule
ValidationViolation
Type Aliases
ApiErrorCategory
AuthenticationMethod
InterceptorPhase
ISOTimestamp
MiddlewareFunction
MiddlewareNext
OperationGroup
OperationHandler
OperationKind
OperationStatus
PipelineEventHandler
PipelineEventType
TransportType
UUID
ValidationLayerName
ValidationRuleType
ViolationSeverity
Variables
ALL_OPERATIONS
DOMAIN_GET
ERROR_CATALOG
EVENT_EMIT
EVENT_HISTORY
EVENT_LIST_TYPES
EVENT_SUBSCRIBE
EVENT_UNSUBSCRIBE
GRAPH_ADD_EDGE
GRAPH_ADD_NODE
GRAPH_DELETE_NODE
GRAPH_FIND_PATH
GRAPH_GET_NEIGHBORS
GRAPH_GET_NODE
GRAPH_TRAVERSE
KNOWLEDGE_BULK_CREATE
KNOWLEDGE_CREATE
KNOWLEDGE_DELETE
KNOWLEDGE_EXISTS
KNOWLEDGE_GET
KNOWLEDGE_LIST
KNOWLEDGE_SEARCH_BY_PROPERTIES
KNOWLEDGE_UPDATE
OPERATIONS_BY_GROUP
OPERATIONS_BY_ID
SEARCH_INDEX_BUILD
SEARCH_INDEX_CLEAR
SEARCH_QUERY
SEARCH_SUGGEST
SYSTEM_SHUTDOWN
SYSTEM_STATUS
Functions
apiError
authenticationError
authorizationError
conflictError
contractError
createAuditInterceptor
createMetricsInterceptor
createOperationDescriptor
createPermissionDescriptor
createRequestContext
createRetryInterceptor
createUUID
createValidationProfile
getAllContracts
getContract
getDeprecatedOperations
getErrorsByCategory
getExperimentalOperations
getOperation
getOperationsByGroup
getRecoverableErrors
getRetryableErrors
internalError
loggingMiddleware
lookupError
metricsMiddleware
notFoundError
rateLimitError
rateLimitMiddleware
registerContract
timeoutError
timeoutMiddleware
tracingMiddleware
validateAllLayers
validateAuthentication
validateAuthorization
validateOperation
validateParameters
validateRequest
validateResponse
validateRuntime
validationError
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
On This Page
Modules
<internal>
Classes
Api
Error
Graph
QL
Transport
Adapter
Interceptor
Chain
Middleware
Pipeline
Operation
Handler
Registry
Public
API
Request
Pipeline
Rest
Transport
Adapter
Transport
Registry
Interfaces
Api
Error
Options
Api
Response
Authentication
Context
Authorization
Context
Capability
Descriptor
Contract
Schema
Create
Knowledge
Object
Request
Deprecation
Entry
Dto
Field
Description
Dto
Schema
Description
Edge
DTO
Error
Catalog
Description
Error
Catalog
Entry
Error
Catalog
Entry
Description
Error
Field
Detail
Event
DTO
Event
Stats
DTO
Execution
Context
Field
Constraints
Field
Schema
Graph
DTO
Graph
Path
DTO
Handler
Registration
Interceptor
Interceptor
Context
Interceptor
Registration
Knowledge
Object
DTO
Knowledge
Object
Filter
Middleware
Context
Middleware
Registration
Node
DTO
Operation
Descriptor
Operation
Group
Description
Operation
Result
Paginated
Request
Paginated
Response
Permission
Description
Permission
Descriptor
Pipeline
Config
Pipeline
Event
Platform
Description
Public
Api
Config
Request
Context
Response
Metadata
Search
Filter
DTO
Search
Options
DTO
Search
Request
Search
Response
DTO
Search
Result
DTO
Service
Status
DTO
System
Status
DTO
Transport
Adapter
Transport
Request
Transport
Response
Transport
Support
Description
Traversal
Request
Traversal
Result
DTO
Update
Knowledge
Object
Request
Validation
Layer
Validation
Profile
Validation
Profile
Description
Validation
Result
Validation
Rule
Validation
Violation
Type Aliases
Api
Error
Category
Authentication
Method
Interceptor
Phase
ISO
Timestamp
Middleware
Function
Middleware
Next
Operation
Group
Operation
Handler
Operation
Kind
Operation
Status
Pipeline
Event
Handler
Pipeline
Event
Type
Transport
Type
UUID
Validation
Layer
Name
Validation
Rule
Type
Violation
Severity
Variables
ALL_
OPERATIONS
DOMAIN_
GET
ERROR_
CATALOG
EVENT_
EMIT
EVENT_
HISTORY
EVENT_
LIST_
TYPES
EVENT_
SUBSCRIBE
EVENT_
UNSUBSCRIBE
GRAPH_
ADD_
EDGE
GRAPH_
ADD_
NODE
GRAPH_
DELETE_
NODE
GRAPH_
FIND_
PATH
GRAPH_
GET_
NEIGHBORS
GRAPH_
GET_
NODE
GRAPH_
TRAVERSE
KNOWLEDGE_
BULK_
CREATE
KNOWLEDGE_
CREATE
KNOWLEDGE_
DELETE
KNOWLEDGE_
EXISTS
KNOWLEDGE_
GET
KNOWLEDGE_
LIST
KNOWLEDGE_
SEARCH_
BY_
PROPERTIES
KNOWLEDGE_
UPDATE
OPERATIONS_
BY_
GROUP
OPERATIONS_
BY_
ID
SEARCH_
INDEX_
BUILD
SEARCH_
INDEX_
CLEAR
SEARCH_
QUERY
SEARCH_
SUGGEST
SYSTEM_
SHUTDOWN
SYSTEM_
STATUS
Functions
api
Error
authentication
Error
authorization
Error
conflict
Error
contract
Error
create
Audit
Interceptor
create
Metrics
Interceptor
create
Operation
Descriptor
create
Permission
Descriptor
create
Request
Context
create
Retry
Interceptor
create
UUID
create
Validation
Profile
get
All
Contracts
get
Contract
get
Deprecated
Operations
get
Errors
By
Category
get
Experimental
Operations
get
Operation
get
Operations
By
Group
get
Recoverable
Errors
get
Retryable
Errors
internal
Error
logging
Middleware
lookup
Error
metrics
Middleware
not
Found
Error
rate
Limit
Error
rate
Limit
Middleware
register
Contract
timeout
Error
timeout
Middleware
tracing
Middleware
validate
All
Layers
validate
Authentication
validate
Authorization
validate
Operation
validate
Parameters
validate
Request
validate
Response
validate
Runtime
validation
Error
KnowledgeOS API Reference
Loading...