CLIENTS-286 CLIENTS-288 #560
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Documentation for SR delete API
ewencp
reviewed
Jun 1, 2017
docs/api.rst
Outdated
| @@ -164,6 +164,38 @@ The subjects resource provides a list of all registered subjects in your schema | |||
| 1, 2, 3, 4 | |||
| ] | |||
|
|
|||
| .. http:delete:: /subjects/(string: subject) | |||
|
|
|||
| Deletes the specified subject and its associated compatibility level if registered. It is recommended to use this API only in development environments. In production environments, it must be use with care as it would delete all the registered schemas for the subject. One of the potential scenario to use in production is when a topic needs to be recycled. | |||
There was a problem hiding this comment.
potential scenario -> potential scenarios
There was a problem hiding this comment.
Maybe reword the recommendation to include the recycling case. It's kind of confusing right now since it says "only use in development", then gives an example of using it in production.
docs/api.rst
Outdated
| @@ -332,6 +364,40 @@ The subjects resource provides a list of all registered subjects in your schema | |||
| }" | |||
| } | |||
|
|
|||
| .. http:delete:: /subjects/(string: subject)/versions/(versionId: version) | |||
|
|
|||
| deletes a specific version of the schema registered under this subject. This API is recommended to be used only in development environments or under extreme circumstances where-in, its required to delete a previously registered schema for compatibility purposes or re-register previously registered schema | |||
docs/intro.rst
Outdated
| @@ -47,13 +47,21 @@ Start by running the Schema Registry and the services it depends on: ZooKeeper a | |||
| $ curl -X GET http://localhost:8081/subjects/Kafka-value/versions | |||
| [1] | |||
|
|
|||
| # Deletes all schema versions registered under the subject "Kafka-value" | |||
| $ curl -X DELETE http://localhost:8081/subjects/Kafka-value | |||
There was a problem hiding this comment.
If we delete the entire subject here, the subsequent commands wouldn't work, i.e. if someone followed each of these commands, they wouldn't get the output that is shown. Perhaps move deletion to the end and then verify with a GET to fully demonstrate the functionality?
docs/schema-deletion-guidelines.rst
Outdated
| Schema Deletion Guidelines | ||
| ========================== | ||
|
|
||
| Schema Registry API supports deleting a specific schema version and also a delete subject (deletes all schema versions for the subject). |
There was a problem hiding this comment.
-> a specific schema version or all versions in a subject.
docs/schema-deletion-guidelines.rst
Outdated
| $ curl -X DELETE http://localhost:8081/subjects/Kafka-value/versions/latest | ||
| 1 | ||
|
|
||
| The above API's are primarily intended to be used be in development environment where its common to go through iterations before finalizing a schema. While its not recommended to be used in a production environment, there are few scenarios where these API's can be used in production but with utmost care. |
tjwp
reviewed
Jun 2, 2017
docs/api.rst
Outdated
|
|
||
| .. sourcecode:: http | ||
|
|
||
| DELETE /subjects/test/versions HTTP/1.1 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documentation for SR delete API