Add description to operation, generate Rust method docs

Author: svix-jplatte

src/api.rs

@@ -140,6 +140,9 @@ struct Operation {
     id: String,
     /// The name to use for the operation in code.
     name: String,
+    /// Description of the operation to use for documentation.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    description: Option<String>,
     /// The HTTP method.
     ///
     /// Encoded as "get", "post" or such because that's what aide's PathItem iterator gives us.
@@ -316,6 +319,7 @@ impl Operation {
         let op = Operation {
             id: op_id,
             name: op_name,
+            description: op.description,
             method: method.to_owned(),
             path: path.to_owned(),
             path_params,

templates/svix_resource.rs.jinja

@@ -49,6 +49,9 @@ impl<'a> {{ resource_type_name }}<'a> {
     {% for op in resource.operations %}
     {% set has_query_params = op.query_params | length > 0 -%}
     {% set has_header_params = op.header_params | length > 0 -%}
+    {% if op.description is defined -%}
+        #[doc = " {{ op.description }}"]
+    {% endif -%}
     pub async fn {{ op.name | to_snake_case }}(
         &self,