Naming Panache REST extension

[gytis]

Panache REST extensions for JAX-RS resources generation is currently named panache-rest-hibernate-orm. Shortly we would like to add a MongoDB version too.
This name format, however, is different from the the one used by the hibernate-orm-panache-kotlin, hibernate-orm-panache and others. Would it be more acceptable if we would rename the extensions to hibernate-orm-panache-rest? Or some other name would be more appropraite?

@FroMage has already provided a couple of suggestions here #9254 (comment)

[quarkusbot]

/cc @FroMage @loicmathieu

[gsmet]

@FroMage @gytis this needs to be sorted out by Monday evening to be in CR1.

[FroMage]

Here are my comments copied here for easier reading:

Now that I read it like that, I've my doubts over the order, because originally it was supposed to be X with Panache, which means X with style.

This makes it looks like Panache is a noun and the subject instead of an adjective to make Hibernate ORM/REST stylish.

Perhaps it should be Hibernate ORM REST with Panache or RESTful Hibernate ORM with Panache or REST for Hibernate ORM with Panache?

I guess, similarly, this guide (and the extension names) would better be "REST with Panache" and rest-panache?

Except this sort-of implies it applies to REST apps that aren't necessarily about data, and we plan to have a Panache layer for RESTEasy one day…

Perhaps RESTful data with Panache?

Or CRUD with Panache?

[FroMage]

So, I guess I formally propose:

• quarkus-crud-rest-panache for the common module: "CRUD REST with Panache"
• quarkus-hibernate-orm-crud-rest-panache for the "Hibernate ORM CRUD REST with Panache"
• quarkus-mongodb-crud-rest-panache for the "MongoDB CRUD REST with Panache"

It's a mouthful, but it's sort-of safe. It's not just CRUD because it's only the REST part of CRUD, and it's not just REST because it's only about data.

We could argue that quarkus-hibernate-orm-rest-panache for the "Hibernate ORM REST with Panache" module would be enough (drop CRUD because here it can be implied that doing REST with entities is about CRUD).

But the common module should not be just quarkus-rest-panache because that one is only about CRUD and not the more general "REST with Panache" we plan to add later. Though it could perhaps grow into becoming it. It's just a bit early to make that call right now and I don't want to regret this in the future.

[gytis]

I understand the intent of keeping it explicit that it's not a general REST and I think it's reasonable. I'm just not a bit fan of CRUD in a name. How about the following options:

• quarkus-panache-rest-data (or quarkus-panache-rest-data-common)
• quarkus-hibernate-orm-panache-rest-data
• quarkus-mongodb-panache-rest-data

[FroMage]

rest-data is fine by me, but let's move -panache to the end:

• quarkus-panache-rest-data
• quarkus-hibernate-orm-rest-data-panache
• quarkus-mongodb-rest-data-panache

[gytis]

I assume the same applies to the common module? quarkus-rest-data-panache?

[FroMage]

Probably.

In retrospect we should have named quarkus-panache-common as quarkus-data-panache but that ship has sailed.

quarkus-rest-data-panache seems better than whatever -common.

[gytis]

Fair enough.
I'll try to rename everything and raise a PR together with the path configuration change by Monday. And then I'll update the guide.

[loicmathieu]

+1 for the naming with rest-data but be careful that this will be the first time we have a library with quarkus-something-data so people may assume it's some kind of repositrory library( think spring-data, micronaut-data). But as I said +1 ;)

@FroMage quarkus-panache-common can be renamed, it's an internal library.

The fact that there is some plan for a RESTEasy with Panache is interesting, it reminds me on the discussion around Paging for JAX-RS (#9052) which should be part of it.