odp-core 0.1.1

Transport-independent protocol primitives for the Offering Discovery Protocol.
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
use std::collections::BTreeMap;

use serde::{Deserialize, Serialize};
use serde_json::Value;

pub const VERSION: &str = "1.0";
pub type AdditionalMembers = BTreeMap<String, Value>;

macro_rules! string_enum {
    ($name:ident { $($variant:ident => $value:literal),+ $(,)? }) => {
        #[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, PartialEq, Serialize)]
        pub enum $name {
            $(#[serde(rename = $value)] $variant),+
        }
    };
}

string_enum!(Representation { Terse => "terse", Full => "full" });
string_enum!(PriceType {
    Fixed => "fixed",
    Free => "free",
    Metered => "metered",
    Quote => "quote",
    Range => "range",
    StartingAt => "starting_at",
});
#[derive(Clone, Debug, Eq, Hash, PartialEq)]
pub enum ActionRelation {
    Download,
    Invoke,
    Purchase,
    Quote,
    Reserve,
    Other(String),
}

impl<'de> Deserialize<'de> for ActionRelation {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        Ok(match String::deserialize(deserializer)?.as_str() {
            "download" => Self::Download,
            "invoke" => Self::Invoke,
            "purchase" => Self::Purchase,
            "quote" => Self::Quote,
            "reserve" => Self::Reserve,
            other => Self::Other(other.to_owned()),
        })
    }
}

impl Serialize for ActionRelation {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        match self {
            Self::Download => serializer.serialize_str("download"),
            Self::Invoke => serializer.serialize_str("invoke"),
            Self::Purchase => serializer.serialize_str("purchase"),
            Self::Quote => serializer.serialize_str("quote"),
            Self::Reserve => serializer.serialize_str("reserve"),
            Self::Other(value) => serializer.serialize_str(value),
        }
    }
}
string_enum!(ResourceType { Collection => "collection", Offering => "offering" });
string_enum!(Operation {
    GetCollection => "get-collection",
    GetOffering => "get-offering",
    ListCollectionOfferings => "list-collection-offerings",
    ListCollections => "list-collections",
    ListOfferings => "list-offerings",
    SearchCollections => "search-collections",
    SearchOfferings => "search-offerings",
});
string_enum!(AuthenticationRequirement {
    NotRequired => "not-required",
    Optional => "optional",
    Required => "required",
});
string_enum!(Protocol { Aep => "aep", Mpp => "mpp", Tap => "tap", X402 => "x402" });
string_enum!(PaymentOption {
    Algorand => "algorand",
    Aptos => "aptos",
    Arbitrum => "arbitrum",
    Avalanche => "avalanche",
    Base => "base",
    Card => "card",
    Ethereum => "ethereum",
    Hedera => "hedera",
    Inflow => "inflow",
    Lightning => "lightning",
    Polygon => "polygon",
    Solana => "solana",
    Stellar => "stellar",
    Stripe => "stripe",
    Tempo => "tempo",
    Ton => "ton",
});
string_enum!(FilterType {
    Boolean => "boolean",
    Date => "date",
    DateTime => "date-time",
    Decimal => "decimal",
    Integer => "integer",
    Number => "number",
    String => "string",
});
string_enum!(FilterOperator {
    Equal => "eq",
    Exists => "exists",
    GreaterThan => "gt",
    GreaterThanOrEqual => "gte",
    In => "in",
    LessThan => "lt",
    LessThanOrEqual => "lte",
});
string_enum!(SortDirection { Ascending => "ascending", Descending => "descending" });
string_enum!(MissingPlacement { First => "first", Last => "last" });
string_enum!(ServiceBrandingImageType {
    Png => "image/png",
    Svg => "image/svg+xml",
    WebP => "image/webp",
});
string_enum!(ResourceImageType {
    Avif => "image/avif",
    Jpeg => "image/jpeg",
    Png => "image/png",
    Svg => "image/svg+xml",
    WebP => "image/webp",
});
string_enum!(McpEndpointType { StreamableHttp => "streamable-http" });

#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
pub struct OperationDescriptor {
    pub authentication: AuthenticationRequirement,
    pub name: Operation,
}

#[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize)]
pub struct ServiceProtocols {
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub enrollment: Vec<EnrollmentProtocol>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub payments: Vec<PaymentProtocol>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub trust: Vec<TrustProtocol>,
}

#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
pub struct EnrollmentProtocol {
    pub name: Protocol,
}

