Open API

AcceleratXR makes extensive use of the OpenAPI Specification standard. All services start with an OpenAPI specification file that is processed by our custom code generator. The output that the generator produces is a nearly complete micro-service implementation based on the specification provided. In order to make this possible we have added several custom extensions.

Field Name Parent Type Description
x-baseClass Schema Object string The name of the base class to use when defining the schema’s class file. Possible values are: None, BaseEntity, BaseMongoEntity, SimpleEntity, SimpleMongoEntity. Default value is None.
x-datastores Components Map[string, Datastore Object] A map containing all datastore definition objects.
x-datastore Schema Object Object Describes a single datastore connection the service uses.
x-identifier Schema Object boolean Set to true to indicate the Schema property is an indentifier.
x-index Schema Object boolean Set to true to indicate the Schema property is an index.
x-name Operation Object Path Item Object string
x-schema Path Item Object The name of a Schema Object that the path handles operations for.
x-unique Schema Object boolean Set to true to indicate the Schema property must be unique.

Datastore Object

The Datastore Object is used to identify what database types and connection information is required by the service.

Field Name Type Description
type string REQUIRED. The type of database engine to be used.
url string The connection URL to the database.