Skip to content

Commit ef7bb5f

Browse files
committed
refactor: make API-Version response header configurable
It is disabled by default.
1 parent 6b65575 commit ef7bb5f

1 file changed

Lines changed: 12 additions & 5 deletions

File tree

deegree-ogcapi-features/src/main/java/org/deegree/services/oaf/filter/ApiVersionResponseFilter.java

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
import javax.ws.rs.container.ContainerResponseFilter;
3030
import javax.ws.rs.ext.Provider;
3131

32+
import org.deegree.commons.utils.TunableParameter;
3233
import org.deegree.services.oaf.openapi.OpenApiCreator;
3334

3435

@@ -40,18 +41,24 @@
4041
@Provider
4142
public class ApiVersionResponseFilter implements ContainerResponseFilter {
4243

43-
// Whether to add API version to the header or not
44-
private boolean addApiVersionToHeader = true;
44+
/**
45+
* Name for parameter that allows enabling returning the API version as response header.
46+
*/
47+
public static final String PARAMETER_ENABLE_VERSION_HEADER = "deegree.oaf.openapi.version_response_header";
48+
49+
private boolean addApiVersionToHeader = TunableParameter.get(PARAMETER_ENABLE_VERSION_HEADER, false);
4550

46-
// Constant for API-Version
47-
private static final String API_VERSION_CONSTANT = "API-Version";
51+
/**
52+
* Name for response header with API version.
53+
*/
54+
public static final String HEADER_API_VERSION = "API-Version";
4855

4956
@Override
5057
public void filter(ContainerRequestContext requestContext, ContainerResponseContext responseContext)
5158
throws IOException {
5259

5360
if (addApiVersionToHeader) {
54-
responseContext.getHeaders().add(API_VERSION_CONSTANT, OpenApiCreator.VERSION);
61+
responseContext.getHeaders().add(HEADER_API_VERSION, OpenApiCreator.VERSION);
5562
}
5663
}
5764

0 commit comments

Comments
 (0)