fix(specs): nb_api_calls in getLogs response is optional (#4142) (generated) [skip ci]

Co-authored-by: Clément Vannicatte <[email protected]>

Author: algolia-bot

clients/algoliasearch-client-csharp/algoliasearch/Models/Search/Log.cs

@@ -33,9 +33,8 @@ public Log() { }
   /// <param name="ip">IP address of the client that performed the request. (required).</param>
   /// <param name="queryHeaders">Request headers (API keys are obfuscated). (required).</param>
   /// <param name="sha1">SHA1 signature of the log entry. (required).</param>
-  /// <param name="nbApiCalls">Number of API requests. (required).</param>
   /// <param name="processingTimeMs">Processing time for the query in milliseconds. This doesn't include latency due to the network.  (required).</param>
-  public Log(string timestamp, string method, string answerCode, string queryBody, string answer, string url, string ip, string queryHeaders, string sha1, string nbApiCalls, string processingTimeMs)
+  public Log(string timestamp, string method, string answerCode, string queryBody, string answer, string url, string ip, string queryHeaders, string sha1, string processingTimeMs)
   {
     Timestamp = timestamp ?? throw new ArgumentNullException(nameof(timestamp));
     Method = method ?? throw new ArgumentNullException(nameof(method));
@@ -46,7 +45,6 @@ public Log(string timestamp, string method, string answerCode, string queryBody,
     Ip = ip ?? throw new ArgumentNullException(nameof(ip));
     QueryHeaders = queryHeaders ?? throw new ArgumentNullException(nameof(queryHeaders));
     Sha1 = sha1 ?? throw new ArgumentNullException(nameof(sha1));
-    NbApiCalls = nbApiCalls ?? throw new ArgumentNullException(nameof(nbApiCalls));
     ProcessingTimeMs = processingTimeMs ?? throw new ArgumentNullException(nameof(processingTimeMs));
   }
 

clients/algoliasearch-client-dart/packages/client_search/lib/src/model/log.dart

@@ -19,7 +19,7 @@ final class Log {
     required this.ip,
     required this.queryHeaders,
     required this.sha1,
-    required this.nbApiCalls,
+    this.nbApiCalls,
     required this.processingTimeMs,
     this.index,
     this.queryParams,
@@ -65,7 +65,7 @@ final class Log {
 
   /// Number of API requests.
   @JsonKey(name: r'nb_api_calls')
-  final String nbApiCalls;
+  final String? nbApiCalls;
 
   /// Processing time for the query in milliseconds. This doesn't include latency due to the network.
   @JsonKey(name: r'processing_time_ms')

clients/algoliasearch-client-dart/packages/client_search/lib/src/model/log.g.dart

@@ -163,7 +163,7 @@ public Log setNbApiCalls(String nbApiCalls) {
   }
 
   /** Number of API requests. */
-  @javax.annotation.Nonnull
+  @javax.annotation.Nullable
   public String getNbApiCalls() {
     return nbApiCalls;
   }

clients/algoliasearch-client-go/algolia/search/model_log.go

@@ -51,7 +51,7 @@ export type Log = {
   /**
    * Number of API requests.
    */
-  nb_api_calls: string;
+  nb_api_calls?: string;
 
   /**
    * Processing time for the query in milliseconds. This doesn\'t include latency due to the network.

clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/model/search/Log.java

@@ -16,8 +16,8 @@ import kotlinx.serialization.json.*
  * @param ip IP address of the client that performed the request.
  * @param queryHeaders Request headers (API keys are obfuscated).
  * @param sha1 SHA1 signature of the log entry.
- * @param nbApiCalls Number of API requests.
  * @param processingTimeMs Processing time for the query in milliseconds. This doesn't include latency due to the network.
+ * @param nbApiCalls Number of API requests.
  * @param index Index targeted by the query.
  * @param queryParams Query parameters sent with the request.
  * @param queryNbHits Number of search results (hits) returned for the query.
@@ -53,12 +53,12 @@ public data class Log(
   /** SHA1 signature of the log entry. */
   @SerialName(value = "sha1") val sha1: String,
 
-  /** Number of API requests. */
-  @SerialName(value = "nb_api_calls") val nbApiCalls: String,
-
   /** Processing time for the query in milliseconds. This doesn't include latency due to the network.  */
   @SerialName(value = "processing_time_ms") val processingTimeMs: String,
 
+  /** Number of API requests. */
+  @SerialName(value = "nb_api_calls") val nbApiCalls: String? = null,
+
   /** Index targeted by the query. */
   @SerialName(value = "index") val index: String? = null,
 

clients/algoliasearch-client-javascript/packages/client-search/model/log.ts

@@ -278,9 +278,6 @@ public function listInvalidProperties()
         if (!isset($this->container['sha1']) || null === $this->container['sha1']) {
             $invalidProperties[] = "'sha1' can't be null";
         }
-        if (!isset($this->container['nbApiCalls']) || null === $this->container['nbApiCalls']) {
-            $invalidProperties[] = "'nbApiCalls' can't be null";
-        }
         if (!isset($this->container['processingTimeMs']) || null === $this->container['processingTimeMs']) {
             $invalidProperties[] = "'processingTimeMs' can't be null";
         }
@@ -518,7 +515,7 @@ public function setSha1($sha1)
     /**
      * Gets nbApiCalls.
      *
-     * @return string
+     * @return null|string
      */
     public function getNbApiCalls()
     {
@@ -528,7 +525,7 @@ public function getNbApiCalls()
     /**
      * Sets nbApiCalls.
      *
-     * @param string $nbApiCalls number of API requests
+     * @param null|string $nbApiCalls number of API requests
      *
      * @return self
      */

clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/model/search/Log.kt

@@ -66,7 +66,7 @@ class Log(BaseModel):
     """ Request headers (API keys are obfuscated). """
     sha1: str
     """ SHA1 signature of the log entry. """
-    nb_api_calls: str
+    nb_api_calls: Optional[str] = None
     """ Number of API requests. """
     processing_time_ms: str
     """ Processing time for the query in milliseconds. This doesn't include latency due to the network.  """

clients/algoliasearch-client-php/lib/Model/Search/Log.php

@@ -181,8 +181,6 @@ def initialize(attributes = {})
 
         if attributes.key?(:nb_api_calls)
           self.nb_api_calls = attributes[:nb_api_calls]
-        else
-          self.nb_api_calls = nil
         end
 
         if attributes.key?(:processing_time_ms)

clients/algoliasearch-client-python/algoliasearch/search/models/log.py

@@ -78,7 +78,7 @@ case class Log(
     ip: String,
     queryHeaders: String,
     sha1: String,
-    nbApiCalls: String,
+    nbApiCalls: Option[String] = scala.None,
     processingTimeMs: String,
     index: Option[String] = scala.None,
     queryParams: Option[String] = scala.None,

clients/algoliasearch-client-ruby/lib/algolia/models/search/log.rb

@@ -26,7 +26,7 @@ public struct Log: Codable, JSONEncodable {
     /// SHA1 signature of the log entry.
     public var sha1: String
     /// Number of API requests.
-    public var nbApiCalls: String
+    public var nbApiCalls: String?
     /// Processing time for the query in milliseconds. This doesn't include latency due to the network.
     public var processingTimeMs: String
     /// Index targeted by the query.
@@ -48,7 +48,7 @@ public struct Log: Codable, JSONEncodable {
         ip: String,
         queryHeaders: String,
         sha1: String,
-        nbApiCalls: String,
+        nbApiCalls: String? = nil,
         processingTimeMs: String,
         index: String? = nil,
         queryParams: String? = nil,
@@ -103,7 +103,7 @@ public struct Log: Codable, JSONEncodable {
         try container.encode(self.ip, forKey: .ip)
         try container.encode(self.queryHeaders, forKey: .queryHeaders)
         try container.encode(self.sha1, forKey: .sha1)
-        try container.encode(self.nbApiCalls, forKey: .nbApiCalls)
+        try container.encodeIfPresent(self.nbApiCalls, forKey: .nbApiCalls)
         try container.encode(self.processingTimeMs, forKey: .processingTimeMs)
         try container.encodeIfPresent(self.index, forKey: .index)
         try container.encodeIfPresent(self.queryParams, forKey: .queryParams)
@@ -143,7 +143,7 @@ extension Log: Hashable {
         hasher.combine(self.ip.hashValue)
         hasher.combine(self.queryHeaders.hashValue)
         hasher.combine(self.sha1.hashValue)
-        hasher.combine(self.nbApiCalls.hashValue)
+        hasher.combine(self.nbApiCalls?.hashValue)
         hasher.combine(self.processingTimeMs.hashValue)
         hasher.combine(self.index?.hashValue)
         hasher.combine(self.queryParams?.hashValue)

clients/algoliasearch-client-scala/src/main/scala/algoliasearch/search/Log.scala

@@ -15341,7 +15341,6 @@ paths:
                         - ip
                         - query_headers
                         - sha1
-                        - nb_api_calls
                         - processing_time_ms
         '400':
           $ref: '#/components/responses/BadRequest'

clients/algoliasearch-client-swift/Sources/Search/Models/Log.swift

@@ -2989,7 +2989,6 @@ paths:
                         - ip
                         - query_headers
                         - sha1
-                        - nb_api_calls
                         - processing_time_ms
         '400':
           $ref: '#/components/responses/BadRequest'