maykinmedia / open-klant

Registratiecomponent voor de opslag en ontsluiting van klantgegevens volgens de Klantinteracties API-specificatie.
Other
2 stars 3 forks source link

OpenAPI spec "digitale_adressen" does not match with "digitaleAdressen" attribuut in _expand of ExpandPartij #283

Open andyverberne opened 3 days ago

andyverberne commented 3 days ago

Product versie / Product version

2.3.0

Omschrijf het probleem / Describe the bug

Snippet from OpenAPI spec:

ExpandPartij:
  allOf:
    - $ref: '#/components/schemas/Partij'
    - type: object
      properties:
        _expand:
          type: object
          description: Display details of the linked resources requested in the
            `expand` parameter
          properties:
            digitale_adressen:
              type: array
              items:
                $ref: '#/components/schemas/DigitaalAdres'
              nullable: true
              description: Digitaal adresen dat een partij verstrekte voor gebruik
                bij toekomstig contact met de gemeente.

Snippet from retrieved response:

"_expand": {
            "digitaleAdressen": [
                {
                    "uuid": "31cc0d7f-70f6-4686-ae10-bd11c1282bfb",
                    "url": "https://open-klant-lab2.ow.lab.dimpact.nl/klantinteracties/api/v1/digitaleadressen/31cc0d7f-70f6-4686-ae10-bd11c1282bfb",
                    "verstrektDoorBetrokkene": null,
                    "verstrektDoorPartij": {
                        "uuid": "59dde1a4-b623-4250-8637-b15d25b0716f",
                        "url": "https://open-klant-lab2.ow.lab.dimpact.nl/klantinteracties/api/v1/partijen/59dde1a4-b623-4250-8637-b15d25b0716f"
                    },
                    "adres": "a@b.com",
                    "soortDigitaalAdres": "email",
                    "omschrijving": "E-mail adres"
                },

Stappen om te reproduceren / Steps to reproduce

  1. Retrieve the OpenAPI spec using the API specificaties button the user interface of Open Klant
  2. Create a Partij with one or more digitale adressen
  3. Retrieve the Partij using the &expand=digitaleAdressen query parameter
  4. Compare the reult with the OpenAPI spec: digitale_adressen != digitaleAdressen

Verwacht gedrag / Expected behavior

No response