Class MiddlewareVersionV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractMiddlewareVersion

com.kingsrook.qqq.middleware.javalin.specs.v1.MiddlewareVersionV1

Direct Known Subclasses:

ApiAwareMiddlewareVersionV1

public class MiddlewareVersionV1
extends AbstractMiddlewareVersion

Version 1 of the QQQ UI API (`/qqq/v1`). Its semantic version (see docs/UI-API-CHANGELOG.md) is published as the OpenAPI info.version and by GET /qqq/v1/version.

Field Summary

Fields

Modifier and Type	Field	Description
static final List<String>	FEATURES	Optional core features, published by GET /version.
static final String	SEMANTIC_VERSION	The semantic version of the v1 UI API.

Fields inherited from class com.kingsrook.qqq.middleware.javalin.specs.AbstractMiddlewareVersion

LOG

Constructor Summary

Constructors

Constructor	Description
MiddlewareVersionV1()

Method Summary

Modifier and Type	Method	Description
List<AbstractEndpointSpec<?,?,?>>	getEndpointSpecs()	hey - don't re-construct the endpoint-spec objects inside this method...
List<String>	getFeatures()	Core feature names this version supports, published by the version endpoint, so clients can toggle optional areas without probing.
String	getSemanticVersion()	The semantic version (MAJOR.MINOR.PATCH) of this version of the API, as published in the OpenAPI info.version.
String	getVersion()

Methods inherited from class com.kingsrook.qqq.middleware.javalin.specs.AbstractMiddlewareVersion

generateExtensionOpenAPIModel, generateOpenAPIModel, getAllEndpointSpecs, getDocumentationBasePaths, getExtensions, getJavalinEndpointGroup, getVersionBasePath, loadExtensions, preExecute, setQInstance, warnIfPathMethodAlreadyUsed

Methods inherited from class java.lang.Object

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

Field Details

SEMANTIC_VERSION

public static final String SEMANTIC_VERSION

The semantic version of the v1 UI API. Bump MINOR for additive changes and PATCH for fixes (UiApiContractTest enforces it); a breaking change needs a new URL version (/qqq/v2).

See Also:

• Constant Field Values

FEATURES

public static final List<String> FEATURES

Optional core features, published by GET /version.

Constructor Details

MiddlewareVersionV1

public MiddlewareVersionV1()

Method Details

getVersion

public String getVersion()

Specified by:

getVersion in class AbstractMiddlewareVersion

getSemanticVersion

public String getSemanticVersion()

Description copied from class: AbstractMiddlewareVersion

The semantic version (MAJOR.MINOR.PATCH) of this version of the API, as published in the OpenAPI info.version. MAJOR matches the URL version. See docs/UI-API-CHANGELOG.md for the rules. The default (for versions that predate semver) is the URL version itself.

Overrides:

getSemanticVersion in class AbstractMiddlewareVersion

getFeatures

public List<String> getFeatures()

Description copied from class: AbstractMiddlewareVersion

Core feature names this version supports, published by the version endpoint, so clients can toggle optional areas without probing.

Overrides:

getFeatures in class AbstractMiddlewareVersion

getEndpointSpecs

public List<AbstractEndpointSpec<?,?,?>> getEndpointSpecs()

Description copied from class: AbstractMiddlewareVersion

hey - don't re-construct the endpoint-spec objects inside this method...

Specified by:

getEndpointSpecs in class AbstractMiddlewareVersion