Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
JohnPreston committed Mar 10, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
1 parent d9c2681 commit 26e5d81
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
@@ -8,16 +8,25 @@ Simple / light HTTP client library (using requests) to manipulate schemas and de

* RedPanda API specification is documented `here <https://docs.redpanda.com/current/manage/schema-reg/schema-reg-api/>`__

.. warning::

RedPanda SR does not have 100% compatibility with Confluent's.
Confluent Cloud specific endpoints not implemented (and no plans to be).


Usage
======

Very simple example to manipulate the schema registry and its resources.
Every function returns the ``requests.Response`` object to allow you to implement any kind of logic from there,
instead of trying to implement it for you.

Non 2xx HTTP codes raise exceptions which are in the ``kafka_schema_registry_admin.client_wrapper.errors``
More specific exceptions will be created in due course to identify exact exceptions.

.. code-block::
from kafka_schema_registry_admin import SchemaRegistry
registry = SchemaRegistry("http://localhost:8081")
subjects = registry.get_all_subjects()
schemas = registry.get_all_schemas()
subjects = registry.get_all_subjects().json()

0 comments on commit 26e5d81

Please sign in to comment.