Id equal to model name when root is used in Entity

[aitortomas]

See issue #250

[aitortomas]

With my fix, the schema in Swagger-UI would show with the class name from the entity.
Should it show the defined "root" if existing?
I am open to discussion.

[dblock]

So this was a misunderstanding of the spec?

Fix the build please (rubocop), update changelog.

[aitortomas]

Yes, it looks like a misunderstanding of the specs, at least for the case in which root is defined in the entities.

[dblock]

Merged via tim-vandecasteele@834ee01.

[iangreenleaf]

This now breaks my entity references because root gets used in the models object but not in apis[].operations[].type.

Should @root be used at all by default? Seems like it's internal data and meant for defining the formatting, not for defining the model ID.

[aitortomas]

I see what you mean, I can put the root logic inside the parse_entity_name method and it will work.
Despite that, I am open to discussion regarding if root should actually be used or not.

[dblock]

@iangreenleaf and @aitortomas Can you please help resolve this? Lets make sure we don't break backward compatibility or have a way out documented in UPGRADING?

[aitortomas]

Check https://github.com/tim-vandecasteele/grape-swagger/pull/254

[iangreenleaf]

Looks like #254 is a good fix if we're keeping the root logic. I'm still on the side of removing it, though. @dblock @aitortomas do either of you know why it was added in the first place? I found the commit that introduced it (2747bb2) but I don't know if there's an associated issue and discussion.

It seems like the kind of behavior that might be convenient for some apps, but not everyone in general. The fact that I want my output wrapped as {xyz: {…}} doesn't necessarily mean I want xyz to be my canonical model name.

Removing this would break backwards compatibility with anyone depending on it, but I think we could work out a simple upgrade path. For example, people who wanted this behavior could redefine entity_name to something like this:

def entity_name
  super || @root
end

[dblock]

To answer your question, honestly I don't know the background for this.