Jane version(s) affected: 6.1.0

(maybe other versions)

Description

When a property is non-required and not explicitly set, it must not be send in the request payload. Typically used in PATCH requests.

I have an entity with a property that can be non-null or null. Behind the scene, a null value erase the data...

It may be not the good way to do it, idk. But anyway a PATCH is intended for partial update.

How to reproduce

Here is a minimal example: https://github.com/Gounlaf/janephp-bug-nullable-nonrequired

Possible Solution

In other language (Java/Kotlin) there are library that provide an Optional type. I found an implementation by iFixit here: https://github.com/iFixit/php7-optional. It might help to support it correctly.

Regards,

When running janephp v4 for an openapi v2.0 swagger file, after about 40 minutes I get this error:

PHP Notice:  Undefined index: document-origin in /home/user/projects/janephp/vendor/jane-php/open-api/Normalizer/SchemaNormalizer.php on line 43
PHP Stack trace:
PHP   1. {main}() /home/user/projects/janephp/vendor/jane-php/open-api/bin/jane-openapi:0
PHP   2. Jane\OpenApi\Application->run() /home/user/projects/janephp/vendor/jane-php/open-api/bin/jane-openapi:22
PHP   3. Jane\OpenApi\Application->doRun() /home/user/projects/janephp/vendor/symfony/console/Application.php:148
PHP   4. Jane\OpenApi\Application->doRunCommand() /home/user/projects/janephp/vendor/symfony/console/Application.php:272
PHP   5. Jane\OpenApi\Command\GenerateCommand->run() /home/user/projects/janephp/vendor/symfony/console/Application.php:1011
PHP   6. Jane\OpenApi\Command\GenerateCommand->execute() /home/user/projects/janephp/vendor/symfony/console/Command/Command.php:255
PHP   7. Jane\OpenApi\JaneOpenApi->generate() /home/user/projects/janephp/vendor/jane-php/open-api/Command/GenerateCommand.php:69
PHP   8. Jane\OpenApi\Generator\Psr18ClientGenerator->generate() /home/user/projects/janephp/vendor/jane-php/json-schema/Generator/ChainGenerator.php:28
PHP   9. Jane\OpenApi\Generator\Psr7OperationGenerator->createOperation() /home/user/projects/janephp/vendor/jane-php/open-api/Generator/ClientGenerator.php:43
PHP  10. Jane\OpenApi\Generator\Psr7EndpointGenerator->createEndpointClass() /home/user/projects/janephp/vendor/jane-php/open-api/Generator/OperationGenerator.php:33
PHP  11. Jane\OpenApi\Generator\Psr7EndpointGenerator->getConstructor() /home/user/projects/janephp/vendor/jane-php/open-api/Generator/EndpointGenerator.php:74
PHP  12. Jane\OpenApi\Generator\Psr7EndpointGenerator->resolveParameter() /home/user/projects/janephp/vendor/jane-php/open-api/Generator/EndpointGenerator.php:145
PHP  13. Jane\JsonSchemaRuntime\Reference->resolve() /home/user/projects/janephp/vendor/jane-php/open-api/Generator/EndpointGenerator.php:647
PHP  14. Jane\OpenApi\Generator\Psr7EndpointGenerator->Jane\OpenApi\Generator\{closure:/home/user/projects/janephp/vendor/jane-php/open-api/Generator/EndpointGenerator.php:629-647}() /home/user/projects/janephp/vendor/jane-php/json-schema-runtime/Reference.php:68
PHP  15. Symfony\Component\Serializer\Serializer->denormalize() /home/user/projects/janephp/vendor/jane-php/open-api/Generator/EndpointGenerator.php:631
PHP  16. Jane\OpenApi\Normalizer\BodyParameterNormalizer->denormalize() /home/user/projects/janephp/vendor/symfony/serializer/Serializer.php:191
PHP  17. Symfony\Component\Serializer\Serializer->denormalize() /home/user/projects/janephp/vendor/jane-php/open-api/Normalizer/BodyParameterNormalizer.php:64
PHP  18. Jane\OpenApi\Normalizer\SchemaNormalizer->denormalize() /home/user/projects/janephp/vendor/symfony/serializer/Serializer.php:191

PHP Fatal error:  Uncaught TypeError: Argument 2 passed to Jane\JsonSchemaRuntime\Reference::__construct() must be of the type string, null given, called in /home/user/projects/janephp/vendor/jane-php/open-api/Normalizer/SchemaNormalizer.php on line 43 and defined in /home/user/projects/janephp/vendor/jane-php/json-schema-runtime/Reference.php:28
Stack trace:
#0 /home/user/projects/janephp/vendor/jane-php/open-api/Normalizer/SchemaNormalizer.php(43): Jane\JsonSchemaRuntime\Reference->__construct('#/definitions/S...', NULL)
#1 /home/user/projects/janephp/vendor/symfony/serializer/Serializer.php(191): Jane\OpenApi\Normalizer\SchemaNormalizer->denormalize(Object(stdClass), 'Jane\\OpenApi\\Mo...', 'json', Array)
#2 /home/user/projects/janephp/vendor/jane-php/open-api/Normalizer/BodyParameterNormalizer.php(64): Symfony\Component\Serializer\Serializer->denormalize(Object(stdClass), 'Jane\\OpenApi\\Mo...', 'jso in /home/user/projects/janephp/vendor/jane-php/json-schema-runtime/Reference.php on line 28

If necessary I can provide the swagger file on request, but it looks more like a general issue to me (missing validation if $context['document-origin'] is present).

Fixes #225

I stumbled open

Uncaught TypeError: Argument 1 passed to Jane\OpenApi\Generator\RequestBodyGenerator::getSerializeStatements() must be an instance of Jane\OpenApi\JsonSchema\Model\RequestBody or null, instance of Jane\JsonSchemaRuntime\Reference

and

Call to undefined method Jane\JsonSchemaRuntime\Reference::getContent()

when using an openapi specification with references in the request body. This is not an optimal fix but this will at least end up in a generated client. Whether the client is working correctly is still something to find out. I cannot provide a minimal example yet as I have to reduce the problem.

For now I need some feedback on that error and hints on solving this over all in this library.

In my JSON file I have the OpenApi "required" section to define the required fields. But when Jane generates the JSON Models it makes everything nullable, which is a problem, when I want the required fields to be not nullable. Also it doesn't put |null in the doc block.

Is there a config option? Or is this a bug?

We have several places running the same API and we want to be able to configure our applications which one to use based on the environment (dev, test, prod). This is not possible when hardcoding the host: xxx field into the spec.

The documentation mentions that it should be possible to handle these cases. However, I could not find a way to do:

• Keep the basePath in the spec (it will not change)
• Be able to parametrize the host, probably while the Client class is being created.

Looking at the code, I seem to have the following problem. When host is not provided, the Client::create() factory method will not contain the AddHostPlugin() call. There is no way for me to pass this plugin into the create call, however. I can only provide the whole $httpClient instance. I don't understand how to keep most of the default client creation and only provide the host URL, the single plugin.

It seems to me that with the current functionality, I have two options:

• Provide both host and basePath and be locked to a single host url
• Manually parse the spec file for basePath and create a custom $httpClient instance. I have to parse the spec because I cannot read the basePath value anywhere

Am I missing something?

This gist shows the create functions I am talking about: https://gist.github.com/melkamar/f98e8996dc55a2e457a6efeed2154ee1

Thanks!

When a schema file provides a required header Content-Type it will influence the type check for the header that is auto generated by jane. This later conflicts with the options resolver as it expects it to be the type of the schema and not the auto generated array. This change will ensure it is at least of type array.

Regarding the options resolver and content types I rearranged the passed headers as the generated Content-Type header is marked defined and required but the headers that are checked by the options resolver do not include the auto generated Content-Type header and therefore fail due to being "non-"existing.

Hey,

