make the OpenAPI info.version field accessible through the generated client (#400)

progenitor-impl/src/lib.rs

@@ -289,12 +289,25 @@ impl Generator {
             }
         });
 
-        let client_docstring = if let Some(description) = &spec.info.description
+        let client_docstring = {
-        {
+            let mut s = format!("Client for {}", spec.info.title);
-            format!("Client for {}\n\n{}", spec.info.title, description)
+
-        } else {
+            if let Some(ss) = &spec.info.description {
-            format!("Client for {}", spec.info.title)
+                s.push_str("\n\n");
+                s.push_str(ss);
+            }
+            if let Some(ss) = &spec.info.terms_of_service {
+                s.push_str("\n\n");
+                s.push_str(ss);
+            }
+
+            s.push_str(&format!("\n\nVersion: {}", &spec.info.version));
+
+            s
         };
+
+        let version_str = &spec.info.version;
+
         let file = quote! {
             // Re-export ResponseValue and Error since those are used by the
             // public interface of Client.
@@ -359,16 +372,24 @@ impl Generator {
                     }
                 }
 
-                /// Return the base URL to which requests are made.
+                /// Get the base URL to which requests are made.
                 pub fn baseurl(&self) -> &String {
                     &self.baseurl
                 }
 
-                /// Return the internal `reqwest::Client` used to make requests.
+                /// Get the internal `reqwest::Client` used to make requests.
                 pub fn client(&self) -> &reqwest::Client {
                     &self.client
                 }
 
+                /// Get the version of this API.
+                ///
+                /// This string is pulled directly from the source OpenAPI
+                /// document and may be in any format the API selects.
+                pub fn api_version(&self) -> &'static str {
+                    #version_str
+                }
+
                 #maybe_inner
             }
 

progenitor-impl/tests/output/buildomat-builder-tagged.out

