Add version as an OpenAPI extension, cleanup obsolete properties and versions 0.0.0 (#2655)

Co-authored-by: Laurent Saint-Félix <[email protected]>

Author: swallez

compiler-rs/clients_schema/src/lib.rs

@@ -50,7 +50,6 @@ pub trait Documented {
     fn doc_url(&self) -> Option<&str>;
     fn doc_id(&self) -> Option<&str>;
     fn description(&self) -> Option<&str>;
-    fn since(&self) -> Option<&str>;
 }
 
 #[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord, Hash)]
@@ -252,9 +251,9 @@ pub enum Flavor {
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(rename_all = "camelCase")]
 pub struct Availability {
-    since: Option<String>,
-    stability: Option<Stability>,
-    visibility: Option<Visibility>,
+    pub since: Option<String>,
+    pub stability: Option<Stability>,
+    pub visibility: Option<Visibility>,
 }
 
 /// The availability of an
@@ -312,9 +311,6 @@ pub struct Property {
     #[serde(skip_serializing_if = "Option::is_none")]
     pub doc_id: Option<String>,
 
-    #[serde(skip_serializing_if = "Option::is_none")]
-    pub since: Option<String>,
-
     #[serde(skip_serializing_if = "Option::is_none")]
     pub server_default: Option<ServerDefault>,
 
@@ -324,9 +320,6 @@ pub struct Property {
     #[serde(skip_serializing_if = "Option::is_none")]
     pub availability: Option<Availabilities>,
 
-    #[serde(skip_serializing_if = "Option::is_none")]
-    pub stability: Option<Stability>,
-
     /// If specified takes precedence over `name` when generating code. `name` is always the value
     /// to be sent over the wire
     #[serde(skip_serializing_if = "Option::is_none")]
@@ -357,10 +350,6 @@ impl Documented for Property {
     fn description(&self) -> Option<&str> {
         self.description.as_deref()
     }
-
-    fn since(&self) -> Option<&str> {
-        self.since.as_deref()
-    }
 }
 
 #[derive(Debug, Clone, Serialize, Deserialize)]
@@ -536,10 +525,6 @@ impl Documented for BaseType {
     fn description(&self) -> Option<&str> {
         self.description.as_deref()
     }
-
-    fn since(&self) -> Option<&str> {
-        None
-    }
 }
 
 trait WithBaseType {
@@ -558,10 +543,6 @@ impl<T: WithBaseType> Documented for T {
     fn description(&self) -> Option<&str> {
         self.base().description()
     }
-
-    fn since(&self) -> Option<&str> {
-        self.base().since()
-    }
 }
 
 /// An interface type
@@ -843,20 +824,6 @@ pub struct Endpoint {
 
     pub urls: Vec<UrlTemplate>,
 
-    /// The version when this endpoint reached its current stability level.
-    /// Missing data means "forever", i.e. before any of the target client versions produced from this spec.
-    #[serde(skip_serializing_if = "Option::is_none")]
-    pub since: Option<String>,
-
-    #[serde(skip_serializing_if = "Option::is_none")]
-    pub stability: Option<Stability>,
-
-    #[serde(skip_serializing_if = "Option::is_none")]
-    pub visibility: Option<Visibility>,
-
-    #[serde(skip_serializing_if = "Option::is_none")]
-    pub feature_flag: Option<String>,
-
     #[serde(default, skip_serializing_if = "Vec::is_empty")]
     pub request_media_type: Vec<String>,
 
@@ -879,10 +846,6 @@ impl Documented for Endpoint {
     fn description(&self) -> Option<&str> {
         Some(self.description.as_str())
     }
-
-    fn since(&self) -> Option<&str> {
-        self.since.as_deref()
-    }
 }
 
 #[derive(Debug, Clone, Serialize, Deserialize)]

compiler-rs/clients_schema_to_openapi/src/lib.rs

@@ -23,6 +23,7 @@ mod utils;
 use std::collections::HashSet;
 use std::io::{BufWriter, Write};
 use std::path::Path;
+use indexmap::IndexMap;
 
 use clients_schema::{Availabilities, Endpoint, IndexedModel};
 use openapiv3::{Components, OpenAPI};
@@ -147,3 +148,19 @@ fn info(model: &IndexedModel) -> openapiv3::Info {
         extensions: Default::default(),
     }
 }
+
+pub fn availability_as_extension(availabilities: &Option<Availabilities>) -> IndexMap<String, serde_json::Value> {
+    let mut result = IndexMap::new();
+
+    if let Some(avails) = availabilities {
+        // We may have several availabilities, but since generally exists only on stateful (stack)
+        for (_, availability) in avails {
+            if let Some(since) = &availability.since {
+                result.insert("x-available-since".to_string(), serde_json::Value::String(since.clone()));
+                break;
+            }
+        }
+    }
+
+    result
+}

compiler-rs/clients_schema_to_openapi/src/paths.rs

@@ -211,9 +211,10 @@ pub fn add_endpoint(
             deprecated: endpoint.deprecation.is_some(),
             security: None,
             servers: vec![],
-            extensions: Default::default(), // FIXME: translate availability?
+            extensions: crate::availability_as_extension(&endpoint.availability),
         };
 
+
         let mut operation_path = url_template.path.clone();
 
         // Disabled -- OpenAPI path templates do not contain the query string

compiler-rs/clients_schema_to_openapi/src/schemas.rs

@@ -472,12 +472,11 @@ impl<'a> TypesAndComponents<'a> {
         data.external_docs = self.convert_external_docs(prop);
         data.deprecated = prop.deprecation.is_some();
         data.description = prop.description.clone();
+        data.extensions = crate::availability_as_extension(&prop.availability);
         // TODO: prop.aliases as extensions
         // TODO: prop.server_default as extension
-        // TODO: prop.availability as extension
         // TODO: prop.doc_id as extension (new representation of since and stability)
         // TODO: prop.es_quirk as extension?
         // TODO: prop.codegen_name as extension?
-        // TODO: prop.deprecation as extension
     }
 }

compiler-rs/clients_schema_to_openapi/src/utils.rs

@@ -86,13 +86,6 @@ pub trait IntoSchema {
         schema
     }
 
-    fn into_schema_with_data_fn(self, f: fn(&mut SchemaData) -> ()) -> Schema
-    where Self: Sized {
-        let mut schema = self.into_schema();
-        f(&mut schema.schema_data);
-        schema
-    }
-
     fn into_schema(self) -> Schema;
 }