I'm trying to use janephp/automapper-bundle to map User entity to its doctrine equivalent DoctrineUser. Both them have propery $id that has type Ramsey\Uuid\UuidInterface. So when I use map($user, $doctrineUser) I get the error "Cannot instantiate interface Ramsey\Uuid\UuidInterface". Is there any solution that helps me to handle this?

Thanks :)

Class examples:

class User {
    public function __construct(
        private UuidInterface $id,
        private string $email,
        private string $roles,
    ) {}



    // getters and other functions //
}

/**
 * @ORM\Table("users")
 * @ORM\Entity(repositoryClass=UserRepository::class)
 */
class DoctrineUser implements UserInterface, PasswordAuthenticatedUserInterface {
    /**
     * @ORM\Id
     * @ORM\Column(type="uuid")
     */
    private UuidInterface $id;

    /**
     * @ORM\Column(type="string", length=180, unique=true)
     */
    private string $email;

    /**
     * @ORM\Column(type="json")
     */
    private array $roles = [];

    /**
     * @ORM\Column(type="string")
     */
    private string $password;



    // getters and setters //
}

class UserRepository extends ServiceEntityRepository {
    // constructor //

    public function create(User $user, string $password): void
    {
        $doctrineUser = new DoctrineUser();
        $this->automapper->map($user, $doctrineUser); // <-----------------
        $doctrineUser->setPassword($password);

        $this->save($doctrineUser);
    }
}

Jane version(s) affected: open-api-runtime 6.1.1

Description
Tried to generate a model for https://api.poc-picturepark.com/docs/rest/PictureparkSwagger.json, got this error:

PHP Fatal error:  Uncaught Error: Call to a member function getDescription() on array in /vendor/jane-php/open-api-3/Generator/Endpoint/GetTransformResponseBodyTrait.php:43
Stack trace:
#0 /vendor/jane-php/open-api-3/Generator/EndpointGenerator.php(80): Jane\OpenApi3\Generator\EndpointGenerator->getTransformResponseBody(Object(Jane\OpenApiCommon\Guesser\Guess\OperationGuess), 'BusinessProcess...', Object(Jane\OpenApi3\Guesser\GuessClass), Object(Jane\OpenApiCommon\Generator\ExceptionGenerator), Object(Jane\JsonSchema\Generator\Context\Context))
#1 /vendor/jane-php/open-api-common/Generator/OperationGenerator.php(38): Jane\OpenApi3\Generator\EndpointGenerator->createEndpointClass(Object(Jane\OpenApiCommon\Guesser\Guess\OperationGuess), Object(Jane\JsonSchema\Generator\Context\Context))
#2 /vendor/jane-php/open-api-common/Generator/ClientGenerator.php(38): Jane\OpenApiCommon\Generator\OperationGenerator->createOperation('businessProcess...', Object(J in /vendor/jane-php/open-api-3/Generator/Endpoint/GetTransformResponseBodyTrait.php on line 43

How to reproduce
Installed latest symfony, allowed flex contribs, composer required open-api-runtime, added mentioned PictureparkSwagger.json to the config and ran the generate command

Possible Solution

Additional context

When a parameter has a reference for a schema, NonBodyParameterGenerator::getDefaultAsExpr() throws the error:

Fatal error: Uncaught Error: Call to undefined method Jane\JsonSchemaRuntime\Reference::getDefault()

My temporary fix was:

    /**
     * Generate a default value as an Expr.
     */
    private function getDefaultAsExpr(Parameter $parameter): Expr
    {
        $schema = $parameter->getSchema();
        $default = $schema instanceof Reference ? $schema->resolve()['default'] : $schema->getDefault();
        $expr = $this->parser->parse('<?php ' . var_export($default, true) . ';')[0];

        if ($expr instanceof Stmt\Expression) {
            return $expr->expr;
        }

        return $expr;
    }

Example OAS3 schema:

components:
  parameters:
    foo:
      in: query
      required: false
      schema:
        $ref: '#/components/schemas/string_enum_4'
  schemas:
    string_enum_4:
      enum:
        - bar
        - baz
        - qux
        - quux
      type: string

