Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

REST API Documentation #181

Open
carlospsikick opened this issue Mar 23, 2021 · 5 comments
Open

REST API Documentation #181

carlospsikick opened this issue Mar 23, 2021 · 5 comments
Labels
doc Improvements to documentation help wanted Extra attention is needed rest-proxy Issues related to the REST proxy API schema-registry Issues related to the schema registr API

Comments

@carlospsikick
Copy link

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
Copy link
Contributor

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
Copy link

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
Copy link
Contributor

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.

@hackaugusto hackaugusto added the doc Improvements to documentation label May 6, 2021
@OneCricketeer
Copy link
Contributor

drop-in replacement for the

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

@lornajane lornajane added help wanted Extra attention is needed schema-registry Issues related to the schema registr API rest-proxy Issues related to the REST proxy API labels Apr 1, 2022
@Ashleycodesseo
Copy link

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Improvements to documentation help wanted Extra attention is needed rest-proxy Issues related to the REST proxy API schema-registry Issues related to the schema registr API
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants