Struct DiscoveryReport 

pub struct DiscoveryReport { /* private fields */ }

Collection of ResponseShapes keyed by endpoint name.

A discovery probe fills this report and passes it to OpenApiGenerator.

Example

use stygian_graph::domain::discovery::{DiscoveryReport, ResponseShape};
use serde_json::json;

let mut report = DiscoveryReport::new();
let body = json!({"id": 1, "name": "Test"});
report.add_endpoint("get_items", ResponseShape::from_body(&body));
assert_eq!(report.endpoints().len(), 1);

Implementations

impl DiscoveryReport

pub fn new() -> Self

Create an empty report.

Example

use stygian_graph::domain::discovery::DiscoveryReport;

let report = DiscoveryReport::new();
assert!(report.endpoints().is_empty());

pub fn add_endpoint(&mut self, name: &str, shape: ResponseShape)

Add a discovered endpoint shape.

Example

use stygian_graph::domain::discovery::{DiscoveryReport, ResponseShape};
use serde_json::json;

let mut report = DiscoveryReport::new();
report.add_endpoint("users", ResponseShape::from_body(&json!({"id": 1})));

pub fn endpoints(&self) -> &BTreeMap<String, ResponseShape>

Return a view of all discovered endpoints.

Example

use stygian_graph::domain::discovery::DiscoveryReport;

let report = DiscoveryReport::new();
assert!(report.endpoints().is_empty());

Trait Implementations

impl Clone for DiscoveryReport

fn clone(&self) -> DiscoveryReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DiscoveryReport

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

Formats the value using the given formatter.

impl Default for DiscoveryReport

fn default() -> DiscoveryReport

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DiscoveryReport

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DiscoveryReport

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

where __S: Serializer,

Serialize this value into the given Serde serializer.