The generated normalizers does not match the interfaces DenormalizerInterface NormalizerInterface DenormalizerAwareInterface NormalizerAwareInterface

see #157

Resolved parameter types for response bodies of type mixed are used as type hints in endpoint constructor and related client operation method signatures.

This PR fixes this by using the default parameter type null for these cases.

Fixes #682

Adds:

• Default message based on https://github.com/symfony/symfony/blob/6.3/src/Symfony/Component/HttpFoundation/Response.php#L149-L212 in exceptions with no descriptions
• Response as an exception attribute

Is your feature request related to a problem? Please describe. I would need a way to warm-up mappers when using the AutoMapper bundle

Describe the solution you'd like Something like this when defining the bundle configuration:

jane_auto_mapper:
    autoregister: true
    mappings:
        - source: Jane\Bundle\AutoMapper\Tests\Fixtures\User
          target: Jane\Bundle\AutoMapper\Tests\Fixtures\UserDTO
          pass: DummyApp\UserConfigurationPass
    warmup:
        - source: array
          target: Jane\Bundle\AutoMapper\Tests\Fixtures\User
        - source: Jane\Bundle\AutoMapper\Tests\Fixtures\User
          target: Jane\Bundle\AutoMapper\Tests\Fixtures\UserDTO

Is your feature request related to a problem? Please describe. Adding a way to check a model metadata from a CLI perspective into our Symfony Bundle.

Describe the solution you'd like A command in the bundle where I can give a model FQCN and it will output if it sees properties with metadata issues.

Is your feature request related to a problem? Please describe.

Jane can not process usages of oneOf which often used in OpenAPI schemas

Describe the solution you'd like

Right now I do not have fully-scale solution for support of oneOf. Saying full-scale solution I mean at least two aspects:

• building an object model (classes) against OpenAPI specs
• converting the data being transferred during the usage of the API via the SDK

First I'd like to discuss what we want to receive in PHP code when we use oneOf i.e what classes should be built from schemas with oneOf

First of all I think we must strictly distinguish the contexts of oneOf keywords usage. There can be two options:

• oneOf applied to the entity which has its own name and therefore can be explicitly converted to some class in object oriented programming languages like PHP

    {
      "Entity": {
        "type": "object",
        "oneOf": [
           ......
        ]
      }
    }

