Extend API base path to include version information

[Kate-Lyndegaard]

Feature Description:

The URI of the API (base path) is extended to include the major version number, prefixed by the letter v.

A pull request is made so that this feature can be available as an optional extension to the core deegree OGC API product.

Additional information:

This issue is related to the Dutch API requirement labeled AP-20:

API-20: Include the major version number in the URI

The URI of an API (base path) must include the major version number, prefixed by the letter v. This allows the exploration of multiple versions of an API in the browser. The minor and patch version numbers are not part of the URI and may not have any impact on existing client implementations.

An example of a base path for an API with current version 1.0.2:

https://api.example.org/v1/

Definition of done:

The URI of an API (base path) includes the major version number, prefixed by the letter v.

A pull request including the functionality is made available to deegree OGC API.

The functionality is optional.

[copierrj]

The TMC discussed this feature request and has the following question:

While we do understand the need to add a version to a public url, we are not (yet) convinced that deegree should be aware of this. Wouldn't it be possible to use a reverse proxy / ingress controller to accomplish this?

[stempler]

Please review the related Pull Request.

While we do understand the need to add a version to a public url, we are not (yet) convinced that deegree should be aware of this. Wouldn't it be possible to use a reverse proxy / ingress controller to accomplish this?

In our view arguments to include the functionality in deegree would be:

• the information on the API version is already present within deegree - see

  deegree-ogcapi/deegree-ogcapi-features/src/main/java/org/deegree/services/oaf/openapi/OpenApiCreator.java

  Line 63 in 32a6fc8

  private static final String VERSION = "1.0";

• the API version is already being exposed via the OpenAPI document
• thus the API version information needs to be maintained in deegree anyway
• by letting deegree expose the API version information it implements it is ensured to be the correct version