add a description field for external doc links (#4772)

Author: miguelgrinberg

compiler-rs/clients_schema/src/lib.rs

@@ -58,6 +58,7 @@ pub trait Documented {
 pub trait ExternalDocument {
     fn ext_doc_id(&self) -> Option<&str>;
     fn ext_doc_url(&self) -> Option<&str>;
+    fn ext_doc_description(&self) -> Option<&str>;
     fn ext_previous_version_doc_url(&self) -> Option<&str>;
 }
 
@@ -323,6 +324,9 @@ pub struct Property {
     #[serde(skip_serializing_if = "Option::is_none")]
     pub ext_doc_url: Option<String>,
 
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub ext_doc_description: Option<String>,
+
     #[serde(skip_serializing_if = "Option::is_none")]
     pub ext_previous_version_doc_url: Option<String>,
 
@@ -375,6 +379,10 @@ impl ExternalDocument for Property {
         self.ext_doc_url.as_deref()
     }
 
+    fn ext_doc_description(&self) -> Option<&str> {
+        self.ext_doc_description.as_deref()
+    }
+
     fn ext_previous_version_doc_url(&self) -> Option<&str> {
         self.ext_previous_version_doc_url.as_deref()
     }
@@ -536,6 +544,9 @@ pub struct BaseType {
     #[serde(skip_serializing_if = "Option::is_none")]
     pub ext_doc_url: Option<String>,
 
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub ext_doc_description: Option<String>,
+
     #[serde(skip_serializing_if = "Option::is_none")]
     pub ext_previous_version_doc_url: Option<String>,
 
@@ -579,6 +590,7 @@ impl BaseType {
             spec_location: None,
             ext_doc_id: None,
             ext_doc_url: None,
+            ext_doc_description: None,
             ext_previous_version_doc_url: None,
         }
     }
@@ -603,6 +615,10 @@ impl ExternalDocument for BaseType {
         self.ext_doc_url.as_deref()
     }
 
+    fn ext_doc_description(&self) -> Option<&str> {
+        self.ext_doc_description.as_deref()
+    }
+
     fn ext_previous_version_doc_url(&self) -> Option<&str> {
         self.ext_previous_version_doc_url.as_deref()
     }
@@ -635,6 +651,10 @@ impl<T: WithBaseType> ExternalDocument for T {
         self.base().doc_url()
     }
 
+    fn ext_doc_description(&self) -> Option<&str> {
+        self.base().ext_doc_description()
+    }
+
     fn ext_previous_version_doc_url(&self) -> Option<&str> {
         self.base().ext_previous_version_doc_url()
     }
@@ -915,6 +935,9 @@ pub struct Endpoint {
     #[serde(skip_serializing_if = "Option::is_none")]
     pub ext_doc_url: Option<String>,
 
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub ext_doc_description: Option<String>,
+
     #[serde(skip_serializing_if = "Option::is_none")]
     pub ext_previous_version_doc_url: Option<String>,
 
@@ -968,6 +991,10 @@ impl ExternalDocument for Endpoint {
         self.ext_doc_url.as_deref()
     }
 
+    fn ext_doc_description(&self) -> Option<&str> {
+        self.ext_doc_description.as_deref()
+    }
+
     fn ext_previous_version_doc_url(&self) -> Option<&str> {
         self.ext_previous_version_doc_url.as_deref()
     }

compiler-rs/clients_schema_to_openapi/src/schemas.rs

@@ -215,7 +215,7 @@ impl<'a> TypesAndComponents<'a> {
                 extensions.insert("x-previousVersionUrl".to_string(), serde_json::json!(previous_version_doc_url));
             }
             ExternalDocumentation {
-                description: None,
+                description: obj.ext_doc_description().map(|desc| { desc.to_string() }),
                 url: url.trim().replace("{branch}", &branch.unwrap_or("current".to_string())),
                 extensions,
             }

compiler-rs/compiler-wasm-lib/pkg/compiler_wasm_lib_bg.wasm

@@ -404,6 +404,7 @@ fn generate_interface_def(
             doc_url: None,
             ext_doc_id: None,
             ext_doc_url: None,
+            ext_doc_description: None,
             ext_previous_version_doc_url: None,
             codegen_name: None, // FIXME: extension in workplace search
             description: None,

compiler-rs/openapi_to_clients_schema/src/types.rs

@@ -443,6 +443,7 @@ export class Endpoint {
   docId?: string
   extDocId?: string
   extDocUrl?: string
+  extDocDescription?: string
   extPreviousVersionDocUrl?: string
   deprecation?: Deprecation
   availability: Availabilities

compiler/src/model/metamodel.ts

@@ -703,6 +703,9 @@ export function hoistRequestAnnotations (
       const docUrl = docIds.find(entry => entry[0] === value.trim())
       assert(jsDocs, docUrl != null, `The @ext_doc_id '${value.trim()}' is not present in _doc_ids/table.csv`)
       endpoint.extDocUrl = docUrl[1].replace(/\r/g, '')
+      if (docUrl[3].replace(/\r/g, '') !== '') {
+        endpoint.extDocDescription = docUrl[3].replace(/\r/g, '')
+      }
     } else if (tag === 'availability') {
       // The @availability jsTag is different than most because it allows
       // multiple values within the same docstring, hence needing to parse

compiler/src/model/utils.ts

@@ -443,6 +443,7 @@ export class Endpoint {
   docId?: string
   extDocId?: string
   extDocUrl?: string
+  extDocDescription?: string
   extPreviousVersionDocUrl?: string
   deprecation?: Deprecation
   availability: Availabilities