Skip to content

Commit b317f84

Browse files
algolia-botmillotp
andcommitted
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]>
1 parent 9707a87 commit b317f84

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+181
-84
lines changed

src/main/scala/algoliasearch/abtesting/FilterEffectsEmptySearch.scala renamed to src/main/scala/algoliasearch/abtesting/EmptySearchFilter.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ package algoliasearch.abtesting
3030
* @param trackedSearchesCount
3131
* Number of tracked searches removed from the A/B test.
3232
*/
33-
case class FilterEffectsEmptySearch(
33+
case class EmptySearchFilter(
3434
usersCount: Option[Int] = scala.None,
3535
trackedSearchesCount: Option[Int] = scala.None
3636
)

src/main/scala/algoliasearch/abtesting/FilterEffects.scala

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,6 @@ package algoliasearch.abtesting
2626
/** A/B test filter effects resulting from configuration settings.
2727
*/
2828
case class FilterEffects(
29-
outliers: Option[FilterEffectsOutliers] = scala.None,
30-
emptySearch: Option[FilterEffectsEmptySearch] = scala.None
29+
outliers: Option[OutliersFilter] = scala.None,
30+
emptySearch: Option[EmptySearchFilter] = scala.None
3131
)

src/main/scala/algoliasearch/abtesting/FilterEffectsOutliers.scala renamed to src/main/scala/algoliasearch/abtesting/OutliersFilter.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ package algoliasearch.abtesting
3030
* @param trackedSearchesCount
3131
* Number of tracked searches removed from the A/B test.
3232
*/
33-
case class FilterEffectsOutliers(
33+
case class OutliersFilter(
3434
usersCount: Option[Int] = scala.None,
3535
trackedSearchesCount: Option[Int] = scala.None
3636
)

src/main/scala/algoliasearch/analytics/ClickPositionsInner.scala renamed to src/main/scala/algoliasearch/analytics/ClickPosition.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ package algoliasearch.analytics
3131
* @param clickCount
3232
* Number of times this search has been clicked at that position.
3333
*/
34-
case class ClickPositionsInner(
34+
case class ClickPosition(
3535
position: Option[Seq[Int]] = scala.None,
3636
clickCount: Option[Int] = scala.None
3737
)

src/main/scala/algoliasearch/analytics/GetClickPositionsResponse.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,5 +29,5 @@ package algoliasearch.analytics
2929
* List of positions in the search results and clicks associated with this search.
3030
*/
3131
case class GetClickPositionsResponse(
32-
positions: Seq[ClickPositionsInner]
32+
positions: Seq[ClickPosition]
3333
)

src/main/scala/algoliasearch/analytics/TopSearchWithAnalytics.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ case class TopSearchWithAnalytics(
5454
count: Int,
5555
clickThroughRate: Option[Double] = scala.None,
5656
averageClickPosition: Option[Double] = scala.None,
57-
clickPositions: Seq[ClickPositionsInner],
57+
clickPositions: Seq[ClickPosition],
5858
conversionRate: Option[Double] = scala.None,
5959
trackedSearchCount: Int,
6060
clickCount: Int,

src/main/scala/algoliasearch/analytics/TopSearchWithRevenueAnalytics.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ case class TopSearchWithRevenueAnalytics(
6666
count: Int,
6767
clickThroughRate: Option[Double] = scala.None,
6868
averageClickPosition: Option[Double] = scala.None,
69-
clickPositions: Seq[ClickPositionsInner],
69+
clickPositions: Seq[ClickPosition],
7070
conversionRate: Option[Double] = scala.None,
7171
trackedSearchCount: Int,
7272
clickCount: Int,

src/main/scala/algoliasearch/api/MonitoringClient.scala

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@
33
*/
44
package algoliasearch.api
55

6+
import algoliasearch.monitoring.BadRequest
67
import algoliasearch.monitoring.ErrorBase
7-
import algoliasearch.monitoring.GetServers403Response
8+
import algoliasearch.monitoring.Forbidden
89
import algoliasearch.monitoring.IncidentsResponse
910
import algoliasearch.monitoring.IndexingTimeResponse
1011
import algoliasearch.monitoring.InfrastructureResponse
@@ -13,6 +14,7 @@ import algoliasearch.monitoring.LatencyResponse
1314
import algoliasearch.monitoring.Metric._
1415
import algoliasearch.monitoring.Period._
1516
import algoliasearch.monitoring.StatusResponse
17+
import algoliasearch.monitoring.Unauthorized
1618
import algoliasearch.monitoring._
1719
import algoliasearch.ApiClient
1820
import algoliasearch.api.MonitoringClient.hosts

src/main/scala/algoliasearch/api/QuerySuggestionsClient.scala

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44
package algoliasearch.api
55

66
import algoliasearch.querysuggestions.BaseResponse
7+
import algoliasearch.querysuggestions.ConfigStatus
78
import algoliasearch.querysuggestions.Configuration
89
import algoliasearch.querysuggestions.ConfigurationResponse
910
import algoliasearch.querysuggestions.ConfigurationWithIndex
1011
import algoliasearch.querysuggestions.ErrorBase
11-
import algoliasearch.querysuggestions.GetConfigStatus200Response
12-
import algoliasearch.querysuggestions.GetLogFile200Response
12+
import algoliasearch.querysuggestions.LogFile
1313
import algoliasearch.querysuggestions._
1414
import algoliasearch.ApiClient
1515
import algoliasearch.api.QuerySuggestionsClient.hosts
@@ -263,15 +263,15 @@ class QuerySuggestionsClient(
263263
*/
264264
def getConfigStatus(indexName: String, requestOptions: Option[RequestOptions] = None)(implicit
265265
ec: ExecutionContext
266-
): Future[GetConfigStatus200Response] = Future {
266+
): Future[ConfigStatus] = Future {
267267
requireNotNull(indexName, "Parameter `indexName` is required when calling `getConfigStatus`.")
268268

269269
val request = HttpRequest
270270
.builder()
271271
.withMethod("GET")
272272
.withPath(s"/1/configs/${escape(indexName)}/status")
273273
.build()
274-
execute[GetConfigStatus200Response](request, requestOptions)
274+
execute[ConfigStatus](request, requestOptions)
275275
}
276276

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

290290
val request = HttpRequest
291291
.builder()
292292
.withMethod("GET")
293293
.withPath(s"/1/logs/${escape(indexName)}")
294294
.build()
295-
execute[GetLogFile200Response](request, requestOptions)
295+
execute[LogFile](request, requestOptions)
296296
}
297297

298298
/** Updates a QuerySuggestions configuration.

src/main/scala/algoliasearch/api/UsageClient.scala

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@
44
package algoliasearch.api
55

66
import algoliasearch.usage.ErrorBase
7-
import algoliasearch.usage.GetUsage200Response
8-
import algoliasearch.usage.GetUsage400Response
7+
import algoliasearch.usage.Forbidden
98
import algoliasearch.usage.Granularity._
9+
import algoliasearch.usage.IndexUsage
10+
import algoliasearch.usage.InvalidRequest
1011
import algoliasearch.usage.Statistic._
1112
import algoliasearch.usage._
1213
import algoliasearch.ApiClient
@@ -273,7 +274,7 @@ class UsageClient(
273274
endDate: String,
274275
granularity: Option[Granularity] = None,
275276
requestOptions: Option[RequestOptions] = None
276-
)(implicit ec: ExecutionContext): Future[GetUsage200Response] = Future {
277+
)(implicit ec: ExecutionContext): Future[IndexUsage] = Future {
277278
requireNotNull(statistic, "Parameter `statistic` is required when calling `getIndexUsage`.")
278279
requireNotNull(indexName, "Parameter `indexName` is required when calling `getIndexUsage`.")
279280
requireNotNull(startDate, "Parameter `startDate` is required when calling `getIndexUsage`.")
@@ -287,7 +288,7 @@ class UsageClient(
287288
.withQueryParameter("endDate", endDate)
288289
.withQueryParameter("granularity", granularity)
289290
.build()
290-
execute[GetUsage200Response](request, requestOptions)
291+
execute[IndexUsage](request, requestOptions)
291292
}
292293

293294
/** Retrieves usage statistics evaluated over a specified period.
@@ -393,7 +394,7 @@ class UsageClient(
393394
endDate: String,
394395
granularity: Option[Granularity] = None,
395396
requestOptions: Option[RequestOptions] = None
396-
)(implicit ec: ExecutionContext): Future[GetUsage200Response] = Future {
397+
)(implicit ec: ExecutionContext): Future[IndexUsage] = Future {
397398
requireNotNull(statistic, "Parameter `statistic` is required when calling `getUsage`.")
398399
requireNotNull(startDate, "Parameter `startDate` is required when calling `getUsage`.")
399400
requireNotNull(endDate, "Parameter `endDate` is required when calling `getUsage`.")
@@ -406,7 +407,7 @@ class UsageClient(
406407
.withQueryParameter("endDate", endDate)
407408
.withQueryParameter("granularity", granularity)
408409
.build()
409-
execute[GetUsage200Response](request, requestOptions)
410+
execute[IndexUsage](request, requestOptions)
410411
}
411412

412413
}

src/main/scala/algoliasearch/ingestion/DockerStreamsInput.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
*/
2424
package algoliasearch.ingestion
2525

26-
/** DockerStreamsInput
26+
/** The selected streams of a singer or airbyte connector.
2727
*/
2828
case class DockerStreamsInput(
2929
streams: Any

src/main/scala/algoliasearch/ingestion/TransformationTryResponseError.scala renamed to src/main/scala/algoliasearch/ingestion/TransformationError.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ package algoliasearch.ingestion
3030
* @param message
3131
* A descriptive message explaining the failure.
3232
*/
33-
case class TransformationTryResponseError(
33+
case class TransformationError(
3434
code: Option[Int] = scala.None,
3535
message: Option[String] = scala.None
3636
)

src/main/scala/algoliasearch/ingestion/TransformationTryResponse.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,5 @@ package algoliasearch.ingestion
3030
*/
3131
case class TransformationTryResponse(
3232
payloads: Seq[Any],
33-
error: Option[TransformationTryResponseError] = scala.None
33+
error: Option[TransformationError] = scala.None
3434
)

src/main/scala/algoliasearch/monitoring/GetServers403Response.scala renamed to src/main/scala/algoliasearch/monitoring/BadRequest.scala

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
*/
1919
package algoliasearch.monitoring
2020

21-
/** GetServers403Response
21+
/** BadRequest
2222
*/
23-
case class GetServers403Response(
23+
case class BadRequest(
2424
reason: Option[String] = scala.None
2525
)

src/main/scala/algoliasearch/monitoring/LatencyResponseMetrics.scala renamed to src/main/scala/algoliasearch/monitoring/Forbidden.scala

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
*/
1919
package algoliasearch.monitoring
2020

21-
/** LatencyResponseMetrics
21+
/** Forbidden
2222
*/
23-
case class LatencyResponseMetrics(
24-
latency: Option[Map[String, Seq[TimeInner]]] = scala.None
23+
case class Forbidden(
24+
reason: Option[String] = scala.None
2525
)

src/main/scala/algoliasearch/monitoring/IncidentsInner.scala renamed to src/main/scala/algoliasearch/monitoring/IncidentEntry.scala

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@
1818
*/
1919
package algoliasearch.monitoring
2020

21-
/** IncidentsInner
21+
/** IncidentEntry
2222
*
2323
* @param t
2424
* Timestamp, measured in milliseconds since the Unix epoch.
2525
*/
26-
case class IncidentsInner(
26+
case class IncidentEntry(
2727
t: Option[Long] = scala.None,
2828
v: Option[Incident] = scala.None
2929
)

src/main/scala/algoliasearch/monitoring/IncidentsResponse.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,5 @@ package algoliasearch.monitoring
2121
/** IncidentsResponse
2222
*/
2323
case class IncidentsResponse(
24-
incidents: Option[Map[String, Seq[IncidentsInner]]] = scala.None
24+
incidents: Option[Map[String, Seq[IncidentEntry]]] = scala.None
2525
)

src/main/scala/algoliasearch/monitoring/IndexingTimeResponseMetrics.scala renamed to src/main/scala/algoliasearch/monitoring/IndexingMetric.scala

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
*/
1919
package algoliasearch.monitoring
2020

21-
/** IndexingTimeResponseMetrics
21+
/** IndexingMetric
2222
*/
23-
case class IndexingTimeResponseMetrics(
24-
indexing: Option[Map[String, Seq[TimeInner]]] = scala.None
23+
case class IndexingMetric(
24+
indexing: Option[Map[String, Seq[TimeEntry]]] = scala.None
2525
)

src/main/scala/algoliasearch/monitoring/IndexingTimeResponse.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,5 @@ package algoliasearch.monitoring
2121
/** IndexingTimeResponse
2222
*/
2323
case class IndexingTimeResponse(
24-
metrics: Option[IndexingTimeResponseMetrics] = scala.None
24+
metrics: Option[IndexingMetric] = scala.None
2525
)

src/main/scala/algoliasearch/monitoring/InfrastructureResponse.scala

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

src/main/scala/algoliasearch/monitoring/LatencyResponse.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,5 @@ package algoliasearch.monitoring
2121
/** LatencyResponse
2222
*/
2323
case class LatencyResponse(
24-
metrics: Option[LatencyResponseMetrics] = scala.None
24+
metrics: Option[LatencyMetric] = scala.None
2525
)

src/main/scala/algoliasearch/monitoring/InfrastructureResponseMetrics.scala renamed to src/main/scala/algoliasearch/monitoring/Metrics.scala

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
*/
1919
package algoliasearch.monitoring
2020

21-
/** InfrastructureResponseMetrics
21+
/** Metrics
2222
*
2323
* @param cpuUsage
2424
* CPU idleness in %.
@@ -32,7 +32,7 @@ package algoliasearch.monitoring
3232
* @param avgBuildTime
3333
* Average build time of the indices in seconds.
3434
*/
35-
case class InfrastructureResponseMetrics(
35+
case class Metrics(
3636
cpuUsage: Option[Map[String, Seq[ProbesMetric]]] = scala.None,
3737
ramIndexingUsage: Option[Map[String, Seq[ProbesMetric]]] = scala.None,
3838
ramSearchUsage: Option[Map[String, Seq[ProbesMetric]]] = scala.None,

src/main/scala/algoliasearch/monitoring/TimeInner.scala renamed to src/main/scala/algoliasearch/monitoring/TimeEntry.scala

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,14 @@
1818
*/
1919
package algoliasearch.monitoring
2020

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

src/main/scala/algoliasearch/querysuggestions/GetConfigStatus200Response.scala renamed to src/main/scala/algoliasearch/querysuggestions/ConfigStatus.scala

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
*/
2323
package algoliasearch.querysuggestions
2424

25-
/** GetConfigStatus200Response
25+
/** ConfigStatus
2626
*
2727
* @param indexName
2828
* Name of the Query Suggestions index (case-sensitive).
@@ -35,7 +35,7 @@ package algoliasearch.querysuggestions
3535
* @param lastSuccessfulBuildDuration
3636
* Duration of the last successful build in seconds.
3737
*/
38-
case class GetConfigStatus200Response(
38+
case class ConfigStatus(
3939
indexName: Option[String] = scala.None,
4040
isRunning: Option[Boolean] = scala.None,
4141
lastBuiltAt: Option[String] = scala.None,

0 commit comments

Comments
 (0)