Skip to content

Make the API more developer friendly #56

@bigludo7

Description

@bigludo7

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions