Add limit and offset to job endpont

Author: augustuswm

rfd-api-spec.json

@@ -720,6 +720,24 @@
         "summary": "List all jobs for a RFD",
         "operationId": "list_jobs",
         "parameters": [
+          {
+            "in": "query",
+            "name": "limit",
+            "schema": {
+              "nullable": true,
+              "type": "integer",
+              "format": "int64"
+            }
+          },
+          {
+            "in": "query",
+            "name": "offset",
+            "schema": {
+              "nullable": true,
+              "type": "integer",
+              "format": "int64"
+            }
+          },
           {
             "in": "query",
             "name": "rfd",

rfd-api/src/context.rs

@@ -819,11 +819,12 @@ impl RfdContext {
         &self,
         caller: &Caller<RfdPermission>,
         filter: Option<JobFilter>,
+        pagination: &ListPagination,
     ) -> ResourceResult<Vec<Job>, StoreError> {
         let mut jobs = JobStore::list(
             &*self.storage,
             filter.map(|filter| vec![filter]).unwrap_or_default(),
-            &ListPagination::default().limit(UNLIMITED),
+            pagination,
         )
         .await
         .tap_err(|err| tracing::error!(?err, "Failed to lookup jobs"))

rfd-api/src/endpoints/job.rs

@@ -9,15 +9,19 @@ use serde::Deserialize;
 use trace_request::trace_request;
 use tracing::instrument;
 use v_api::{response::client_error, ApiContext};
-use v_model::permissions::Caller;
+use v_model::{permissions::Caller, storage::ListPagination};
 
 use crate::{context::RfdContext, permissions::RfdPermission};
 
+use super::UNLIMITED;
+
 // Read Endpoints
 
 #[derive(Debug, Deserialize, JsonSchema)]
 struct ListJobsQuery {
     rfd: String,
+    limit: Option<i64>,
+    offset: Option<i64>,
 }
 
 /// List all jobs for a RFD
@@ -50,6 +54,9 @@ async fn list_jobs_op(
             .list_jobs(
                 caller,
                 Some(JobFilter::default().rfd(Some(vec![rfd_number]))),
+                &ListPagination::default()
+                    .limit(query.limit.unwrap_or(UNLIMITED))
+                    .offset(query.offset.unwrap_or(0)),
             )
             .await?;
         Ok(HttpResponseOk(jobs))

rfd-api/src/endpoints/mod.rs

@@ -2,6 +2,8 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
 
+pub static UNLIMITED: i64 = 9999999;
+
 pub mod job;
 pub mod rfd;
 pub mod webhook;

rfd-cli/src/generated/cli.rs

@@ -465,6 +465,18 @@ impl<T: CliConfig> Cli<T> {
 
     pub fn cli_list_jobs() -> ::clap::Command {
         ::clap::Command::new("")
+            .arg(
+                ::clap::Arg::new("limit")
+                    .long("limit")
+                    .value_parser(::clap::value_parser!(i64))
+                    .required(false),
+            )
+            .arg(
+                ::clap::Arg::new("offset")
+                    .long("offset")
+                    .value_parser(::clap::value_parser!(i64))
+                    .required(false),
+            )
             .arg(
                 ::clap::Arg::new("rfd")
                     .long("rfd")
@@ -2121,6 +2133,14 @@ impl<T: CliConfig> Cli<T> {
 
     pub async fn execute_list_jobs(&self, matches: &::clap::ArgMatches) -> anyhow::Result<()> {
         let mut request = self.client.list_jobs();
+        if let Some(value) = matches.get_one::<i64>("limit") {
+            request = request.limit(value.clone());
+        }
+
+        if let Some(value) = matches.get_one::<i64>("offset") {
+            request = request.offset(value.clone());
+        }
+
         if let Some(value) = matches.get_one::<::std::string::String>("rfd") {
             request = request.rfd(value.clone());
         }

rfd-sdk/src/generated/sdk.rs

@@ -13490,6 +13490,8 @@ impl Client {
     ///
     /// ```ignore
     /// let response = client.list_jobs()
+    ///    .limit(limit)
+    ///    .offset(offset)
     ///    .rfd(rfd)
     ///    .send()
     ///    .await;
@@ -15709,17 +15711,43 @@ pub mod builder {
     #[derive(Debug, Clone)]
     pub struct ListJobs<'a> {
         client: &'a super::Client,
+        limit: Result<Option<i64>, String>,
+        offset: Result<Option<i64>, String>,
         rfd: Result<::std::string::String, String>,
     }
 
     impl<'a> ListJobs<'a> {
         pub fn new(client: &'a super::Client) -> Self {
             Self {
                 client: client,
+                limit: Ok(None),
+                offset: Ok(None),
                 rfd: Err("rfd was not initialized".to_string()),
             }
         }
 
+        pub fn limit<V>(mut self, value: V) -> Self
+        where
+            V: std::convert::TryInto<i64>,
+        {
+            self.limit = value
+                .try_into()
+                .map(Some)
+                .map_err(|_| "conversion to `i64` for limit failed".to_string());
+            self
+        }
+
+        pub fn offset<V>(mut self, value: V) -> Self
+        where
+            V: std::convert::TryInto<i64>,
+        {
+            self.offset = value
+                .try_into()
+                .map(Some)
+                .map_err(|_| "conversion to `i64` for offset failed".to_string());
+            self
+        }
+
         pub fn rfd<V>(mut self, value: V) -> Self
         where
             V: std::convert::TryInto<::std::string::String>,
@@ -15734,7 +15762,14 @@ pub mod builder {
         pub async fn send(
             self,
         ) -> Result<ResponseValue<::std::vec::Vec<types::Job>>, Error<types::Error>> {
-            let Self { client, rfd } = self;
+            let Self {
+                client,
+                limit,
+                offset,
+                rfd,
+            } = self;
+            let limit = limit.map_err(Error::InvalidRequest)?;
+            let offset = offset.map_err(Error::InvalidRequest)?;
             let rfd = rfd.map_err(Error::InvalidRequest)?;
             let url = format!("{}/job", client.baseurl,);
             #[allow(unused_mut)]
@@ -15745,6 +15780,8 @@ pub mod builder {
                     ::reqwest::header::ACCEPT,
                     ::reqwest::header::HeaderValue::from_static("application/json"),
                 )
+                .query(&progenitor_client::QueryParam::new("limit", &limit))
+                .query(&progenitor_client::QueryParam::new("offset", &offset))
                 .query(&progenitor_client::QueryParam::new("rfd", &rfd))
                 .build()?;
             let result = client.client.execute(request).await;

rfd-ts/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oxide/rfd.ts",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "TypeScript client for the RFD API",
   "engines": {
     "node": ">=18"

rfd-ts/src/Api.ts

@@ -615,6 +615,8 @@ export interface DeleteGroupPathParams {
 }
 
 export interface ListJobsQueryParams {
+  limit?: number
+  offset?: number
   rfd: string
 }
 

rfd-ts/src/validate.ts

@@ -884,6 +884,8 @@ export const ListJobsParams = z.preprocess(
   z.object({
     path: z.object({}),
     query: z.object({
+      limit: z.number().optional(),
+      offset: z.number().optional(),
       rfd: z.string(),
     }),
   }),