Struct EndpointMeta 

pub struct EndpointMeta {
    pub name: String,
    pub path: String,
    pub protocol: Protocol,
    pub description: Option<String>,
    pub method: Option<String>,
    pub request_schema: Option<Value>,
    pub response_schema: Option<Value>,
    pub tags: Vec<String>,
}

Fully-qualified description of an endpoint exposed by the application.

An EndpointMeta carries everything required to generate documentation for a single endpoint: its human-readable name, network location, protocol and optional request/response JSON schemas.

Schemas are stored as raw serde_json::Value instances to avoid a hard dependency on a specific schema-generation crate in the public API.

Fields

name: String

Display name of the endpoint, used as a title in generated docs.

path: String

URL path (for HTTP/WebSocket) or topic string (for MQTT).

protocol: Protocol

Transport protocol used by this endpoint.

description: Option<String>

Optional long-form, human-readable description.

method: Option<String>

HTTP verb (GET, POST, …). None for WebSocket and MQTT endpoints.

request_schema: Option<Value>

JSON Schema describing the expected request payload, when applicable.

response_schema: Option<Value>

JSON Schema describing the response payload, when applicable.

tags: Vec<String>

Tags used to group the endpoint in the documentation UI.

Implementations

impl EndpointMeta

pub fn new( name: impl Into<String>, path: impl Into<String>, protocol: Protocol, ) -> Self

Create a new EndpointMeta with only the mandatory fields populated.

Optional fields (description, method, request_schema, response_schema) are initialised to None and can be filled in afterwards by mutating the returned value.

Examples

use lucy_types::endpoint::{EndpointMeta, Protocol};

let meta = EndpointMeta::new("health", "/health", Protocol::Http);
assert_eq!(meta.name, "health");
assert_eq!(meta.path, "/health");
assert_eq!(meta.protocol, Protocol::Http);

Trait Implementations

impl Clone for EndpointMeta

fn clone(&self) -> EndpointMeta

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EndpointMeta

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EndpointMeta

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for EndpointMeta

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.