Class UserPreferencesSpecUtils

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.v1.utils.UserPreferencesSpecUtils

public final class UserPreferencesSpecUtils
extends Object

Shared contract and JSON handling for core preferences specs.

Method Summary

Modifier and Type	Method	Description
static List<Parameter>	actionParameters()	Action and section names come only from the URL path.
static RequestBody	actionRequestBody()	Publish the action body separately from PATCH.
static PreferenceActionRequestV1	readActionRequest(io.javalin.http.Context context)	Preserve unknown properties for core rejection.
static PreferenceSectionPatchRequestV1	readRequest(io.javalin.http.Context context)	Retain every property for core validation, and reject malformed or non-object JSON.
static RequestBody	requestBody()	JSON body referencing the published request schema.
static Map<String,Schema>	schemas()	Component schemas for generated clients.
static List<Parameter>	sectionParameters()	Section name comes only from the URL path.
static void	writeResponse(io.javalin.http.Context context, Object output)	Keep explicit nulls in the wire representation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

sectionParameters

public static List<Parameter> sectionParameters()

Section name comes only from the URL path.

schemas

public static Map<String,Schema> schemas()

Component schemas for generated clients.

requestBody

public static RequestBody requestBody()

JSON body referencing the published request schema.

readRequest

public static PreferenceSectionPatchRequestV1 readRequest(io.javalin.http.Context context)
                                                   throws QBadRequestException

Retain every property for core validation, and reject malformed or non-object JSON.

Throws:

QBadRequestException

writeResponse

public static void writeResponse(io.javalin.http.Context context,
 Object output)

Keep explicit nulls in the wire representation.

actionParameters

public static List<Parameter> actionParameters()

Action and section names come only from the URL path.

actionRequestBody

public static RequestBody actionRequestBody()

Publish the action body separately from PATCH.

readActionRequest

public static PreferenceActionRequestV1 readActionRequest(io.javalin.http.Context context)
                                                   throws QBadRequestException

Preserve unknown properties for core rejection.

Throws:

QBadRequestException