nominal_api/conjure/endpoints/scout/savedviews/
saved_view_service.rs

1use conjure_http::endpoint;
2/// Saved Views allow users to store and reuse filter and table display configurations across
3/// assets, runs, checklists, and more. They can be favorited, archived, and shared across a workspace.
4#[conjure_http::conjure_endpoints(
5    name = "SavedViewService",
6    use_legacy_error_serialization
7)]
8pub trait SavedViewService {
9    /// Creates a new saved view in the given workspace. If no workspace is specified,
10    /// it is created in the user's default workspace.
11    #[endpoint(
12        method = POST,
13        path = "/scout/saved-views/v1",
14        name = "createSavedView",
15        produces = conjure_http::server::StdResponseSerializer
16    )]
17    fn create_saved_view(
18        &self,
19        #[auth]
20        auth_: conjure_object::BearerToken,
21        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
22        request: super::super::super::super::objects::scout::savedviews::api::CreateSavedViewRequest,
23    ) -> Result<
24        super::super::super::super::objects::scout::savedviews::api::CreateSavedViewResponse,
25        conjure_http::private::Error,
26    >;
27    /// Fetches a saved view by RID. Throws NOT_FOUND if it does not exist.
28    #[endpoint(
29        method = GET,
30        path = "/scout/saved-views/v1/{savedViewRid}",
31        name = "getSavedView",
32        produces = conjure_http::server::StdResponseSerializer
33    )]
34    fn get_saved_view(
35        &self,
36        #[auth]
37        auth_: conjure_object::BearerToken,
38        #[path(
39            name = "savedViewRid",
40            decoder = conjure_http::server::conjure::FromPlainDecoder,
41            log_as = "savedViewRid",
42            safe
43        )]
44        saved_view_rid: super::super::super::super::objects::scout::rids::api::SavedViewRid,
45    ) -> Result<
46        super::super::super::super::objects::scout::savedviews::api::GetSavedViewResponse,
47        conjure_http::private::Error,
48    >;
49    /// Retrieves multiple saved views. Any invalid or unknown RIDs are omitted from the response.
50    #[endpoint(
51        method = POST,
52        path = "/scout/saved-views/v1/batch-get",
53        name = "batchGetSavedViews",
54        produces = conjure_http::server::StdResponseSerializer
55    )]
56    fn batch_get_saved_views(
57        &self,
58        #[auth]
59        auth_: conjure_object::BearerToken,
60        #[body(
61            deserializer = conjure_http::server::StdRequestDeserializer,
62            log_as = "savedViewRids",
63            safe
64        )]
65        saved_view_rids: std::collections::BTreeSet<
66            super::super::super::super::objects::scout::rids::api::SavedViewRid,
67        >,
68    ) -> Result<
69        super::super::super::super::objects::scout::savedviews::api::BatchGetSavedViewsResponse,
70        conjure_http::private::Error,
71    >;
72    /// Searches for saved views using a nested query expression. Supports pagination.
73    #[endpoint(
74        method = POST,
75        path = "/scout/saved-views/v1/search",
76        name = "searchSavedViews",
77        produces = conjure_http::server::StdResponseSerializer
78    )]
79    fn search_saved_views(
80        &self,
81        #[auth]
82        auth_: conjure_object::BearerToken,
83        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
84        request: super::super::super::super::objects::scout::savedviews::api::SearchSavedViewsRequest,
85    ) -> Result<
86        super::super::super::super::objects::scout::savedviews::api::SearchSavedViewsResponse,
87        conjure_http::private::Error,
88    >;
89    /// Updates metadata, search filters, or display settings for an existing saved view.
90    /// Throws NOT_FOUND if the view doesn't exist and INVALID_ARGUMENT if it is archived.
91    #[endpoint(
92        method = PUT,
93        path = "/scout/saved-views/v1/{savedViewRid}",
94        name = "updateSavedView",
95        produces = conjure_http::server::StdResponseSerializer
96    )]
97    fn update_saved_view(
98        &self,
99        #[auth]
100        auth_: conjure_object::BearerToken,
101        #[path(
102            name = "savedViewRid",
103            decoder = conjure_http::server::conjure::FromPlainDecoder,
104            log_as = "savedViewRid",
105            safe
106        )]
107        saved_view_rid: super::super::super::super::objects::scout::rids::api::SavedViewRid,
108        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
109        request: super::super::super::super::objects::scout::savedviews::api::UpdateSavedViewRequest,
110    ) -> Result<
111        super::super::super::super::objects::scout::savedviews::api::UpdateSavedViewResponse,
112        conjure_http::private::Error,
113    >;
114    /// Archives the specified saved view. Archived views are hidden from search.
115    #[endpoint(
116        method = POST,
117        path = "/scout/saved-views/v1/{savedViewRid}/archive",
118        name = "archiveSavedView"
119    )]
120    fn archive_saved_view(
121        &self,
122        #[auth]
123        auth_: conjure_object::BearerToken,
124        #[path(
125            name = "savedViewRid",
126            decoder = conjure_http::server::conjure::FromPlainDecoder,
127            log_as = "savedViewRid",
128            safe
129        )]
130        saved_view_rid: super::super::super::super::objects::scout::rids::api::SavedViewRid,
131    ) -> Result<(), conjure_http::private::Error>;
132    /// Restores archived saved view, making them discoverable in search again.
133    #[endpoint(
134        method = POST,
135        path = "/scout/saved-views/v1/{savedViewRid}/unarchive",
136        name = "unarchiveSavedView"
137    )]
138    fn unarchive_saved_view(
139        &self,
140        #[auth]
141        auth_: conjure_object::BearerToken,
142        #[path(
143            name = "savedViewRid",
144            decoder = conjure_http::server::conjure::FromPlainDecoder,
145            log_as = "savedViewRid",
146            safe
147        )]
148        saved_view_rid: super::super::super::super::objects::scout::rids::api::SavedViewRid,
149    ) -> Result<(), conjure_http::private::Error>;
150}
151/// Saved Views allow users to store and reuse filter and table display configurations across
152/// assets, runs, checklists, and more. They can be favorited, archived, and shared across a workspace.
153#[conjure_http::conjure_endpoints(
154    name = "SavedViewService",
155    use_legacy_error_serialization
156)]
157pub trait AsyncSavedViewService {
158    /// Creates a new saved view in the given workspace. If no workspace is specified,
159    /// it is created in the user's default workspace.
160    #[endpoint(
161        method = POST,
162        path = "/scout/saved-views/v1",
163        name = "createSavedView",
164        produces = conjure_http::server::StdResponseSerializer
165    )]
166    async fn create_saved_view(
167        &self,
168        #[auth]
169        auth_: conjure_object::BearerToken,
170        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
171        request: super::super::super::super::objects::scout::savedviews::api::CreateSavedViewRequest,
172    ) -> Result<
173        super::super::super::super::objects::scout::savedviews::api::CreateSavedViewResponse,
174        conjure_http::private::Error,
175    >;
176    /// Fetches a saved view by RID. Throws NOT_FOUND if it does not exist.
177    #[endpoint(
178        method = GET,
179        path = "/scout/saved-views/v1/{savedViewRid}",
180        name = "getSavedView",
181        produces = conjure_http::server::StdResponseSerializer
182    )]
183    async fn get_saved_view(
184        &self,
185        #[auth]
186        auth_: conjure_object::BearerToken,
187        #[path(
188            name = "savedViewRid",
189            decoder = conjure_http::server::conjure::FromPlainDecoder,
190            log_as = "savedViewRid",
191            safe
192        )]
193        saved_view_rid: super::super::super::super::objects::scout::rids::api::SavedViewRid,
194    ) -> Result<
195        super::super::super::super::objects::scout::savedviews::api::GetSavedViewResponse,
196        conjure_http::private::Error,
197    >;
198    /// Retrieves multiple saved views. Any invalid or unknown RIDs are omitted from the response.
199    #[endpoint(
200        method = POST,
201        path = "/scout/saved-views/v1/batch-get",
202        name = "batchGetSavedViews",
203        produces = conjure_http::server::StdResponseSerializer
204    )]
205    async fn batch_get_saved_views(
206        &self,
207        #[auth]
208        auth_: conjure_object::BearerToken,
209        #[body(
210            deserializer = conjure_http::server::StdRequestDeserializer,
211            log_as = "savedViewRids",
212            safe
213        )]
214        saved_view_rids: std::collections::BTreeSet<
215            super::super::super::super::objects::scout::rids::api::SavedViewRid,
216        >,
217    ) -> Result<
218        super::super::super::super::objects::scout::savedviews::api::BatchGetSavedViewsResponse,
219        conjure_http::private::Error,
220    >;
221    /// Searches for saved views using a nested query expression. Supports pagination.
222    #[endpoint(
223        method = POST,
224        path = "/scout/saved-views/v1/search",
225        name = "searchSavedViews",
226        produces = conjure_http::server::StdResponseSerializer
227    )]
228    async fn search_saved_views(
229        &self,
230        #[auth]
231        auth_: conjure_object::BearerToken,
232        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
233        request: super::super::super::super::objects::scout::savedviews::api::SearchSavedViewsRequest,
234    ) -> Result<
235        super::super::super::super::objects::scout::savedviews::api::SearchSavedViewsResponse,
236        conjure_http::private::Error,
237    >;
238    /// Updates metadata, search filters, or display settings for an existing saved view.
239    /// Throws NOT_FOUND if the view doesn't exist and INVALID_ARGUMENT if it is archived.
240    #[endpoint(
241        method = PUT,
242        path = "/scout/saved-views/v1/{savedViewRid}",
243        name = "updateSavedView",
244        produces = conjure_http::server::StdResponseSerializer
245    )]
246    async fn update_saved_view(
247        &self,
248        #[auth]
249        auth_: conjure_object::BearerToken,
250        #[path(
251            name = "savedViewRid",
252            decoder = conjure_http::server::conjure::FromPlainDecoder,
253            log_as = "savedViewRid",
254            safe
255        )]
256        saved_view_rid: super::super::super::super::objects::scout::rids::api::SavedViewRid,
257        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
258        request: super::super::super::super::objects::scout::savedviews::api::UpdateSavedViewRequest,
259    ) -> Result<
260        super::super::super::super::objects::scout::savedviews::api::UpdateSavedViewResponse,
261        conjure_http::private::Error,
262    >;
263    /// Archives the specified saved view. Archived views are hidden from search.
264    #[endpoint(
265        method = POST,
266        path = "/scout/saved-views/v1/{savedViewRid}/archive",
267        name = "archiveSavedView"
268    )]
269    async fn archive_saved_view(
270        &self,
271        #[auth]
272        auth_: conjure_object::BearerToken,
273        #[path(
274            name = "savedViewRid",
275            decoder = conjure_http::server::conjure::FromPlainDecoder,
276            log_as = "savedViewRid",
277            safe
278        )]
279        saved_view_rid: super::super::super::super::objects::scout::rids::api::SavedViewRid,
280    ) -> Result<(), conjure_http::private::Error>;
281    /// Restores archived saved view, making them discoverable in search again.
282    #[endpoint(
283        method = POST,
284        path = "/scout/saved-views/v1/{savedViewRid}/unarchive",
285        name = "unarchiveSavedView"
286    )]
287    async fn unarchive_saved_view(
288        &self,
289        #[auth]
290        auth_: conjure_object::BearerToken,
291        #[path(
292            name = "savedViewRid",
293            decoder = conjure_http::server::conjure::FromPlainDecoder,
294            log_as = "savedViewRid",
295            safe
296        )]
297        saved_view_rid: super::super::super::super::objects::scout::rids::api::SavedViewRid,
298    ) -> Result<(), conjure_http::private::Error>;
299}
300/// Saved Views allow users to store and reuse filter and table display configurations across
301/// assets, runs, checklists, and more. They can be favorited, archived, and shared across a workspace.
302#[conjure_http::conjure_endpoints(
303    name = "SavedViewService",
304    use_legacy_error_serialization,
305    local
306)]
307pub trait LocalAsyncSavedViewService {
308    /// Creates a new saved view in the given workspace. If no workspace is specified,
309    /// it is created in the user's default workspace.
310    #[endpoint(
311        method = POST,
312        path = "/scout/saved-views/v1",
313        name = "createSavedView",
314        produces = conjure_http::server::StdResponseSerializer
315    )]
316    async fn create_saved_view(
317        &self,
318        #[auth]
319        auth_: conjure_object::BearerToken,
320        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
321        request: super::super::super::super::objects::scout::savedviews::api::CreateSavedViewRequest,
322    ) -> Result<
323        super::super::super::super::objects::scout::savedviews::api::CreateSavedViewResponse,
324        conjure_http::private::Error,
325    >;
326    /// Fetches a saved view by RID. Throws NOT_FOUND if it does not exist.
327    #[endpoint(
328        method = GET,
329        path = "/scout/saved-views/v1/{savedViewRid}",
330        name = "getSavedView",
331        produces = conjure_http::server::StdResponseSerializer
332    )]
333    async fn get_saved_view(
334        &self,
335        #[auth]
336        auth_: conjure_object::BearerToken,
337        #[path(
338            name = "savedViewRid",
339            decoder = conjure_http::server::conjure::FromPlainDecoder,
340            log_as = "savedViewRid",
341            safe
342        )]
343        saved_view_rid: super::super::super::super::objects::scout::rids::api::SavedViewRid,
344    ) -> Result<
345        super::super::super::super::objects::scout::savedviews::api::GetSavedViewResponse,
346        conjure_http::private::Error,
347    >;
348    /// Retrieves multiple saved views. Any invalid or unknown RIDs are omitted from the response.
349    #[endpoint(
350        method = POST,
351        path = "/scout/saved-views/v1/batch-get",
352        name = "batchGetSavedViews",
353        produces = conjure_http::server::StdResponseSerializer
354    )]
355    async fn batch_get_saved_views(
356        &self,
357        #[auth]
358        auth_: conjure_object::BearerToken,
359        #[body(
360            deserializer = conjure_http::server::StdRequestDeserializer,
361            log_as = "savedViewRids",
362            safe
363        )]
364        saved_view_rids: std::collections::BTreeSet<
365            super::super::super::super::objects::scout::rids::api::SavedViewRid,
366        >,
367    ) -> Result<
368        super::super::super::super::objects::scout::savedviews::api::BatchGetSavedViewsResponse,
369        conjure_http::private::Error,
370    >;
371    /// Searches for saved views using a nested query expression. Supports pagination.
372    #[endpoint(
373        method = POST,
374        path = "/scout/saved-views/v1/search",
375        name = "searchSavedViews",
376        produces = conjure_http::server::StdResponseSerializer
377    )]
378    async fn search_saved_views(
379        &self,
380        #[auth]
381        auth_: conjure_object::BearerToken,
382        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
383        request: super::super::super::super::objects::scout::savedviews::api::SearchSavedViewsRequest,
384    ) -> Result<
385        super::super::super::super::objects::scout::savedviews::api::SearchSavedViewsResponse,
386        conjure_http::private::Error,
387    >;
388    /// Updates metadata, search filters, or display settings for an existing saved view.
389    /// Throws NOT_FOUND if the view doesn't exist and INVALID_ARGUMENT if it is archived.
390    #[endpoint(
391        method = PUT,
392        path = "/scout/saved-views/v1/{savedViewRid}",
393        name = "updateSavedView",
394        produces = conjure_http::server::StdResponseSerializer
395    )]
396    async fn update_saved_view(
397        &self,
398        #[auth]
399        auth_: conjure_object::BearerToken,
400        #[path(
401            name = "savedViewRid",
402            decoder = conjure_http::server::conjure::FromPlainDecoder,
403            log_as = "savedViewRid",
404            safe
405        )]
406        saved_view_rid: super::super::super::super::objects::scout::rids::api::SavedViewRid,
407        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
408        request: super::super::super::super::objects::scout::savedviews::api::UpdateSavedViewRequest,
409    ) -> Result<
410        super::super::super::super::objects::scout::savedviews::api::UpdateSavedViewResponse,
411        conjure_http::private::Error,
412    >;
413    /// Archives the specified saved view. Archived views are hidden from search.
414    #[endpoint(
415        method = POST,
416        path = "/scout/saved-views/v1/{savedViewRid}/archive",
417        name = "archiveSavedView"
418    )]
419    async fn archive_saved_view(
420        &self,
421        #[auth]
422        auth_: conjure_object::BearerToken,
423        #[path(
424            name = "savedViewRid",
425            decoder = conjure_http::server::conjure::FromPlainDecoder,
426            log_as = "savedViewRid",
427            safe
428        )]
429        saved_view_rid: super::super::super::super::objects::scout::rids::api::SavedViewRid,
430    ) -> Result<(), conjure_http::private::Error>;
431    /// Restores archived saved view, making them discoverable in search again.
432    #[endpoint(
433        method = POST,
434        path = "/scout/saved-views/v1/{savedViewRid}/unarchive",
435        name = "unarchiveSavedView"
436    )]
437    async fn unarchive_saved_view(
438        &self,
439        #[auth]
440        auth_: conjure_object::BearerToken,
441        #[path(
442            name = "savedViewRid",
443            decoder = conjure_http::server::conjure::FromPlainDecoder,
444            log_as = "savedViewRid",
445            safe
446        )]
447        saved_view_rid: super::super::super::super::objects::scout::rids::api::SavedViewRid,
448    ) -> Result<(), conjure_http::private::Error>;
449}
nominal_api/conjure/endpoints/scout/savedviews/saved_view_service.rs

nominal_api/conjure/endpoints/scout/savedviews/
saved_view_service.rs
