The @Description annotation does not work

[evgeny-mordyasov]

The @description annotation does not work when it is specified in the service interface. When I specify the annotation in the class, then everything is ok. I want to document my services in the interface so as not to clutter the code in the implementation with unnecessary annotations.

My interface:

public interface RestClientService {

    HttpResponse findByEntityId(@Description("client id") Long entityId);
}

My class:

public class RestClientServiceImpl implements RestClientService {

    private final ClientService service;

    public RestClientServiceImpl(ClientService service) {
        this.service = service;
    }

    @Get("/{entityId}")
    @Override
    public HttpResponse findByEntityId(@Param Long entityId) {
       ...
    }
}

My Config:

@Configuration
public class ArmeriaConfig {

    @Bean
    public ArmeriaServerConfigurator armeriaConfigurator(RestClientService restClientService) {
        return serverBuilder ->
                serverBuilder
                        .serviceUnder("/docs", docService());
    }

    private DocService docService() {
        return DocService.builder().build();
    }
}

Dependency maven:

<dependency>
    <groupId>com.linecorp.armeria</groupId>
    <artifactId>armeria-spring-boot3-starter</artifactId>
    <version>1.25.2</version>
</dependency>

[ikhoon]

It is a nice suggestion. Transferred this into an issue #5195
Please watch the issue to get updated. 🙇‍♂️