Struct ResponseShape 

pub struct ResponseShape {
    pub fields: BTreeMap<String, JsonType>,
    pub sample: Option<Value>,
    pub pagination_detected: bool,
    pub pagination_style: PaginationStyle,
}

Shape of a single discovered endpoint’s response.

Example

use stygian_graph::domain::discovery::{ResponseShape, PaginationStyle, JsonType};
use serde_json::json;
use std::collections::BTreeMap;

let shape = ResponseShape {
    fields: BTreeMap::from([("id".into(), JsonType::Integer), ("name".into(), JsonType::String)]),
    sample: Some(json!({"id": 1, "name": "Widget"})),
    pagination_detected: true,
    pagination_style: PaginationStyle::default(),
};
assert_eq!(shape.fields.len(), 2);

Fields

fields: BTreeMap<String, JsonType>

Inferred field types

sample: Option<Value>

Optional representative sample value

pagination_detected: bool

Whether pagination was detected

pagination_style: PaginationStyle

Pagination envelope style details

Implementations

impl ResponseShape

pub fn from_body(body: &Value) -> Self

Build a ResponseShape by analysing a JSON response body.

If the body is an object with a data key that is an array, fields are inferred from the first array element. Otherwise the top-level object fields are used.

Example

use stygian_graph::domain::discovery::ResponseShape;
use serde_json::json;

let body = json!({"data": [{"id": 1, "name": "A"}], "total": 50, "per_page": 25});
let shape = ResponseShape::from_body(&body);
assert!(shape.pagination_detected);
assert!(shape.fields.contains_key("id"));

Trait Implementations

impl Clone for ResponseShape

fn clone(&self) -> ResponseShape

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseShape

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResponseShape

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ResponseShape

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

where __S: Serializer,

Serialize this value into the given Serde serializer.