imagegen-bridge-core 0.1.0

Provider-neutral domain contract for Imagegen Bridge
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

//! Schema root for the complete native wire contract.

use schemars::JsonSchema;
use serde::{Deserialize, Serialize};

use crate::{
    BridgeError, ImageJob, ImageJobPage, ImageJobUpdate, ImagePreset, ImagePresetCreate,
    ImagePresetPage, ImagePresetWrite, ImageRequest, ImageResponse, ProviderCapabilities,
    ProviderDescriptor, ProviderEvent, ValidationIssue,
};

/// All top-level native messages represented as one versioned JSON Schema.
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
#[serde(tag = "message", content = "body", rename_all = "snake_case")]
pub enum ContractMessage {
    /// Normalized request.
    Request(ImageRequest),
    /// Normalized response.
    Response(ImageResponse),
    /// Provider capability document.
    Capabilities(ProviderCapabilities),
    /// Provider discovery document.
    Provider(ProviderDescriptor),
    /// Incremental provider event.
    Event(ProviderEvent),
    /// Complete durable job detail.
    Job(Box<ImageJob>),
    /// Cursor-paginated durable job summaries.
    JobPage(ImageJobPage),
    /// Mutable retained-history fields.
    JobUpdate(ImageJobUpdate),
    /// Persisted reusable request preset.
    Preset(ImagePreset),
    /// Preset create payload.
    PresetCreate(ImagePresetCreate),
    /// Preset replacement payload.
    PresetWrite(ImagePresetWrite),
    /// Cursor-paginated preset collection.
    PresetPage(ImagePresetPage),
    /// Public bridge error.
    Error(BridgeError),
    /// One validation issue.
    ValidationIssue(ValidationIssue),
}

/// Generates the current native contract schema.
#[must_use]
pub fn contract_schema() -> schemars::Schema {
    schemars::schema_for!(ContractMessage)
}