Producttype eigenschappen : is analoog aan zaaktype eigenschappen

[alextreme]

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.

[Floris272]

Looking at OpenZaak it seems that Eigenschap is a separate model with its own endpoint. Should this also be the case in Open Producten?

[stevenbal]

@alextreme since the title mentions "is analoog aan zaaktype eigenschappen": should just ProductType have eigenschappen with naam and waarde (meaning that Product doesn't have any eigenschappen itself). Or should (like in Catalogi and Zaken API) ProductType define types of eigenschappen (naam) and Product.eigenschappen contain the values of these eigenschappen?

[alextreme]

@stevenbal check this with @Floris272 just in case, but my assumption looking at the notes is the second: ProductType define types of eigenschappen (naam) and Product.eigenschappen contain the values of these eigenschappen

But both Floris and I had trouble wrapping our heads around this during our last meeting