Apicurio / apicurio-epics

Repository to hold issues representing high level Apicurio team epics.
0 stars 0 forks source link

Improved Artifact References support (UI, etc) in Registry #25

Closed EricWittmann closed 1 year ago

EricWittmann commented 2 years ago

We support references in registry already, but really only in the API. We have some good ideas to improve support for references. Some ideas:

UI support

Add references in the UI, for display and when adding/updating artifacts.

Here is the UX design iterations

CLI support

We have no designs for this, but it sure would be nice. There's probably some overlap between what we can do with the maven plugin and what we can do with the CLI (regarding registration of a collection of self-referencing local files).

De-referencing support

It would nice to have an option in the REST API to dereference the content when downloading it. This could make it much easier for consumers that don't support external references. Challenge: this needs to be implemented for each artifact type. We currently have this implemented in OpenAPI and AsyncAPI only.

Extended maven plugin support

We have basic maven plugin support now. But it would be really nice to be able to just point the maven plugin to a bunch of repository files (that reference each other) and have it figure out how to properly add the content to the registry including appropriate reference mappings.

Tasks in this Epic