Interface: APIEndpoint
An HTTP endpoint exposed by a StreamShare-compatible service.
Properties
id
id:
string
Stable endpoint identifier, unique within the service manifest.
label
label:
string
Human-readable name displayed by clients.
method
method:
"GET"|"POST"
HTTP method used to call the endpoint.
pathname
pathname:
string
Service-root-relative URL path.
params
params:
Param[]
Parameters accepted by the endpoint.
hidden?
optionalhidden?:boolean
Prevents clients from presenting the endpoint as a direct navigation entry.
kind
kind:
ServiceEndpointKind
Semantic purpose used by clients to discover the endpoint.