loafle/openapi-generator-original
3
0
Fork 1
mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-12-18 20:07:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

[PHP] Correctly format JSON in headers (#4024)

Browse Source 
* [PHP] Correctly format JSON in headers

`ObjectSerializer::toHeaderValue()` in the generated PHP code calls
`toString()` on the values, which formats JSON with the `JSON_PRETTY_PRINT`
option. This will result in a multi-line header which cannot be parsed
since linebreaks aren't allowed by RFC 7230.

In my case I have a header schema called `UpdateUser` which I had hoped
would be serialized as `{"type":"staff","id":123}`.

Every single `__toString()` in the generator does the same thing, so I
figured it's safe to change `toHeaderValue()` to convert to JSON directly,
without `JSON_PRETTY_PRINT`. This fix works for me.

* More sensible approach to providing a header value

* Just strip the newlines

* Go back to previous solution
This commit is contained in:
Hinrik Örn Sigurðsson
2019-10-03 13:38:15 +02:00
committed by Akihito Nakano
parent cc1bfe5fef
commit 60567bddd6
92 changed files with 902 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/AdditionalPropertiesAnyType.php
View File

@@ -292,6 +292,16 @@ class AdditionalPropertiesAnyType implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/AdditionalPropertiesArray.php
View File

@@ -292,6 +292,16 @@ class AdditionalPropertiesArray implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/AdditionalPropertiesBoolean.php
View File

@@ -292,6 +292,16 @@ class AdditionalPropertiesBoolean implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/AdditionalPropertiesClass.php
View File

@@ -592,6 +592,16 @@ class AdditionalPropertiesClass implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/AdditionalPropertiesInteger.php
View File

@@ -292,6 +292,16 @@ class AdditionalPropertiesInteger implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/AdditionalPropertiesNumber.php
View File

@@ -292,6 +292,16 @@ class AdditionalPropertiesNumber implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/AdditionalPropertiesObject.php
View File

@@ -292,6 +292,16 @@ class AdditionalPropertiesObject implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/AdditionalPropertiesString.php
View File

@@ -292,6 +292,16 @@ class AdditionalPropertiesString implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/Animal.php
View File

@@ -328,6 +328,16 @@ class Animal implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/ApiResponse.php
View File

@@ -352,6 +352,16 @@ class ApiResponse implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/ArrayOfArrayOfNumberOnly.php
View File

@@ -292,6 +292,16 @@ class ArrayOfArrayOfNumberOnly implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/ArrayOfNumberOnly.php
View File

@@ -292,6 +292,16 @@ class ArrayOfNumberOnly implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/ArrayTest.php
View File

@@ -352,6 +352,16 @@ class ArrayTest implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/Capitalization.php
View File

@@ -442,6 +442,16 @@ class Capitalization implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/Cat.php
View File

@@ -286,6 +286,16 @@ class Cat extends Animal
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/CatAllOf.php
View File

@@ -292,6 +292,16 @@ class CatAllOf implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/Category.php
View File

@@ -325,6 +325,16 @@ class Category implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/ClassModel.php
View File

@@ -293,6 +293,16 @@ class ClassModel implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/Client.php
View File

@@ -292,6 +292,16 @@ class Client implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/Dog.php
View File

@@ -286,6 +286,16 @@ class Dog extends Animal
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/DogAllOf.php
View File

@@ -292,6 +292,16 @@ class DogAllOf implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/EnumArrays.php
View File

@@ -378,6 +378,16 @@ class EnumArrays implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/EnumTest.php
View File

@@ -547,6 +547,16 @@ class EnumTest implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/File.php
View File

@@ -293,6 +293,16 @@ class File implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/FileSchemaTestClass.php
View File

@@ -322,6 +322,16 @@ class FileSchemaTestClass implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/FormatTest.php
View File

@@ -807,6 +807,16 @@ class FormatTest implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/HasOnlyReadOnly.php
View File

@@ -322,6 +322,16 @@ class HasOnlyReadOnly implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/MapTest.php
View File

@@ -406,6 +406,16 @@ class MapTest implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/MixedPropertiesAndAdditionalPropertiesClass.php
View File

@@ -352,6 +352,16 @@ class MixedPropertiesAndAdditionalPropertiesClass implements ModelInterface, Arr
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/Model200Response.php
View File

@@ -323,6 +323,16 @@ class Model200Response implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/ModelList.php
View File

@@ -292,6 +292,16 @@ class ModelList implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/ModelReturn.php
View File

@@ -293,6 +293,16 @@ class ModelReturn implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/Name.php
View File

@@ -386,6 +386,16 @@ class Name implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/NumberOnly.php
View File

@@ -292,6 +292,16 @@ class NumberOnly implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/Order.php
View File

@@ -476,6 +476,16 @@ class Order implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/OuterComposite.php
View File

@@ -352,6 +352,16 @@ class OuterComposite implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/Pet.php
View File

@@ -482,6 +482,16 @@ class Pet implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/ReadOnlyFirst.php
View File

@@ -322,6 +322,16 @@ class ReadOnlyFirst implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/SpecialModelName.php
View File

@@ -292,6 +292,16 @@ class SpecialModelName implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/Tag.php
View File

@@ -322,6 +322,16 @@ class Tag implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/TypeHolderDefault.php
View File

@@ -427,6 +427,16 @@ class TypeHolderDefault implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/TypeHolderExample.php
View File

@@ -460,6 +460,16 @@ class TypeHolderExample implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/User.php
View File

@@ -502,6 +502,16 @@ class User implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

10
samples/client/petstore/php/OpenAPIClient-php/lib/Model/XmlItem.php
View File

@@ -1132,6 +1132,16 @@ class XmlItem implements ModelInterface, ArrayAccess
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}

4
samples/client/petstore/php/OpenAPIClient-php/lib/ObjectSerializer.php
View File

@@ -150,6 +150,10 @@ class ObjectSerializer
*/
public static function toHeaderValue($value)
{
if (method_exists($value, 'toHeaderValue')) {
return $value->toHeaderValue();
}
return self::toString($value);
}