restate icon indicating copy to clipboard operation
restate copied to clipboard

Expose service documentation

Open slinkydeveloper opened this issue 2 years ago • 3 comments

Could we expose the service documentation when listing the services in meta?

slinkydeveloper avatar Aug 15 '23 13:08 slinkydeveloper

Look at https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto#L990

slinkydeveloper avatar Aug 15 '23 13:08 slinkydeveloper

Can be problematic: https://github.com/protocolbuffers/protobuf/issues/8728

slinkydeveloper avatar Aug 15 '23 14:08 slinkydeveloper

This is still relevant with the new interface refactor. In Java we could extract the javadocs and use those as documentation.

slinkydeveloper avatar Mar 21 '24 11:03 slinkydeveloper

Starting point for Java is this one: https://docs.oracle.com/en/java/javase/11/docs/api/java.compiler/javax/lang/model/util/Elements.html#getDocComment(javax.lang.model.element.Element)

slinkydeveloper avatar Oct 31 '24 13:10 slinkydeveloper