Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change conceptual names (Entity and Entry) #1100

Open
userlocalhost opened this issue Mar 6, 2024 · 1 comment
Open

Change conceptual names (Entity and Entry) #1100

userlocalhost opened this issue Mar 6, 2024 · 1 comment
Assignees

Comments

@userlocalhost
Copy link
Member

userlocalhost commented Mar 6, 2024

Background

Now, this application uses following conceptual names

  1. Entity: consists of structural attribute(s) that represents what type of data it will have.
  2. Entry: consists of data attribute(s) that represents what data it actually has based on its type.

Problem

It may be hard to understand these concept from each names (Entity and Entry), because the meaning of their name and description are quite different.

Proposal

I think, we should change those names as below

  1. Entity → Model (consists of structural attribute(s) that represents what type of data it will have)
  2. Entry → Item (consists of data attribute(s) that represents what data it actually has based on its type)

Along with this, we also have to change following model names

  1. EntityAttr → ModelAttr

But both names ("entity" and "entry") in the parameters of APIv1 should be remained because of backward compatibility.

@userlocalhost
Copy link
Member Author

userlocalhost commented Mar 6, 2024

It's not simple issue.
I tackled with this just about an hour. I'm so frustrated because it's hard to keep backward compatibility, we have to sort changing name and remaining name carefully in each files that is related with APIv1.

@userlocalhost userlocalhost self-assigned this Mar 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant