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

Producttype eigenschappen : is analoog aan zaaktype eigenschappen #11

Open
alextreme opened this issue Nov 8, 2024 · 0 comments
Open
Labels
enhancement New feature or request

Comments

@alextreme
Copy link
Member

alextreme commented Nov 8, 2024

Gebruikersverhaal

Als gemeentelijke ontwikkelaar
wil ik dat een ProductType eigenschappen kan bevatten in de vorm van key/value paren
zodat aanvullende metadata flexibel kan worden toegevoegd aan producttypen, en deze informatie bruikbaar is voor integraties en specifieke gemeentelijke toepassingen.


Acceptatiecriteria

Eigenschappen in ProductType

  • Het datamodel van de ProductType-entiteit bevat een veld eigenschappen, waarin een lijst van key/value paren kan worden opgeslagen.
  • Elke eigenschap bevat:
    • key: Een unieke naam voor de eigenschap binnen het ProductType (bijv. "doelgroep", "leveringstijd").
    • value: De waarde die aan de key is gekoppeld (bijv. "inwoners boven 18", "3 werkdagen").
  • Eigenschappen zijn optioneel per ProductType, maar als ze aanwezig zijn, moet elke key uniek zijn binnen hetzelfde ProductType.

Validatie

  • Bij het aanmaken of wijzigen van een eigenschap valideert de API:
    • Dat de key uniek is binnen het ProductType.
    • Dat zowel de key als de value niet leeg zijn.
  • Bij foutieve invoer retourneert de API duidelijke foutmeldingen in het Nederlands, zoals:
    • "De eigenschap-sleutel 'doelgroep' is al in gebruik binnen dit ProductType."
    • "De waarde voor de eigenschap 'leveringstijd' mag niet leeg zijn."

API-functionaliteit

  • Bij het opvragen van een ProductType retourneert de API de lijst van eigenschappen als key/value paren.
  • Eigenschappen kunnen via de API worden toegevoegd, gewijzigd of verwijderd.
  • Filtering op eigenschappen wordt ondersteund in de API (bijv. GET /producttypen?eigenschappen[doelgroep]=inwoners boven 18).

Documentatie

  • De API-documentatie bevat voorbeelden van het instellen, bewerken en opvragen van eigenschappen.
  • Voorbeeld-API-aanvragen tonen hoe eigenschappen kunnen worden gebruikt in integraties en gemeentelijke toepassingen.

Definition of Done (DoD)

  • Het veld eigenschappen is toegevoegd aan het ProductType-datamodel en geïmplementeerd in de API.
  • De API ondersteunt het beheren en opvragen van eigenschappen als key/value paren.
  • Validatie en foutafhandeling zijn volledig geïmplementeerd.
  • Filtering op eigenschappen werkt zoals beschreven en is getest.
  • Documentatie is bijgewerkt met uitleg, voorbeelden, en validatieregels.
@alextreme alextreme added the enhancement New feature or request label Nov 8, 2024
@alextreme alextreme transferred this issue from maykinmedia/open-producten-prototype Dec 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant