You are viewing a plain text version of this content. The canonical link for it is here.

Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2020/07/23 03:13:08 UTC

[GitHub] [pulsar] BewareMyPower commented on issue #7625: [docs] request body description of sinks REST APIs is wrong

BewareMyPower commented on issue #7625:
URL: https://github.com/apache/pulsar/issues/7625#issuecomment-662798336


   This part of doc seems to be generated by Java annotations, eg. `A JSON value presenting config payload of a Pulsar Sink` is from `@ApiParam` before the following line:
   
   ```java
   final @FormDataParam("sinkConfig") SinkConfig sinkConfig
   ```
   
   The above three `@FormDataParam` fields don't have associated `@ApiParam`s. I'm not familiar with JavaDoc, would the addition of `@ApiParam` work? @jiazhai 


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org