#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
pub struct PaymentProtocol {
    pub authentication: AuthenticationRequirement,
    pub name: Protocol,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub options: Vec<PaymentOption>,
}

#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
pub struct TrustProtocol {
    pub name: Protocol,
}

#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
pub struct HttpConfiguration {
    pub endpoint_base: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub openapi: Option<ServiceOpenApi>,
    #[serde(flatten)]
    pub additional: AdditionalMembers,
}

#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
pub struct CapabilityLink {
    pub href: String,
    #[serde(flatten)]
    pub additional: AdditionalMembers,
}

#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
pub struct FilterUnit {
    pub code: String,
    pub system: String,
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub title: String,
    #[serde(flatten)]
    pub additional: AdditionalMembers,
}

#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
pub struct FilterDefinition {
    pub description: String,
    pub id: String,
    pub operators: Vec<FilterOperator>,
    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
    pub refinable: bool,
    pub title: String,
    #[serde(rename = "type")]
    pub filter_type: FilterType,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub unit: Option<FilterUnit>,
    #[serde(flatten)]
    pub additional: AdditionalMembers,
}

#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
pub struct SortKey {
    pub direction: SortDirection,
    pub filter_id: String,
    pub missing: MissingPlacement,
    #[serde(flatten)]
    pub additional: AdditionalMembers,
}

#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
pub struct SortDefinition {
    pub description: String,
    pub id: String,
    pub keys: Vec<SortKey>,
    pub title: String,
    #[serde(flatten)]
    pub additional: AdditionalMembers,
}

#[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize)]
pub struct FilterCapabilitySource {
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub inline: Vec<FilterDefinition>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub linked: Option<CapabilityLink>,
    #[serde(flatten)]
    pub additional: AdditionalMembers,
}

#[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize)]
pub struct SortCapabilitySource {
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub inline: Vec<SortDefinition>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub linked: Option<CapabilityLink>,
    #[serde(flatten)]
    pub additional: AdditionalMembers,
}

#[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize)]
pub struct SearchCapabilities {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub filters: Option<FilterCapabilitySource>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sorts: Option<SortCapabilitySource>,
    #[serde(flatten)]
    pub additional: AdditionalMembers,
}

#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
pub struct ServiceBrandingImage {
    pub src: String,
    #[serde(rename = "type", skip_serializing_if = "Option::is_none")]
    pub media_type: Option<ServiceBrandingImageType>,
}

#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
pub struct ServiceBranding {
    pub icon: ServiceBrandingImage,
    pub logo: ServiceBrandingImage,
}

#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
pub struct ServiceOpenApi {
    pub url: String,
}

#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
pub struct McpEndpoint {
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub description: String,
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub name: String,
    #[serde(rename = "type")]
    pub endpoint_type: McpEndpointType,
    pub url: String,
}

#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
pub struct ServiceDocument {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub branding: Option<ServiceBranding>,
    pub description: String,
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub documentation_url: String,
    pub http: HttpConfiguration,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub keywords: Vec<String>,
    pub language: String,
    pub localizations: Vec<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub mcp: Vec<McpEndpoint>,
    pub name: String,
    pub odp_version: String,
    pub operations: Vec<OperationDescriptor>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub payment_origins: Vec<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub protocols: Option<ServiceProtocols>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub search_capabilities: Option<SearchCapabilities>,
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub status_url: String,
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub support_url: String,
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub website_url: String,
    #[serde(flatten)]
    pub additional: AdditionalMembers,
}

#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
pub struct ResourceImage {
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub alt: String,
    #[serde(default, skip_serializing_if = "is_zero")]
    pub height: u32,
    pub src: String,
    #[serde(rename = "type", skip_serializing_if = "Option::is_none")]
    pub media_type: Option<ResourceImageType>,
    #[serde(default, skip_serializing_if = "is_zero")]
    pub width: u32,
}

fn is_zero(value: &u32) -> bool {
    *value == 0
}

#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
pub struct Collection {
    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
    pub auth_expands: bool,
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub description: String,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub detail_fields: Vec<String>,
    pub id: String,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub images: Vec<ResourceImage>,
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub language: String,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub localizations: Vec<String>,
    pub name: String,
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub odp_version: String,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub parent_ids: Vec<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub search_capabilities: Option<SearchCapabilities>,
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub web_url: String,
    #[serde(flatten)]
    pub additional: AdditionalMembers,
}

