com.hcl.domino.keep.dbrequests.data

Class GetOpenAPI

java.lang.Object

com.hcl.domino.keep.dbrequests.AsyncDominoJNX<io.vertx.core.json.JsonObject>

com.hcl.domino.keep.dbrequests.AsyncDominoJNXJson

com.hcl.domino.keep.dbrequests.data.GetOpenAPI

All Implemented Interfaces:

AsyncDominoBase<io.vertx.core.json.JsonObject>, KeepSubscriberInfo, io.reactivex.ObservableOnSubscribe<io.vertx.core.json.JsonObject>

@AllowOpenAccess(value=true)
public class GetOpenAPI
extends AsyncDominoJNXJson

Gets the OpenAPI spec for a KeepDatabase

Nested Class Summary

Nested classes/interfaces inherited from interface com.hcl.domino.keep.dbrequests.AsyncDominoBase

AsyncDominoBase.RequestType

Field Summary

Fields inherited from class com.hcl.domino.keep.dbrequests.AsyncDominoJNX

apiName, appTags, logger, requestParams, UNNEEDED_CALL, user, vertx

Constructor Summary

Constructors

Constructor and Description
GetOpenAPI()

Method Summary

Modifier and Type	Method and Description
io.vertx.core.json.JsonObject	buildCoreApiComponents(io.vertx.core.json.JsonObject api, KeepDbInfo dbInfo, io.vertx.core.json.JsonObject designJson)
io.vertx.core.json.JsonObject	buildCoreApiPaths(io.vertx.core.json.JsonObject api, KeepDbInfo dbInfo, io.vertx.core.json.JsonObject designJson) Builds the “paths” part of the OpenAPI spec
io.vertx.core.json.JsonArray	buildCoreApiTags(KeepDbInfo dbInfo) Generates a JsonArray of the relevant tags, a subset from the
io.vertx.core.json.JsonObject	buildInfo(io.vertx.core.json.JsonObject api) Build the info part of the OpenAPI spec
io.vertx.core.json.JsonObject	buildMetadataResponseFields() Build JsonObject of metadata fields for documents
io.vertx.core.json.JsonObject	convertFieldToObject(io.vertx.core.json.JsonObject fieldsObj, java.lang.String fieldName) Builds a JsonObject for the given field, with title, description, type and schema.
void	process(DbRequestParameters<io.vertx.core.json.JsonObject> request) Actual work is done here.
io.vertx.core.json.JsonArray	replaceParamSchema(io.vertx.core.json.JsonObject pathObj, java.lang.String paramName, java.lang.Object newSchema, boolean removeExamples) Replaces the schema for a given parameter

Methods inherited from class com.hcl.domino.keep.dbrequests.AsyncDominoJNXJson

getDbRequestParameters

Methods inherited from class com.hcl.domino.keep.dbrequests.AsyncDominoJNX

accessControlCheck, dontCallProcessPayload, emitterToObserver, getActualDatabaseName, getApiName, getAppTags, getBarbican, getEventbusId, getKeepDbInfo, getRequestType, getSubscriber, getUser, getUserForMetrics, isProcessPayloadRequired, isWorkInProgress, processDominoRequest, recordAppMetrics, setApiName, setBarbican, setDbFileName, setKeepDbInfo, setProcessPayloadRequired, setRequestParams, setRequestType, setSubscriber, setUser, setVertx, subscribe, validateDqlAccess, validateOpenAccess, validationCheck

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hcl.domino.keep.dbrequests.AsyncDominoBase

customValidator, preflight

Constructor Detail

GetOpenAPI

public GetOpenAPI()

Method Detail

buildCoreApiComponents

public io.vertx.core.json.JsonObject buildCoreApiComponents(io.vertx.core.json.JsonObject api,
                                                            KeepDbInfo dbInfo,
                                                            io.vertx.core.json.JsonObject designJson)

Parameters:

api - the OpenAPI to modify

dbInfo - KeepDatabase config

designJson - JSON version of the database design

Returns:

JsonObject for component schemas

buildCoreApiPaths

public io.vertx.core.json.JsonObject buildCoreApiPaths(io.vertx.core.json.JsonObject api,
                                                       KeepDbInfo dbInfo,
                                                       io.vertx.core.json.JsonObject designJson)

Builds the “paths” part of the OpenAPI spec

Parameters:

api - OpenAPI spec that is used as a base

dbInfo - KeepDatabase config

designJson - JSON version fo the DXL design

Returns:

JsonObject containing appropriate paths for the KeepDatabase config

buildCoreApiTags

public io.vertx.core.json.JsonArray buildCoreApiTags(KeepDbInfo dbInfo)

Generates a JsonArray of the relevant tags, a subset from the

Parameters:

dbInfo - KeepDatabase config

Returns:

JsonArray of valid tags

buildInfo

public io.vertx.core.json.JsonObject buildInfo(io.vertx.core.json.JsonObject api)

Build the info part of the OpenAPI spec

Parameters:

api - the OpenAPI to modify

Returns:

info object

buildMetadataResponseFields

public io.vertx.core.json.JsonObject buildMetadataResponseFields()

Build JsonObject of metadata fields for documents

Returns:

JsonObject containing additional fields

convertFieldToObject

public io.vertx.core.json.JsonObject convertFieldToObject(io.vertx.core.json.JsonObject fieldsObj,
                                                          java.lang.String fieldName)

Builds a JsonObject for the given field, with title, description, type and schema. If the field does not exist on the form, no schema is added

Parameters:

fieldsObj - JsonObject of all fields in the Form

fieldName - string field name being iterated

Returns:

JsonObject for the relevant field

process

public void process(DbRequestParameters<io.vertx.core.json.JsonObject> request)
             throws java.lang.Exception

Description copied from interface: AsyncDominoBase

Actual work is done here. The DbRequestParameters injects all needed components as well as functions like validation and results

Parameters:

request - DbRequestParameters granting access to session and database

Throws:

java.lang.Exception - Anything that can go wrong, will go wrong

replaceParamSchema

public io.vertx.core.json.JsonArray replaceParamSchema(io.vertx.core.json.JsonObject pathObj,
                                                       java.lang.String paramName,
                                                       java.lang.Object newSchema,
                                                       boolean removeExamples)

Replaces the schema for a given parameter

Parameters:

pathObj - JsonObject for the path to query. The JsonObject will contain a “parameters” array

paramName - String parameter name to look for

newSchema - JsonObject containing the new schema

removeExamples - whether examples should be removed. If the schema has been changed to an enum, this is no longer relevant

Returns:

JsonArray for the parameters, which can then be inserted into the path