Reform API standards

This library contains a set of Spring Boot components used across HMCTS APIs.

SensitiveHeadersRequestTraceFilter

Removes sensitive headers before they are added to Spring trace.
In order to use this filter declare the following Bean in your app:

@Bean
public SensitiveHeadersRequestTraceFilter requestTraceFilter(Set<Include> includes) {
    return new SensitiveHeadersRequestTraceFilter(includes, <your_custom_headers_go_here>);
}

@APIDeprecated

An annotation for controller classes and methods that adds warning headers to the responses generated by the API.

A typical usage would be to add the @APIDeprecated annotation to a method as in the following example:

@APIDeprecated(
    name = "Deprecated Endpoint",
    expiryDate = "2018-06-30",
    docLink = "https://example.org/docs/foo",
    note = "Some note."
)
public Model someAction() {
    // request handling code ...
}

The annotation has the attributes that are used for forming a Warning header.

name for friendly name of the endpoint,
expiryDate for the date which the endpoint will cease to serve,
docLink for the details of documentation regarding the API updates
note for optional notes to the clients

A sample of the Warning header is as follows:

The UserProfileEndpoint is deprecated and will be removed by 2018-06-30. Please see https://example.org/docs/foo for details. Some note.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Update plugin io.spring.dependency-management to v1.1.5
Update dependency com.google.guava:guava to v33.2.0-jre
Update dependency gradle to v8
Update dependency io.rest-assured:rest-assured to v5
Update plugin org.springframework.boot to v3
Click on this checkbox to rebase all open PRs at once

Detected dependencies

github-actions

.github/workflows/gradle.yml

actions/checkout v4

actions/setup-java v4

.github/workflows/jitpack_build.yml

actions/checkout v4

gradle

build.gradle

io.spring.dependency-management 1.1.4

org.springframework.boot 2.7.18

com.google.guava:guava 33.1.0-jre

junit:junit 4.13.2

io.rest-assured:rest-assured 3.3.0

org.hamcrest:hamcrest-all 1.3

javax.inject:javax.inject 1

gradle-wrapper

gradle/wrapper/gradle-wrapper.properties

gradle 7.6.4

Check this box to trigger a request for Renovate to run again on this repository

hmcts / reform-api-standards Goto Github PK