Owned data in API response models

Author: RoDmitry

openapi-generator-template/model.mustache

@@ -127,9 +127,9 @@ impl Default for {{classname}} {
 #[derive(bon::Builder)]
 #[builder(on(Cow<'_, str>, into))]
 #[builder(on(String, into))]
-{{/vendorExtensions.x-rust-builder}}
-{{#vendorExtensions.x-rust-has-byte-array}}#[serde_as]
-{{/vendorExtensions.x-rust-has-byte-array}}{{#oneOf.isEmpty}}#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
+{{/vendorExtensions.x-rust-builder}}{{!
+}}{{#vendorExtensions.x-rust-has-byte-array}}#[serde_as]{{/vendorExtensions.x-rust-has-byte-array}}{{!
+}}{{#oneOf.isEmpty}}#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
 pub struct {{{classname}}}<'a{{#vendorExtensions.x-rust-generic-parameter}}, {{{.}}}{{/vendorExtensions.x-rust-generic-parameter}}> {
 {{#vars}}
     {{#description}}
@@ -153,7 +153,7 @@ pub struct {{{classname}}}<'a{{#vendorExtensions.x-rust-generic-parameter}}, {{{
     ### ByteArray
     }}{{^isModel}}{{#isByteArray}}Vec<u8>{{/isByteArray}}{{!
     ### String
-    }}{{^isByteArray}}{{#isString}}Cow<'a, str>{{/isString}}{{!
+    }}{{^isByteArray}}{{#isString}}{{#model}}{{#vendorExtensions.x-rust-is-owned-data}}String{{/vendorExtensions.x-rust-is-owned-data}}{{^vendorExtensions.x-rust-is-owned-data}}Cow<'a, str>{{/vendorExtensions.x-rust-is-owned-data}}{{/model}}{{/isString}}{{!
     ### Arrays
     }}{{^isString}}{{#isArray}}Vec<{{#items}}{{!
     ### Array Models
@@ -186,7 +186,7 @@ impl<'a{{#vendorExtensions.x-rust-generic-parameter}}, {{{.}}}{{/vendorExtension
     }}{{^vendorExtensions.x-rust-type}}{{#isNullable}}Option<{{/isNullable}}{{!
     }}{{#isEnum}}{{#isArray}}{{#uniqueItems}}std::collections::HashSet<{{/uniqueItems}}{{^uniqueItems}}Vec<{{/uniqueItems}}{{/isArray}}{{{enumName}}}{{#isArray}}>{{/isArray}}{{/isEnum}}{{!
     }}{{^isEnum}}{{#isByteArray}}Vec<u8>{{/isByteArray}}{{!
-    }}{{^isByteArray}}{{#isString}}Cow<'a, str>{{/isString}}{{!
+    }}{{^isByteArray}}{{#isString}}{{#model}}{{#vendorExtensions.x-rust-is-owned-data}}String{{/vendorExtensions.x-rust-is-owned-data}}{{^vendorExtensions.x-rust-is-owned-data}}Cow<'a, str>{{/vendorExtensions.x-rust-is-owned-data}}{{/model}}{{/isString}}{{!
     }}{{^isString}}{{#isArray}}Vec<{{#items}}{{!
     }}{{#isModel}}{{{dataType}}}<'a>{{/isModel}}{{!
     }}{{^isModel}}{{{dataType}}}{{/isModel}}{{/items}}>{{/isArray}}{{!

preprocessed_openapi.yml

@@ -3226,6 +3226,7 @@ components:
             description: Timestamp of when the collection was created (Unix epoch in seconds)
             format: int64
             readOnly: true
+      x-rust-is-owned-data: true
     Field:
       required:
       - name
@@ -3381,6 +3382,7 @@ components:
           x-go-type: '[]*CollectionAlias'
           items:
             $ref: '#/components/schemas/CollectionAlias'
+      x-rust-is-owned-data: true
     SearchResult:
       type: object
       properties:
@@ -3429,7 +3431,9 @@ components:
           type: object
           description: Custom JSON object that can be returned in the search response
           additionalProperties: true
+          x-rust-is-owned-data: true
       x-rust-generic-parameter: D
+      x-rust-is-owned-data: true
     SearchRequestParams:
       type: object
       required:
@@ -3448,6 +3452,8 @@ components:
           properties:
             transcribed_query:
               type: string
+          x-rust-is-owned-data: true
+      x-rust-is-owned-data: true
     SearchResultConversation:
       type: object
       required:
@@ -3466,6 +3472,7 @@ components:
           type: string
         query:
           type: string
+      x-rust-is-owned-data: true
     SearchGroupedHit:
       type: object
       required:
@@ -3484,6 +3491,7 @@ components:
             $ref: '#/components/schemas/SearchResultHit'
           x-rust-type: Vec<models::SearchResultHit<'a, D>>
       x-rust-generic-parameter: D
+      x-rust-is-owned-data: true
     SearchResultHit:
       type: object
       properties:
@@ -3496,12 +3504,14 @@ components:
           type: object
           description: Highlighted version of the matching document
           additionalProperties: true
+          x-rust-is-owned-data: true
         document:
           type: object
           description: Can be any key-value pair
           additionalProperties:
             type: object
           x-rust-type: Option<D>
+          x-rust-is-owned-data: true
         text_match:
           type: integer
           format: int64
@@ -3524,11 +3534,13 @@ components:
               type: integer
             typo_prefix_score:
               type: integer
+          x-rust-is-owned-data: true
         geo_distance_meters:
           type: object
           description: Can be any key-value pair
           additionalProperties:
             type: integer
+          x-rust-is-owned-data: true
         vector_distance:
           type: number
           format: float
@@ -3541,6 +3553,7 @@ components:
               type: number
               format: float
               description: Combined score from rank fusion of text and vector search
+          x-rust-is-owned-data: true
         search_index:
           type: integer
           description: Returned only for union query response. Indicates the index of the query which this document matched to.
@@ -3556,6 +3569,7 @@ components:
           country: USA
         text_match: 1234556
       x-rust-generic-parameter: D
+      x-rust-is-owned-data: true
     SearchHighlight:
       type: object
       properties:
@@ -3597,6 +3611,7 @@ components:
           items:
             type: object
             x-go-type: interface{}
+      x-rust-is-owned-data: true
     SearchSynonymSchema:
       type: object
       required:
@@ -3636,6 +3651,7 @@ components:
         id:
           type: string
           description: The id of the synonym that was deleted
+      x-rust-is-owned-data: true
     SearchSynonymsResponse:
       type: object
       required:
@@ -3646,13 +3662,15 @@ components:
           x-go-type: '[]*SearchSynonym'
           items:
             $ref: '#/components/schemas/SearchSynonym'
+      x-rust-is-owned-data: true
     HealthStatus:
       type: object
       required:
       - ok
       properties:
         ok:
           type: boolean
+      x-rust-is-owned-data: true
     SchemaChangeStatus:
       type: object
       properties:
@@ -3665,20 +3683,23 @@ components:
         altered_docs:
           type: integer
           description: Number of documents that have been altered
+      x-rust-is-owned-data: true
     SuccessStatus:
       type: object
       required:
       - success
       properties:
         success:
           type: boolean
+      x-rust-is-owned-data: true
     ApiResponse:
       type: object
       required:
       - message
       properties:
         message:
           type: string
+      x-rust-is-owned-data: true
     ApiKeySchema:
       type: object
       required:
@@ -3722,6 +3743,7 @@ components:
           type: integer
           format: int64
           description: The id of the API key that was deleted
+      x-rust-is-owned-data: true
     ApiKeysResponse:
       type: object
       required:
@@ -3732,6 +3754,7 @@ components:
           x-go-type: '[]*ApiKey'
           items:
             $ref: '#/components/schemas/ApiKey'
+      x-rust-is-owned-data: true
     MultiSearchResult:
       type: object
       required:
@@ -3745,6 +3768,7 @@ components:
         conversation:
           $ref: '#/components/schemas/SearchResultConversation'
       x-rust-generic-parameter: D
+      x-rust-is-owned-data: true
     MultiSearchResultItem:
       allOf:
       - $ref: '#/components/schemas/SearchResult'
@@ -3758,6 +3782,7 @@ components:
             type: string
             description: Error description
       x-rust-generic-parameter: D
+      x-rust-is-owned-data: true
     SearchParameters:
       type: object
       properties:
@@ -4355,6 +4380,7 @@ components:
       properties:
         ok:
           type: boolean
+      x-rust-is-owned-data: true
     AnalyticsEvent:
       type: object
       required:
@@ -4413,6 +4439,7 @@ components:
                   type: string
               query:
                 type: string
+      x-rust-is-owned-data: true
     AnalyticsRuleCreate:
       type: object
       required:
@@ -4503,6 +4530,7 @@ components:
           type: integer
         doc_counter_events:
           type: integer
+      x-rust-is-owned-data: true
     APIStatsResponse:
       type: object
       properties:
@@ -4521,6 +4549,7 @@ components:
         latency_ms:
           type: object
           x-go-type: map[string]float64
+          x-rust-is-owned-data: true
         overloaded_requests_per_second:
           type: number
           format: double
@@ -4530,6 +4559,7 @@ components:
         requests_per_second:
           type: object
           x-go-type: map[string]float64
+          x-rust-is-owned-data: true
         search_latency_ms:
           type: number
           format: double
@@ -4545,6 +4575,7 @@ components:
         write_requests_per_second:
           type: number
           format: double
+      x-rust-is-owned-data: true
     StopwordsSetUpsertSchema:
       type: object
       properties:

typesense/src/traits/multi_search_ext.rs

@@ -119,7 +119,7 @@ impl<'a> MultiSearchResultExt<'a> for MultiSearchResult<'a, Value> {
         if let Some(error_msg) = &raw_item.error {
             return Err(MultiSearchParseError::ApiError {
                 index,
-                message: error_msg.clone().into_owned(),
+                message: error_msg.clone(),
             });
         }
 

typesense_codegen/src/models/api_response.rs

@@ -15,13 +15,13 @@ use serde::{Deserialize, Serialize};
 #[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
 pub struct ApiResponse<'a> {
     #[serde(rename = "message")]
-    pub message: Cow<'a, str>,
+    pub message: String,
     #[serde(skip)]
     pub _phantom: PhantomData<&'a ()>,
 }
 
 impl<'a> ApiResponse<'a> {
-    pub fn new(message: Cow<'a, str>) -> Self {
+    pub fn new(message: String) -> Self {
         Self {
             message,
             _phantom: PhantomData,

typesense_codegen/src/models/collection_response.rs

@@ -16,7 +16,7 @@ use serde::{Deserialize, Serialize};
 pub struct CollectionResponse<'a> {
     /// Name of the collection
     #[serde(rename = "name")]
-    pub name: Cow<'a, str>,
+    pub name: String,
     /// A list of fields for querying, filtering and faceting
     #[serde(rename = "fields")]
     pub fields: Vec<models::Field<'a>>,
@@ -25,7 +25,7 @@ pub struct CollectionResponse<'a> {
         rename = "default_sorting_field",
         skip_serializing_if = "Option::is_none"
     )]
-    pub default_sorting_field: Option<Cow<'a, str>>,
+    pub default_sorting_field: Option<String>,
     /// List of symbols or special characters to be used for splitting the text into individual words in addition to space and new-line characters.
     #[serde(rename = "token_separators", skip_serializing_if = "Option::is_none")]
     pub token_separators: Option<Vec<String>>,
@@ -58,7 +58,7 @@ pub struct CollectionResponse<'a> {
 
 impl<'a> CollectionResponse<'a> {
     pub fn new(
-        name: Cow<'a, str>,
+        name: String,
         fields: Vec<models::Field<'a>>,
         num_documents: i64,
         created_at: i64,

typesense_codegen/src/models/multi_search_result_item.rs

@@ -56,7 +56,7 @@ pub struct MultiSearchResultItem<'a, D> {
     pub code: Option<i64>,
     /// Error description
     #[serde(rename = "error", skip_serializing_if = "Option::is_none")]
-    pub error: Option<Cow<'a, str>>,
+    pub error: Option<String>,
     #[serde(skip)]
     pub _phantom: PhantomData<&'a ()>,
 }

typesense_codegen/src/models/schema_change_status.rs

@@ -16,7 +16,7 @@ use serde::{Deserialize, Serialize};
 pub struct SchemaChangeStatus<'a> {
     /// Name of the collection being modified
     #[serde(rename = "collection", skip_serializing_if = "Option::is_none")]
-    pub collection: Option<Cow<'a, str>>,
+    pub collection: Option<String>,
     /// Number of documents that have been validated
     #[serde(rename = "validated_docs", skip_serializing_if = "Option::is_none")]
     pub validated_docs: Option<i32>,

typesense_codegen/src/models/search_highlight.rs

@@ -15,16 +15,16 @@ use serde::{Deserialize, Serialize};
 #[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
 pub struct SearchHighlight<'a> {
     #[serde(rename = "field", skip_serializing_if = "Option::is_none")]
-    pub field: Option<Cow<'a, str>>,
+    pub field: Option<String>,
     /// Present only for (non-array) string fields
     #[serde(rename = "snippet", skip_serializing_if = "Option::is_none")]
-    pub snippet: Option<Cow<'a, str>>,
+    pub snippet: Option<String>,
     /// Present only for (array) string[] fields
     #[serde(rename = "snippets", skip_serializing_if = "Option::is_none")]
     pub snippets: Option<Vec<String>>,
     /// Full field value with highlighting, present only for (non-array) string fields
     #[serde(rename = "value", skip_serializing_if = "Option::is_none")]
-    pub value: Option<Cow<'a, str>>,
+    pub value: Option<String>,
     /// Full field value with highlighting, present only for (array) string[] fields
     #[serde(rename = "values", skip_serializing_if = "Option::is_none")]
     pub values: Option<Vec<String>>,

typesense_codegen/src/models/search_request_params.rs

@@ -15,9 +15,9 @@ use serde::{Deserialize, Serialize};
 #[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
 pub struct SearchRequestParams<'a> {
     #[serde(rename = "collection_name")]
-    pub collection_name: Cow<'a, str>,
+    pub collection_name: String,
     #[serde(rename = "q")]
-    pub q: Cow<'a, str>,
+    pub q: String,
     #[serde(rename = "per_page")]
     pub per_page: i32,
     #[serde(rename = "voice_query", skip_serializing_if = "Option::is_none")]
@@ -27,7 +27,7 @@ pub struct SearchRequestParams<'a> {
 }
 
 impl<'a> SearchRequestParams<'a> {
-    pub fn new(collection_name: Cow<'a, str>, q: Cow<'a, str>, per_page: i32) -> Self {
+    pub fn new(collection_name: String, q: String, per_page: i32) -> Self {
         Self {
             collection_name,
             q,

typesense_codegen/src/models/search_request_params_voice_query.rs

@@ -15,7 +15,7 @@ use serde::{Deserialize, Serialize};
 #[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
 pub struct SearchRequestParamsVoiceQuery<'a> {
     #[serde(rename = "transcribed_query", skip_serializing_if = "Option::is_none")]
-    pub transcribed_query: Option<Cow<'a, str>>,
+    pub transcribed_query: Option<String>,
     #[serde(skip)]
     pub _phantom: PhantomData<&'a ()>,
 }