#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
pub struct SchemaReference {
    pub url: String,
}

#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
pub struct PricePreview {
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub amount: String,
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub currency: String,
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub maximum: String,
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub minimum: String,
    #[serde(rename = "type")]
    pub price_type: PriceType,
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub unit: String,
    #[serde(flatten)]
    pub additional: AdditionalMembers,
}

#[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize)]
pub struct ActionRequest {
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub content_type: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub schema: Option<SchemaReference>,
}

#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
pub struct HttpActionTarget {
    pub href: String,
    pub method: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub request: Option<ActionRequest>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub response_content_types: Vec<String>,
}

#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
pub struct OpenApiActionTarget {
    pub operation_id: String,
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub url: String,
}

#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
pub struct Action {
    pub authentication: AuthenticationRequirement,
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub description: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub http: Option<HttpActionTarget>,
    pub id: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub openapi: Option<OpenApiActionTarget>,
    pub rel: ActionRelation,
}

#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
pub struct Offering {
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub actions: Vec<Action>,
    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
    pub auth_expands: bool,
    #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
    pub attributes: BTreeMap<String, Value>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub collection_ids: Vec<String>,
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub description: String,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub detail_fields: Vec<String>,
    pub id: String,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub images: Vec<ResourceImage>,
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub language: String,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub localizations: Vec<String>,
    pub name: String,
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub odp_version: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub price: Option<PricePreview>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub schema: Option<SchemaReference>,
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub web_url: String,
    #[serde(flatten)]
    pub additional: AdditionalMembers,
}

#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
pub struct InvalidParameter {
    #[serde(rename = "in")]
    pub location: String,
    pub name: String,
    pub reason: String,
    #[serde(flatten)]
    pub additional: AdditionalMembers,
}

#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
pub struct ProblemDetails {
    pub code: String,
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub detail: String,
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub instance: String,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub invalid_params: Vec<InvalidParameter>,
    pub status: u16,
    pub title: String,
    #[serde(rename = "type")]
    pub problem_type: String,
    #[serde(flatten)]
    pub additional: AdditionalMembers,
}

#[derive(Clone, Debug, Deserialize, Eq, Hash, PartialEq, Serialize)]
pub struct ResourceIdentity {
    pub id: String,
    pub service: String,
    #[serde(rename = "type")]
    pub resource_type: ResourceType,
}

#[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize)]
pub struct CollectionSearchRequest {
    #[serde(default, skip_serializing_if = "is_zero_usize")]
    pub limit: usize,
    pub odp_version: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub parent_id: Option<Option<String>>,
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub query: String,
    #[serde(flatten)]
    pub additional: AdditionalMembers,
}

#[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize)]
pub struct OfferingSearchRequest {
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub collection_id: String,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub filters: Vec<FilterExpression>,
    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
    pub include_descendants: bool,
    #[serde(default, skip_serializing_if = "is_zero_usize")]
    pub limit: usize,
    pub odp_version: String,
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub query: String,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub refinements: Vec<String>,
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub sort: String,
    #[serde(flatten)]
    pub additional: AdditionalMembers,
}

fn is_zero_usize(value: &usize) -> bool {
    *value == 0
}

#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
pub struct FilterExpression {
    pub id: String,
    pub operator: FilterOperator,
    pub value: Value,
    #[serde(flatten)]
    pub additional: AdditionalMembers,
}

#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
pub struct RefinementBucket {
    pub count: u64,
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub count_relation: String,
    pub value: Value,
    #[serde(flatten)]
    pub additional: AdditionalMembers,
}

#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
pub struct RefinementGroup {
    pub filter_id: String,
    pub values: Vec<RefinementBucket>,
    #[serde(flatten)]
    pub additional: AdditionalMembers,
}

#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
pub struct Page<T> {
    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
    pub auth_expands: bool,
    pub items: Vec<T>,
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub next: String,
    pub odp_version: String,
    #[serde(flatten)]
    pub additional: AdditionalMembers,
}

#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
pub struct OfferingPage<T> {
    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
    pub auth_expands: bool,
    pub items: Vec<T>,
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub next: String,
    pub odp_version: String,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub refinements: Vec<RefinementGroup>,
    #[serde(flatten)]
    pub additional: AdditionalMembers,
}