Skip to main content

nominal_api/conjure/endpoints/scout/channel/api/
channel_search_service.rs

1use conjure_http::endpoint;
2/// Channel search over a `DataFrame`, which can expand to multiple locators.
3#[conjure_http::conjure_endpoints(
4    name = "ChannelSearchService",
5    use_legacy_error_serialization
6)]
7pub trait ChannelSearchService {
8    /// Returns the expanded locator topology for a frame plus per-locator delimiter
9    /// info.
10    #[endpoint(
11        method = POST,
12        path = "/channels/v1/delimiters",
13        name = "getLocatorDelimiters",
14        produces = conjure_http::server::StdResponseSerializer
15    )]
16    fn get_locator_delimiters(
17        &self,
18        #[auth]
19        auth_: conjure_object::BearerToken,
20        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
21        request: super::super::super::super::super::objects::scout::channel::api::GetLocatorDelimitersRequest,
22    ) -> Result<
23        super::super::super::super::super::objects::scout::channel::api::GetLocatorDelimitersResponse,
24        conjure_http::private::Error,
25    >;
26    /// Lazy one-level hierarchical expansion under `parent`. Returns a mix of leaf
27    /// channels and prefix nodes, each labelled with the set of locators where
28    /// they exist.
29    #[endpoint(
30        method = POST,
31        path = "/channels/v1/browse",
32        name = "listChannelChildren",
33        produces = conjure_http::server::StdResponseSerializer
34    )]
35    fn list_channel_children(
36        &self,
37        #[auth]
38        auth_: conjure_object::BearerToken,
39        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
40        request: super::super::super::super::super::objects::scout::channel::api::ListChannelChildrenRequest,
41    ) -> Result<
42        super::super::super::super::super::objects::scout::channel::api::ListChannelChildrenResponse,
43        conjure_http::private::Error,
44    >;
45    /// Flat text search across the frame. Returns matching channels, each labelled
46    /// with the set of locators in which they exist.
47    #[endpoint(
48        method = POST,
49        path = "/channels/v1/search",
50        name = "searchChannels",
51        produces = conjure_http::server::StdResponseSerializer
52    )]
53    fn search_channels(
54        &self,
55        #[auth]
56        auth_: conjure_object::BearerToken,
57        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
58        request: super::super::super::super::super::objects::scout::channel::api::SearchChannelsRequest,
59    ) -> Result<
60        super::super::super::super::super::objects::scout::channel::api::SearchChannelsResponse,
61        conjure_http::private::Error,
62    >;
63    /// Batched form of `getLocatorDelimiters`.
64    #[endpoint(
65        method = POST,
66        path = "/channels/v1/delimiters/batch",
67        name = "batchGetLocatorDelimiters",
68        produces = conjure_http::server::StdResponseSerializer
69    )]
70    fn batch_get_locator_delimiters(
71        &self,
72        #[auth]
73        auth_: conjure_object::BearerToken,
74        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
75        request: super::super::super::super::super::objects::scout::channel::api::BatchGetLocatorDelimitersRequest,
76    ) -> Result<
77        super::super::super::super::super::objects::scout::channel::api::BatchGetLocatorDelimitersResponse,
78        conjure_http::private::Error,
79    >;
80    /// Batched form of `searchChannels`. The channel search is performed across the
81    /// union of all entry scopes and so is the limit and top-n selection by relevance.
82    #[endpoint(
83        method = POST,
84        path = "/channels/v1/search/batch",
85        name = "batchSearchChannels",
86        produces = conjure_http::server::StdResponseSerializer
87    )]
88    fn batch_search_channels(
89        &self,
90        #[auth]
91        auth_: conjure_object::BearerToken,
92        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
93        request: super::super::super::super::super::objects::scout::channel::api::BatchSearchChannelsRequest,
94    ) -> Result<
95        super::super::super::super::super::objects::scout::channel::api::BatchSearchChannelsResponse,
96        conjure_http::private::Error,
97    >;
98    /// Batched form of `listChannelChildren`. The hierarchical expansion is performed
99    /// across the union of all entry scopes for the shared `parent` path.
100    #[endpoint(
101        method = POST,
102        path = "/channels/v1/browse/batch",
103        name = "batchListChannelChildren",
104        produces = conjure_http::server::StdResponseSerializer
105    )]
106    fn batch_list_channel_children(
107        &self,
108        #[auth]
109        auth_: conjure_object::BearerToken,
110        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
111        request: super::super::super::super::super::objects::scout::channel::api::BatchListChannelChildrenRequest,
112    ) -> Result<
113        super::super::super::super::super::objects::scout::channel::api::BatchListChannelChildrenResponse,
114        conjure_http::private::Error,
115    >;
116}
117/// Channel search over a `DataFrame`, which can expand to multiple locators.
118#[conjure_http::conjure_endpoints(
119    name = "ChannelSearchService",
120    use_legacy_error_serialization
121)]
122pub trait AsyncChannelSearchService {
123    /// Returns the expanded locator topology for a frame plus per-locator delimiter
124    /// info.
125    #[endpoint(
126        method = POST,
127        path = "/channels/v1/delimiters",
128        name = "getLocatorDelimiters",
129        produces = conjure_http::server::StdResponseSerializer
130    )]
131    async fn get_locator_delimiters(
132        &self,
133        #[auth]
134        auth_: conjure_object::BearerToken,
135        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
136        request: super::super::super::super::super::objects::scout::channel::api::GetLocatorDelimitersRequest,
137    ) -> Result<
138        super::super::super::super::super::objects::scout::channel::api::GetLocatorDelimitersResponse,
139        conjure_http::private::Error,
140    >;
141    /// Lazy one-level hierarchical expansion under `parent`. Returns a mix of leaf
142    /// channels and prefix nodes, each labelled with the set of locators where
143    /// they exist.
144    #[endpoint(
145        method = POST,
146        path = "/channels/v1/browse",
147        name = "listChannelChildren",
148        produces = conjure_http::server::StdResponseSerializer
149    )]
150    async fn list_channel_children(
151        &self,
152        #[auth]
153        auth_: conjure_object::BearerToken,
154        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
155        request: super::super::super::super::super::objects::scout::channel::api::ListChannelChildrenRequest,
156    ) -> Result<
157        super::super::super::super::super::objects::scout::channel::api::ListChannelChildrenResponse,
158        conjure_http::private::Error,
159    >;
160    /// Flat text search across the frame. Returns matching channels, each labelled
161    /// with the set of locators in which they exist.
162    #[endpoint(
163        method = POST,
164        path = "/channels/v1/search",
165        name = "searchChannels",
166        produces = conjure_http::server::StdResponseSerializer
167    )]
168    async fn search_channels(
169        &self,
170        #[auth]
171        auth_: conjure_object::BearerToken,
172        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
173        request: super::super::super::super::super::objects::scout::channel::api::SearchChannelsRequest,
174    ) -> Result<
175        super::super::super::super::super::objects::scout::channel::api::SearchChannelsResponse,
176        conjure_http::private::Error,
177    >;
178    /// Batched form of `getLocatorDelimiters`.
179    #[endpoint(
180        method = POST,
181        path = "/channels/v1/delimiters/batch",
182        name = "batchGetLocatorDelimiters",
183        produces = conjure_http::server::StdResponseSerializer
184    )]
185    async fn batch_get_locator_delimiters(
186        &self,
187        #[auth]
188        auth_: conjure_object::BearerToken,
189        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
190        request: super::super::super::super::super::objects::scout::channel::api::BatchGetLocatorDelimitersRequest,
191    ) -> Result<
192        super::super::super::super::super::objects::scout::channel::api::BatchGetLocatorDelimitersResponse,
193        conjure_http::private::Error,
194    >;
195    /// Batched form of `searchChannels`. The channel search is performed across the
196    /// union of all entry scopes and so is the limit and top-n selection by relevance.
197    #[endpoint(
198        method = POST,
199        path = "/channels/v1/search/batch",
200        name = "batchSearchChannels",
201        produces = conjure_http::server::StdResponseSerializer
202    )]
203    async fn batch_search_channels(
204        &self,
205        #[auth]
206        auth_: conjure_object::BearerToken,
207        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
208        request: super::super::super::super::super::objects::scout::channel::api::BatchSearchChannelsRequest,
209    ) -> Result<
210        super::super::super::super::super::objects::scout::channel::api::BatchSearchChannelsResponse,
211        conjure_http::private::Error,
212    >;
213    /// Batched form of `listChannelChildren`. The hierarchical expansion is performed
214    /// across the union of all entry scopes for the shared `parent` path.
215    #[endpoint(
216        method = POST,
217        path = "/channels/v1/browse/batch",
218        name = "batchListChannelChildren",
219        produces = conjure_http::server::StdResponseSerializer
220    )]
221    async fn batch_list_channel_children(
222        &self,
223        #[auth]
224        auth_: conjure_object::BearerToken,
225        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
226        request: super::super::super::super::super::objects::scout::channel::api::BatchListChannelChildrenRequest,
227    ) -> Result<
228        super::super::super::super::super::objects::scout::channel::api::BatchListChannelChildrenResponse,
229        conjure_http::private::Error,
230    >;
231}
232/// Channel search over a `DataFrame`, which can expand to multiple locators.
233#[conjure_http::conjure_endpoints(
234    name = "ChannelSearchService",
235    use_legacy_error_serialization,
236    local
237)]
238pub trait LocalAsyncChannelSearchService {
239    /// Returns the expanded locator topology for a frame plus per-locator delimiter
240    /// info.
241    #[endpoint(
242        method = POST,
243        path = "/channels/v1/delimiters",
244        name = "getLocatorDelimiters",
245        produces = conjure_http::server::StdResponseSerializer
246    )]
247    async fn get_locator_delimiters(
248        &self,
249        #[auth]
250        auth_: conjure_object::BearerToken,
251        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
252        request: super::super::super::super::super::objects::scout::channel::api::GetLocatorDelimitersRequest,
253    ) -> Result<
254        super::super::super::super::super::objects::scout::channel::api::GetLocatorDelimitersResponse,
255        conjure_http::private::Error,
256    >;
257    /// Lazy one-level hierarchical expansion under `parent`. Returns a mix of leaf
258    /// channels and prefix nodes, each labelled with the set of locators where
259    /// they exist.
260    #[endpoint(
261        method = POST,
262        path = "/channels/v1/browse",
263        name = "listChannelChildren",
264        produces = conjure_http::server::StdResponseSerializer
265    )]
266    async fn list_channel_children(
267        &self,
268        #[auth]
269        auth_: conjure_object::BearerToken,
270        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
271        request: super::super::super::super::super::objects::scout::channel::api::ListChannelChildrenRequest,
272    ) -> Result<
273        super::super::super::super::super::objects::scout::channel::api::ListChannelChildrenResponse,
274        conjure_http::private::Error,
275    >;
276    /// Flat text search across the frame. Returns matching channels, each labelled
277    /// with the set of locators in which they exist.
278    #[endpoint(
279        method = POST,
280        path = "/channels/v1/search",
281        name = "searchChannels",
282        produces = conjure_http::server::StdResponseSerializer
283    )]
284    async fn search_channels(
285        &self,
286        #[auth]
287        auth_: conjure_object::BearerToken,
288        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
289        request: super::super::super::super::super::objects::scout::channel::api::SearchChannelsRequest,
290    ) -> Result<
291        super::super::super::super::super::objects::scout::channel::api::SearchChannelsResponse,
292        conjure_http::private::Error,
293    >;
294    /// Batched form of `getLocatorDelimiters`.
295    #[endpoint(
296        method = POST,
297        path = "/channels/v1/delimiters/batch",
298        name = "batchGetLocatorDelimiters",
299        produces = conjure_http::server::StdResponseSerializer
300    )]
301    async fn batch_get_locator_delimiters(
302        &self,
303        #[auth]
304        auth_: conjure_object::BearerToken,
305        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
306        request: super::super::super::super::super::objects::scout::channel::api::BatchGetLocatorDelimitersRequest,
307    ) -> Result<
308        super::super::super::super::super::objects::scout::channel::api::BatchGetLocatorDelimitersResponse,
309        conjure_http::private::Error,
310    >;
311    /// Batched form of `searchChannels`. The channel search is performed across the
312    /// union of all entry scopes and so is the limit and top-n selection by relevance.
313    #[endpoint(
314        method = POST,
315        path = "/channels/v1/search/batch",
316        name = "batchSearchChannels",
317        produces = conjure_http::server::StdResponseSerializer
318    )]
319    async fn batch_search_channels(
320        &self,
321        #[auth]
322        auth_: conjure_object::BearerToken,
323        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
324        request: super::super::super::super::super::objects::scout::channel::api::BatchSearchChannelsRequest,
325    ) -> Result<
326        super::super::super::super::super::objects::scout::channel::api::BatchSearchChannelsResponse,
327        conjure_http::private::Error,
328    >;
329    /// Batched form of `listChannelChildren`. The hierarchical expansion is performed
330    /// across the union of all entry scopes for the shared `parent` path.
331    #[endpoint(
332        method = POST,
333        path = "/channels/v1/browse/batch",
334        name = "batchListChannelChildren",
335        produces = conjure_http::server::StdResponseSerializer
336    )]
337    async fn batch_list_channel_children(
338        &self,
339        #[auth]
340        auth_: conjure_object::BearerToken,
341        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
342        request: super::super::super::super::super::objects::scout::channel::api::BatchListChannelChildrenRequest,
343    ) -> Result<
344        super::super::super::super::super::objects::scout::channel::api::BatchListChannelChildrenResponse,
345        conjure_http::private::Error,
346    >;
347}