DeltaSync (>= ApiOmat 20.03.1)

DeltaSync allows you to reduce the payload of responses that would contain multiple entities.
It can be applied to GET requests that return collections of a specific model (e.g. getAllModels or getReferences) and is controlled via the request headers. You can find more information about the underlying concept on the DeltaSync page.

DeltaSync is available since ApiOmat 20.03.1 (with Brewer 1.1.0).

This section explains how you can use DeltaSync in your generated service.

Custom Headers in Requests to Yambas (>= ApiOmat 20.11.0)

You can use the request-scoped RequestState object to set additional headers for the requests to Yambas over a FeignClient. The RequestState provides methods to append custom headers. Please note that existing headers will be overwritten by your custom headers. If you need to append an header value, you have to append it manually. Alternatively, you can extend the class RequestHeaderRequestInterceptor and overwrite the addCustomHeaders method with your own implementation to change this behavior. Don't forget to configure this custom implementation in your application.yml.

CORS handling (>= ApiOmat 20.11.0)

This section explains how to configure Cross Origin Resource Sharing in your service - in other words, whether external pages can make cross domain requests to YAMBAS via your service.
CORS handling is available since ApiOmat 20.11.0 (with Brewer 2.0.0).

You can configure CORS handling via the following properties of your service (in src/main/resources/application.yml ):

• {ServiceName}.cors-configuration.allowedOrigins: Set the allowed origins (URIs).

• {ServiceName}.cors-configuration.allowedMethods: Set the allowed HTTP methods.

The default value for both properties is *, which means all origins and methods will be allowed as long as they are valid URIs/HTTP methods, respectively.
If either property is set to "none", or has an empty value, no CORS requests will be allowed at all!

Here is an example where CORS is enabled only for GET and HEAD requests from two specific URIs:

hobbitservice:
  cors-configuration:
    allowedOrigins:
      - "http://127.0.0.1:9081"
      - "https://other.secure.domain"
    allowedMethods:
      - GET
      - HEAD

When you start your service, the configuration class {ServiceName}CorsConfiguration will register all of your service's data model endpoints for CORS.
As part of this process, it retrieves the values for both properties and uses them as params for the registerMapping method of the Spring class CorsRegistry.

If you have created your own custom endpoints and need to enable CORS for them, simply add them to the list of endpoints in the addCorsMappings method of {ServiceName}CorsConfiguration.
For example:

Add logo for marketplace

You can add a SVG or PNG image as your service's logo.
This image must be named logo.[png/svg] and placed inside the src/main/resources/ folder of your generated service.
To achieve a good result, please use a resolution of 81x81px.

Application Owner Request

When using ApiOmat Yambas as data persistence for your service the authorization verification is done within Yambas itself. Sometimes there are situations where you want to act as an application owner without having any request that was sent by an application owner.

For Example:

• If you have a periodic cron job within your service that needs to access data which is only accessible by application owner, but you do not have any origin request to do so.

• Another scenario would be, if you need access to data objects that are directly unaccessible for the current request user, but the service logic itself needs those information to be able to process the users request.

For those scenarios ApiOmat provides you the so called application owner requests.