search

Aiven-Open / karapace

Karapace - Your Apache Kafka® essentials in one tool
https://karapace.io
Apache License 2.0
470 stars 71 forks source link

REST API Documentation #181

Open carlospsikick opened 3 years ago

carlospsikick commented 3 years ago

hello! Is there a place where I could review the endpoints documentation? Similar to https://api.aiven.io/doc/#operation/ServiceKafkaTopicCreate

Thanks in advance

lornajane commented 3 years ago

Thanks for asking us about this, I've got to confess that the API docs are a work in progress but your nudge is welcome :) While we work on that, please let us know if you have any specific questions we can help with?

mortenlj commented 3 years ago

Since the REST part is supposed to be a near drop-in replacement for the Confluent REST proxy, is it safe to assume that the Confluent docs will be useful to look at?

lornajane commented 3 years ago

Yes, the two products are diverging but pretty slowly so that should be a decent reference for anything that isn't super new on their side. I'll also leave this issue open so I remember to circle back with API docs once I have them available.

OneCricketeer commented 3 years ago

drop-in replacement for the

Believe you meant Schema Registry here, which does expose an OpenApi specification

Ashleycodesseo commented 1 month ago

hey @lornajane I saw that this issue was still open. If you need any help with REST API documentation I'd be happy to contribute! Please let me know! Thanks!