nominal_api_conjure/conjure/endpoints/scout/
run_service.rs

1use conjure_http::endpoint;
2/// Runs are collections of channels and metadata from one or more data sources, synchronized over a
3/// range of real time, which represents a test event or simulation. These API endpoints let you
4/// manage runs in the Nominal app.
5#[conjure_http::conjure_endpoints(name = "RunService", use_legacy_error_serialization)]
6pub trait RunService {
7    /// Create a new run in Nominal.
8    ///
9    /// Throws if start is equal to or after end.
10    #[endpoint(
11        method = POST,
12        path = "/scout/v1/run",
13        name = "createRun",
14        produces = conjure_http::server::StdResponseSerializer
15    )]
16    fn create_run(
17        &self,
18        #[auth]
19        auth_: conjure_object::BearerToken,
20        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
21        details: super::super::super::objects::scout::run::api::CreateRunRequest,
22    ) -> Result<
23        super::super::super::objects::scout::run::api::Run,
24        conjure_http::private::Error,
25    >;
26    /// Updates an existing run based on its RID.
27    ///
28    /// Throws if start is equal to or after end.
29    #[endpoint(
30        method = PUT,
31        path = "/scout/v1/run/{rid}",
32        name = "updateRun",
33        produces = conjure_http::server::StdResponseSerializer
34    )]
35    fn update_run(
36        &self,
37        #[auth]
38        auth_: conjure_object::BearerToken,
39        #[path(
40            name = "rid",
41            decoder = conjure_http::server::conjure::FromPlainDecoder,
42            safe
43        )]
44        rid: super::super::super::objects::scout::run::api::RunRid,
45        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
46        details: super::super::super::objects::scout::run::api::UpdateRunRequest,
47    ) -> Result<
48        super::super::super::objects::scout::run::api::Run,
49        conjure_http::private::Error,
50    >;
51    /// Batch edits metadata across multiple runs. Supports rename/merge for labels and properties.
52    /// If more than 1000 runs are targeted, this endpoint will throw a 400.
53    #[endpoint(
54        method = POST,
55        path = "/scout/v1/run/metadata/batch-edit",
56        name = "batchEditRunMetadata",
57        produces = conjure_http::server::StdResponseSerializer
58    )]
59    fn batch_edit_run_metadata(
60        &self,
61        #[auth]
62        auth_: conjure_object::BearerToken,
63        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
64        request: super::super::super::objects::scout::run::api::BatchEditRunMetadataRequest,
65    ) -> Result<
66        super::super::super::objects::scout::run::api::BatchEditRunMetadataResponse,
67        conjure_http::private::Error,
68    >;
69    /// Adds datasources to the run in question.
70    ///
71    /// Throws if any of the ref names conflict with existing data sources or each other.
72    #[endpoint(
73        method = POST,
74        path = "/scout/v1/run/{runRid}/data-sources",
75        name = "addDataSourcesToRun",
76        produces = conjure_http::server::StdResponseSerializer
77    )]
78    fn add_data_sources_to_run(
79        &self,
80        #[auth]
81        auth_: conjure_object::BearerToken,
82        #[path(
83            name = "runRid",
84            decoder = conjure_http::server::conjure::FromPlainDecoder,
85            log_as = "runRid",
86            safe
87        )]
88        run_rid: super::super::super::objects::scout::run::api::RunRid,
89        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
90        request: std::collections::BTreeMap<
91            super::super::super::objects::scout::api::DataSourceRefName,
92            super::super::super::objects::scout::run::api::CreateRunDataSource,
93        >,
94    ) -> Result<
95        super::super::super::objects::scout::run::api::Run,
96        conjure_http::private::Error,
97    >;
98    /// Updates a run if it exists, otherwise it's created from scratch.
99    /// Will throw if the workspace of an existing run is different from the workspace of the request.
100    #[endpoint(
101        method = POST,
102        path = "/scout/v1/run/create-or-update",
103        name = "createOrUpdateRun",
104        produces = conjure_http::server::StdResponseSerializer
105    )]
106    fn create_or_update_run(
107        &self,
108        #[auth]
109        auth_: conjure_object::BearerToken,
110        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
111        details: super::super::super::objects::scout::run::api::CreateOrUpdateRunRequest,
112    ) -> Result<
113        super::super::super::objects::scout::run::api::Run,
114        conjure_http::private::Error,
115    >;
116    /// Fetches details about the run in question based on its RID.
117    #[endpoint(
118        method = GET,
119        path = "/scout/v1/run/{rid}",
120        name = "getRun",
121        produces = conjure_http::server::StdResponseSerializer
122    )]
123    fn get_run(
124        &self,
125        #[auth]
126        auth_: conjure_object::BearerToken,
127        #[path(
128            name = "rid",
129            decoder = conjure_http::server::conjure::FromPlainDecoder,
130            safe
131        )]
132        rid: super::super::super::objects::scout::run::api::RunRid,
133    ) -> Result<
134        super::super::super::objects::scout::run::api::Run,
135        conjure_http::private::Error,
136    >;
137    /// Fetches details about the run in question based on its RID,
138    /// including metrics for check and violation review status.
139    #[endpoint(
140        method = GET,
141        path = "/scout/v1/run/{rid}/with-data-review-metrics",
142        name = "getRunWithDataReviewMetrics",
143        produces = conjure_http::server::StdResponseSerializer
144    )]
145    fn get_run_with_data_review_metrics(
146        &self,
147        #[auth]
148        auth_: conjure_object::BearerToken,
149        #[path(
150            name = "rid",
151            decoder = conjure_http::server::conjure::FromPlainDecoder,
152            safe
153        )]
154        rid: super::super::super::objects::scout::run::api::RunRid,
155    ) -> Result<
156        super::super::super::objects::scout::run::api::RunWithDataReviewMetrics,
157        conjure_http::private::Error,
158    >;
159    /// Fetches details about the run in question based on its RID, including a summary of the data review status.
160    #[endpoint(
161        method = GET,
162        path = "/scout/v1/run/{rid}/with-data-review-summary",
163        name = "getRunWithDataReviewSummary",
164        produces = conjure_http::server::StdResponseSerializer
165    )]
166    fn get_run_with_data_review_summary(
167        &self,
168        #[auth]
169        auth_: conjure_object::BearerToken,
170        #[path(
171            name = "rid",
172            decoder = conjure_http::server::conjure::FromPlainDecoder,
173            safe
174        )]
175        rid: super::super::super::objects::scout::run::api::RunRid,
176    ) -> Result<
177        super::super::super::objects::scout::run::api::RunWithDataReviewSummary,
178        conjure_http::private::Error,
179    >;
180    /// Fetches a run based on the run number, rather than RID.
181    #[endpoint(
182        method = POST,
183        path = "/scout/v1/run/by-id",
184        name = "getRunById",
185        produces = conjure_http::server::StdResponseSerializer
186    )]
187    fn get_run_by_id(
188        &self,
189        #[auth]
190        auth_: conjure_object::BearerToken,
191        #[body(
192            deserializer = conjure_http::server::StdRequestDeserializer,
193            log_as = "getRunByIdRequest"
194        )]
195        get_run_by_id_request: super::super::super::objects::scout::run::api::GetRunByIdRequest,
196    ) -> Result<
197        super::super::super::objects::scout::run::api::Run,
198        conjure_http::private::Error,
199    >;
200    /// Fetches a list of run details based on a list of RIDs.
201    #[endpoint(
202        method = POST,
203        path = "/scout/v1/run/multiple",
204        name = "getRuns",
205        produces = conjure_http::server::conjure::CollectionResponseSerializer
206    )]
207    fn get_runs(
208        &self,
209        #[auth]
210        auth_: conjure_object::BearerToken,
211        #[body(deserializer = conjure_http::server::StdRequestDeserializer, safe)]
212        rids: std::collections::BTreeSet<
213            super::super::super::objects::scout::run::api::RunRid,
214        >,
215    ) -> Result<
216        std::collections::BTreeMap<
217            super::super::super::objects::scout::run::api::RunRid,
218            super::super::super::objects::scout::run::api::Run,
219        >,
220        conjure_http::private::Error,
221    >;
222    /// Fetches the runs with the given asset.
223    #[endpoint(
224        method = POST,
225        path = "/scout/v1/run/by-asset",
226        name = "getRunsByAsset",
227        produces = conjure_http::server::StdResponseSerializer
228    )]
229    fn get_runs_by_asset(
230        &self,
231        #[auth]
232        auth_: conjure_object::BearerToken,
233        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
234        request: super::super::super::objects::scout::run::api::GetRunsByAssetRequest,
235    ) -> Result<
236        super::super::super::objects::scout::run::api::GetRunsByAssetResponse,
237        conjure_http::private::Error,
238    >;
239    /// Fetches the latest run for each requested asset.
240    /// Assets without associated runs will not be included in response.
241    #[endpoint(
242        method = POST,
243        path = "/scout/v1/run/by-assets/latest",
244        name = "getLatestRunForAssets",
245        produces = conjure_http::server::conjure::CollectionResponseSerializer
246    )]
247    fn get_latest_run_for_assets(
248        &self,
249        #[auth]
250        auth_: conjure_object::BearerToken,
251        #[body(deserializer = conjure_http::server::StdRequestDeserializer, safe)]
252        request: std::collections::BTreeSet<
253            super::super::super::objects::scout::rids::api::AssetRid,
254        >,
255    ) -> Result<
256        std::collections::BTreeMap<
257            super::super::super::objects::scout::rids::api::AssetRid,
258            super::super::super::objects::scout::run::api::Run,
259        >,
260        conjure_http::private::Error,
261    >;
262    /// This legacy bulk-list surface returns string property values only.
263    #[endpoint(
264        method = GET,
265        path = "/scout/v1/all-runs-properties-labels",
266        name = "getAllRunsPropertiesAndLabels",
267        produces = conjure_http::server::StdResponseSerializer
268    )]
269    fn get_all_runs_properties_and_labels(
270        &self,
271        #[auth]
272        auth_: conjure_object::BearerToken,
273        #[query(
274            name = "workspaces",
275            decoder = conjure_http::server::conjure::FromPlainSeqDecoder<_>,
276            safe
277        )]
278        workspaces: std::collections::BTreeSet<
279            super::super::super::objects::api::rids::WorkspaceRid,
280        >,
281    ) -> Result<
282        super::super::super::objects::scout::run::api::AllRunsPropertiesAndLabelsResponse,
283        conjure_http::private::Error,
284    >;
285    /// Searches for runs that match the given filters. Defaults to returning un-archived runs, absent an archive
286    /// filter.
287    #[endpoint(
288        method = POST,
289        path = "/scout/v1/search-runs",
290        name = "searchRuns",
291        produces = conjure_http::server::StdResponseSerializer
292    )]
293    fn search_runs(
294        &self,
295        #[auth]
296        auth_: conjure_object::BearerToken,
297        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
298        request: super::super::super::objects::scout::run::api::SearchRunsRequest,
299    ) -> Result<
300        super::super::super::objects::scout::run::api::SearchRunsResponse,
301        conjure_http::private::Error,
302    >;
303    /// Searches for runs that match the given filters and
304    /// includes metrics for check and violation review status. Defaults to returning un-archived runs, absent an
305    /// archive filter.
306    #[endpoint(
307        method = POST,
308        path = "/scout/v1/search-runs-with-data-review-metrics",
309        name = "searchRunsWithDataReviewMetrics",
310        produces = conjure_http::server::StdResponseSerializer
311    )]
312    fn search_runs_with_data_review_metrics(
313        &self,
314        #[auth]
315        auth_: conjure_object::BearerToken,
316        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
317        request: super::super::super::objects::scout::run::api::SearchRunsRequest,
318    ) -> Result<
319        super::super::super::objects::scout::run::api::SearchRunsWithDataReviewMetricsResponse,
320        conjure_http::private::Error,
321    >;
322    /// Searches for runs that match the given filters and includes a summary of the data review status. Defaults to
323    /// returning un-archived runs, absent an archive filter.
324    #[endpoint(
325        method = POST,
326        path = "/scout/v1/search-runs-with-data-review-summary",
327        name = "searchRunsWithDataReviewSummary",
328        produces = conjure_http::server::StdResponseSerializer
329    )]
330    fn search_runs_with_data_review_summary(
331        &self,
332        #[auth]
333        auth_: conjure_object::BearerToken,
334        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
335        request: super::super::super::objects::scout::run::api::SearchRunsRequest,
336    ) -> Result<
337        super::super::super::objects::scout::run::api::SearchRunsWithDataReviewSummaryResponse,
338        conjure_http::private::Error,
339    >;
340    /// Soft-deletes a run. Runs still exist in the database but are no longer visible.
341    #[endpoint(
342        method = PUT,
343        path = "/scout/v1/archive-run/{rid}",
344        name = "archiveRun",
345        produces = conjure_http::server::StdResponseSerializer
346    )]
347    fn archive_run(
348        &self,
349        #[auth]
350        auth_: conjure_object::BearerToken,
351        #[path(
352            name = "rid",
353            decoder = conjure_http::server::conjure::FromPlainDecoder,
354            safe
355        )]
356        rid: super::super::super::objects::scout::run::api::RunRid,
357        #[query(
358            name = "includeLinkedWorkbooks",
359            decoder = conjure_http::server::conjure::FromPlainOptionDecoder,
360            log_as = "includeLinkedWorkbooks"
361        )]
362        include_linked_workbooks: Option<bool>,
363    ) -> Result<bool, conjure_http::private::Error>;
364    #[endpoint(
365        method = PUT,
366        path = "/scout/v1/unarchive-run/{rid}",
367        name = "unarchiveRun",
368        produces = conjure_http::server::StdResponseSerializer
369    )]
370    fn unarchive_run(
371        &self,
372        #[auth]
373        auth_: conjure_object::BearerToken,
374        #[path(
375            name = "rid",
376            decoder = conjure_http::server::conjure::FromPlainDecoder,
377            safe
378        )]
379        rid: super::super::super::objects::scout::run::api::RunRid,
380        #[query(
381            name = "includeLinkedWorkbooks",
382            decoder = conjure_http::server::conjure::FromPlainOptionDecoder,
383            log_as = "includeLinkedWorkbooks"
384        )]
385        include_linked_workbooks: Option<bool>,
386    ) -> Result<bool, conjure_http::private::Error>;
387    #[endpoint(method = POST, path = "/scout/v1/archive-run", name = "archiveRuns")]
388    fn archive_runs(
389        &self,
390        #[auth]
391        auth_: conjure_object::BearerToken,
392        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
393        request: super::super::super::objects::scout::run::api::ArchiveRunsRequest,
394    ) -> Result<(), conjure_http::private::Error>;
395    #[endpoint(method = POST, path = "/scout/v1/unarchive-run", name = "unarchiveRuns")]
396    fn unarchive_runs(
397        &self,
398        #[auth]
399        auth_: conjure_object::BearerToken,
400        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
401        request: super::super::super::objects::scout::run::api::UnarchiveRunsRequest,
402    ) -> Result<(), conjure_http::private::Error>;
403    /// Returns the list of ref names that are in use across specified and authorized workspaces.
404    #[endpoint(
405        method = GET,
406        path = "/scout/v1/data-source-ref-names-and-types",
407        name = "getDataSourceRefNameAndTypeList",
408        produces = conjure_http::server::conjure::CollectionResponseSerializer
409    )]
410    fn get_data_source_ref_name_and_type_list(
411        &self,
412        #[auth]
413        auth_: conjure_object::BearerToken,
414        #[query(
415            name = "workspaces",
416            decoder = conjure_http::server::conjure::FromPlainSeqDecoder<_>,
417            safe
418        )]
419        workspaces: std::collections::BTreeSet<
420            super::super::super::objects::api::rids::WorkspaceRid,
421        >,
422    ) -> Result<
423        Vec<super::super::super::objects::scout::run::api::RefNameAndType>,
424        conjure_http::private::Error,
425    >;
426    /// Updates the attachments associated with a run.
427    #[endpoint(
428        method = POST,
429        path = "/scout/v1/run/{rid}/attachments",
430        name = "updateRunAttachment"
431    )]
432    fn update_run_attachment(
433        &self,
434        #[auth]
435        auth_: conjure_object::BearerToken,
436        #[path(
437            name = "rid",
438            decoder = conjure_http::server::conjure::FromPlainDecoder,
439            safe
440        )]
441        rid: super::super::super::objects::scout::run::api::RunRid,
442        #[body(deserializer = conjure_http::server::StdRequestDeserializer, safe)]
443        request: super::super::super::objects::scout::run::api::UpdateAttachmentsRequest,
444    ) -> Result<(), conjure_http::private::Error>;
445}
446/// Runs are collections of channels and metadata from one or more data sources, synchronized over a
447/// range of real time, which represents a test event or simulation. These API endpoints let you
448/// manage runs in the Nominal app.
449#[conjure_http::conjure_endpoints(name = "RunService", use_legacy_error_serialization)]
450pub trait AsyncRunService {
451    /// Create a new run in Nominal.
452    ///
453    /// Throws if start is equal to or after end.
454    #[endpoint(
455        method = POST,
456        path = "/scout/v1/run",
457        name = "createRun",
458        produces = conjure_http::server::StdResponseSerializer
459    )]
460    async fn create_run(
461        &self,
462        #[auth]
463        auth_: conjure_object::BearerToken,
464        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
465        details: super::super::super::objects::scout::run::api::CreateRunRequest,
466    ) -> Result<
467        super::super::super::objects::scout::run::api::Run,
468        conjure_http::private::Error,
469    >;
470    /// Updates an existing run based on its RID.
471    ///
472    /// Throws if start is equal to or after end.
473    #[endpoint(
474        method = PUT,
475        path = "/scout/v1/run/{rid}",
476        name = "updateRun",
477        produces = conjure_http::server::StdResponseSerializer
478    )]
479    async fn update_run(
480        &self,
481        #[auth]
482        auth_: conjure_object::BearerToken,
483        #[path(
484            name = "rid",
485            decoder = conjure_http::server::conjure::FromPlainDecoder,
486            safe
487        )]
488        rid: super::super::super::objects::scout::run::api::RunRid,
489        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
490        details: super::super::super::objects::scout::run::api::UpdateRunRequest,
491    ) -> Result<
492        super::super::super::objects::scout::run::api::Run,
493        conjure_http::private::Error,
494    >;
495    /// Batch edits metadata across multiple runs. Supports rename/merge for labels and properties.
496    /// If more than 1000 runs are targeted, this endpoint will throw a 400.
497    #[endpoint(
498        method = POST,
499        path = "/scout/v1/run/metadata/batch-edit",
500        name = "batchEditRunMetadata",
501        produces = conjure_http::server::StdResponseSerializer
502    )]
503    async fn batch_edit_run_metadata(
504        &self,
505        #[auth]
506        auth_: conjure_object::BearerToken,
507        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
508        request: super::super::super::objects::scout::run::api::BatchEditRunMetadataRequest,
509    ) -> Result<
510        super::super::super::objects::scout::run::api::BatchEditRunMetadataResponse,
511        conjure_http::private::Error,
512    >;
513    /// Adds datasources to the run in question.
514    ///
515    /// Throws if any of the ref names conflict with existing data sources or each other.
516    #[endpoint(
517        method = POST,
518        path = "/scout/v1/run/{runRid}/data-sources",
519        name = "addDataSourcesToRun",
520        produces = conjure_http::server::StdResponseSerializer
521    )]
522    async fn add_data_sources_to_run(
523        &self,
524        #[auth]
525        auth_: conjure_object::BearerToken,
526        #[path(
527            name = "runRid",
528            decoder = conjure_http::server::conjure::FromPlainDecoder,
529            log_as = "runRid",
530            safe
531        )]
532        run_rid: super::super::super::objects::scout::run::api::RunRid,
533        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
534        request: std::collections::BTreeMap<
535            super::super::super::objects::scout::api::DataSourceRefName,
536            super::super::super::objects::scout::run::api::CreateRunDataSource,
537        >,
538    ) -> Result<
539        super::super::super::objects::scout::run::api::Run,
540        conjure_http::private::Error,
541    >;
542    /// Updates a run if it exists, otherwise it's created from scratch.
543    /// Will throw if the workspace of an existing run is different from the workspace of the request.
544    #[endpoint(
545        method = POST,
546        path = "/scout/v1/run/create-or-update",
547        name = "createOrUpdateRun",
548        produces = conjure_http::server::StdResponseSerializer
549    )]
550    async fn create_or_update_run(
551        &self,
552        #[auth]
553        auth_: conjure_object::BearerToken,
554        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
555        details: super::super::super::objects::scout::run::api::CreateOrUpdateRunRequest,
556    ) -> Result<
557        super::super::super::objects::scout::run::api::Run,
558        conjure_http::private::Error,
559    >;
560    /// Fetches details about the run in question based on its RID.
561    #[endpoint(
562        method = GET,
563        path = "/scout/v1/run/{rid}",
564        name = "getRun",
565        produces = conjure_http::server::StdResponseSerializer
566    )]
567    async fn get_run(
568        &self,
569        #[auth]
570        auth_: conjure_object::BearerToken,
571        #[path(
572            name = "rid",
573            decoder = conjure_http::server::conjure::FromPlainDecoder,
574            safe
575        )]
576        rid: super::super::super::objects::scout::run::api::RunRid,
577    ) -> Result<
578        super::super::super::objects::scout::run::api::Run,
579        conjure_http::private::Error,
580    >;
581    /// Fetches details about the run in question based on its RID,
582    /// including metrics for check and violation review status.
583    #[endpoint(
584        method = GET,
585        path = "/scout/v1/run/{rid}/with-data-review-metrics",
586        name = "getRunWithDataReviewMetrics",
587        produces = conjure_http::server::StdResponseSerializer
588    )]
589    async fn get_run_with_data_review_metrics(
590        &self,
591        #[auth]
592        auth_: conjure_object::BearerToken,
593        #[path(
594            name = "rid",
595            decoder = conjure_http::server::conjure::FromPlainDecoder,
596            safe
597        )]
598        rid: super::super::super::objects::scout::run::api::RunRid,
599    ) -> Result<
600        super::super::super::objects::scout::run::api::RunWithDataReviewMetrics,
601        conjure_http::private::Error,
602    >;
603    /// Fetches details about the run in question based on its RID, including a summary of the data review status.
604    #[endpoint(
605        method = GET,
606        path = "/scout/v1/run/{rid}/with-data-review-summary",
607        name = "getRunWithDataReviewSummary",
608        produces = conjure_http::server::StdResponseSerializer
609    )]
610    async fn get_run_with_data_review_summary(
611        &self,
612        #[auth]
613        auth_: conjure_object::BearerToken,
614        #[path(
615            name = "rid",
616            decoder = conjure_http::server::conjure::FromPlainDecoder,
617            safe
618        )]
619        rid: super::super::super::objects::scout::run::api::RunRid,
620    ) -> Result<
621        super::super::super::objects::scout::run::api::RunWithDataReviewSummary,
622        conjure_http::private::Error,
623    >;
624    /// Fetches a run based on the run number, rather than RID.
625    #[endpoint(
626        method = POST,
627        path = "/scout/v1/run/by-id",
628        name = "getRunById",
629        produces = conjure_http::server::StdResponseSerializer
630    )]
631    async fn get_run_by_id(
632        &self,
633        #[auth]
634        auth_: conjure_object::BearerToken,
635        #[body(
636            deserializer = conjure_http::server::StdRequestDeserializer,
637            log_as = "getRunByIdRequest"
638        )]
639        get_run_by_id_request: super::super::super::objects::scout::run::api::GetRunByIdRequest,
640    ) -> Result<
641        super::super::super::objects::scout::run::api::Run,
642        conjure_http::private::Error,
643    >;
644    /// Fetches a list of run details based on a list of RIDs.
645    #[endpoint(
646        method = POST,
647        path = "/scout/v1/run/multiple",
648        name = "getRuns",
649        produces = conjure_http::server::conjure::CollectionResponseSerializer
650    )]
651    async fn get_runs(
652        &self,
653        #[auth]
654        auth_: conjure_object::BearerToken,
655        #[body(deserializer = conjure_http::server::StdRequestDeserializer, safe)]
656        rids: std::collections::BTreeSet<
657            super::super::super::objects::scout::run::api::RunRid,
658        >,
659    ) -> Result<
660        std::collections::BTreeMap<
661            super::super::super::objects::scout::run::api::RunRid,
662            super::super::super::objects::scout::run::api::Run,
663        >,
664        conjure_http::private::Error,
665    >;
666    /// Fetches the runs with the given asset.
667    #[endpoint(
668        method = POST,
669        path = "/scout/v1/run/by-asset",
670        name = "getRunsByAsset",
671        produces = conjure_http::server::StdResponseSerializer
672    )]
673    async fn get_runs_by_asset(
674        &self,
675        #[auth]
676        auth_: conjure_object::BearerToken,
677        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
678        request: super::super::super::objects::scout::run::api::GetRunsByAssetRequest,
679    ) -> Result<
680        super::super::super::objects::scout::run::api::GetRunsByAssetResponse,
681        conjure_http::private::Error,
682    >;
683    /// Fetches the latest run for each requested asset.
684    /// Assets without associated runs will not be included in response.
685    #[endpoint(
686        method = POST,
687        path = "/scout/v1/run/by-assets/latest",
688        name = "getLatestRunForAssets",
689        produces = conjure_http::server::conjure::CollectionResponseSerializer
690    )]
691    async fn get_latest_run_for_assets(
692        &self,
693        #[auth]
694        auth_: conjure_object::BearerToken,
695        #[body(deserializer = conjure_http::server::StdRequestDeserializer, safe)]
696        request: std::collections::BTreeSet<
697            super::super::super::objects::scout::rids::api::AssetRid,
698        >,
699    ) -> Result<
700        std::collections::BTreeMap<
701            super::super::super::objects::scout::rids::api::AssetRid,
702            super::super::super::objects::scout::run::api::Run,
703        >,
704        conjure_http::private::Error,
705    >;
706    /// This legacy bulk-list surface returns string property values only.
707    #[endpoint(
708        method = GET,
709        path = "/scout/v1/all-runs-properties-labels",
710        name = "getAllRunsPropertiesAndLabels",
711        produces = conjure_http::server::StdResponseSerializer
712    )]
713    async fn get_all_runs_properties_and_labels(
714        &self,
715        #[auth]
716        auth_: conjure_object::BearerToken,
717        #[query(
718            name = "workspaces",
719            decoder = conjure_http::server::conjure::FromPlainSeqDecoder<_>,
720            safe
721        )]
722        workspaces: std::collections::BTreeSet<
723            super::super::super::objects::api::rids::WorkspaceRid,
724        >,
725    ) -> Result<
726        super::super::super::objects::scout::run::api::AllRunsPropertiesAndLabelsResponse,
727        conjure_http::private::Error,
728    >;
729    /// Searches for runs that match the given filters. Defaults to returning un-archived runs, absent an archive
730    /// filter.
731    #[endpoint(
732        method = POST,
733        path = "/scout/v1/search-runs",
734        name = "searchRuns",
735        produces = conjure_http::server::StdResponseSerializer
736    )]
737    async fn search_runs(
738        &self,
739        #[auth]
740        auth_: conjure_object::BearerToken,
741        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
742        request: super::super::super::objects::scout::run::api::SearchRunsRequest,
743    ) -> Result<
744        super::super::super::objects::scout::run::api::SearchRunsResponse,
745        conjure_http::private::Error,
746    >;
747    /// Searches for runs that match the given filters and
748    /// includes metrics for check and violation review status. Defaults to returning un-archived runs, absent an
749    /// archive filter.
750    #[endpoint(
751        method = POST,
752        path = "/scout/v1/search-runs-with-data-review-metrics",
753        name = "searchRunsWithDataReviewMetrics",
754        produces = conjure_http::server::StdResponseSerializer
755    )]
756    async fn search_runs_with_data_review_metrics(
757        &self,
758        #[auth]
759        auth_: conjure_object::BearerToken,
760        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
761        request: super::super::super::objects::scout::run::api::SearchRunsRequest,
762    ) -> Result<
763        super::super::super::objects::scout::run::api::SearchRunsWithDataReviewMetricsResponse,
764        conjure_http::private::Error,
765    >;
766    /// Searches for runs that match the given filters and includes a summary of the data review status. Defaults to
767    /// returning un-archived runs, absent an archive filter.
768    #[endpoint(
769        method = POST,
770        path = "/scout/v1/search-runs-with-data-review-summary",
771        name = "searchRunsWithDataReviewSummary",
772        produces = conjure_http::server::StdResponseSerializer
773    )]
774    async fn search_runs_with_data_review_summary(
775        &self,
776        #[auth]
777        auth_: conjure_object::BearerToken,
778        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
779        request: super::super::super::objects::scout::run::api::SearchRunsRequest,
780    ) -> Result<
781        super::super::super::objects::scout::run::api::SearchRunsWithDataReviewSummaryResponse,
782        conjure_http::private::Error,
783    >;
784    /// Soft-deletes a run. Runs still exist in the database but are no longer visible.
785    #[endpoint(
786        method = PUT,
787        path = "/scout/v1/archive-run/{rid}",
788        name = "archiveRun",
789        produces = conjure_http::server::StdResponseSerializer
790    )]
791    async fn archive_run(
792        &self,
793        #[auth]
794        auth_: conjure_object::BearerToken,
795        #[path(
796            name = "rid",
797            decoder = conjure_http::server::conjure::FromPlainDecoder,
798            safe
799        )]
800        rid: super::super::super::objects::scout::run::api::RunRid,
801        #[query(
802            name = "includeLinkedWorkbooks",
803            decoder = conjure_http::server::conjure::FromPlainOptionDecoder,
804            log_as = "includeLinkedWorkbooks"
805        )]
806        include_linked_workbooks: Option<bool>,
807    ) -> Result<bool, conjure_http::private::Error>;
808    #[endpoint(
809        method = PUT,
810        path = "/scout/v1/unarchive-run/{rid}",
811        name = "unarchiveRun",
812        produces = conjure_http::server::StdResponseSerializer
813    )]
814    async fn unarchive_run(
815        &self,
816        #[auth]
817        auth_: conjure_object::BearerToken,
818        #[path(
819            name = "rid",
820            decoder = conjure_http::server::conjure::FromPlainDecoder,
821            safe
822        )]
823        rid: super::super::super::objects::scout::run::api::RunRid,
824        #[query(
825            name = "includeLinkedWorkbooks",
826            decoder = conjure_http::server::conjure::FromPlainOptionDecoder,
827            log_as = "includeLinkedWorkbooks"
828        )]
829        include_linked_workbooks: Option<bool>,
830    ) -> Result<bool, conjure_http::private::Error>;
831    #[endpoint(method = POST, path = "/scout/v1/archive-run", name = "archiveRuns")]
832    async fn archive_runs(
833        &self,
834        #[auth]
835        auth_: conjure_object::BearerToken,
836        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
837        request: super::super::super::objects::scout::run::api::ArchiveRunsRequest,
838    ) -> Result<(), conjure_http::private::Error>;
839    #[endpoint(method = POST, path = "/scout/v1/unarchive-run", name = "unarchiveRuns")]
840    async fn unarchive_runs(
841        &self,
842        #[auth]
843        auth_: conjure_object::BearerToken,
844        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
845        request: super::super::super::objects::scout::run::api::UnarchiveRunsRequest,
846    ) -> Result<(), conjure_http::private::Error>;
847    /// Returns the list of ref names that are in use across specified and authorized workspaces.
848    #[endpoint(
849        method = GET,
850        path = "/scout/v1/data-source-ref-names-and-types",
851        name = "getDataSourceRefNameAndTypeList",
852        produces = conjure_http::server::conjure::CollectionResponseSerializer
853    )]
854    async fn get_data_source_ref_name_and_type_list(
855        &self,
856        #[auth]
857        auth_: conjure_object::BearerToken,
858        #[query(
859            name = "workspaces",
860            decoder = conjure_http::server::conjure::FromPlainSeqDecoder<_>,
861            safe
862        )]
863        workspaces: std::collections::BTreeSet<
864            super::super::super::objects::api::rids::WorkspaceRid,
865        >,
866    ) -> Result<
867        Vec<super::super::super::objects::scout::run::api::RefNameAndType>,
868        conjure_http::private::Error,
869    >;
870    /// Updates the attachments associated with a run.
871    #[endpoint(
872        method = POST,
873        path = "/scout/v1/run/{rid}/attachments",
874        name = "updateRunAttachment"
875    )]
876    async fn update_run_attachment(
877        &self,
878        #[auth]
879        auth_: conjure_object::BearerToken,
880        #[path(
881            name = "rid",
882            decoder = conjure_http::server::conjure::FromPlainDecoder,
883            safe
884        )]
885        rid: super::super::super::objects::scout::run::api::RunRid,
886        #[body(deserializer = conjure_http::server::StdRequestDeserializer, safe)]
887        request: super::super::super::objects::scout::run::api::UpdateAttachmentsRequest,
888    ) -> Result<(), conjure_http::private::Error>;
889}
890/// Runs are collections of channels and metadata from one or more data sources, synchronized over a
891/// range of real time, which represents a test event or simulation. These API endpoints let you
892/// manage runs in the Nominal app.
893#[conjure_http::conjure_endpoints(
894    name = "RunService",
895    use_legacy_error_serialization,
896    local
897)]
898pub trait LocalAsyncRunService {
899    /// Create a new run in Nominal.
900    ///
901    /// Throws if start is equal to or after end.
902    #[endpoint(
903        method = POST,
904        path = "/scout/v1/run",
905        name = "createRun",
906        produces = conjure_http::server::StdResponseSerializer
907    )]
908    async fn create_run(
909        &self,
910        #[auth]
911        auth_: conjure_object::BearerToken,
912        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
913        details: super::super::super::objects::scout::run::api::CreateRunRequest,
914    ) -> Result<
915        super::super::super::objects::scout::run::api::Run,
916        conjure_http::private::Error,
917    >;
918    /// Updates an existing run based on its RID.
919    ///
920    /// Throws if start is equal to or after end.
921    #[endpoint(
922        method = PUT,
923        path = "/scout/v1/run/{rid}",
924        name = "updateRun",
925        produces = conjure_http::server::StdResponseSerializer
926    )]
927    async fn update_run(
928        &self,
929        #[auth]
930        auth_: conjure_object::BearerToken,
931        #[path(
932            name = "rid",
933            decoder = conjure_http::server::conjure::FromPlainDecoder,
934            safe
935        )]
936        rid: super::super::super::objects::scout::run::api::RunRid,
937        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
938        details: super::super::super::objects::scout::run::api::UpdateRunRequest,
939    ) -> Result<
940        super::super::super::objects::scout::run::api::Run,
941        conjure_http::private::Error,
942    >;
943    /// Batch edits metadata across multiple runs. Supports rename/merge for labels and properties.
944    /// If more than 1000 runs are targeted, this endpoint will throw a 400.
945    #[endpoint(
946        method = POST,
947        path = "/scout/v1/run/metadata/batch-edit",
948        name = "batchEditRunMetadata",
949        produces = conjure_http::server::StdResponseSerializer
950    )]
951    async fn batch_edit_run_metadata(
952        &self,
953        #[auth]
954        auth_: conjure_object::BearerToken,
955        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
956        request: super::super::super::objects::scout::run::api::BatchEditRunMetadataRequest,
957    ) -> Result<
958        super::super::super::objects::scout::run::api::BatchEditRunMetadataResponse,
959        conjure_http::private::Error,
960    >;
961    /// Adds datasources to the run in question.
962    ///
963    /// Throws if any of the ref names conflict with existing data sources or each other.
964    #[endpoint(
965        method = POST,
966        path = "/scout/v1/run/{runRid}/data-sources",
967        name = "addDataSourcesToRun",
968        produces = conjure_http::server::StdResponseSerializer
969    )]
970    async fn add_data_sources_to_run(
971        &self,
972        #[auth]
973        auth_: conjure_object::BearerToken,
974        #[path(
975            name = "runRid",
976            decoder = conjure_http::server::conjure::FromPlainDecoder,
977            log_as = "runRid",
978            safe
979        )]
980        run_rid: super::super::super::objects::scout::run::api::RunRid,
981        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
982        request: std::collections::BTreeMap<
983            super::super::super::objects::scout::api::DataSourceRefName,
984            super::super::super::objects::scout::run::api::CreateRunDataSource,
985        >,
986    ) -> Result<
987        super::super::super::objects::scout::run::api::Run,
988        conjure_http::private::Error,
989    >;
990    /// Updates a run if it exists, otherwise it's created from scratch.
991    /// Will throw if the workspace of an existing run is different from the workspace of the request.
992    #[endpoint(
993        method = POST,
994        path = "/scout/v1/run/create-or-update",
995        name = "createOrUpdateRun",
996        produces = conjure_http::server::StdResponseSerializer
997    )]
998    async fn create_or_update_run(
999        &self,
1000        #[auth]
1001        auth_: conjure_object::BearerToken,
1002        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
1003        details: super::super::super::objects::scout::run::api::CreateOrUpdateRunRequest,
1004    ) -> Result<
1005        super::super::super::objects::scout::run::api::Run,
1006        conjure_http::private::Error,
1007    >;
1008    /// Fetches details about the run in question based on its RID.
1009    #[endpoint(
1010        method = GET,
1011        path = "/scout/v1/run/{rid}",
1012        name = "getRun",
1013        produces = conjure_http::server::StdResponseSerializer
1014    )]
1015    async fn get_run(
1016        &self,
1017        #[auth]
1018        auth_: conjure_object::BearerToken,
1019        #[path(
1020            name = "rid",
1021            decoder = conjure_http::server::conjure::FromPlainDecoder,
1022            safe
1023        )]
1024        rid: super::super::super::objects::scout::run::api::RunRid,
1025    ) -> Result<
1026        super::super::super::objects::scout::run::api::Run,
1027        conjure_http::private::Error,
1028    >;
1029    /// Fetches details about the run in question based on its RID,
1030    /// including metrics for check and violation review status.
1031    #[endpoint(
1032        method = GET,
1033        path = "/scout/v1/run/{rid}/with-data-review-metrics",
1034        name = "getRunWithDataReviewMetrics",
1035        produces = conjure_http::server::StdResponseSerializer
1036    )]
1037    async fn get_run_with_data_review_metrics(
1038        &self,
1039        #[auth]
1040        auth_: conjure_object::BearerToken,
1041        #[path(
1042            name = "rid",
1043            decoder = conjure_http::server::conjure::FromPlainDecoder,
1044            safe
1045        )]
1046        rid: super::super::super::objects::scout::run::api::RunRid,
1047    ) -> Result<
1048        super::super::super::objects::scout::run::api::RunWithDataReviewMetrics,
1049        conjure_http::private::Error,
1050    >;
1051    /// Fetches details about the run in question based on its RID, including a summary of the data review status.
1052    #[endpoint(
1053        method = GET,
1054        path = "/scout/v1/run/{rid}/with-data-review-summary",
1055        name = "getRunWithDataReviewSummary",
1056        produces = conjure_http::server::StdResponseSerializer
1057    )]
1058    async fn get_run_with_data_review_summary(
1059        &self,
1060        #[auth]
1061        auth_: conjure_object::BearerToken,
1062        #[path(
1063            name = "rid",
1064            decoder = conjure_http::server::conjure::FromPlainDecoder,
1065            safe
1066        )]
1067        rid: super::super::super::objects::scout::run::api::RunRid,
1068    ) -> Result<
1069        super::super::super::objects::scout::run::api::RunWithDataReviewSummary,
1070        conjure_http::private::Error,
1071    >;
1072    /// Fetches a run based on the run number, rather than RID.
1073    #[endpoint(
1074        method = POST,
1075        path = "/scout/v1/run/by-id",
1076        name = "getRunById",
1077        produces = conjure_http::server::StdResponseSerializer
1078    )]
1079    async fn get_run_by_id(
1080        &self,
1081        #[auth]
1082        auth_: conjure_object::BearerToken,
1083        #[body(
1084            deserializer = conjure_http::server::StdRequestDeserializer,
1085            log_as = "getRunByIdRequest"
1086        )]
1087        get_run_by_id_request: super::super::super::objects::scout::run::api::GetRunByIdRequest,
1088    ) -> Result<
1089        super::super::super::objects::scout::run::api::Run,
1090        conjure_http::private::Error,
1091    >;
1092    /// Fetches a list of run details based on a list of RIDs.
1093    #[endpoint(
1094        method = POST,
1095        path = "/scout/v1/run/multiple",
1096        name = "getRuns",
1097        produces = conjure_http::server::conjure::CollectionResponseSerializer
1098    )]
1099    async fn get_runs(
1100        &self,
1101        #[auth]
1102        auth_: conjure_object::BearerToken,
1103        #[body(deserializer = conjure_http::server::StdRequestDeserializer, safe)]
1104        rids: std::collections::BTreeSet<
1105            super::super::super::objects::scout::run::api::RunRid,
1106        >,
1107    ) -> Result<
1108        std::collections::BTreeMap<
1109            super::super::super::objects::scout::run::api::RunRid,
1110            super::super::super::objects::scout::run::api::Run,
1111        >,
1112        conjure_http::private::Error,
1113    >;
1114    /// Fetches the runs with the given asset.
1115    #[endpoint(
1116        method = POST,
1117        path = "/scout/v1/run/by-asset",
1118        name = "getRunsByAsset",
1119        produces = conjure_http::server::StdResponseSerializer
1120    )]
1121    async fn get_runs_by_asset(
1122        &self,
1123        #[auth]
1124        auth_: conjure_object::BearerToken,
1125        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
1126        request: super::super::super::objects::scout::run::api::GetRunsByAssetRequest,
1127    ) -> Result<
1128        super::super::super::objects::scout::run::api::GetRunsByAssetResponse,
1129        conjure_http::private::Error,
1130    >;
1131    /// Fetches the latest run for each requested asset.
1132    /// Assets without associated runs will not be included in response.
1133    #[endpoint(
1134        method = POST,
1135        path = "/scout/v1/run/by-assets/latest",
1136        name = "getLatestRunForAssets",
1137        produces = conjure_http::server::conjure::CollectionResponseSerializer
1138    )]
1139    async fn get_latest_run_for_assets(
1140        &self,
1141        #[auth]
1142        auth_: conjure_object::BearerToken,
1143        #[body(deserializer = conjure_http::server::StdRequestDeserializer, safe)]
1144        request: std::collections::BTreeSet<
1145            super::super::super::objects::scout::rids::api::AssetRid,
1146        >,
1147    ) -> Result<
1148        std::collections::BTreeMap<
1149            super::super::super::objects::scout::rids::api::AssetRid,
1150            super::super::super::objects::scout::run::api::Run,
1151        >,
1152        conjure_http::private::Error,
1153    >;
1154    /// This legacy bulk-list surface returns string property values only.
1155    #[endpoint(
1156        method = GET,
1157        path = "/scout/v1/all-runs-properties-labels",
1158        name = "getAllRunsPropertiesAndLabels",
1159        produces = conjure_http::server::StdResponseSerializer
1160    )]
1161    async fn get_all_runs_properties_and_labels(
1162        &self,
1163        #[auth]
1164        auth_: conjure_object::BearerToken,
1165        #[query(
1166            name = "workspaces",
1167            decoder = conjure_http::server::conjure::FromPlainSeqDecoder<_>,
1168            safe
1169        )]
1170        workspaces: std::collections::BTreeSet<
1171            super::super::super::objects::api::rids::WorkspaceRid,
1172        >,
1173    ) -> Result<
1174        super::super::super::objects::scout::run::api::AllRunsPropertiesAndLabelsResponse,
1175        conjure_http::private::Error,
1176    >;
1177    /// Searches for runs that match the given filters. Defaults to returning un-archived runs, absent an archive
1178    /// filter.
1179    #[endpoint(
1180        method = POST,
1181        path = "/scout/v1/search-runs",
1182        name = "searchRuns",
1183        produces = conjure_http::server::StdResponseSerializer
1184    )]
1185    async fn search_runs(
1186        &self,
1187        #[auth]
1188        auth_: conjure_object::BearerToken,
1189        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
1190        request: super::super::super::objects::scout::run::api::SearchRunsRequest,
1191    ) -> Result<
1192        super::super::super::objects::scout::run::api::SearchRunsResponse,
1193        conjure_http::private::Error,
1194    >;
1195    /// Searches for runs that match the given filters and
1196    /// includes metrics for check and violation review status. Defaults to returning un-archived runs, absent an
1197    /// archive filter.
1198    #[endpoint(
1199        method = POST,
1200        path = "/scout/v1/search-runs-with-data-review-metrics",
1201        name = "searchRunsWithDataReviewMetrics",
1202        produces = conjure_http::server::StdResponseSerializer
1203    )]
1204    async fn search_runs_with_data_review_metrics(
1205        &self,
1206        #[auth]
1207        auth_: conjure_object::BearerToken,
1208        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
1209        request: super::super::super::objects::scout::run::api::SearchRunsRequest,
1210    ) -> Result<
1211        super::super::super::objects::scout::run::api::SearchRunsWithDataReviewMetricsResponse,
1212        conjure_http::private::Error,
1213    >;
1214    /// Searches for runs that match the given filters and includes a summary of the data review status. Defaults to
1215    /// returning un-archived runs, absent an archive filter.
1216    #[endpoint(
1217        method = POST,
1218        path = "/scout/v1/search-runs-with-data-review-summary",
1219        name = "searchRunsWithDataReviewSummary",
1220        produces = conjure_http::server::StdResponseSerializer
1221    )]
1222    async fn search_runs_with_data_review_summary(
1223        &self,
1224        #[auth]
1225        auth_: conjure_object::BearerToken,
1226        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
1227        request: super::super::super::objects::scout::run::api::SearchRunsRequest,
1228    ) -> Result<
1229        super::super::super::objects::scout::run::api::SearchRunsWithDataReviewSummaryResponse,
1230        conjure_http::private::Error,
1231    >;
1232    /// Soft-deletes a run. Runs still exist in the database but are no longer visible.
1233    #[endpoint(
1234        method = PUT,
1235        path = "/scout/v1/archive-run/{rid}",
1236        name = "archiveRun",
1237        produces = conjure_http::server::StdResponseSerializer
1238    )]
1239    async fn archive_run(
1240        &self,
1241        #[auth]
1242        auth_: conjure_object::BearerToken,
1243        #[path(
1244            name = "rid",
1245            decoder = conjure_http::server::conjure::FromPlainDecoder,
1246            safe
1247        )]
1248        rid: super::super::super::objects::scout::run::api::RunRid,
1249        #[query(
1250            name = "includeLinkedWorkbooks",
1251            decoder = conjure_http::server::conjure::FromPlainOptionDecoder,
1252            log_as = "includeLinkedWorkbooks"
1253        )]
1254        include_linked_workbooks: Option<bool>,
1255    ) -> Result<bool, conjure_http::private::Error>;
1256    #[endpoint(
1257        method = PUT,
1258        path = "/scout/v1/unarchive-run/{rid}",
1259        name = "unarchiveRun",
1260        produces = conjure_http::server::StdResponseSerializer
1261    )]
1262    async fn unarchive_run(
1263        &self,
1264        #[auth]
1265        auth_: conjure_object::BearerToken,
1266        #[path(
1267            name = "rid",
1268            decoder = conjure_http::server::conjure::FromPlainDecoder,
1269            safe
1270        )]
1271        rid: super::super::super::objects::scout::run::api::RunRid,
1272        #[query(
1273            name = "includeLinkedWorkbooks",
1274            decoder = conjure_http::server::conjure::FromPlainOptionDecoder,
1275            log_as = "includeLinkedWorkbooks"
1276        )]
1277        include_linked_workbooks: Option<bool>,
1278    ) -> Result<bool, conjure_http::private::Error>;
1279    #[endpoint(method = POST, path = "/scout/v1/archive-run", name = "archiveRuns")]
1280    async fn archive_runs(
1281        &self,
1282        #[auth]
1283        auth_: conjure_object::BearerToken,
1284        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
1285        request: super::super::super::objects::scout::run::api::ArchiveRunsRequest,
1286    ) -> Result<(), conjure_http::private::Error>;
1287    #[endpoint(method = POST, path = "/scout/v1/unarchive-run", name = "unarchiveRuns")]
1288    async fn unarchive_runs(
1289        &self,
1290        #[auth]
1291        auth_: conjure_object::BearerToken,
1292        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
1293        request: super::super::super::objects::scout::run::api::UnarchiveRunsRequest,
1294    ) -> Result<(), conjure_http::private::Error>;
1295    /// Returns the list of ref names that are in use across specified and authorized workspaces.
1296    #[endpoint(
1297        method = GET,
1298        path = "/scout/v1/data-source-ref-names-and-types",
1299        name = "getDataSourceRefNameAndTypeList",
1300        produces = conjure_http::server::conjure::CollectionResponseSerializer
1301    )]
1302    async fn get_data_source_ref_name_and_type_list(
1303        &self,
1304        #[auth]
1305        auth_: conjure_object::BearerToken,
1306        #[query(
1307            name = "workspaces",
1308            decoder = conjure_http::server::conjure::FromPlainSeqDecoder<_>,
1309            safe
1310        )]
1311        workspaces: std::collections::BTreeSet<
1312            super::super::super::objects::api::rids::WorkspaceRid,
1313        >,
1314    ) -> Result<
1315        Vec<super::super::super::objects::scout::run::api::RefNameAndType>,
1316        conjure_http::private::Error,
1317    >;
1318    /// Updates the attachments associated with a run.
1319    #[endpoint(
1320        method = POST,
1321        path = "/scout/v1/run/{rid}/attachments",
1322        name = "updateRunAttachment"
1323    )]
1324    async fn update_run_attachment(
1325        &self,
1326        #[auth]
1327        auth_: conjure_object::BearerToken,
1328        #[path(
1329            name = "rid",
1330            decoder = conjure_http::server::conjure::FromPlainDecoder,
1331            safe
1332        )]
1333        rid: super::super::super::objects::scout::run::api::RunRid,
1334        #[body(deserializer = conjure_http::server::StdRequestDeserializer, safe)]
1335        request: super::super::super::objects::scout::run::api::UpdateAttachmentsRequest,
1336    ) -> Result<(), conjure_http::private::Error>;
1337}
nominal_api_conjure/conjure/endpoints/scout/run_service.rs

nominal_api_conjure/conjure/endpoints/scout/
run_service.rs
