privileges in description

Author: l-trotta

compiler-rs/clients_schema_to_openapi/src/lib.rs

@@ -23,7 +23,7 @@ pub mod cli;
 
 use indexmap::IndexMap;
 
-use clients_schema::{Availabilities, Flavor, IndexedModel, Privileges, Stability, Visibility};
+use clients_schema::{Availabilities, Flavor, IndexedModel, Stability, Visibility};
 use openapiv3::{Components, OpenAPI};
 use clients_schema::transform::ExpandConfig;
 use crate::components::TypesAndComponents;
@@ -149,7 +149,7 @@ fn info(model: &IndexedModel) -> openapiv3::Info {
  }
 }
 
-pub fn extensions(availabilities: &Option<Availabilities>, privileges: &Option<Privileges>) -> IndexMap<String, serde_json::Value> {
+pub fn extensions(availabilities: &Option<Availabilities>) -> IndexMap<String, serde_json::Value> {
  let mut result = IndexMap::new();
 
  if let Some(avails) = availabilities {
@@ -173,15 +173,5 @@ pub fn extensions(availabilities: &Option<Availabilities>, privileges: &Option<P
  }
  }
  }
-
- if let Some(privs) = privileges {
- if privs.index.len()>0 {
- result.insert("index-privileges".to_string(),serde_json::Value::String(privs.index.join(",")));
- }
- if privs.cluster.len()>0 {
- result.insert("cluster-privileges".to_string(),serde_json::Value::String(privs.cluster.join(",")));
- }
- }
-
  result
 }

compiler-rs/clients_schema_to_openapi/src/paths.rs

@@ -19,7 +19,7 @@ use std::collections::HashMap;
 use std::fmt::Write;
 
 use anyhow::{anyhow, bail};
-use clients_schema::Property;
+use clients_schema::{Privileges, Property};
 use indexmap::IndexMap;
 use indexmap::indexmap;
 use icu_segmenter::SentenceSegmenter;
@@ -250,6 +250,13 @@ pub fn add_endpoint(
  parameters.append(&mut query_params.clone());
 
  let sum_desc = split_summary_desc(&endpoint.description);
+ 
+ let privilege_desc = add_privileges(&endpoint.privileges);
+ 
+ let full_desc = match (sum_desc.description, privilege_desc) {
+ (Some(a), Some(b)) => Some(a+ &b),
+ (opt_a, opt_b) => opt_a.or(opt_b)
+ };
 
  // Create the operation, it will be repeated if we have several methods
  let operation = openapiv3::Operation {
@@ -259,7 +266,7 @@ pub fn add_endpoint(
  vec![namespace.to_string()]
  },
  summary: sum_desc.summary,
- description: sum_desc.description,
+ description: full_desc,
  external_docs: tac.convert_external_docs(endpoint),
  // external_docs: None, // Need values that differ from client purposes
  operation_id: None, // set in clone_operation below with operation_counter
@@ -274,7 +281,7 @@ pub fn add_endpoint(
  deprecated: endpoint.deprecation.is_some(),
  security: None,
  servers: vec![],
- extensions: crate::extensions(&endpoint.availability,&endpoint.privileges),
+ extensions: crate::extensions(&endpoint.availability),
  };
 
 
@@ -403,6 +410,20 @@ fn split_summary_desc(desc: &str) -> SplitDesc{
  }
 }
 
+fn add_privileges(privileges: &Option<Privileges>) -> Option<String>{
+ if let Some(privs) = privileges {
+ let mut result = "Required privileges:".to_string();
+ if privs.index.len()>0 {
+ result = result + " index-privileges: " + &privs.index.join(",");
+ }
+ if privs.cluster.len()>0 {
+ result = result + " cluster-privileges: " + &privs.cluster.join(",");
+ }
+ return Some(result)
+ }
+ None
+}
+
 #[derive(PartialEq,Debug)]
 struct SplitDesc {
  summary: Option<String>,

compiler-rs/clients_schema_to_openapi/src/schemas.rs

@@ -469,7 +469,7 @@ impl<'a> TypesAndComponents<'a> {
  data.external_docs = self.convert_external_docs(prop);
  data.deprecated = prop.deprecation.is_some();
  data.description = self.property_description(prop)?;
- data.extensions = crate::extensions(&prop.availability, &None);
+ data.extensions = crate::extensions(&prop.availability);
  // TODO: prop.aliases as extensions
  // TODO: prop.server_default as extension
  // TODO: prop.doc_id as extension (new representation of since and stability)