kafka icon indicating copy to clipboard operation
kafka copied to clipboard

KAFKA-13976: Improvements for OpenAPI specs

Open vamossagar12 opened this issue 3 years ago • 6 comments

  1. Added relevant APIResponses for all API endpoints.
  2. Documented response codes/query-parameters/path-parameters/request body for all Connect related API endpoints.

vamossagar12 avatar Jun 18 '22 17:06 vamossagar12

@mimaison Plz review. For some of the APIs returning Response, I have tried to use the actual class as response types. Also, there are a few endpoints, which return Maps. I have tried to use MapSchema as I couldn't find much documentation/examples around this. Do you think MapSchema would work? Thanks!

vamossagar12 avatar Jun 18 '22 17:06 vamossagar12

@tombentley i saw the original PR for adding OpenAPI spec was reviewed by you as well. Plz review this one as well whenever you get the chance. Thanks!

vamossagar12 avatar Jun 23 '22 16:06 vamossagar12

Thanks for the review @tombentley . I made the changes as suggested

vamossagar12 avatar Jul 02 '22 12:07 vamossagar12

@tombentley could you plz take a look whenever you get the chance. Thanks!

vamossagar12 avatar Jul 27 '22 10:07 vamossagar12

@tombentley / @mimaison Plz review this PR whenever you get the chance..

vamossagar12 avatar Aug 12 '22 17:08 vamossagar12

Thanks for the PR. Quite a few things are still not quite right, see my comments.

Thanks @mimaison . Sorry about that. I see there are quite a few misses in the PR. Would correct them as you pointed.

vamossagar12 avatar Aug 17 '22 09:08 vamossagar12

Converting to draft. Need some time before I get to this.

vamossagar12 avatar Jun 07 '23 14:06 vamossagar12

@vamossagar12 Are you still planning to complete this item?

mimaison avatar Oct 04 '23 14:10 mimaison

@mimaison , yes sorry this completely missed my radar. Let me get to it some time next week.

vamossagar12 avatar Oct 04 '23 14:10 vamossagar12

@mimaison , turns out I mayn't be able to spend time on this one. I will close this PR and unassigned the JIRA.

vamossagar12 avatar Oct 18 '23 09:10 vamossagar12