swagger-api / swagger-api/swagger-codegen

[PHP] Keep array keys while deserializing data

Open
#10,584 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Mustache
Stars
17.8k
Forks
6k
PR merge metrics
No merged PRs in 30d

Description

Description

I have some API results that contains key/value arrays. They are currently lost during the deserialization process.
My workaround was to duplicate the ObjectSerializer template to fix it, but I may miss some important updates one day.

Swagger-codegen version

2.4.17

Swagger declaration file content or url
Command line used for generation
Steps to reproduce
  1. Fetch data with a key/value array
  2. Deserialize the data
  3. Dump the generated model and see that the keys disappeared
Related issues/PRs
Suggest a fix/enhancement

Keep the keys while deserializing in ObjectSerializer, if this isn't intentional.
I'll open a PR

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the PHP ObjectSerializer template used by generated clients and reproduce the reported key/value-array case from the three listed steps. Trace deserialization and verify that the resulting model retains the original keys; done when the generated model no longer loses them.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
api
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.