fix(specs): proper title with linter (generated)

algolia/api-clients-automation#3444 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Pierre Millot <[email protected]>
algolia · Jul 30, 2024 · b60d250 · b60d250
1 parent 64c3ab5
commit b60d250
Show file tree

Hide file tree

Showing 41 changed files with 1,070 additions and 96 deletions.
diff --git a/lib/Api/QuerySuggestionsClient.php b/lib/Api/QuerySuggestionsClient.php
@@ -391,7 +391,7 @@ public function getConfig($indexName, $requestOptions = [])
      * @param string $indexName      Query Suggestions index name. (required)
      * @param array  $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
-     * @return \Algolia\AlgoliaSearch\Model\QuerySuggestions\GetConfigStatus200Response|array<string, mixed>
+     * @return \Algolia\AlgoliaSearch\Model\QuerySuggestions\ConfigStatus|array<string, mixed>
      */
     public function getConfigStatus($indexName, $requestOptions = [])
     {
@@ -428,7 +428,7 @@ public function getConfigStatus($indexName, $requestOptions = [])
      * @param string $indexName      Query Suggestions index name. (required)
      * @param array  $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
-     * @return \Algolia\AlgoliaSearch\Model\QuerySuggestions\GetLogFile200Response|array<string, mixed>
+     * @return \Algolia\AlgoliaSearch\Model\QuerySuggestions\LogFile|array<string, mixed>
      */
     public function getLogFile($indexName, $requestOptions = [])
     {

diff --git a/lib/Api/UsageClient.php b/lib/Api/UsageClient.php
@@ -265,7 +265,7 @@ public function customPut($path, $parameters = null, $body = null, $requestOptio
      * @param array  $granularity    Granularity of the aggregated metrics.  - &#x60;hourly&#x60;: the maximum time range for hourly metrics is 7 days. - &#x60;daily&#x60;: the maximum time range for daily metrics is 365 days. (optional)
      * @param array  $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
-     * @return \Algolia\AlgoliaSearch\Model\Usage\GetUsage200Response|array<string, mixed>
+     * @return \Algolia\AlgoliaSearch\Model\Usage\IndexUsage|array<string, mixed>
      */
     public function getIndexUsage($statistic, $indexName, $startDate, $endDate, $granularity = null, $requestOptions = [])
     {
@@ -341,7 +341,7 @@ public function getIndexUsage($statistic, $indexName, $startDate, $endDate, $gra
      * @param array  $granularity    Granularity of the aggregated metrics.  - &#x60;hourly&#x60;: the maximum time range for hourly metrics is 7 days. - &#x60;daily&#x60;: the maximum time range for daily metrics is 365 days. (optional)
      * @param array  $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
-     * @return \Algolia\AlgoliaSearch\Model\Usage\GetUsage200Response|array<string, mixed>
+     * @return \Algolia\AlgoliaSearch\Model\Usage\IndexUsage|array<string, mixed>
      */
     public function getUsage($statistic, $startDate, $endDate, $granularity = null, $requestOptions = [])
     {

diff --git a/...el/Abtesting/FilterEffectsEmptySearch.php → lib/Model/Abtesting/EmptySearchFilter.php b/...el/Abtesting/FilterEffectsEmptySearch.php → lib/Model/Abtesting/EmptySearchFilter.php
@@ -7,13 +7,13 @@
 use Algolia\AlgoliaSearch\Model\AbstractModel;
 
 /**
- * FilterEffectsEmptySearch Class Doc Comment.
+ * EmptySearchFilter Class Doc Comment.
  *
  * @category Class
  *
  * @description Empty searches removed from the A/B test as a result of configuration settings.
  */
-class FilterEffectsEmptySearch extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
+class EmptySearchFilter extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
 {
     /**
      * Array of property to type mappings. Used for (de)serialization.

diff --git a/lib/Model/Abtesting/FilterEffects.php b/lib/Model/Abtesting/FilterEffects.php
@@ -21,8 +21,8 @@ class FilterEffects extends AbstractModel implements ModelInterface, \ArrayAcces
      * @var string[]
      */
     protected static $modelTypes = [
-        'outliers' => '\Algolia\AlgoliaSearch\Model\Abtesting\FilterEffectsOutliers',
-        'emptySearch' => '\Algolia\AlgoliaSearch\Model\Abtesting\FilterEffectsEmptySearch',
+        'outliers' => '\Algolia\AlgoliaSearch\Model\Abtesting\OutliersFilter',
+        'emptySearch' => '\Algolia\AlgoliaSearch\Model\Abtesting\EmptySearchFilter',
     ];
 
     /**
@@ -163,7 +163,7 @@ public function valid()
     /**
      * Gets outliers.
      *
-     * @return null|FilterEffectsOutliers
+     * @return null|OutliersFilter
      */
     public function getOutliers()
     {
@@ -173,7 +173,7 @@ public function getOutliers()
     /**
      * Sets outliers.
      *
-     * @param null|FilterEffectsOutliers $outliers outliers
+     * @param null|OutliersFilter $outliers outliers
      *
      * @return self
      */
@@ -187,7 +187,7 @@ public function setOutliers($outliers)
     /**
      * Gets emptySearch.
      *
-     * @return null|FilterEffectsEmptySearch
+     * @return null|EmptySearchFilter
      */
     public function getEmptySearch()
     {
@@ -197,7 +197,7 @@ public function getEmptySearch()
     /**
      * Sets emptySearch.
      *
-     * @param null|FilterEffectsEmptySearch $emptySearch emptySearch
+     * @param null|EmptySearchFilter $emptySearch emptySearch
      *
      * @return self
      */

diff --git a/...Model/Abtesting/FilterEffectsOutliers.php → lib/Model/Abtesting/OutliersFilter.php b/...Model/Abtesting/FilterEffectsOutliers.php → lib/Model/Abtesting/OutliersFilter.php
@@ -7,13 +7,13 @@
 use Algolia\AlgoliaSearch\Model\AbstractModel;
 
 /**
- * FilterEffectsOutliers Class Doc Comment.
+ * OutliersFilter Class Doc Comment.
  *
  * @category Class
  *
  * @description Outliers removed from the A/B test as a result of configuration settings.
  */
-class FilterEffectsOutliers extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
+class OutliersFilter extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
 {
     /**
      * Array of property to type mappings. Used for (de)serialization.

diff --git a/lib/Model/Analytics/ClickPositionsInner.php → lib/Model/Analytics/ClickPosition.php b/lib/Model/Analytics/ClickPositionsInner.php → lib/Model/Analytics/ClickPosition.php
@@ -7,13 +7,13 @@
 use Algolia\AlgoliaSearch\Model\AbstractModel;
 
 /**
- * ClickPositionsInner Class Doc Comment.
+ * ClickPosition Class Doc Comment.
  *
  * @category Class
  *
  * @description Click position.
  */
-class ClickPositionsInner extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
+class ClickPosition extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
 {
     /**
      * Array of property to type mappings. Used for (de)serialization.
@@ -194,10 +194,10 @@ public function getPosition()
     public function setPosition($position)
     {
         if (!is_null($position) && (count($position) > 2)) {
-            throw new \InvalidArgumentException('invalid value for $position when calling ClickPositionsInner., number of items must be less than or equal to 2.');
+            throw new \InvalidArgumentException('invalid value for $position when calling ClickPosition., number of items must be less than or equal to 2.');
         }
         if (!is_null($position) && (count($position) < 2)) {
-            throw new \InvalidArgumentException('invalid length for $position when calling ClickPositionsInner., number of items must be greater than or equal to 2.');
+            throw new \InvalidArgumentException('invalid length for $position when calling ClickPosition., number of items must be greater than or equal to 2.');
         }
         $this->container['position'] = $position;
 
@@ -224,7 +224,7 @@ public function getClickCount()
     public function setClickCount($clickCount)
     {
         if (!is_null($clickCount) && ($clickCount < 0)) {
-            throw new \InvalidArgumentException('invalid value for $clickCount when calling ClickPositionsInner., must be bigger than or equal to 0.');
+            throw new \InvalidArgumentException('invalid value for $clickCount when calling ClickPosition., must be bigger than or equal to 0.');
         }
 
         $this->container['clickCount'] = $clickCount;

diff --git a/lib/Model/Analytics/GetClickPositionsResponse.php b/lib/Model/Analytics/GetClickPositionsResponse.php
@@ -19,7 +19,7 @@ class GetClickPositionsResponse extends AbstractModel implements ModelInterface,
      * @var string[]
      */
     protected static $modelTypes = [
-        'positions' => '\Algolia\AlgoliaSearch\Model\Analytics\ClickPositionsInner[]',
+        'positions' => '\Algolia\AlgoliaSearch\Model\Analytics\ClickPosition[]',
     ];
 
     /**
@@ -166,7 +166,7 @@ public function valid()
     /**
      * Gets positions.
      *
-     * @return \Algolia\AlgoliaSearch\Model\Analytics\ClickPositionsInner[]
+     * @return \Algolia\AlgoliaSearch\Model\Analytics\ClickPosition[]
      */
     public function getPositions()
     {
@@ -176,7 +176,7 @@ public function getPositions()
     /**
      * Sets positions.
      *
-     * @param \Algolia\AlgoliaSearch\Model\Analytics\ClickPositionsInner[] $positions list of positions in the search results and clicks associated with this search
+     * @param \Algolia\AlgoliaSearch\Model\Analytics\ClickPosition[] $positions list of positions in the search results and clicks associated with this search
      *
      * @return self
      */

diff --git a/lib/Model/Analytics/TopSearchWithAnalytics.php b/lib/Model/Analytics/TopSearchWithAnalytics.php
@@ -23,7 +23,7 @@ class TopSearchWithAnalytics extends AbstractModel implements ModelInterface, \A
         'count' => 'int',
         'clickThroughRate' => 'float',
         'averageClickPosition' => 'float',
-        'clickPositions' => '\Algolia\AlgoliaSearch\Model\Analytics\ClickPositionsInner[]',
+        'clickPositions' => '\Algolia\AlgoliaSearch\Model\Analytics\ClickPosition[]',
         'conversionRate' => 'float',
         'trackedSearchCount' => 'int',
         'clickCount' => 'int',
@@ -401,7 +401,7 @@ public function setAverageClickPosition($averageClickPosition)
     /**
      * Gets clickPositions.
      *
-     * @return \Algolia\AlgoliaSearch\Model\Analytics\ClickPositionsInner[]
+     * @return \Algolia\AlgoliaSearch\Model\Analytics\ClickPosition[]
      */
     public function getClickPositions()
     {
@@ -411,7 +411,7 @@ public function getClickPositions()
     /**
      * Sets clickPositions.
      *
-     * @param \Algolia\AlgoliaSearch\Model\Analytics\ClickPositionsInner[] $clickPositions list of positions in the search results and clicks associated with this search
+     * @param \Algolia\AlgoliaSearch\Model\Analytics\ClickPosition[] $clickPositions list of positions in the search results and clicks associated with this search
      *
      * @return self
      */

diff --git a/lib/Model/Analytics/TopSearchWithRevenueAnalytics.php b/lib/Model/Analytics/TopSearchWithRevenueAnalytics.php
@@ -23,7 +23,7 @@ class TopSearchWithRevenueAnalytics extends AbstractModel implements ModelInterf
         'count' => 'int',
         'clickThroughRate' => 'float',
         'averageClickPosition' => 'float',
-        'clickPositions' => '\Algolia\AlgoliaSearch\Model\Analytics\ClickPositionsInner[]',
+        'clickPositions' => '\Algolia\AlgoliaSearch\Model\Analytics\ClickPosition[]',
         'conversionRate' => 'float',
         'trackedSearchCount' => 'int',
         'clickCount' => 'int',
@@ -476,7 +476,7 @@ public function setAverageClickPosition($averageClickPosition)
     /**
      * Gets clickPositions.
      *
-     * @return \Algolia\AlgoliaSearch\Model\Analytics\ClickPositionsInner[]
+     * @return \Algolia\AlgoliaSearch\Model\Analytics\ClickPosition[]
      */
     public function getClickPositions()
     {
@@ -486,7 +486,7 @@ public function getClickPositions()
     /**
      * Sets clickPositions.
      *
-     * @param \Algolia\AlgoliaSearch\Model\Analytics\ClickPositionsInner[] $clickPositions list of positions in the search results and clicks associated with this search
+     * @param \Algolia\AlgoliaSearch\Model\Analytics\ClickPosition[] $clickPositions list of positions in the search results and clicks associated with this search
      *
      * @return self
      */

diff --git a/lib/Model/Ingestion/DockerStreamsInput.php b/lib/Model/Ingestion/DockerStreamsInput.php
@@ -10,6 +10,8 @@
  * DockerStreamsInput Class Doc Comment.
  *
  * @category Class
+ *
+ * @description The selected streams of a singer or airbyte connector.
  */
 class DockerStreamsInput extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
 {

diff --git a/...estion/TransformationTryResponseError.php → lib/Model/Ingestion/TransformationError.php b/...estion/TransformationTryResponseError.php → lib/Model/Ingestion/TransformationError.php
@@ -7,13 +7,13 @@
 use Algolia\AlgoliaSearch\Model\AbstractModel;
 
 /**
- * TransformationTryResponseError Class Doc Comment.
+ * TransformationError Class Doc Comment.
  *
  * @category Class
  *
  * @description The error if the transformation failed.
  */
-class TransformationTryResponseError extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
+class TransformationError extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
 {
     /**
      * Array of property to type mappings. Used for (de)serialization.

diff --git a/lib/Model/Ingestion/TransformationTryResponse.php b/lib/Model/Ingestion/TransformationTryResponse.php
@@ -20,7 +20,7 @@ class TransformationTryResponse extends AbstractModel implements ModelInterface,
      */
     protected static $modelTypes = [
         'payloads' => 'object[]',
-        'error' => '\Algolia\AlgoliaSearch\Model\Ingestion\TransformationTryResponseError',
+        'error' => '\Algolia\AlgoliaSearch\Model\Ingestion\TransformationError',
     ];
 
     /**
@@ -191,7 +191,7 @@ public function setPayloads($payloads)
     /**
      * Gets error.
      *
-     * @return null|TransformationTryResponseError
+     * @return null|TransformationError
      */
     public function getError()
     {
@@ -201,7 +201,7 @@ public function getError()
     /**
      * Sets error.
      *
-     * @param null|TransformationTryResponseError $error error
+     * @param null|TransformationError $error error
      *
      * @return self
      */

diff --git a/...odel/Monitoring/GetServers403Response.php → lib/Model/Monitoring/BadRequest.php b/...odel/Monitoring/GetServers403Response.php → lib/Model/Monitoring/BadRequest.php
@@ -7,11 +7,11 @@
 use Algolia\AlgoliaSearch\Model\AbstractModel;
 
 /**
- * GetServers403Response Class Doc Comment.
+ * BadRequest Class Doc Comment.
  *
  * @category Class
  */
-class GetServers403Response extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
+class BadRequest extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable
 {
     /**
      * Array of property to type mappings. Used for (de)serialization.