• oneOf applied to properties

    {
      "Entity": {
        "type": "object",
        "properties": {
          "theProperty": {
            "type": "object",
            "oneOf": [
              .......
            ]
        }
      }
    }

In terms of programming languages which support types, oneOf naturally corresponds with the union types and the best option is - to convert all usages of oneOf into unions. In PHP it’s possible to use syntax of union in argument and property declarations, but it’s not possible to declare custom type as a union of types, so some tricks will be required to process such cases

OneOf for Entity

OneOf custom types

In PHP it’s not possible to declare custom type as a union of types and where possible we can do some tricks replacing union with inheritance

Schema Example:

{
    "Entity": {
        "type": "object",
        "title": "Entity which can be TypeOne or TypeTwo",
        "oneOf": [
            {
                "$ref": "#/components/schemas/TypeOne"
            },
            {
                "$ref": "#/components/schemas/TypeTwo"
            }
        ]
    },
    "TypeOne": {
        "type": "object",
        "title": "TypeOne",
        "properties": {
            "typeOneProperty": {
                "type": "string"
            }
        }
    },
    "TypeTwo": {
        "type": "object",
        "title": "TypeTwo",
        "properties": {
            "typeTwoProperty": {
                "type": "string"
            }
        }
    }
}

PHP Code:

class Entity {
    
}

class TypeOne extends Entity {

    /**
     * @var string
     */
    private $typeOneProperty;
}

class TypeTwo extends Entity {

    /**
     * @var string
     */
    private $typeTwoProperty;
}

OneOf built-in types

But it’s also not possible to declare that your entity is one of primitive types.

Schema Example:

     "components": {
        "schemas": {
            "Entity": {
                "type": "object",
                "title": "An Entity which can be an integer or a string",
                "oneOf": [
                    {
                        "type": "integer"
                    },
                    {
                        "type": "string"
                    }
                ]
            }
        }
    }

PHP Code:

PHP does not allow declare classes which can be union of several types, we can not declare that some class is a parent for integer and string. I'm afraid no way to process such cases for in PHP-clients

OneOf for property

It’s possible to use syntax of union in argument and property declarations

OneOf built-in types

Schema Example:

{
    "Entity": {
        "type": "object",
        "title": "Entity which can be TypeOne or TypeTwo",
        "properties": {
            "theProperty": {
                "type": "object",
                "oneOf": [
                    {
                        "type": "integer"
                    },
                    {
                        "type": "string"
                    }
                ]
            }
        }
    }
}

PHP Code:

class Entity {
    /**
     \* @var int|string 
     */
    private $theProperty;

    /**
     * @return int|string
     */
    public function getTheProperty()
    {
        return $this->theProperty;
    }

    /**
     * @param int|string $theProperty
     */
    public function setTheProperty($theProperty): void
    {
        $this->theProperty = $theProperty;
    }
}

OneOf custom types

Schema Example:

{
    "Entity": {
        "type": "object",
        "title": "Entity which can be TypeOne or TypeTwo",
        "properties": {
            "theProperty": {
                "type": "object",
                "oneOf": [
                    {
                        "$ref": "#/components/schemas/TypeOne"
                    },
                    {
                        "$ref": "#/components/schemas/TypeTwo"
                    }
                ]
            }
        }
    },
    "TypeOne": {
        "type": "object",
        "title": "TypeOne",
        "properties": {
            "typeOneProperty": {
                "type": "string"
            }
        }
    },
    "TypeTwo": {
        "type": "object",
        "title": "TypeTwo",
        "properties": {
            "typeTwoProperty": {
                "type": "string"
            }
        }
    }
}

PHP Code:

class Entity {
    /**
     * @var TypeOne|TypeTwo 
     */
    private $theProperty;

    /**
     * @return TypeOne|TypeTwo
     */
    public function getTheProperty()
    {
        return $this->theProperty;
    }

    /**
     * @param TypeOne|TypeTwo $theProperty
     */
    public function setTheProperty($theProperty): void
    {
        $this->theProperty = $theProperty;
    }
}

class TypeOne {

    /**
     * @var string
     */
    private $typeOneProperty;
}

class TypeTwo {

    /**
     * @var string
     */
    private $typeTwoProperty;
}

Conclusion

If we agree about expected result in terms of PHP classes, I could continue working on how this conversion can be achieved in terms of serialization. Looking forward for your reply. Cheers

Jane version(s) affected: 7.4.0

Description
Exceptions do not contain server response body thus not allowing to understand what exactly went wrong during the request.

E.g. we're trying to create some resource, but server-side validation of some field failed and the server returned a 422 response. Jane would throw an UnprocessableEntityException that we can catch in our client code, but we can't show the user what exactly went wrong because we don't have access to the response body, containing that information.

I'm not sure whether something's wrong with my OpenAPI specification, but exception classes that are generated by Jane only contain the Unprocessable entity message and nothing else.

How to reproduce

1. Send POST /collection with payload that would cause 422 error.
2. Catch UnprocessableEntityException.
3. Try to render human-readable error message with details of which particular field is invalid and why.

Possible Solution
I believe exceptions must contain a response body with error details at least in raw format in case there's no easy way to standardize it.

Hello,

here is a failing test case for a problem which occurs in jane-php/open-api-3 version 7.4.0. Problem was not present in 7.3.1

given this deifnition

    "components": {
        "schemas": {
            "Foo": {
                "properties": {
                    "bar": {
                        "$ref": "#\/components\/schemas\/Bar"
                    }
                },
                "type": "object"
            },
            "Bar": {
                "type": "object"
            }
        }
    }

I expect the type of property Foo:$bar to be mixed, and not mixed[]

WDYT?