Skip to content

Unresolved reference while instantiating Encoding#68

Merged
cebe merged 2 commits intocebe:masterfrom
karsa-mistmere:patch-1
Apr 7, 2020
Merged

Unresolved reference while instantiating Encoding#68
cebe merged 2 commits intocebe:masterfrom
karsa-mistmere:patch-1

Conversation

@karsa-mistmere
Copy link
Copy Markdown
Contributor

@karsa-mistmere karsa-mistmere commented Apr 1, 2020 •
edited
Loading

If there's a $ref within a multipart/form-data requestBody, the Encoding will be instantiated with a Reference object instead of a Schema object as expected resulting in a TypeErrorException.

To reproduce, just parse the following OpenAPI schema:

openapi: "3.0.0"
info:
  version: 1.0.0
  title: Multipart demo
paths:
  /pets:
    post:
      summary: Create a pet
      operationId: createPets
      tags:
        - pets
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                pet:
                  $ref: '#/components/schemas/Pet'
                petImage:
                  type: string
                  format: binary
            encoding:
              pet:
                contentType: application/json
              petImage:
                contentType: image/*
          application/json:
            schema:
              $ref: '#/components/schemas/Pet'
        description: The pet to be created
        required: true
      responses:
        '201':
          description: Null response

components:
  schemas:
    Pet:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string

Since this parameter is only ever used to guess the default encoding type of a property if and when it is not explicitly defined, I propose to skip the schema parameter altogether if during instantiation it is still an unresolved reference (otherwise we would have to pre-resolve references during instantiation leading to all other kinds of mishaps and a very substantial rewrite of the whole project).

php-openapi/src/spec/MediaType.php

Lines 56 to 62 in aafedb5

// Don't pass the schema if it's still an unresolved reference.
if (this->schema->properties[$property] instanceof Reference) {
$encoding[$property] = new Encoding($encodingData);
}
else {
$encoding[$property] = new Encoding($encodingData, $this->schema->properties[$property] ?? null);
}

@karsa-mistmere
Unresolved reference while instantiating Encoding
aafedb5 
If there's a `$ref` within a `multipart/form-data` `requestBody`, the `Encoding` will be instantiated with a `Reference` object instead of a `Schema` object as expected resulting in a `TypeErrorException`.
Since this parameter is only ever used to guess the default encoding type of a property if and when it is not explicitly defined, I propose to skip the schema parameter altogether if during instantiation it is still an unresolved reference (otherwise we would have to pre-resolve references during instantiation leading to all other kinds of mishaps and a very substantial rewrite of the whole project).
@cebe cebe added this to the 1.4.1 milestone Apr 1, 2020
@cebe cebe added the bug Something isn't working label Apr 1, 2020
@cebe cebe self-assigned this Apr 1, 2020
@cebe
Copy link
Copy Markdown
Owner

cebe commented Apr 1, 2020

Thanks for the fix! Could you add a test case to verify it?

@karsa-mistmere
Test case for unresolved references while instantiating Encoding
98d0465 
Test case for unresolved references while instantiating Encoding
@karsa-mistmere
Copy link
Copy Markdown
Contributor Author

karsa-mistmere commented Apr 1, 2020

Sure, I've commited it.

@cebe cebe merged commit 9572321 into cebe:master Apr 7, 2020
@cebe
Copy link
Copy Markdown
Owner

cebe commented Apr 7, 2020

Thank you!

cebe added a commit that referenced this pull request Apr 7, 2020
@cebe
cleanup fix for Unresolved reference while instantiating Encoding
ff90fca 
PR #68
@karsa-mistmere karsa-mistmere deleted the patch-1 branch April 29, 2020 16:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@cebe cebe

Labels

bug Something isn't working

Projects

None yet

Milestone

1.4.1

Development

Successfully merging this pull request may close these issues.

2 participants

@karsa-mistmere @cebe