netbox-openapi 0.6.0

low level netbox bindings (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
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

//! Generic foreign-key fields, derived from the NetBox OpenAPI schema.
//! Auto-generated by `scripts/generate.sh` - do not edit.

/// How a generic foreign key is encoded in a NetBox write payload.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum GenericFkEncoding {
    /// A single nested `{ "object_type": ..., "object_id": ... }`.
    Nested,
    /// An array of nested `{ "object_type": ..., "object_id": ... }`.
    NestedList,
    /// A sibling scalar pair: a `<field>_type` content type and a `<field>_id`.
    Split,
}

/// `(app_label.model, field, encoding)` for every generic foreign key in the
/// NetBox write API. `field` is the logical base name; for `Split` it expands to
/// `<field>_type` and `<field>_id` on the wire, otherwise it is the property
/// carrying the (array of) `GenericObjectRequest`.
pub const GENERIC_FK_FIELDS: &[(&str, &str, GenericFkEncoding)] = &[
    (
        "circuits.circuitgroupassignment",
        "member",
        GenericFkEncoding::Split,
    ),
    (
        "circuits.circuittermination",
        "termination",
        GenericFkEncoding::Split,
    ),
    (
        "dcim.cable",
        "a_terminations",
        GenericFkEncoding::NestedList,
    ),
    (
        "dcim.cable",
        "b_terminations",
        GenericFkEncoding::NestedList,
    ),
    ("dcim.inventoryitem", "component", GenericFkEncoding::Split),
    (
        "dcim.inventoryitemtemplate",
        "component",
        GenericFkEncoding::Split,
    ),
    (
        "dcim.macaddress",
        "assigned_object",
        GenericFkEncoding::Split,
    ),
    ("extras.bookmark", "object", GenericFkEncoding::Split),
    (
        "extras.eventrule",
        "action_object",
        GenericFkEncoding::Split,
    ),
    ("extras.imageattachment", "object", GenericFkEncoding::Split),
    (
        "extras.journalentry",
        "assigned_object",
        GenericFkEncoding::Split,
    ),
    ("extras.notification", "object", GenericFkEncoding::Split),
    ("extras.subscription", "object", GenericFkEncoding::Split),
    (
        "ipam.fhrpgroupassignment",
        "interface",
        GenericFkEncoding::Split,
    ),
    (
        "ipam.ipaddress",
        "assigned_object",
        GenericFkEncoding::Split,
    ),
    ("ipam.prefix", "scope", GenericFkEncoding::Split),
    ("ipam.service", "parent_object", GenericFkEncoding::Split),
    ("ipam.vlangroup", "scope", GenericFkEncoding::Split),
    (
        "tenancy.contactassignment",
        "object",
        GenericFkEncoding::Split,
    ),
    ("virtualization.cluster", "scope", GenericFkEncoding::Split),
    (
        "vpn.l2vpntermination",
        "assigned_object",
        GenericFkEncoding::Split,
    ),
    (
        "vpn.tunneltermination",
        "termination",
        GenericFkEncoding::Split,
    ),
    ("wireless.wirelesslan", "scope", GenericFkEncoding::Split),
];

/// Returns the [`GenericFkEncoding`] for `field` on `model` (keyed as
/// `app_label.model`, e.g. `"dcim.cable"`) if it is a generic foreign key.
pub fn generic_fk_encoding(model: &str, field: &str) -> Option<GenericFkEncoding> {
    GENERIC_FK_FIELDS
        .iter()
        .find(|(m, f, _)| *m == model && *f == field)
        .map(|(_, _, enc)| *enc)
}

/// Returns `true` if `field` on `model` is a generic foreign key whose value
/// must be encoded as a content-type reference rather than a bare id.
pub fn is_generic_fk(model: &str, field: &str) -> bool {
    generic_fk_encoding(model, field).is_some()
}