Class UiApiOperationIds

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.UiApiOperationIds

public class UiApiOperationIds
extends Object

OpenAPI operationIds of the UI API (`/qqq/v1`). Generated clients name their methods after these, so they are part of the contract: once released, an operationId never changes (UiApiContract fails the build if one does). Core operations have hand-chosen names (CORE). Any other operation (an extension's, or a new core one not yet named here) gets a name derived from its method and path (derive()), unless its spec sets one explicitly with BasicOperation.withOperationId. Do not rename an entry of CORE: add new ones only.

Constructor Summary

Constructors

Constructor	Description
UiApiOperationIds()

Method Summary

Modifier and Type	Method	Description
static String	derive(HttpMethod httpMethod, String path)	Derive an operationId: the lower-case method, then each path segment in camel case, with `{param}` segments as `By{Param}`.
static Map<String,String>	getCore()	The named core operations (`METHOD /path` -> operationId).
static String	of(HttpMethod httpMethod, String path)	The operationId for an operation (path relative to the version base, e.g.

Methods inherited from class java.lang.Object

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

Constructor Details

UiApiOperationIds

public UiApiOperationIds()

Method Details

of

public static String of(HttpMethod httpMethod,
 String path)

The operationId for an operation (path relative to the version base, e.g. `/table/{tableName}/query`).

derive

public static String derive(HttpMethod httpMethod,
 String path)

Derive an operationId: the lower-case method, then each path segment in camel case, with `{param}` segments as `By{Param}`. e.g. `GET /qbit/alerts/inbox/{id}` gives `getQbitAlertsInboxById`.

getCore

public static Map<String,String> getCore()

The named core operations (`METHOD /path` -> operationId).