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

Rename "Dataset" to "Entity List" #466

Closed
6 tasks done
matthew-white opened this issue Aug 22, 2023 · 4 comments · Fixed by getodk/docs#1651
Closed
6 tasks done

Rename "Dataset" to "Entity List" #466

matthew-white opened this issue Aug 22, 2023 · 4 comments · Fixed by getodk/docs#1651
Assignees
Labels
backend Requires a change to the API server entities Multiple Encounter workflows frontend Requires a change to the UI

Comments

@matthew-white
Copy link
Member

matthew-white commented Aug 22, 2023

Make this change in:

  • Frontend
    • Text
    • Routes
    • API requests
  • Backend
    • API endpoints (should we add aliases so that it isn't a breaking change?)
    • API docs
    • Don't rename database tables
    • Maybe don't rename audit log actions?
    • Don't rename "dataset" where it is used only internally in the code (e.g., the frame name)
  • User docs
@matthew-white matthew-white added backend Requires a change to the API server frontend Requires a change to the UI entities Multiple Encounter workflows labels Aug 22, 2023
@github-project-automation github-project-automation bot moved this to 🕒 backlog in ODK Central Aug 22, 2023
@matthew-white matthew-white moved this from 🕒 backlog to ✏️ in progress in ODK Central Aug 22, 2023
@matthew-white matthew-white changed the title Rename "Dataset" to "Entity List"(?) Rename "Dataset" to "Entity List" Aug 25, 2023
@matthew-white
Copy link
Member Author

matthew-white commented Aug 28, 2023

Why we decided not to change API endpoints

@lognaturel wrote on Slack:

But for the APIs, maybe we should also consider the option of keeping dataset? It’s confusing but seems like the kind of thing an API consumer could handle.

We’ve decided to keep “dataset” for the spec, API, and everything dev-facing in Central. The hope is that this split will be more consistent and less confusing than a partial conversion.

I wrote:

Along the lines of what Sadiq said, the difficulty is that it’s not just mapping /v1/projects/:id/datasets to /v1/projects/:id/entity-lists. When you link a form attachment to a dataset, you do so by specifying "dataset": true in the request body. For a couple of responses (project extended metadata, form attachments), dataset is also in the response body.

@ktuite
Copy link
Member

ktuite commented Sep 15, 2023

I'm thinking we should update the Problems that mention Datasets. Some of them wind up passed through to frontend like here in the dataset property validation step.

@lognaturel
Copy link
Member

Continuing musings from #482 (comment). We need to decide what problem messages should be consistent with: everything else in backend or the universe outside of backend. These messages are at the edge so it's not an obvious decision. My current leaning is to keep everything in backend using 'dataset', even moving forward, and to be sure that problems that have messages with 'dataset' are explicitly handled in frontend and given localizable strings.

@matthew-white
Copy link
Member Author

I'm thinking we should update the Problems that mention Datasets.

This question was separated into its own issue, #487.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend Requires a change to the API server entities Multiple Encounter workflows frontend Requires a change to the UI
Projects
Status: ✅ done
Development

Successfully merging a pull request may close this issue.

4 participants