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.

Sign up for GitHub

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

Jump to bottom

Make the API more developer friendly #56

Open

bigludo7 opened this issue Oct 29, 2024 · 1 comment

Labels

Collaborator

bigludo7 commented Oct 29, 2024

Problem description
As we target developer adoption for our API, 2 feedbacks from development:

The polymorphic patter use on line 576-578 is not developer-friendly as it require a manual processing with code generator. It will be better to use same name for the enum value and the corresponding class.

          NO_DATA: '#/components/schemas/PopulationDensityData'
          LOW_DENSITY: '#/components/schemas/PopulationDensityData'
          DENSITY_ESTIMATION: '#/components/schemas/DensityEstimationPopulationDensityData'

There is probably unnecessary complexity with all the classes defined in the yaml. We can merge CellPopulationDensityData and PopulationDensityData in one class and avoid one unnecessary level that will make the API sipler
The class DensityEstimationPopulationDensityData has probably too many Density but this point is linked to my first point.

Possible evolution

Alternative solution

Additional context

The text was updated successfully, but these errors were encountered:

bigludo7 added the enhancement label

Collaborator Author

bigludo7 commented Nov 14, 2024

Hello @jgarciahospital - Any feedback from your dev team?
We can craft a PR on this topic to support our proposal - WDYT?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment