nominal-api 0.1239.0

API bindings for the Nominal platform
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

use conjure_http::endpoint;
/// Service for managing demo workbooks in sandbox workspaces.
/// All endpoints validate that the provided workspace has the human-readable ID "sandbox".
#[conjure_http::conjure_client(name = "SandboxWorkspaceService")]
pub trait SandboxWorkspaceService<
    #[response_body]
    I: Iterator<
            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
        >,
> {
    /// Returns the list of demo workbook RIDs for the given sandbox workspace.
    #[endpoint(
        method = GET,
        path = "/scout/v1/sandbox-workspace/{workspaceRid}/demo-workbooks",
        name = "getDemoWorkbooks",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn get_demo_workbooks(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "workspaceRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        workspace_rid: &super::super::super::super::super::objects::api::rids::WorkspaceRid,
    ) -> Result<
        super::super::super::super::super::objects::scout::sandbox::api::GetDemoWorkbooksResponse,
        conjure_http::private::Error,
    >;
    /// Sets the list of demo workbook RIDs for the given sandbox workspace, replacing any existing entries.
    #[endpoint(
        method = PUT,
        path = "/scout/v1/sandbox-workspace/{workspaceRid}/demo-workbooks",
        name = "setDemoWorkbooks",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    fn set_demo_workbooks(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "workspaceRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        workspace_rid: &super::super::super::super::super::objects::api::rids::WorkspaceRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::sandbox::api::SetDemoWorkbooksRequest,
    ) -> Result<(), conjure_http::private::Error>;
    /// Appends workbooks to the existing demo workbook list. If archiveOnLabelConflict is true,
    /// existing workbooks with an exact label-set match are archived along with all related
    /// resources instead of raising an error. The cascade performs a full graph traversal:
    /// starting from the workbook's data scope (asset RIDs or run RIDs), it alternates between
    /// discovering runs linked to assets and assets linked to runs until convergence. All
    /// discovered assets, runs, datasets (from both asset and run data scopes), and events
    /// (from snapshot refs and from all discovered assets) are then archived. This ensures no
    /// orphaned resources remain when demo workbooks are replaced. Partial (subset/superset)
    /// label conflicts always raise an error.
    #[endpoint(
        method = POST,
        path = "/scout/v1/sandbox-workspace/{workspaceRid}/demo-workbooks",
        name = "addDemoWorkbooks",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    fn add_demo_workbooks(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "workspaceRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        workspace_rid: &super::super::super::super::super::objects::api::rids::WorkspaceRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::sandbox::api::AddDemoWorkbooksRequest,
    ) -> Result<(), conjure_http::private::Error>;
}
/// Service for managing demo workbooks in sandbox workspaces.
/// All endpoints validate that the provided workspace has the human-readable ID "sandbox".
#[conjure_http::conjure_client(name = "SandboxWorkspaceService")]
pub trait AsyncSandboxWorkspaceService<
    #[response_body]
    I: conjure_http::private::Stream<
            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
        >,
> {
    /// Returns the list of demo workbook RIDs for the given sandbox workspace.
    #[endpoint(
        method = GET,
        path = "/scout/v1/sandbox-workspace/{workspaceRid}/demo-workbooks",
        name = "getDemoWorkbooks",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn get_demo_workbooks(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "workspaceRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        workspace_rid: &super::super::super::super::super::objects::api::rids::WorkspaceRid,
    ) -> Result<
        super::super::super::super::super::objects::scout::sandbox::api::GetDemoWorkbooksResponse,
        conjure_http::private::Error,
    >;
    /// Sets the list of demo workbook RIDs for the given sandbox workspace, replacing any existing entries.
    #[endpoint(
        method = PUT,
        path = "/scout/v1/sandbox-workspace/{workspaceRid}/demo-workbooks",
        name = "setDemoWorkbooks",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn set_demo_workbooks(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "workspaceRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        workspace_rid: &super::super::super::super::super::objects::api::rids::WorkspaceRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::sandbox::api::SetDemoWorkbooksRequest,
    ) -> Result<(), conjure_http::private::Error>;
    /// Appends workbooks to the existing demo workbook list. If archiveOnLabelConflict is true,
    /// existing workbooks with an exact label-set match are archived along with all related
    /// resources instead of raising an error. The cascade performs a full graph traversal:
    /// starting from the workbook's data scope (asset RIDs or run RIDs), it alternates between
    /// discovering runs linked to assets and assets linked to runs until convergence. All
    /// discovered assets, runs, datasets (from both asset and run data scopes), and events
    /// (from snapshot refs and from all discovered assets) are then archived. This ensures no
    /// orphaned resources remain when demo workbooks are replaced. Partial (subset/superset)
    /// label conflicts always raise an error.
    #[endpoint(
        method = POST,
        path = "/scout/v1/sandbox-workspace/{workspaceRid}/demo-workbooks",
        name = "addDemoWorkbooks",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn add_demo_workbooks(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "workspaceRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        workspace_rid: &super::super::super::super::super::objects::api::rids::WorkspaceRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::sandbox::api::AddDemoWorkbooksRequest,
    ) -> Result<(), conjure_http::private::Error>;
}
/// Service for managing demo workbooks in sandbox workspaces.
/// All endpoints validate that the provided workspace has the human-readable ID "sandbox".
#[conjure_http::conjure_client(name = "SandboxWorkspaceService", local)]
pub trait LocalAsyncSandboxWorkspaceService<
    #[response_body]
    I: conjure_http::private::Stream<
            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
        >,
> {
    /// Returns the list of demo workbook RIDs for the given sandbox workspace.
    #[endpoint(
        method = GET,
        path = "/scout/v1/sandbox-workspace/{workspaceRid}/demo-workbooks",
        name = "getDemoWorkbooks",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn get_demo_workbooks(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "workspaceRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        workspace_rid: &super::super::super::super::super::objects::api::rids::WorkspaceRid,
    ) -> Result<
        super::super::super::super::super::objects::scout::sandbox::api::GetDemoWorkbooksResponse,
        conjure_http::private::Error,
    >;
    /// Sets the list of demo workbook RIDs for the given sandbox workspace, replacing any existing entries.
    #[endpoint(
        method = PUT,
        path = "/scout/v1/sandbox-workspace/{workspaceRid}/demo-workbooks",
        name = "setDemoWorkbooks",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn set_demo_workbooks(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "workspaceRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        workspace_rid: &super::super::super::super::super::objects::api::rids::WorkspaceRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::sandbox::api::SetDemoWorkbooksRequest,
    ) -> Result<(), conjure_http::private::Error>;
    /// Appends workbooks to the existing demo workbook list. If archiveOnLabelConflict is true,
    /// existing workbooks with an exact label-set match are archived along with all related
    /// resources instead of raising an error. The cascade performs a full graph traversal:
    /// starting from the workbook's data scope (asset RIDs or run RIDs), it alternates between
    /// discovering runs linked to assets and assets linked to runs until convergence. All
    /// discovered assets, runs, datasets (from both asset and run data scopes), and events
    /// (from snapshot refs and from all discovered assets) are then archived. This ensures no
    /// orphaned resources remain when demo workbooks are replaced. Partial (subset/superset)
    /// label conflicts always raise an error.
    #[endpoint(
        method = POST,
        path = "/scout/v1/sandbox-workspace/{workspaceRid}/demo-workbooks",
        name = "addDemoWorkbooks",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn add_demo_workbooks(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "workspaceRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        workspace_rid: &super::super::super::super::super::objects::api::rids::WorkspaceRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::sandbox::api::AddDemoWorkbooksRequest,
    ) -> Result<(), conjure_http::private::Error>;
}