openapi-generator icon indicating copy to clipboard operation
openapi-generator copied to clipboard

feat(php-nextgen): allow to serialize collections of enums

Open SomeBdyElse opened this issue 1 year ago • 4 comments

When serializing collections, make sure to serialize the members of the collection first, before applying http_build_query or implode.

@jebentier (2017/07), @dkarlovi (2017/07), @mandrean (2017/08), @jfastnacht (2017/09), @ybelenko (2018/07), @renepardon (2018/12)

PR checklist

  • [x] Read the contribution guidelines.
  • [ ] Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • [ ] Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH) Commit all changed files. This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master. These must match the expectations made by your contribution. You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*. IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • [x] File the PR against the correct branch: master (upcoming 7.1.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • [x] If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

SomeBdyElse avatar May 01 '24 12:05 SomeBdyElse

@SomeBdyElse thanks for the PR. what about adding a test or 2 in https://github.com/OpenAPITools/openapi-generator/blob/master/samples/client/petstore/php-nextgen/OpenAPIClient-php/test/ObjectSerializerTest.php ?

please follow step 3 to update the samples as well.

wing328 avatar May 01 '24 16:05 wing328

Hi @wing328 !

Thank you for looking at the PR. Unfortunately I do not have a Java development environment to build the project and examples. I might try https://github.com/OpenAPITools/openapi-generator?tab=readme-ov-file#development-in-docker .

Is https://github.com/OpenAPITools/openapi-generator/blob/master/samples/client/petstore/php-nextgen/OpenAPIClient-php/test/ObjectSerializerTest.php the right file to create the tests? I thought that the entire samples/client/petstore/php-nextgen/ path is a generated example.

SomeBdyElse avatar May 01 '24 20:05 SomeBdyElse

the right file to create the tests? I thought that the entire samples/client/petstore/php-nextgen/ path is a generated example.

these folder contains integration tests too so do not purge the whole folder when regenerating samples

wing328 avatar May 02 '24 03:05 wing328

Thank you for looking at the PR. Unfortunately I do not have a Java development environment to build the project and examples. I might try https://github.com/OpenAPITools/openapi-generator?tab=readme-ov-file#development-in-docker .

yes, please try that and let me know if you need any help.

wing328 avatar May 08 '24 07:05 wing328

i've updated the samples locally, ran the tests and got some errors:

6) OpenAPI\Client\ObjectSerializerTest::testToQueryValue with data set "form 0.0 float, explode on, required true" (0.0, 'field', 'float', 'form', true, true, 'field=0')
Failed asserting that two strings are equal.
--- Expected
+++ Actual
@@ @@
-'field=0'
+'field='

/mnt/c/Users/wing3/Code/openapi-generator/samples/client/petstore/php-nextgen/OpenAPIClient-php/test/ObjectSerializerTest.php:168

7) OpenAPI\Client\ObjectSerializerTest::testToQueryValue with data set "form 0 number, explode on, required false" (0, 'field', 'number', 'form', true, false, 'field=0')
Failed asserting that two strings are equal.
--- Expected
+++ Actual
@@ @@
-'field=0'
+''

/mnt/c/Users/wing3/Code/openapi-generator/samples/client/petstore/php-nextgen/OpenAPIClient-php/test/ObjectSerializerTest.php:168

8) OpenAPI\Client\ObjectSerializerTest::testToQueryValue with data set "form 0.0 number, explode on, required false" (0.0, 'field', 'number', 'form', true, false, 'field=0')
Failed asserting that two strings are equal.
--- Expected
+++ Actual
@@ @@
-'field=0'
+''

/mnt/c/Users/wing3/Code/openapi-generator/samples/client/petstore/php-nextgen/OpenAPIClient-php/test/ObjectSerializerTest.php:168

9) OpenAPI\Client\ObjectSerializerTest::testToQueryValue with data set "form 0 number, explode on, required true" (0, 'field', 'number', 'form', true, true, 'field=0')
Failed asserting that two strings are equal.
--- Expected
+++ Actual
@@ @@
-'field=0'
+'field='

/mnt/c/Users/wing3/Code/openapi-generator/samples/client/petstore/php-nextgen/OpenAPIClient-php/test/ObjectSerializerTest.php:168

10) OpenAPI\Client\ObjectSerializerTest::testToQueryValue with data set "form 0.0 number, explode on, required true" (0.0, 'field', 'number', 'form', true, true, 'field=0')
Failed asserting that two strings are equal.
--- Expected
+++ Actual
@@ @@
-'field=0'
+'field='

/mnt/c/Users/wing3/Code/openapi-generator/samples/client/petstore/php-nextgen/OpenAPIClient-php/test/ObjectSerializerTest.php:168

11) OpenAPI\Client\OuterEnumTest::testDeserialize
Failed asserting that OpenAPI\Client\Model\OuterEnum Object &00000000000000810000000000000000 (
    'name' => 'PLACED'
    'value' => 'placed'
) is of type "string".

/mnt/c/Users/wing3/Code/openapi-generator/samples/client/petstore/php-nextgen/OpenAPIClient-php/test/OuterEnumTest.php:18

12) OpenAPI\Client\OuterEnumTest::testDeserializeNested
OpenAPI\Client\Model\OuterEnum Object (...) does not match expected type "string".

/mnt/c/Users/wing3/Code/openapi-generator/samples/client/petstore/php-nextgen/OpenAPIClient-php/test/OuterEnumTest.php:48

13) OpenAPI\Client\OuterEnumTest::testSanitizeNestedInvalidValue
Failed asserting that exception of type "TypeError" matches expected exception "InvalidArgumentException". Message was: "OpenAPI\Client\Model\EnumTest::getEnumStringRequired(): Return value must be of type string, null returned" at
/mnt/c/Users/wing3/Code/openapi-generator/samples/client/petstore/php-nextgen/OpenAPIClient-php/src/Model/EnumTest.php:486
/mnt/c/Users/wing3/Code/openapi-generator/samples/client/petstore/php-nextgen/OpenAPIClient-php/src/ObjectSerializer.php:95
/mnt/c/Users/wing3/Code/openapi-generator/samples/client/petstore/php-nextgen/OpenAPIClient-php/test/OuterEnumTest.php:93

can you please take a look when you've time?

wing328 avatar May 27 '24 07:05 wing328