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 <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>
  • Loading branch information
algolia-bot and millotp committed Jul 30, 2024
1 parent a391d7c commit 3f597aa
Show file tree
Hide file tree
Showing 44 changed files with 139 additions and 69 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ public class QuerySuggestionsClient(
* @param indexName Query Suggestions index name.
* @param requestOptions additional request configuration.
*/
public suspend fun getConfigStatus(indexName: String, requestOptions: RequestOptions? = null): GetConfigStatus200Response {
public suspend fun getConfigStatus(indexName: String, requestOptions: RequestOptions? = null): ConfigStatus {
require(indexName.isNotBlank()) { "Parameter `indexName` is required when calling `getConfigStatus`." }
val requestConfig = RequestConfig(
method = RequestMethod.GET,
Expand All @@ -222,7 +222,7 @@ public class QuerySuggestionsClient(
* @param indexName Query Suggestions index name.
* @param requestOptions additional request configuration.
*/
public suspend fun getLogFile(indexName: String, requestOptions: RequestOptions? = null): GetLogFile200Response {
public suspend fun getLogFile(indexName: String, requestOptions: RequestOptions? = null): LogFile {
require(indexName.isNotBlank()) { "Parameter `indexName` is required when calling `getLogFile`." }
val requestConfig = RequestConfig(
method = RequestMethod.GET,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ public class UsageClient(
* @param granularity Granularity of the aggregated metrics. - `hourly`: the maximum time range for hourly metrics is 7 days. - `daily`: the maximum time range for daily metrics is 365 days. (default to daily)
* @param requestOptions additional request configuration.
*/
public suspend fun getIndexUsage(statistic: Statistic, indexName: String, startDate: String, endDate: String, granularity: Granularity? = null, requestOptions: RequestOptions? = null): GetUsage200Response {
public suspend fun getIndexUsage(statistic: Statistic, indexName: String, startDate: String, endDate: String, granularity: Granularity? = null, requestOptions: RequestOptions? = null): IndexUsage {
require(indexName.isNotBlank()) { "Parameter `indexName` is required when calling `getIndexUsage`." }
require(startDate.isNotBlank()) { "Parameter `startDate` is required when calling `getIndexUsage`." }
require(endDate.isNotBlank()) { "Parameter `endDate` is required when calling `getIndexUsage`." }
Expand All @@ -155,7 +155,7 @@ public class UsageClient(
* @param granularity Granularity of the aggregated metrics. - `hourly`: the maximum time range for hourly metrics is 7 days. - `daily`: the maximum time range for daily metrics is 365 days. (default to daily)
* @param requestOptions additional request configuration.
*/
public suspend fun getUsage(statistic: Statistic, startDate: String, endDate: String, granularity: Granularity? = null, requestOptions: RequestOptions? = null): GetUsage200Response {
public suspend fun getUsage(statistic: Statistic, startDate: String, endDate: String, granularity: Granularity? = null, requestOptions: RequestOptions? = null): IndexUsage {
require(startDate.isNotBlank()) { "Parameter `startDate` is required when calling `getUsage`." }
require(endDate.isNotBlank()) { "Parameter `endDate` is required when calling `getUsage`." }
val requestConfig = RequestConfig(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import kotlinx.serialization.json.*
* @param trackedSearchesCount Number of tracked searches removed from the A/B test.
*/
@Serializable
public data class FilterEffectsEmptySearch(
public data class EmptySearchFilter(

/** Number of users removed from the A/B test. */
@SerialName(value = "usersCount") val usersCount: Int? = null,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import kotlinx.serialization.json.*
@Serializable
public data class FilterEffects(

@SerialName(value = "outliers") val outliers: FilterEffectsOutliers? = null,
@SerialName(value = "outliers") val outliers: OutliersFilter? = null,

@SerialName(value = "emptySearch") val emptySearch: FilterEffectsEmptySearch? = null,
@SerialName(value = "emptySearch") val emptySearch: EmptySearchFilter? = null,
)
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import kotlinx.serialization.json.*
* @param trackedSearchesCount Number of tracked searches removed from the A/B test.
*/
@Serializable
public data class FilterEffectsOutliers(
public data class OutliersFilter(

/** Number of users removed from the A/B test. */
@SerialName(value = "usersCount") val usersCount: Int? = null,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import kotlinx.serialization.json.*
* @param clickCount Number of times this search has been clicked at that position.
*/
@Serializable
public data class ClickPositionsInner(
public data class ClickPosition(

/** Range of positions in the search results, using the pattern `[start,end]`. For positions 11 and up, click events are summed over the specified range. `-1` indicates the end of the list of search results. */
@SerialName(value = "position") val position: List<Int>? = null,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,5 @@ import kotlinx.serialization.json.*
public data class GetClickPositionsResponse(

/** List of positions in the search results and clicks associated with this search. */
@SerialName(value = "positions") val positions: List<ClickPositionsInner>,
@SerialName(value = "positions") val positions: List<ClickPosition>,
)
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public data class TopSearchWithAnalytics(
@SerialName(value = "averageClickPosition") val averageClickPosition: Double,

/** List of positions in the search results and clicks associated with this search. */
@SerialName(value = "clickPositions") val clickPositions: List<ClickPositionsInner>,
@SerialName(value = "clickPositions") val clickPositions: List<ClickPosition>,

/** Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. */
@SerialName(value = "conversionRate") val conversionRate: Double,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ public data class TopSearchWithRevenueAnalytics(
@SerialName(value = "averageClickPosition") val averageClickPosition: Double,

/** List of positions in the search results and clicks associated with this search. */
@SerialName(value = "clickPositions") val clickPositions: List<ClickPositionsInner>,
@SerialName(value = "clickPositions") val clickPositions: List<ClickPosition>,

/** Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true. */
@SerialName(value = "conversionRate") val conversionRate: Double,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import kotlinx.serialization.*
import kotlinx.serialization.json.*

/**
* DockerStreamsInput
* The selected streams of a singer or airbyte connector.
*
* @param streams
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import kotlinx.serialization.json.*
* @param message A descriptive message explaining the failure.
*/
@Serializable
public data class TransformationTryResponseError(
public data class TransformationError(

/** The error status code. */
@SerialName(value = "code") val code: Int? = null,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,5 @@ public data class TransformationTryResponse(
/** The array of records returned by the transformation service. */
@SerialName(value = "payloads") val payloads: List<JsonObject>,

@SerialName(value = "error") val error: TransformationTryResponseError? = null,
@SerialName(value = "error") val error: TransformationError? = null,
)
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ import kotlinx.serialization.*
import kotlinx.serialization.json.*

/**
* GetServers403Response
* BadRequest
*
* @param reason
*/
@Serializable
public data class GetServers403Response(
public data class BadRequest(

@SerialName(value = "reason") val reason: String? = null,
)
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
/** Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT. */
package com.algolia.client.model.monitoring

import kotlinx.serialization.*
import kotlinx.serialization.json.*

/**
* Forbidden
*
* @param reason
*/
@Serializable
public data class Forbidden(

@SerialName(value = "reason") val reason: String? = null,
)
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ import kotlinx.serialization.*
import kotlinx.serialization.json.*

/**
* IncidentsInner
* IncidentEntry
*
* @param t Timestamp, measured in milliseconds since the Unix epoch.
* @param v
*/
@Serializable
public data class IncidentsInner(
public data class IncidentEntry(

/** Timestamp, measured in milliseconds since the Unix epoch. */
@SerialName(value = "t") val t: Long? = null,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ import kotlinx.serialization.json.*
@Serializable
public data class IncidentsResponse(

@SerialName(value = "incidents") val incidents: Map<kotlin.String, List<IncidentsInner>>? = null,
@SerialName(value = "incidents") val incidents: Map<kotlin.String, List<IncidentEntry>>? = null,
)
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ import kotlinx.serialization.*
import kotlinx.serialization.json.*

/**
* IndexingTimeResponseMetrics
* IndexingMetric
*
* @param indexing
*/
@Serializable
public data class IndexingTimeResponseMetrics(
public data class IndexingMetric(

@SerialName(value = "indexing") val indexing: Map<kotlin.String, List<TimeInner>>? = null,
@SerialName(value = "indexing") val indexing: Map<kotlin.String, List<TimeEntry>>? = null,
)
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ import kotlinx.serialization.json.*
@Serializable
public data class IndexingTimeResponse(

@SerialName(value = "metrics") val metrics: IndexingTimeResponseMetrics? = null,
@SerialName(value = "metrics") val metrics: IndexingMetric? = null,
)
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ import kotlinx.serialization.json.*
@Serializable
public data class InfrastructureResponse(

@SerialName(value = "metrics") val metrics: InfrastructureResponseMetrics? = null,
@SerialName(value = "metrics") val metrics: Metrics? = null,
)
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ import kotlinx.serialization.*
import kotlinx.serialization.json.*

/**
* LatencyResponseMetrics
* LatencyMetric
*
* @param latency
*/
@Serializable
public data class LatencyResponseMetrics(
public data class LatencyMetric(

@SerialName(value = "latency") val latency: Map<kotlin.String, List<TimeInner>>? = null,
@SerialName(value = "latency") val latency: Map<kotlin.String, List<TimeEntry>>? = null,
)
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ import kotlinx.serialization.json.*
@Serializable
public data class LatencyResponse(

@SerialName(value = "metrics") val metrics: LatencyResponseMetrics? = null,
@SerialName(value = "metrics") val metrics: LatencyMetric? = null,
)
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import kotlinx.serialization.*
import kotlinx.serialization.json.*

/**
* InfrastructureResponseMetrics
* Metrics
*
* @param cpuUsage CPU idleness in %.
* @param ramIndexingUsage RAM used for indexing in MB.
Expand All @@ -14,7 +14,7 @@ import kotlinx.serialization.json.*
* @param avgBuildTime Average build time of the indices in seconds.
*/
@Serializable
public data class InfrastructureResponseMetrics(
public data class Metrics(

/** CPU idleness in %. */
@SerialName(value = "cpu_usage") val cpuUsage: Map<kotlin.String, List<ProbesMetric>>? = null,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ import kotlinx.serialization.*
import kotlinx.serialization.json.*

/**
* TimeInner
* TimeEntry
*
* @param t Timestamp, measured in milliseconds since the Unix epoch.
* @param v Time in ms.
*/
@Serializable
public data class TimeInner(
public data class TimeEntry(

/** Timestamp, measured in milliseconds since the Unix epoch. */
@SerialName(value = "t") val t: Long? = null,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
/** Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT. */
package com.algolia.client.model.monitoring

import kotlinx.serialization.*
import kotlinx.serialization.json.*

/**
* Unauthorized
*
* @param reason
*/
@Serializable
public data class Unauthorized(

@SerialName(value = "reason") val reason: String? = null,
)
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import kotlinx.serialization.*
import kotlinx.serialization.json.*

/**
* GetConfigStatus200Response
* ConfigStatus
*
* @param indexName Name of the Query Suggestions index (case-sensitive).
* @param isRunning Whether the creation or update of the Query Suggestions index is in progress.
Expand All @@ -14,7 +14,7 @@ import kotlinx.serialization.json.*
* @param lastSuccessfulBuildDuration Duration of the last successful build in seconds.
*/
@Serializable
public data class GetConfigStatus200Response(
public data class ConfigStatus(

/** Name of the Query Suggestions index (case-sensitive). */
@SerialName(value = "indexName") val indexName: String? = null,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ import kotlinx.serialization.*
import kotlinx.serialization.json.*

/**
* GetLogFile200Response
* LogFile
*
* @param timestamp Date and time of the log entry, in RFC 3339 format.
* @param level
* @param message Details about this log entry.
* @param contextLevel Level indicating the position of a suggestion in a hierarchy of records. For example, a `contextLevel` of 1 indicates that this suggestion belongs to a previous suggestion with `contextLevel` 0.
*/
@Serializable
public data class GetLogFile200Response(
public data class LogFile(

/** Date and time of the log entry, in RFC 3339 format. */
@SerialName(value = "timestamp") val timestamp: String? = null,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import kotlin.jvm.JvmInline
*
* Implementations:
* - [Int] - *[AroundPrecision.of]*
* - [List<AroundPrecisionFromValueInner>] - *[AroundPrecision.of]*
* - [List<Range>] - *[AroundPrecision.of]*
*/
@Serializable(AroundPrecisionSerializer::class)
public sealed interface AroundPrecision {
Expand All @@ -25,15 +25,15 @@ public sealed interface AroundPrecision {

@Serializable
@JvmInline
public value class ListOfAroundPrecisionFromValueInnerValue(public val value: List<AroundPrecisionFromValueInner>) : AroundPrecision
public value class ListOfRangeValue(public val value: List<Range>) : AroundPrecision

public companion object {

public fun of(value: Int): AroundPrecision {
return IntValue(value)
}
public fun of(value: List<AroundPrecisionFromValueInner>): AroundPrecision {
return ListOfAroundPrecisionFromValueInnerValue(value)
public fun of(value: List<Range>): AroundPrecision {
return ListOfRangeValue(value)
}
}
}
Expand All @@ -42,7 +42,7 @@ internal class AroundPrecisionSerializer : JsonContentPolymorphicSerializer<Arou
override fun selectDeserializer(element: JsonElement): DeserializationStrategy<AroundPrecision> {
return when {
element.isInt -> AroundPrecision.IntValue.serializer()
element.isJsonArrayOfObjects -> AroundPrecision.ListOfAroundPrecisionFromValueInnerValue.serializer()
element.isJsonArrayOfObjects -> AroundPrecision.ListOfRangeValue.serializer()
else -> throw AlgoliaClientException("Failed to deserialize json element: $element")
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import kotlinx.serialization.json.*
* @param `value` Upper boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
*/
@Serializable
public data class AroundPrecisionFromValueInner(
public data class Range(

/** Lower boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal. */
@SerialName(value = "from") val from: Int? = null,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import kotlinx.serialization.json.*
@Serializable
public data class RecommendRule(

@SerialName(value = "_metadata") val metadata: RecommendRuleMetadata? = null,
@SerialName(value = "_metadata") val metadata: RuleMetadata? = null,

/** Unique identifier of a rule object. */
@SerialName(value = "objectID") val objectID: String? = null,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import kotlinx.serialization.json.*
* @param ruleObjectID
*/
@Serializable
public data class RedirectRuleIndexMetadataData(
public data class RedirectRuleIndexData(

@SerialName(value = "ruleObjectID") val ruleObjectID: String,
)
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,5 @@ public data class RedirectRuleIndexMetadata(
/** Redirect rule status. */
@SerialName(value = "succeed") val succeed: Boolean,

@SerialName(value = "data") val `data`: RedirectRuleIndexMetadataData,
@SerialName(value = "data") val `data`: RedirectRuleIndexData,
)
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import kotlinx.serialization.json.*
* @param lastUpdate Date and time when the object was updated, in RFC 3339 format.
*/
@Serializable
public data class RecommendRuleMetadata(
public data class RuleMetadata(

/** Date and time when the object was updated, in RFC 3339 format. */
@SerialName(value = "lastUpdate") val lastUpdate: String? = null,
Expand Down
Loading

0 comments on commit 3f597aa

Please sign in to comment.