search

deegree / deegree-ogcapi

OGC API implementations based on deegree
GNU Lesser General Public License v2.1
5 stars 5 forks source link

Extend API base path to include version information #73

Open Kate-Lyndegaard opened 1 year ago

Kate-Lyndegaard commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

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: