Standard documentation fields for response objects

[pieter-senden]

Context

If a response POJO changes, then all documentation tests using that object have to be updated. This yields a lot of manual work.

Idea

Implement an inspector to check which response POJOs are updated, which tests should thus be updated, and which effectively updates them.

Proposed solution

Step 1

Suppose we have a response POJO, say, BookResponse:

public record BookResponse(UUID id, String title, String author){}

The plugin then creates a test class BookResponseDocumentation with a static method yielding a list of FieldDescriptors for each field in BookResponse.

If such a class already exists, the plugin verifies if each field in BookResponse is present in BookResponseDocumentation and provides the functionality to update if necessary.

Step 2

Given this BookResponseDocumentation class, the plugin uses its static method in the responseFields() method.