apicurio-studio icon indicating copy to clipboard operation
apicurio-studio copied to clipboard

Query - Project, Team and Version support

Open raghurakesh opened this issue 6 years ago • 12 comments

Hi @EricWittmann ,

First of all, I would like to thank you for creating this awesome tool.

This is more of a query - In the roadmap of APICurio, I noticed that you will be supporting the Project, Team concepts and will also support Multiple versions of each project/API. Just wanted to check if there is an approximate timeline when you are planning to release this.

Thanks & Regards Rakesh

raghurakesh avatar May 29 '19 09:05 raghurakesh

Glad you like it! Please don't hesitate to suggest improvements and report bugs. :)

I don't have a specific timeline for those features, but I can tell you that they are high priority. I would expect to see them within the next 2 to 3 months. Especially the Project/Team concepts. Collaboration is currently a great feature of Apicurio (users can simultaneously edit the same API design) but is hampered quite a bit by the limitations of how we currently do sharing.

EricWittmann avatar May 29 '19 11:05 EricWittmann

Hi @EricWittmann,

A humble follow up. Would like to check if this is still in the roadmap? Is there any date planned for this? Please advise.

Thanks & Regards

raghurakesh avatar Sep 30 '19 06:09 raghurakesh

Yes this is still on the roadmap! We've been sidetracked here for a few months with another project, which has delayed Apicurio Studio progress a bit. Hopefully we'll be able to get back to making larger improvements soon!

EricWittmann avatar Sep 30 '19 09:09 EricWittmann

Any new updates on this issue?

askfor avatar Nov 27 '20 07:11 askfor

Any update when we expect this feature? (or there is any issue that block this?)

mecseid avatar Jan 22 '21 10:01 mecseid

There's nothing blocking this other than available developer bandwidth. :(

EricWittmann avatar Jan 27 '21 20:01 EricWittmann

Hi @EricWittmann

thanks for the tool, it's excellent, I'm looking at how to apply this to my codegen project. I miss the Project concept that gives the ability to combine Apis (rest, async) and add additional properties/settings.

I think I will be implementing this (Project concept) in the Fork to have it available for my codegen. Do you have any writeups/ideas about the Project functionality in the Apicurio studio? I can take it into account so later may crate proper PR.

Thanks, Vova

v-bilous avatar May 13 '22 15:05 v-bilous

Jeez sorry for the late response. I'm going back through my GH emails and saw I missed this one. :(

We haven't really sat down to design the Team and Project concepts for Studio. One of the reasons is that we're in the process of "rebooting" the Studio a little bit as we look to turn it into a managed service at Red Hat. This does not mean that we're throwing out the existing code. However, we are ... refreshing it using newer technologies. So we're going to create a new back-end based on Quarkus and a new front-end based on React. The editors (OpenAPI and AsyncAPI) will be leveraged as-is and the existing back-end will be leveraged as much as possible.

If you are willing to do some work on a fork to add a Project feature to the current iteration of Studio, that's awesome! My advice is to go ahead and do that, and that will be an input into what we do for the next iteration (soon) of Studio.

Also I want to make it clear that the project will always be open source. That should be a given for any Red Hat project, but maybe not everyone realizes it. :)

EricWittmann avatar May 31 '22 16:05 EricWittmann

Hi @EricWittmann,

Thanks for your detailed reply, I appreciate it.

I'm happy to hear that you are refreshing the Studio with newer technologies, I will be looking forward to seeing updates. Yeah, I started deep diving into existing code and already added Project with a few fields having simple CRUD pages.

As soon as I have a good version, I can create PR. In any case, I'm going to use the Studio in my company. Also, I can wait for the new version (with a newer tech stack) and create PR for it.

What I think about the adding Project so far:

  • can contain multiple Apis (OpenApi and/or AsyncApi)
  • have the owner of the project and collaborators
  • have an activity log
  • can publish a project to the git repository
  • later - we can code generate the entire project (for code generators with the ability to accept multiple API docs)

Eric, what I see is this is a really promising instrument for OpenAPI First/Metadata driven approach in development, I will be observing the project, thanks to open-sourcing it.

Let's stay in touch. Vova

v-bilous avatar Jun 01 '22 12:06 v-bilous

ping @Apicurio/developers - interesting info here. I think this is consistent with our thinking around projects. Although the last two bullets we haven't really talked about much.

Regarding bullet (2) - access management at the project level is very important. I'm hoping we will have the bandwidth to also have Teams, since adding individual collaborators is slow and painful in the current Studio.

We really do need to think about how references will work - whether they are bound in some way to Projects or whether we allow references across Projects. If we do not allow cross-project references, that might constrain the problem a bit. But it makes it harder to handle the use case of organization-wide shared entities centrally defined. That said, we could (and I think should) allow resources to exist in multiple Projects. Food for thought anyway.

We're just starting to think about the new API now, so it's a good time to talk about this.

EricWittmann avatar Jun 09 '22 18:06 EricWittmann

Hi Eric,

I've missed ur answer, sorry about that. I have an idea about references, let me review how it currently works and I will be able to add vision. I've paused work for some time, but for sure I wanna proceed with the instrument.

Have a great week! With the best wishes from Kyiv, Ukraine 🇺🇦 Vova

v-bilous avatar Jun 26 '22 13:06 v-bilous

Thanks for the response @v-bilous - don't worry about delays, I often get way behind on my GitHub communications.

EricWittmann avatar Jul 08 '22 16:07 EricWittmann