Add include-mode to select which operations to include

Keep the same default behavior to only include public operations

Author: svix-mman

src/api.rs

@@ -9,6 +9,7 @@ use serde::Serialize;
 use crate::{
     types::{FieldType, Types},
     util::{get_schema_name, serialize_btree_map_values},
+    IncludeMode,
 };
 
 /// The API we generate a client for.
@@ -24,7 +25,7 @@ impl Api {
     pub(crate) fn new(
         paths: openapi::Paths,
         component_schemas: &IndexMap<String, openapi::SchemaObject>,
-        include_hidden: bool,
+        include_mode: IncludeMode,
     ) -> anyhow::Result<Self> {
         let mut resources = BTreeMap::new();
 
@@ -40,7 +41,7 @@ impl Api {
 
             for (method, op) in path_item {
                 if let Some((res_path, op)) =
-                    Operation::from_openapi(&path, method, op, component_schemas, include_hidden)
+                    Operation::from_openapi(&path, method, op, component_schemas, include_mode)
                 {
                     let resource = get_or_insert_resource(&mut resources, res_path);
                     resource.operations.push(op);
@@ -184,15 +185,22 @@ impl Operation {
         method: &str,
         op: openapi::Operation,
         component_schemas: &IndexMap<String, aide::openapi::SchemaObject>,
-        include_hidden: bool,
+        include_mode: IncludeMode,
     ) -> Option<(Vec<String>, Self)> {
         let Some(op_id) = op.operation_id else {
             // ignore operations without an operationId
             return None;
         };
         tracing::Span::current().record("op_id", &op_id);
 
-        if !include_hidden && op.extensions.get("x-hidden").is_some_and(|val| val == true) {
+        // verbose, but very easy to understand
+        let x_hidden = op.extensions.get("x-hidden").is_some_and(|val| val == true);
+        let include_operation = match include_mode {
+            IncludeMode::OnlyPublic => !x_hidden,
+            IncludeMode::PublicAndHidden => true,
+            IncludeMode::OnlyHidden => x_hidden,
+        };
+        if !include_operation {
             return None;
         }
 

src/main.rs

@@ -53,15 +53,26 @@ struct GenerateFlags {
     #[clap(long)]
     no_postprocess: bool,
 
-    /// Include operations in the output that are marked `"x-hidden": true`.
-    #[clap(long)]
-    include_hidden: bool,
+    /// Which operations to include
+    #[clap(long, value_enum, default_value_t=IncludeMode::OnlyPublic)]
+    include_mode: IncludeMode,
 
     /// Write api.ron and types.ron files, as a debugging aid.
     #[clap(long)]
     debug: bool,
 }
 
+#[derive(Copy, Clone, clap::ValueEnum)]
+#[clap(rename_all = "kebab-case")]
+enum IncludeMode {
+    /// Only public options
+    OnlyPublic,
+    /// Both public operations and operations marked with `x-hidden`
+    PublicAndHidden,
+    /// Only operations marked with `x-hidden`
+    OnlyHidden,
+}
+
 fn main() -> anyhow::Result<()> {
     tracing_subscriber::fmt().with_writer(io::stderr).init();
 
@@ -119,7 +130,7 @@ fn analyze_and_generate(
     let webhooks = get_webhooks(&spec);
     let mut components = spec.components.unwrap_or_default();
     if let Some(paths) = spec.paths {
-        let api = Api::new(paths, &components.schemas, flags.include_hidden).unwrap();
+        let api = Api::new(paths, &components.schemas, flags.include_mode).unwrap();
         let types = api.types(&mut components.schemas, webhooks);
 
         if flags.debug {