Class ModelApiTableApisProvider

java.lang.Object

com.kingsrook.qqq.api.javalin.ModelApiTableApisProvider

All Implemented Interfaces:

TableApisProviderInterface

public class ModelApiTableApisProvider
extends Object
implements TableApisProviderInterface

The model APIs that expose a table, for the UI API's GET /qqq/v1/table/{tableName}/apis (registered through META-INF/services). Same selection as /apis.json?tableName=: every API instance whose table metadata includes the table and doesn't exclude it.

Nested Class Summary

Nested classes/interfaces inherited from interface com.kingsrook.qqq.middleware.javalin.specs.v1.TableApisProviderInterface

TableApisProviderInterface.TableApi, TableApisProviderInterface.TableApiVersion

Constructor Summary

Constructors

Constructor	Description
ModelApiTableApisProvider()

Method Summary

Modifier and Type	Method	Description
List<TableApisProviderInterface.TableApi>	getTableApis(QInstance qInstance, String tableName)	The APIs in this instance that expose the table (which exists, and which the caller may read).
Optional<String>	getTableSpecJson(QInstance qInstance, String apiName, String version, String tableName)	The table's document, as {api.path}{version}/{table}/openapi.json serves it - only for an API and version that getTableApis lists for the table.

Methods inherited from class java.lang.Object

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

Constructor Details

ModelApiTableApisProvider

public ModelApiTableApisProvider()

Method Details

getTableApis

public List<TableApisProviderInterface.TableApi> getTableApis(QInstance qInstance,
 String tableName)

Description copied from interface: TableApisProviderInterface

The APIs in this instance that expose the table (which exists, and which the caller may read).

Specified by:

getTableApis in interface TableApisProviderInterface

getTableSpecJson

public Optional<String> getTableSpecJson(QInstance qInstance,
 String apiName,
 String version,
 String tableName)
                                  throws Exception

The table's document, as {api.path}{version}/{table}/openapi.json serves it - only for an API and version that getTableApis lists for the table.

Specified by:

getTableSpecJson in interface TableApisProviderInterface

Throws:

Exception