Optional authenticationOptional descriptionDetailed description text for the endpoint
Optional exampleExample (request) => response pair. estuary-rpc will use this both as the appropriate example fields within the OpenApi spec and will dynamically analyze the types to form a guess at what their description should be
Optional methodOptional reqSchema definition for the Request object, overriding a guess formed in the example if provided. If the endpoint uses UrlFormTransport, this will be converted into the appropriate property list
Optional resSchema definition for the Request object, overriding a guess formed in the example if provided
Optional summarySummary text for describing the endpoint
Optional swaggerGeneric swagger JSON to extend the endpoint definition with, overriding everything else from this endpoint definition. Allowable fields defined here.
Optional transportOptional urlGenerated using TypeDoc
All endpoints in estuary-rpc are described by a type that extends SimpleMeta, meaning at the very least that the method type and url must be defined for all of them