Skip to content

Commit

Permalink
fix(specs): proper title with linter (generated)
Browse files Browse the repository at this point in the history
algolia/api-clients-automation#3444

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
  • Loading branch information
algolia-bot and millotp committed Jul 30, 2024
1 parent 9707a87 commit b317f84
Show file tree
Hide file tree
Showing 45 changed files with 181 additions and 84 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ package algoliasearch.abtesting
* @param trackedSearchesCount
* Number of tracked searches removed from the A/B test.
*/
case class FilterEffectsEmptySearch(
case class EmptySearchFilter(
usersCount: Option[Int] = scala.None,
trackedSearchesCount: Option[Int] = scala.None
)
4 changes: 2 additions & 2 deletions src/main/scala/algoliasearch/abtesting/FilterEffects.scala
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,6 @@ package algoliasearch.abtesting
/** A/B test filter effects resulting from configuration settings.
*/
case class FilterEffects(
outliers: Option[FilterEffectsOutliers] = scala.None,
emptySearch: Option[FilterEffectsEmptySearch] = scala.None
outliers: Option[OutliersFilter] = scala.None,
emptySearch: Option[EmptySearchFilter] = scala.None
)
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ package algoliasearch.abtesting
* @param trackedSearchesCount
* Number of tracked searches removed from the A/B test.
*/
case class FilterEffectsOutliers(
case class OutliersFilter(
usersCount: Option[Int] = scala.None,
trackedSearchesCount: Option[Int] = scala.None
)
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ package algoliasearch.analytics
* @param clickCount
* Number of times this search has been clicked at that position.
*/
case class ClickPositionsInner(
case class ClickPosition(
position: Option[Seq[Int]] = scala.None,
clickCount: Option[Int] = scala.None
)
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,5 @@ package algoliasearch.analytics
* List of positions in the search results and clicks associated with this search.
*/
case class GetClickPositionsResponse(
positions: Seq[ClickPositionsInner]
positions: Seq[ClickPosition]
)
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ case class TopSearchWithAnalytics(
count: Int,
clickThroughRate: Option[Double] = scala.None,
averageClickPosition: Option[Double] = scala.None,
clickPositions: Seq[ClickPositionsInner],
clickPositions: Seq[ClickPosition],
conversionRate: Option[Double] = scala.None,
trackedSearchCount: Int,
clickCount: Int,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ case class TopSearchWithRevenueAnalytics(
count: Int,
clickThroughRate: Option[Double] = scala.None,
averageClickPosition: Option[Double] = scala.None,
clickPositions: Seq[ClickPositionsInner],
clickPositions: Seq[ClickPosition],
conversionRate: Option[Double] = scala.None,
trackedSearchCount: Int,
clickCount: Int,
Expand Down
4 changes: 3 additions & 1 deletion src/main/scala/algoliasearch/api/MonitoringClient.scala
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@
*/
package algoliasearch.api

import algoliasearch.monitoring.BadRequest
import algoliasearch.monitoring.ErrorBase
import algoliasearch.monitoring.GetServers403Response
import algoliasearch.monitoring.Forbidden
import algoliasearch.monitoring.IncidentsResponse
import algoliasearch.monitoring.IndexingTimeResponse
import algoliasearch.monitoring.InfrastructureResponse
Expand All @@ -13,6 +14,7 @@ import algoliasearch.monitoring.LatencyResponse
import algoliasearch.monitoring.Metric._
import algoliasearch.monitoring.Period._
import algoliasearch.monitoring.StatusResponse
import algoliasearch.monitoring.Unauthorized
import algoliasearch.monitoring._
import algoliasearch.ApiClient
import algoliasearch.api.MonitoringClient.hosts
Expand Down
12 changes: 6 additions & 6 deletions src/main/scala/algoliasearch/api/QuerySuggestionsClient.scala
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@
package algoliasearch.api

import algoliasearch.querysuggestions.BaseResponse
import algoliasearch.querysuggestions.ConfigStatus
import algoliasearch.querysuggestions.Configuration
import algoliasearch.querysuggestions.ConfigurationResponse
import algoliasearch.querysuggestions.ConfigurationWithIndex
import algoliasearch.querysuggestions.ErrorBase
import algoliasearch.querysuggestions.GetConfigStatus200Response
import algoliasearch.querysuggestions.GetLogFile200Response
import algoliasearch.querysuggestions.LogFile
import algoliasearch.querysuggestions._
import algoliasearch.ApiClient
import algoliasearch.api.QuerySuggestionsClient.hosts
Expand Down Expand Up @@ -263,15 +263,15 @@ class QuerySuggestionsClient(
*/
def getConfigStatus(indexName: String, requestOptions: Option[RequestOptions] = None)(implicit
ec: ExecutionContext
): Future[GetConfigStatus200Response] = Future {
): Future[ConfigStatus] = Future {
requireNotNull(indexName, "Parameter `indexName` is required when calling `getConfigStatus`.")

val request = HttpRequest
.builder()
.withMethod("GET")
.withPath(s"/1/configs/${escape(indexName)}/status")
.build()
execute[GetConfigStatus200Response](request, requestOptions)
execute[ConfigStatus](request, requestOptions)
}

/** Retrieves the logs for a single Query Suggestions index.
Expand All @@ -284,15 +284,15 @@ class QuerySuggestionsClient(
*/
def getLogFile(indexName: String, requestOptions: Option[RequestOptions] = None)(implicit
ec: ExecutionContext
): Future[GetLogFile200Response] = Future {
): Future[LogFile] = Future {
requireNotNull(indexName, "Parameter `indexName` is required when calling `getLogFile`.")

val request = HttpRequest
.builder()
.withMethod("GET")
.withPath(s"/1/logs/${escape(indexName)}")
.build()
execute[GetLogFile200Response](request, requestOptions)
execute[LogFile](request, requestOptions)
}

/** Updates a QuerySuggestions configuration.
Expand Down
13 changes: 7 additions & 6 deletions src/main/scala/algoliasearch/api/UsageClient.scala
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@
package algoliasearch.api

import algoliasearch.usage.ErrorBase
import algoliasearch.usage.GetUsage200Response
import algoliasearch.usage.GetUsage400Response
import algoliasearch.usage.Forbidden
import algoliasearch.usage.Granularity._
import algoliasearch.usage.IndexUsage
import algoliasearch.usage.InvalidRequest
import algoliasearch.usage.Statistic._
import algoliasearch.usage._
import algoliasearch.ApiClient
Expand Down Expand Up @@ -273,7 +274,7 @@ class UsageClient(
endDate: String,
granularity: Option[Granularity] = None,
requestOptions: Option[RequestOptions] = None
)(implicit ec: ExecutionContext): Future[GetUsage200Response] = Future {
)(implicit ec: ExecutionContext): Future[IndexUsage] = Future {
requireNotNull(statistic, "Parameter `statistic` is required when calling `getIndexUsage`.")
requireNotNull(indexName, "Parameter `indexName` is required when calling `getIndexUsage`.")
requireNotNull(startDate, "Parameter `startDate` is required when calling `getIndexUsage`.")
Expand All @@ -287,7 +288,7 @@ class UsageClient(
.withQueryParameter("endDate", endDate)
.withQueryParameter("granularity", granularity)
.build()
execute[GetUsage200Response](request, requestOptions)
execute[IndexUsage](request, requestOptions)
}

/** Retrieves usage statistics evaluated over a specified period.
Expand Down Expand Up @@ -393,7 +394,7 @@ class UsageClient(
endDate: String,
granularity: Option[Granularity] = None,
requestOptions: Option[RequestOptions] = None
)(implicit ec: ExecutionContext): Future[GetUsage200Response] = Future {
)(implicit ec: ExecutionContext): Future[IndexUsage] = Future {
requireNotNull(statistic, "Parameter `statistic` is required when calling `getUsage`.")
requireNotNull(startDate, "Parameter `startDate` is required when calling `getUsage`.")
requireNotNull(endDate, "Parameter `endDate` is required when calling `getUsage`.")
Expand All @@ -406,7 +407,7 @@ class UsageClient(
.withQueryParameter("endDate", endDate)
.withQueryParameter("granularity", granularity)
.build()
execute[GetUsage200Response](request, requestOptions)
execute[IndexUsage](request, requestOptions)
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
*/
package algoliasearch.ingestion

/** DockerStreamsInput
/** The selected streams of a singer or airbyte connector.
*/
case class DockerStreamsInput(
streams: Any
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ package algoliasearch.ingestion
* @param message
* A descriptive message explaining the failure.
*/
case class TransformationTryResponseError(
case class TransformationError(
code: Option[Int] = scala.None,
message: Option[String] = scala.None
)
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,5 @@ package algoliasearch.ingestion
*/
case class TransformationTryResponse(
payloads: Seq[Any],
error: Option[TransformationTryResponseError] = scala.None
error: Option[TransformationError] = scala.None
)
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@
*/
package algoliasearch.monitoring

/** GetServers403Response
/** BadRequest
*/
case class GetServers403Response(
case class BadRequest(
reason: Option[String] = scala.None
)
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@
*/
package algoliasearch.monitoring

/** LatencyResponseMetrics
/** Forbidden
*/
case class LatencyResponseMetrics(
latency: Option[Map[String, Seq[TimeInner]]] = scala.None
case class Forbidden(
reason: Option[String] = scala.None
)
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@
*/
package algoliasearch.monitoring

/** IncidentsInner
/** IncidentEntry
*
* @param t
* Timestamp, measured in milliseconds since the Unix epoch.
*/
case class IncidentsInner(
case class IncidentEntry(
t: Option[Long] = scala.None,
v: Option[Incident] = scala.None
)
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@ package algoliasearch.monitoring
/** IncidentsResponse
*/
case class IncidentsResponse(
incidents: Option[Map[String, Seq[IncidentsInner]]] = scala.None
incidents: Option[Map[String, Seq[IncidentEntry]]] = scala.None
)
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@
*/
package algoliasearch.monitoring

/** IndexingTimeResponseMetrics
/** IndexingMetric
*/
case class IndexingTimeResponseMetrics(
indexing: Option[Map[String, Seq[TimeInner]]] = scala.None
case class IndexingMetric(
indexing: Option[Map[String, Seq[TimeEntry]]] = scala.None
)
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@ package algoliasearch.monitoring
/** IndexingTimeResponse
*/
case class IndexingTimeResponse(
metrics: Option[IndexingTimeResponseMetrics] = scala.None
metrics: Option[IndexingMetric] = scala.None
)
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@ package algoliasearch.monitoring
/** InfrastructureResponse
*/
case class InfrastructureResponse(
metrics: Option[InfrastructureResponseMetrics] = scala.None
metrics: Option[Metrics] = scala.None
)
25 changes: 25 additions & 0 deletions src/main/scala/algoliasearch/monitoring/LatencyMetric.scala
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
/** Algolia Monitoring API The Monitoring API lets you check the status of your Algolia infrastructure. ## Base URLs The
* base URL for requests to the Monitoring API is: - `https://status.algolia.com` **All requests must use HTTPS.** ##
* Availability and authentication Access to the [Infrastructure](#tag/infrastructure) endpoints is available as part
* of the [Premium or Elevate plans](https://www.algolia.com/pricing). To authenticate requests to the Infrastructure
* endpoints, add these headers: - `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. Your
* Monitoring API key. You can find your application ID and API key in the [Algolia
* dashboard](https://dashboard.algolia.com/account). Other endpoints don't require authentication. ## Response status
* and errors The Monitoring API returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely
* on the order of attributes in the API response. Successful responses return a `2xx` status. Client errors return a
* `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message` property with more
* information. ## Version The current version of the Monitoring API is version 1, as indicated by the `/1/` in each
* endpoint's URL.
*
* The version of the OpenAPI document: 1.0.0
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech Do not edit the class manually.
*/
package algoliasearch.monitoring

/** LatencyMetric
*/
case class LatencyMetric(
latency: Option[Map[String, Seq[TimeEntry]]] = scala.None
)
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@ package algoliasearch.monitoring
/** LatencyResponse
*/
case class LatencyResponse(
metrics: Option[LatencyResponseMetrics] = scala.None
metrics: Option[LatencyMetric] = scala.None
)
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
*/
package algoliasearch.monitoring

/** InfrastructureResponseMetrics
/** Metrics
*
* @param cpuUsage
* CPU idleness in %.
Expand All @@ -32,7 +32,7 @@ package algoliasearch.monitoring
* @param avgBuildTime
* Average build time of the indices in seconds.
*/
case class InfrastructureResponseMetrics(
case class Metrics(
cpuUsage: Option[Map[String, Seq[ProbesMetric]]] = scala.None,
ramIndexingUsage: Option[Map[String, Seq[ProbesMetric]]] = scala.None,
ramSearchUsage: Option[Map[String, Seq[ProbesMetric]]] = scala.None,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@
*/
package algoliasearch.monitoring

/** TimeInner
/** TimeEntry
*
* @param t
* Timestamp, measured in milliseconds since the Unix epoch.
* @param v
* Time in ms.
*/
case class TimeInner(
case class TimeEntry(
t: Option[Long] = scala.None,
v: Option[Int] = scala.None
)
25 changes: 25 additions & 0 deletions src/main/scala/algoliasearch/monitoring/Unauthorized.scala
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
/** Algolia Monitoring API The Monitoring API lets you check the status of your Algolia infrastructure. ## Base URLs The
* base URL for requests to the Monitoring API is: - `https://status.algolia.com` **All requests must use HTTPS.** ##
* Availability and authentication Access to the [Infrastructure](#tag/infrastructure) endpoints is available as part
* of the [Premium or Elevate plans](https://www.algolia.com/pricing). To authenticate requests to the Infrastructure
* endpoints, add these headers: - `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. Your
* Monitoring API key. You can find your application ID and API key in the [Algolia
* dashboard](https://dashboard.algolia.com/account). Other endpoints don't require authentication. ## Response status
* and errors The Monitoring API returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely
* on the order of attributes in the API response. Successful responses return a `2xx` status. Client errors return a
* `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message` property with more
* information. ## Version The current version of the Monitoring API is version 1, as indicated by the `/1/` in each
* endpoint's URL.
*
* The version of the OpenAPI document: 1.0.0
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech Do not edit the class manually.
*/
package algoliasearch.monitoring

/** Unauthorized
*/
case class Unauthorized(
reason: Option[String] = scala.None
)
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
*/
package algoliasearch.querysuggestions

/** GetConfigStatus200Response
/** ConfigStatus
*
* @param indexName
* Name of the Query Suggestions index (case-sensitive).
Expand All @@ -35,7 +35,7 @@ package algoliasearch.querysuggestions
* @param lastSuccessfulBuildDuration
* Duration of the last successful build in seconds.
*/
case class GetConfigStatus200Response(
case class ConfigStatus(
indexName: Option[String] = scala.None,
isRunning: Option[Boolean] = scala.None,
lastBuiltAt: Option[String] = scala.None,
Expand Down
Loading

0 comments on commit b317f84

Please sign in to comment.