Add Apicurio catalog documentation #198
Merged
Conversation
This file contains hidden or 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
vordimous
suggested changes
Mar 5, 2024
|
|
||
| > `string` | ||
|
|
||
| The artifact group ID represents an independent scope in Apicurio. |
There was a problem hiding this comment.
Suggested change
| The artifact group ID represents an independent scope in Apicurio. | |
| The artifact group ID represents an independent scope in Apicurio. | |
| --- | |
| ::: right | |
| \* required | |
| ::: | |
| Read how to [enable incubator features](../../../how-tos/install.md#enable-incubator-features). Star and watch the [Zilla repo](https://github.com/aklivity/zilla/releases) for new releases! | ||
| ::: | ||
|
|
||
| Zilla runtime apicurio catalog |
There was a problem hiding this comment.
Suggested change
| Zilla runtime apicurio catalog | |
| Zilla runtime `apicurio` catalog |
|
|
||
| ## Summary | ||
|
|
||
| Defines a catalog with schemas, AsyncAPI/OpenAPI definitions pulled from a remote registry to enforce validation or create APIs. |
There was a problem hiding this comment.
Suggested change
| Defines a catalog with schemas, AsyncAPI/OpenAPI definitions pulled from a remote registry to enforce validation or create APIs. | |
| Defines a catalog with schemas pulled from an [Apicurio Registry](https://www.apicur.io/registry/) to enforce validation or create APIs. |
There was a problem hiding this comment.
I think it is better to generically describe the binding and mention the registry by name since it is a direct feature for the specific project.
2 tasks
vordimous
approved these changes
Mar 14, 2024
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.
No description provided.