Add DefaultValueHook for setting default operation parameter values (#…

…270)

.editorconfig

@@ -4,6 +4,7 @@ root = true
 insert_final_newline = true
 end_of_line = lf
 max_line_length = 120
+trim_trailing_whitespace = true
 
 [{*.kts,*.kt}]
 charset = utf-8
@@ -14,3 +15,6 @@ tab_width = 4
 charset = utf-8
 indent_style = tab
 tab_width = 4
+
+[*.md]
+trim_trailing_whitespace = false

jellyfin-api/src/main/kotlin-generated/org/jellyfin/sdk/api/operations/MediaInfoApi.kt

@@ -86,7 +86,7 @@ public class MediaInfoApi(
 
 	/**
 	 * For backwards compatibility parameters can be sent via Query or Body, with Query having higher
-	 * precedence.
+	 * precedence.
 	 * Query parameters are obsolete.
 	 *
 	 * @param itemId The item id.
@@ -103,7 +103,7 @@ public class MediaInfoApi(
 
 	/**
 	 * For backwards compatibility parameters can be sent via Query or Body, with Query having higher
-	 * precedence.
+	 * precedence.
 	 * Query parameters are obsolete.
 	 *
 	 * @param itemId The item id.

jellyfin-api/src/main/kotlin-generated/org/jellyfin/sdk/api/operations/PlaylistsApi.kt

@@ -49,7 +49,7 @@ public class PlaylistsApi(
 
 	/**
 	 * For backwards compatibility parameters can be sent via Query or Body, with Query having higher
-	 * precedence.
+	 * precedence.
 	 * Query parameters are obsolete.
 	 */
 	public suspend fun createPlaylist(`data`: CreatePlaylistDto? = null):
@@ -63,7 +63,7 @@ public class PlaylistsApi(
 
 	/**
 	 * For backwards compatibility parameters can be sent via Query or Body, with Query having higher
-	 * precedence.
+	 * precedence.
 	 * Query parameters are obsolete.
 	 *
 	 * @param name The playlist name.

openapi-generator/README.md

@@ -8,8 +8,8 @@ Changes to the http client can thus be made without updating the generator.
 
 The generator uses a special hook system to change the generated code to better suite the Kotlin
 language. For example, the "ImageBlurHashes" property in BaseItemDto can be simplified by using a
-Map, and therefor a hook is added for it. All these hooks need to be maintained and updated when the
-OpenAPI specification changes.
+Map, and thus a hook is added for it. All hooks need to be maintained and updated when the OpenAPI
+specification changes.
 
 ## Running
 
@@ -61,6 +61,11 @@ Hooks are classes that will modify the output of the generator. They should be r
     used to fix spelling, moving operations to different services or adding operations to additional
     services.
 
+  - **DefaultValueHook**  
+    A hook that allows changing the default value of parameters in operations. The hook returns an
+    instance of `CustomDefaultValue` that contains the code builder. The generator will use the
+    default value from the JSON schema if all hooks return null.
+
 ## Phases
 
 The conversion happens in multiple phases. The phases in order are:

openapi-generator/src/main/kotlin/org/jellyfin/openapi/MainModule.kt

@@ -21,7 +21,7 @@ val mainModule = module {
 	single { OpenApiTypeBuilder(getAll()) }
 	single { OpenApiReturnTypeBuilder(get()) }
 	single { OpenApiModelBuilder(get(), get()) }
-	single { OpenApiApiServicesBuilder(get(), get(), get(), getAll()) }
+	single { OpenApiApiServicesBuilder(get(), get(), get(), getAll(), getAll()) }
 	single { OpenApiConstantsBuilder() }
 
 	// API

openapi-generator/src/main/kotlin/org/jellyfin/openapi/builder/api/OperationBuilder.kt

@@ -9,6 +9,7 @@ import org.jellyfin.openapi.constants.Packages
 import org.jellyfin.openapi.constants.Strings
 import org.jellyfin.openapi.model.ApiServiceOperation
 import org.jellyfin.openapi.model.ApiServiceOperationParameter
+import org.jellyfin.openapi.model.CustomDefaultValue
 
 open class OperationBuilder(
 	private val deprecatedAnnotationSpecBuilder: DeprecatedAnnotationSpecBuilder,
@@ -40,6 +41,7 @@ open class OperationBuilder(
 			is String -> defaultValue("%S", data.defaultValue)
 			is Int -> defaultValue("%L", data.defaultValue)
 			is Boolean -> defaultValue("%L", data.defaultValue)
+			is CustomDefaultValue -> defaultValue(data.defaultValue.build())
 			// Set value to null by default for nullable values
 			null -> when {
 				typeClassName == List::class.asClassName() -> defaultValue("%N()", "emptyList")

openapi-generator/src/main/kotlin/org/jellyfin/openapi/builder/openapi/OpenApiApiServicesBuilder.kt

@@ -1,9 +1,11 @@
 package org.jellyfin.openapi.builder.openapi
 
+import com.squareup.kotlinpoet.TypeName
 import com.squareup.kotlinpoet.asTypeName
 import io.swagger.v3.oas.models.Operation
 import io.swagger.v3.oas.models.PathItem
 import io.swagger.v3.oas.models.Paths
+import io.swagger.v3.oas.models.parameters.Parameter
 import net.pearx.kasechange.CaseFormat
 import net.pearx.kasechange.toCamelCase
 import org.jellyfin.openapi.OpenApiGeneratorError
@@ -13,17 +15,16 @@ import org.jellyfin.openapi.constants.MimeType
 import org.jellyfin.openapi.constants.Security
 import org.jellyfin.openapi.constants.Strings
 import org.jellyfin.openapi.hooks.ApiTypePath
+import org.jellyfin.openapi.hooks.DefaultValueHook
 import org.jellyfin.openapi.hooks.ServiceNameHook
-import org.jellyfin.openapi.model.ApiService
-import org.jellyfin.openapi.model.ApiServiceOperation
-import org.jellyfin.openapi.model.ApiServiceOperationParameter
-import org.jellyfin.openapi.model.HttpMethod
+import org.jellyfin.openapi.model.*
 
 class OpenApiApiServicesBuilder(
 	private val apiNameBuilder: ApiNameBuilder,
 	private val openApiTypeBuilder: OpenApiTypeBuilder,
 	private val openApiReturnTypeBuilder: OpenApiReturnTypeBuilder,
 	private val serviceNameHooks: Collection<ServiceNameHook>,
+	private val defaultValueHooks: Collection<DefaultValueHook>,
 ) : Builder<Paths, Collection<ApiService>> {
 	private fun getMethod(method: PathItem.HttpMethod) = when (method) {
 		PathItem.HttpMethod.POST -> HttpMethod.POST
@@ -42,6 +43,13 @@ class OpenApiApiServicesBuilder(
 			hook.mapServiceNames(operation, serviceNames)
 		}
 
+	/**
+	 * Returns the default value of the first hook that does not return null or use the default from the schema
+	 */
+	private fun buildDefaultValue(path: ApiTypePath, type: TypeName, parameterSpec: Parameter) = defaultValueHooks
+		.firstNotNullOfOrNull { hook -> hook.onBuildDefaultValue(path, type, parameterSpec) }
+		?: parameterSpec.schema?.default
+
 	private fun buildOperation(
 		operation: Operation,
 		path: String,
@@ -59,6 +67,8 @@ class OpenApiApiServicesBuilder(
 				.build(ApiTypePath(serviceName, operationName, parameterName), parameterSpec.schema)
 				.copy(nullable = parameterSpec.required != true)
 
+			val parameterTypePath = ApiTypePath(serviceName, operationName, parameterName)
+
 			when (parameterSpec.`in`) {
 				"path" -> pathParameters
 				"query" -> queryParameters
@@ -67,7 +77,7 @@ class OpenApiApiServicesBuilder(
 				name = parameterName,
 				originalName = parameterSpec.name,
 				type = type,
-				defaultValue = parameterSpec.schema?.default,
+				defaultValue = buildDefaultValue(parameterTypePath, type, parameterSpec),
 				description = parameterSpec.description,
 				deprecated = parameterSpec.deprecated == true
 			)

openapi-generator/src/main/kotlin/org/jellyfin/openapi/hooks/DefaultValueHook.kt

@@ -0,0 +1,13 @@
+package org.jellyfin.openapi.hooks
+
+import com.squareup.kotlinpoet.TypeName
+import io.swagger.v3.oas.models.parameters.Parameter
+import org.jellyfin.openapi.model.CustomDefaultValue
+
+interface DefaultValueHook {
+	/**
+	 * Create a [CustomDefaultValue] to use when generating the code for this parameter.
+	 * Return `null` if the hook does not want to modify the default value.
+	 */
+	fun onBuildDefaultValue(path: ApiTypePath, type: TypeName, parameterSpec: Parameter): CustomDefaultValue?
+}

openapi-generator/src/main/kotlin/org/jellyfin/openapi/model/CustomDefaultValue.kt

@@ -0,0 +1,19 @@
+package org.jellyfin.openapi.model
+
+import com.squareup.kotlinpoet.CodeBlock
+
+/**
+ * Custom value builder used in hooks.
+ * The implementation should use a [CodeBlock.Builder] to create a value.
+ *
+ * Creating a default value with the integer 1 can be done with:
+ *
+ * ```kotlin
+ * CodeBlock.Builder()
+ * 	.add("1")
+ * 	.build()
+ * ```
+ */
+interface CustomDefaultValue {
+	fun build(): CodeBlock
+}