I sent a reply here [0] before realizing there was a thread.

My main issue with stopping the generation of these files is that they
can be used to generate admin clients. Although, I am not sure how
"good" these generated clients are, though. I know of at least one
third party project that has started work on this [1]. Given that
generating the swagger files is a very easy task, I think we should
continue to do so. However, I don't feel too strongly about it.

Thanks,
Michael

[0] https://github.com/apache/pulsar/issues/18724#issuecomment-1350433212
[1] https://github.com/tealtools/pulsar-admin-client-js

On Tue, Dec 13, 2022 at 9:22 AM tison <wander4...@gmail.com> wrote:
>
> Hi,
>
> This can be regarded as a follow-up to the API docs improving movement[1].
> I noticed that we generate swagger-based REST API docs every release: hold
> the source in the main repo, and then sync to the site repo.
>
> However, this isn't necessary. We can, as we do for the other API docs,
> directly generate swagger files in the site repo. I've prepared these PRs
> to update both the tool's side, the release documents side[2], and the
> cleanup works[3]. Now I am sending this email to request reviews.
>
> Looking forward to your feedback.
>
> Best,
> tison.
>
> [1] https://github.com/apache/pulsar/issues/18693
> [2] https://github.com/apache/pulsar-site/pull/325
> [3] https://github.com/apache/pulsar/pull/18900

Reply via email to