Control protocol capabilities

Describe the annotatr-control-v1 protocol this annotatR version speaks, without starting anything: endpoints, typed operations, limits, security rules and the digests of the shipped JSON Schemas. A client compares this (or the /v1/handshake response) with its own expectations before sending commands.

Usage

at_control_capabilities()

Value

A list with protocol, protocol_version, annotatr_version, status (see at_interop_capabilities()), endpoints, operations, limits, security, schemas (file name -> SHA-256) and digest.

See also

at_control_start(), at_control_command()

Other control: at_control_close(), at_control_command(), at_control_connect(), at_control_events(), at_control_request_status(), at_control_start(), at_control_state(), at_control_stop()

Examples

cc <- at_control_capabilities()
cc$operations
#> [[1]]
#> [1] "session.load"
#> 
#> [[2]]
#> [1] "session.save"
#> 
#> [[3]]
#> [1] "context.goto"
#> 
#> [[4]]
#> [1] "context.view"
#> 
#> [[5]]
#> [1] "context.selection"
#> 
#> [[6]]
#> [1] "annotations.stage"
#> 
#> [[7]]
#> [1] "annotations.commit"
#> 
#> [[8]]
#> [1] "mask.preview"
#> 
#> [[9]]
#> [1] "export"
#> 
#> [[10]]
#> [1] "training.export"
#> 
#> [[11]]
#> [1] "close"
#>