@@ -1577,6 +1577,8 @@ pub mod types {
 
 #[derive(Clone, Debug)]
 ///Client for Buildomat
+///
+///Version: 1.0
 pub struct Client {
     pub(crate) baseurl: String,
     pub(crate) client: reqwest::Client,
@@ -1611,15 +1613,23 @@ impl Client {
         }
     }
 
-    /// Return the base URL to which requests are made.
+    /// Get the base URL to which requests are made.
     pub fn baseurl(&self) -> &String {
         &self.baseurl
     }
 
-    /// Return the internal `reqwest::Client` used to make requests.
+    /// Get the internal `reqwest::Client` used to make requests.
     pub fn client(&self) -> &reqwest::Client {
         &self.client
     }
+
+    /// Get the version of this API.
+    ///
+    /// This string is pulled directly from the source OpenAPI
+    /// document and may be in any format the API selects.
+    pub fn api_version(&self) -> &'static str {
+        "1.0"
+    }
 }
 
 impl Client {

progenitor-impl/tests/output/buildomat-builder.out

@@ -1577,6 +1577,8 @@ pub mod types {
 
 #[derive(Clone, Debug)]
 ///Client for Buildomat
+///
+///Version: 1.0
 pub struct Client {
     pub(crate) baseurl: String,
     pub(crate) client: reqwest::Client,
@@ -1611,15 +1613,23 @@ impl Client {
         }
     }
 
-    /// Return the base URL to which requests are made.
+    /// Get the base URL to which requests are made.
     pub fn baseurl(&self) -> &String {
         &self.baseurl
     }
 
-    /// Return the internal `reqwest::Client` used to make requests.
+    /// Get the internal `reqwest::Client` used to make requests.
     pub fn client(&self) -> &reqwest::Client {
         &self.client
     }
+
+    /// Get the version of this API.
+    ///
+    /// This string is pulled directly from the source OpenAPI
+    /// document and may be in any format the API selects.
+    pub fn api_version(&self) -> &'static str {
+        "1.0"
+    }
 }
 
 impl Client {

progenitor-impl/tests/output/buildomat-positional.out

@@ -252,6 +252,8 @@ pub mod types {
 
 #[derive(Clone, Debug)]
 ///Client for Buildomat
+///
+///Version: 1.0
 pub struct Client {
     pub(crate) baseurl: String,
     pub(crate) client: reqwest::Client,
@@ -286,15 +288,23 @@ impl Client {
         }
     }
 
-    /// Return the base URL to which requests are made.
+    /// Get the base URL to which requests are made.
     pub fn baseurl(&self) -> &String {
         &self.baseurl
     }
 
-    /// Return the internal `reqwest::Client` used to make requests.
+    /// Get the internal `reqwest::Client` used to make requests.
     pub fn client(&self) -> &reqwest::Client {
         &self.client
     }
+
+    /// Get the version of this API.
+    ///
+    /// This string is pulled directly from the source OpenAPI
+    /// document and may be in any format the API selects.
+    pub fn api_version(&self) -> &'static str {
+        "1.0"
+    }
 }
 
 impl Client {

progenitor-impl/tests/output/keeper-builder-tagged.out

@@ -902,6 +902,8 @@ pub mod types {
 ///Client for Keeper API
 ///
 ///report execution of cron jobs through a mechanism other than mail
+///
+///Version: 1.0
 pub struct Client {
     pub(crate) baseurl: String,
     pub(crate) client: reqwest::Client,
@@ -936,15 +938,23 @@ impl Client {
         }
     }
 
-    /// Return the base URL to which requests are made.
+    /// Get the base URL to which requests are made.
     pub fn baseurl(&self) -> &String {
         &self.baseurl
     }
 
-    /// Return the internal `reqwest::Client` used to make requests.
+    /// Get the internal `reqwest::Client` used to make requests.
     pub fn client(&self) -> &reqwest::Client {
         &self.client
     }
+
+    /// Get the version of this API.
+    ///
+    /// This string is pulled directly from the source OpenAPI
+    /// document and may be in any format the API selects.
+    pub fn api_version(&self) -> &'static str {
+        "1.0"
+    }
 }
 
 impl Client {

progenitor-impl/tests/output/keeper-builder.out

@@ -902,6 +902,8 @@ pub mod types {
 ///Client for Keeper API
 ///
 ///report execution of cron jobs through a mechanism other than mail
+///
+///Version: 1.0
 pub struct Client {
     pub(crate) baseurl: String,
     pub(crate) client: reqwest::Client,
@@ -936,15 +938,23 @@ impl Client {
         }
     }
 
-    /// Return the base URL to which requests are made.
+    /// Get the base URL to which requests are made.
     pub fn baseurl(&self) -> &String {
         &self.baseurl
     }
 
-    /// Return the internal `reqwest::Client` used to make requests.
+    /// Get the internal `reqwest::Client` used to make requests.
     pub fn client(&self) -> &reqwest::Client {
         &self.client
     }
+
+    /// Get the version of this API.
+    ///
+    /// This string is pulled directly from the source OpenAPI
+    /// document and may be in any format the API selects.
+    pub fn api_version(&self) -> &'static str {
+        "1.0"
+    }
 }
 
 impl Client {

progenitor-impl/tests/output/keeper-positional.out

@@ -141,6 +141,8 @@ pub mod types {
 ///Client for Keeper API
 ///
 ///report execution of cron jobs through a mechanism other than mail
+///
+///Version: 1.0
 pub struct Client {
     pub(crate) baseurl: String,
     pub(crate) client: reqwest::Client,
@@ -175,15 +177,23 @@ impl Client {
         }
     }
 
-    /// Return the base URL to which requests are made.
+    /// Get the base URL to which requests are made.
     pub fn baseurl(&self) -> &String {
         &self.baseurl
     }
 
-    /// Return the internal `reqwest::Client` used to make requests.
+    /// Get the internal `reqwest::Client` used to make requests.
     pub fn client(&self) -> &reqwest::Client {
         &self.client
     }
+
+    /// Get the version of this API.
+    ///
+    /// This string is pulled directly from the source OpenAPI
+    /// document and may be in any format the API selects.
+    pub fn api_version(&self) -> &'static str {
+        "1.0"
+    }
 }
 
 impl Client {

progenitor-impl/tests/output/nexus-builder-tagged.out

@@ -17034,6 +17034,8 @@ pub mod types {
 ///Client for Oxide Region API
 ///
 ///API for interacting with the Oxide control plane
+///
+///Version: 0.0.1
 pub struct Client {
     pub(crate) baseurl: String,
     pub(crate) client: reqwest::Client,
@@ -17068,15 +17070,23 @@ impl Client {
         }
     }
 
-    /// Return the base URL to which requests are made.
+    /// Get the base URL to which requests are made.
     pub fn baseurl(&self) -> &String {
         &self.baseurl
     }
 
-    /// Return the internal `reqwest::Client` used to make requests.
+    /// Get the internal `reqwest::Client` used to make requests.
     pub fn client(&self) -> &reqwest::Client {
         &self.client
     }
+
+    /// Get the version of this API.
+    ///
+    /// This string is pulled directly from the source OpenAPI
+    /// document and may be in any format the API selects.
+    pub fn api_version(&self) -> &'static str {
+        "0.0.1"
+    }
 }
 
 pub trait ClientDisksExt {

progenitor-impl/tests/output/nexus-builder.out

@@ -17090,6 +17090,8 @@ pub mod types {
 ///Client for Oxide Region API
 ///
 ///API for interacting with the Oxide control plane
+///
+///Version: 0.0.1
 pub struct Client {
     pub(crate) baseurl: String,
     pub(crate) client: reqwest::Client,
@@ -17124,15 +17126,23 @@ impl Client {
         }
     }
 
-    /// Return the base URL to which requests are made.
+    /// Get the base URL to which requests are made.
     pub fn baseurl(&self) -> &String {
         &self.baseurl
     }
 
-    /// Return the internal `reqwest::Client` used to make requests.
+    /// Get the internal `reqwest::Client` used to make requests.
     pub fn client(&self) -> &reqwest::Client {
         &self.client
     }
+
+    /// Get the version of this API.
+    ///
+    /// This string is pulled directly from the source OpenAPI
+    /// document and may be in any format the API selects.
+    pub fn api_version(&self) -> &'static str {
+        "0.0.1"
+    }
 }
 
 impl Client {

progenitor-impl/tests/output/nexus-positional.out

@@ -5862,6 +5862,8 @@ pub mod types {
 ///Client for Oxide Region API
 ///
 ///API for interacting with the Oxide control plane
+///
+///Version: 0.0.1
 pub struct Client {
     pub(crate) baseurl: String,
     pub(crate) client: reqwest::Client,
@@ -5896,15 +5898,23 @@ impl Client {
         }
     }
 
-    /// Return the base URL to which requests are made.
+    /// Get the base URL to which requests are made.
     pub fn baseurl(&self) -> &String {
         &self.baseurl
     }
 
-    /// Return the internal `reqwest::Client` used to make requests.
+    /// Get the internal `reqwest::Client` used to make requests.
     pub fn client(&self) -> &reqwest::Client {
         &self.client
     }
+
+    /// Get the version of this API.
+    ///
+    /// This string is pulled directly from the source OpenAPI
+    /// document and may be in any format the API selects.
+    pub fn api_version(&self) -> &'static str {
+        "0.0.1"
+    }
 }
 
 impl Client {

progenitor-impl/tests/output/param-overrides-builder-tagged.out

@@ -13,6 +13,8 @@ pub mod types {
 ///Client for Parameter override test
 ///
 ///Minimal API for testing parameter overrides
+///
+///Version: v1
 pub struct Client {
     pub(crate) baseurl: String,
     pub(crate) client: reqwest::Client,
@@ -47,15 +49,23 @@ impl Client {
         }
     }
 
-    /// Return the base URL to which requests are made.
+    /// Get the base URL to which requests are made.
     pub fn baseurl(&self) -> &String {
         &self.baseurl
     }
 
-    /// Return the internal `reqwest::Client` used to make requests.
+    /// Get the internal `reqwest::Client` used to make requests.
     pub fn client(&self) -> &reqwest::Client {
         &self.client
     }
+
+    /// Get the version of this API.
+    ///
+    /// This string is pulled directly from the source OpenAPI
+    /// document and may be in any format the API selects.
+    pub fn api_version(&self) -> &'static str {
+        "v1"
+    }
 }
 
 impl Client {

progenitor-impl/tests/output/param-overrides-builder.out

@@ -13,6 +13,8 @@ pub mod types {
 ///Client for Parameter override test
 ///
 ///Minimal API for testing parameter overrides
+///
+///Version: v1
 pub struct Client {
     pub(crate) baseurl: String,
     pub(crate) client: reqwest::Client,
@@ -47,15 +49,23 @@ impl Client {
         }
     }
 
-    /// Return the base URL to which requests are made.
+    /// Get the base URL to which requests are made.
     pub fn baseurl(&self) -> &String {
         &self.baseurl
     }
 
-    /// Return the internal `reqwest::Client` used to make requests.
+    /// Get the internal `reqwest::Client` used to make requests.
     pub fn client(&self) -> &reqwest::Client {
         &self.client
     }
+
+    /// Get the version of this API.
+    ///
+    /// This string is pulled directly from the source OpenAPI
+    /// document and may be in any format the API selects.
+    pub fn api_version(&self) -> &'static str {
+        "v1"
+    }
 }
 
 impl Client {

progenitor-impl/tests/output/param-overrides-positional.out

@@ -13,6 +13,8 @@ pub mod types {
 ///Client for Parameter override test
 ///
 ///Minimal API for testing parameter overrides
+///
+///Version: v1
 pub struct Client {
     pub(crate) baseurl: String,
     pub(crate) client: reqwest::Client,
@@ -47,15 +49,23 @@ impl Client {
         }
     }
 
-    /// Return the base URL to which requests are made.
+    /// Get the base URL to which requests are made.
     pub fn baseurl(&self) -> &String {
         &self.baseurl
     }
 
-    /// Return the internal `reqwest::Client` used to make requests.
+    /// Get the internal `reqwest::Client` used to make requests.
     pub fn client(&self) -> &reqwest::Client {
         &self.client
     }
+
+    /// Get the version of this API.
+    ///
+    /// This string is pulled directly from the source OpenAPI
+    /// document and may be in any format the API selects.
+    pub fn api_version(&self) -> &'static str {
+        "v1"
+    }
 }
 
 impl Client {

progenitor-impl/tests/output/propolis-server-builder-tagged.out

@@ -1955,6 +1955,8 @@ pub mod types {
 ///Client for Oxide Propolis Server API
 ///
 ///API for interacting with the Propolis hypervisor frontend.
+///
+///Version: 0.0.1
 pub struct Client {
     pub(crate) baseurl: String,
     pub(crate) client: reqwest::Client,
@@ -1989,15 +1991,23 @@ impl Client {
         }
     }
 
-    /// Return the base URL to which requests are made.
+    /// Get the base URL to which requests are made.
     pub fn baseurl(&self) -> &String {
         &self.baseurl
     }
 
-    /// Return the internal `reqwest::Client` used to make requests.
+    /// Get the internal `reqwest::Client` used to make requests.
     pub fn client(&self) -> &reqwest::Client {
         &self.client
     }
+
+    /// Get the version of this API.
+    ///
+    /// This string is pulled directly from the source OpenAPI
+    /// document and may be in any format the API selects.
+    pub fn api_version(&self) -> &'static str {
+        "0.0.1"
+    }
 }
 
 impl Client {

progenitor-impl/tests/output/propolis-server-builder.out

@@ -1961,6 +1961,8 @@ pub mod types {
 ///Client for Oxide Propolis Server API
 ///
 ///API for interacting with the Propolis hypervisor frontend.
+///
+///Version: 0.0.1
 pub struct Client {
     pub(crate) baseurl: String,
     pub(crate) client: reqwest::Client,
@@ -1995,15 +1997,23 @@ impl Client {
         }
     }
 
-    /// Return the base URL to which requests are made.
+    /// Get the base URL to which requests are made.
     pub fn baseurl(&self) -> &String {
         &self.baseurl
     }
 
-    /// Return the internal `reqwest::Client` used to make requests.
+    /// Get the internal `reqwest::Client` used to make requests.
     pub fn client(&self) -> &reqwest::Client {
         &self.client
     }
+
+    /// Get the version of this API.
+    ///
+    /// This string is pulled directly from the source OpenAPI
+    /// document and may be in any format the API selects.
+    pub fn api_version(&self) -> &'static str {
+        "0.0.1"
+    }
 }
 
 impl Client {

progenitor-impl/tests/output/propolis-server-positional.out

@@ -608,6 +608,8 @@ pub mod types {
 ///Client for Oxide Propolis Server API
 ///
 ///API for interacting with the Propolis hypervisor frontend.
+///
+///Version: 0.0.1
 pub struct Client {
     pub(crate) baseurl: String,
     pub(crate) client: reqwest::Client,
@@ -642,15 +644,23 @@ impl Client {
         }
     }
 
-    /// Return the base URL to which requests are made.
+    /// Get the base URL to which requests are made.
     pub fn baseurl(&self) -> &String {
         &self.baseurl
     }
 
-    /// Return the internal `reqwest::Client` used to make requests.
+    /// Get the internal `reqwest::Client` used to make requests.
     pub fn client(&self) -> &reqwest::Client {
         &self.client
     }
+
+    /// Get the version of this API.
+    ///
+    /// This string is pulled directly from the source OpenAPI
+    /// document and may be in any format the API selects.
+    pub fn api_version(&self) -> &'static str {
+        "0.0.1"
+    }
 }
 
 impl Client {

progenitor-impl/tests/output/test_default_params_builder.out

@@ -226,6 +226,8 @@ pub mod types {
 
 #[derive(Clone, Debug)]
 ///Client for pagination-demo
+///
+///Version: 9000
 pub struct Client {
     pub(crate) baseurl: String,
     pub(crate) client: reqwest::Client,
@@ -260,15 +262,23 @@ impl Client {
         }
     }
 
-    /// Return the base URL to which requests are made.
+    /// Get the base URL to which requests are made.
     pub fn baseurl(&self) -> &String {
         &self.baseurl
     }
 
-    /// Return the internal `reqwest::Client` used to make requests.
+    /// Get the internal `reqwest::Client` used to make requests.
     pub fn client(&self) -> &reqwest::Client {
         &self.client
     }
+
+    /// Get the version of this API.
+    ///
+    /// This string is pulled directly from the source OpenAPI
+    /// document and may be in any format the API selects.
+    pub fn api_version(&self) -> &'static str {
+        "9000"
+    }
 }
 
 impl Client {

progenitor-impl/tests/output/test_default_params_positional.out

@@ -56,6 +56,8 @@ pub mod types {
 
 #[derive(Clone, Debug)]
 ///Client for pagination-demo
+///
+///Version: 9000
 pub struct Client {
     pub(crate) baseurl: String,
     pub(crate) client: reqwest::Client,
@@ -90,15 +92,23 @@ impl Client {
         }
     }
 
-    /// Return the base URL to which requests are made.
+    /// Get the base URL to which requests are made.
     pub fn baseurl(&self) -> &String {
         &self.baseurl
     }
 
-    /// Return the internal `reqwest::Client` used to make requests.
+    /// Get the internal `reqwest::Client` used to make requests.
     pub fn client(&self) -> &reqwest::Client {
         &self.client
     }
+
+    /// Get the version of this API.
+    ///
+    /// This string is pulled directly from the source OpenAPI
+    /// document and may be in any format the API selects.
+    pub fn api_version(&self) -> &'static str {
+        "9000"
+    }
 }
 
 impl Client {

progenitor-impl/tests/output/test_freeform_response.out

@@ -25,6 +25,8 @@ pub mod types {
 
 #[derive(Clone, Debug)]
 ///Client for pagination-demo
+///
+///Version: 9000
 pub struct Client {
     pub(crate) baseurl: String,
     pub(crate) client: reqwest::Client,
@@ -59,15 +61,23 @@ impl Client {
         }
     }
 
-    /// Return the base URL to which requests are made.
+    /// Get the base URL to which requests are made.
     pub fn baseurl(&self) -> &String {
         &self.baseurl
     }
 
-    /// Return the internal `reqwest::Client` used to make requests.
+    /// Get the internal `reqwest::Client` used to make requests.
     pub fn client(&self) -> &reqwest::Client {
         &self.client
     }
+
+    /// Get the version of this API.
+    ///
+    /// This string is pulled directly from the source OpenAPI
+    /// document and may be in any format the API selects.
+    pub fn api_version(&self) -> &'static str {
+        "9000"
+    }
 }
 
 impl Client {

progenitor-impl/tests/output/test_renamed_parameters.out

@@ -25,6 +25,8 @@ pub mod types {
 
 #[derive(Clone, Debug)]
 ///Client for pagination-demo
+///
+///Version: 9000
 pub struct Client {
     pub(crate) baseurl: String,
     pub(crate) client: reqwest::Client,
@@ -59,15 +61,23 @@ impl Client {
         }
     }
 
-    /// Return the base URL to which requests are made.
+    /// Get the base URL to which requests are made.
     pub fn baseurl(&self) -> &String {
         &self.baseurl
     }
 
-    /// Return the internal `reqwest::Client` used to make requests.
+    /// Get the internal `reqwest::Client` used to make requests.
     pub fn client(&self) -> &reqwest::Client {
         &self.client
     }
+
+    /// Get the version of this API.
+    ///
+    /// This string is pulled directly from the source OpenAPI
+    /// document and may be in any format the API selects.
+    pub fn api_version(&self) -> &'static str {
+        "9000"
+    }
 }
 
 impl Client {