Skip to content

[API] Support custom parameter aliases #278

@jo-asplin-met-no

Description

@jo-asplin-met-no

For relevant endpoints, we introduce a query parameter param-aliases defined like this (typically as serialized JSON):

"<alias 1>": "<param name 1>"
"<alias 2>": "<param name 2>"
...

The effect of this is that the real/underlying parameter names are no longer exposed at all to the client, neither in input (query parameters) nor in output (response).

The motivation is twofold for a given client application:

  1. Favorite/alternative parameter names can be used.
  2. Irrelevant parameters can be hidden.

A primary case could be the GeoWeb client where a major obstacle to making use of E-SOH is the sheer number of parameters. Ideally, a GeoWeb user should be presented with just a single parameter for air_temperature. E-SOH currently provides 14 combinations of parameter names with air_temperature as the standard name component.

NOTE: to make this feature more convenient for a specific client (such as GeoWeb), we could offer a separate collection (typically called geoweb for the GeoWeb case) where the parameter alias mapping is hard-coded. The client then simply points to that collection instead of the main collection.

Metadata

Metadata

Assignees

No one assigned

    Labels

    APIFor issues and PR related to the APIs

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions