Merge branch 'master' into wip-reference-cache

Author: cebe

.travis.yml

@@ -4,21 +4,21 @@ matrix:
   include:
     # linux tests
     - php: '7.1'
-      env: YAML=^3.0
+      env: YAML=^3.4
     - php: '7.1'
       env: YAML=~4.3.0
     - php: '7.2'
-      env: YAML=^3.0
+      env: YAML=^3.4
     - php: '7.2'
       env: YAML=~4.3.0
     - php: '7.3'
-      env: YAML=^3.0
+      env: YAML=^3.4
     - php: '7.3'
       env: YAML=~4.3.0
     - php: '7.3'
       env: YAML=^5.0
     - php: '7.4'
-      env: YAML=^3.0
+      env: YAML=^3.4
     - php: '7.4'
       env: YAML=~4.3.0
     - php: '7.4'

Makefile

@@ -1,6 +1,6 @@
 TESTCASE=
 XDEBUG=0
-PHPARGS=-dmemory_limit=64M
+PHPARGS=-dmemory_limit=512M
 XPHPARGS=
 ifeq ($(XDEBUG),1)
 XPHPARGS=-dzend_extension=xdebug.so -dxdebug.remote_enable=1 -dxdebug.remote_autostart=1

README.md

@@ -26,6 +26,7 @@ do awesome work:
 - [cebe/yii2-openapi](https://github.com/cebe/yii2-openapi) Code Generator for REST API from OpenAPI 3 Descriptions, includes fake data generator.
 - [cebe/yii2-app-api](https://github.com/cebe/yii2-app-api) Yii framework application template for developing API-first applications.
 - [league/openapi-psr7-validator](https://github.com/thephpleague/openapi-psr7-validator) validates PSR-7 messages (HTTP request/response) against OpenAPI descriptions.
+- [dsuurlant/response2schema](https://github.com/dsuurlant/response2schema) a quick and easy tool for generating OpenAPI schemas based on example data.
 - ... ([add yours](https://github.com/cebe/php-openapi/edit/master/README.md#L24))
 
 ## Usage
@@ -89,7 +90,7 @@ Read OpenAPI Description from YAML:
 use cebe\openapi\Reader;
 
 // realpath is needed for resolving references with relative Paths or URLs
-$openapi = Reader::readFromYamlFile(realpath('openapi.json'));
+$openapi = Reader::readFromYamlFile(realpath('openapi.yaml'));
 // you may also specify the URL to your API Description file
 $openapi = Reader::readFromYamlFile('https://raw.githubusercontent.com/OAI/OpenAPI-Specification/3.0.2/examples/v3.0/petstore-expanded.yaml');
 ```

composer.json

@@ -20,7 +20,7 @@
 	"require": {
 		"php": ">=7.1.0",
 		"ext-json": "*",
-		"symfony/yaml": "^3.0 | ~4.0.0 | ~4.1.0 | ~4.2.0 | ~4.3.0 | ^5.0",
+		"symfony/yaml": "^3.4 | ^4.0 | ^5.0",
 		"justinrainbow/json-schema": "^5.0"
 	},
 	"require-dev": {

src/spec/MediaType.php

@@ -53,7 +53,13 @@ public function __construct(array $data)
                 if ($encodingData instanceof Encoding) {
                     $encoding[$property] = $encodingData;
                 } elseif (is_array($encodingData)) {
-                    $encoding[$property] = new Encoding($encodingData, $this->schema->properties[$property] ?? null);
+                    $schema = $this->schema->properties[$property] ?? null;
+                    // Don't pass the schema if it's still an unresolved reference.
+                    if ($schema instanceof Reference) {
+                        $encoding[$property] = new Encoding($encodingData);
+                    } else {
+                        $encoding[$property] = new Encoding($encodingData, $schema);
+                    }
                 } else {
                     $givenType = gettype($encodingData);
                     if ($givenType === 'object') {

src/spec/Schema.php

@@ -26,9 +26,9 @@
  * @property string $title
  * @property int|float $multipleOf
  * @property int|float $maximum
- * @property int|float $exclusiveMaximum
+ * @property bool $exclusiveMaximum
  * @property int|float $minimum
- * @property int|float $exclusiveMinimum
+ * @property bool $exclusiveMinimum
  * @property int $maxLength
  * @property int $minLength
  * @property string $pattern (This string SHOULD be a valid regular expression, according to the [ECMA 262 regular expression dialect](https://www.ecma-international.org/ecma-262/5.1/#sec-7.8.5))

tests/ReaderTest.php

@@ -96,8 +96,12 @@ public function testSymfonyYamlBugHunt()
     {
         // skip test on symfony/yaml 5.0 due to bug https://github.com/symfony/symfony/issues/34805
         $installed = json_decode(file_get_contents(__DIR__ . '/../vendor/composer/installed.json'), true);
+        // Check for composer 2.0 structure
+        if (array_key_exists('packages', $installed)) {
+            $installed = $installed['packages'];
+        }
         foreach($installed as $pkg) {
-            if ($pkg['name'] === 'symfony/yaml' && strncmp($pkg['version_normalized'], '5.0', 3) === 0) {
+            if ($pkg['name'] === 'symfony/yaml' && version_compare($pkg['version'], 'v4.4', '>=')) {
                 $this->markTestSkipped(
                     'This test is incompatible with symfony/yaml 4.4 and 5.0, see symfony bug https://github.com/symfony/symfony/issues/34805'
                 );

tests/spec/MediaTypeTest.php

@@ -3,7 +3,9 @@
 use cebe\openapi\Reader;
 use cebe\openapi\spec\MediaType;
 use cebe\openapi\spec\Example;
+use cebe\openapi\spec\OpenApi;
 use cebe\openapi\spec\Reference;
+use Symfony\Component\Yaml\Yaml;
 
 /**
  * @covers \cebe\openapi\spec\MediaType
@@ -114,4 +116,54 @@ public function testPathsCanNotBeCreatedFromBullshit($config, $expectedException
 
         new MediaType($config);
     }
+
+    public function testUnresolvedReferencesInEncoding()
+    {
+        $yaml = Yaml::parse(<<<'YAML'
+openapi: "3.0.0"
+info:
+  version: 1.0.0
+  title: Encoding test
+paths:
+  /pets:
+    post:
+      summary: Create a pet
+      operationId: createPets
+      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'
+      responses:
+        '201':
+          description: Null response
+components:
+  schemas:
+    Pet:
+      type: object
+      properties:
+        name:
+          type: string
+YAML
+);
+        $openapi = new OpenApi($yaml);
+        $result = $openapi->validate();
+
+        $this->assertEquals([], $openapi->getErrors());
+        $this->assertTrue($result);
+    }
 }

tests/spec/OpenApiTest.php

@@ -186,8 +186,12 @@ public function testSpecs($openApiFile)
         // skip test on symfony/yaml 5.0 due to bug https://github.com/symfony/symfony/issues/34805
         if ($openApiFile === 'oai/openapi-specification/examples/v3.0/uspto.yaml') {
             $installed = json_decode(file_get_contents(__DIR__ . '/../../vendor/composer/installed.json'), true);
+            // Check for composer 2.0 structure
+            if (array_key_exists('packages', $installed)) {
+                $installed = $installed['packages'];
+            }
             foreach ($installed as $pkg) {
-                if ($pkg['name'] === 'symfony/yaml' && strncmp($pkg['version_normalized'], '5.0', 3) === 0) {
+                if ($pkg['name'] === 'symfony/yaml' && version_compare($pkg['version'], 'v4.4', '>=')) {
                     $this->markTestSkipped(
                         'This test is incompatible with symfony/yaml 4.4 and 5.0, see symfony bug https://github.com/symfony/symfony/issues/34805'
                     );

tests/spec/SchemaTest.php

@@ -320,4 +320,39 @@ public function testRefAdditionalProperties()
         $schema = new Schema(['additionalProperties' => new Reference(['$ref' => '#/here'], Schema::class)]);
         $this->assertInstanceOf(Reference::class, $schema->additionalProperties);
     }
+
+    /**
+     * Ensure that a property named "$ref" is not interpreted as a reference.
+     * @link https://github.com/OAI/OpenAPI-Specification/issues/2173
+     */
+    public function testPropertyNameRef()
+    {
+        $json = <<<'JSON'
+{
+  "components": {
+    "schemas": {
+      "person": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string"
+          },
+          "$ref": {
+            "type": "string"
+          }
+        }
+      }
+    }
+  }
+}
+JSON;
+        $openApi = Reader::readFromJson($json);
+        $this->assertInstanceOf(Schema::class, $person = $openApi->components->schemas['person']);
+
+        $this->assertEquals(['name', '$ref'], array_keys($person->properties));
+        $this->assertInstanceOf(Schema::class, $person->properties['name']);
+        $this->assertInstanceOf(Schema::class, $person->properties['$ref']);
+        $this->assertEquals('string', $person->properties['name']->type);
+        $this->assertEquals('string', $person->properties['$ref']->type);
+    }
 }

yarn.lock

@@ -164,9 +164,9 @@ classnames@^2.2.0, classnames@^2.2.3, classnames@^2.2.6:
   integrity sha512-JR/iSQOSt+LQIWwrwEzJ9uk0xfN3mTVYMwt1Ir5mUcSN6pU+V4zQFFaJsclJbPuAUQH+yfWef6tm7l1quW3C8Q==
 
 clipboard@^2.0.0:
-  version "2.0.4"
-  resolved "https://registry.yarnpkg.com/clipboard/-/clipboard-2.0.4.tgz#836dafd66cf0fea5d71ce5d5b0bf6e958009112d"
-  integrity sha512-Vw26VSLRpJfBofiVaFb/I8PVfdI1OxKcYShe6fm0sP/DtmiWQNCjhM/okTvdCo0G+lMMm1rMYbk4IK4x1X+kgQ==
+  version "2.0.6"
+  resolved "https://registry.yarnpkg.com/clipboard/-/clipboard-2.0.6.tgz#52921296eec0fdf77ead1749421b21c968647376"
+  integrity sha512-g5zbiixBRk/wyKakSwCKd7vQXDjFnAMGHoEyBogG/bw9kTD9GvdAvaoRR1ALcEzt3pVKxZR0pViekPMIS0QyGg==
   dependencies:
     good-listener "^1.2.2"
     select "^1.1.2"
@@ -557,9 +557,9 @@ [email protected]:
   integrity sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==
 
 ini@^1.3.0:
-  version "1.3.5"
-  resolved "https://registry.yarnpkg.com/ini/-/ini-1.3.5.tgz#eee25f56db1c9ec6085e0c22778083f596abf927"
-  integrity sha512-RZY5huIKCMRWDUqZlEi72f/lmXKMvuszcMBduliQ3nnWbx9X/ZBQO7DijMEYS9EhHBb2qacRUMtC7svLwe0lcw==
+  version "1.3.7"
+  resolved "https://registry.yarnpkg.com/ini/-/ini-1.3.7.tgz#a09363e1911972ea16d7a8851005d84cf09a9a84"
+  integrity sha512-iKpRpXP+CrP2jyrxvg1kMUpXDyRUFDWurxbnVT1vQPx+Wz9uCYsMIqYuSBLV+PAaZG/d7kRLKRFc9oDMsH+mFQ==
 
 invert-kv@^1.0.0:
   version "1.0.0"
@@ -783,9 +783,9 @@ min-document@^2.19.0:
     dom-walk "^0.1.0"
 
 minimist@^1.2.0:
-  version "1.2.0"
-  resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.0.tgz#a35008b20f41383eec1fb914f4cd5df79a264284"
-  integrity sha1-o1AIsg9BOD7sH7kU9M1d95omQoQ=
+  version "1.2.5"
+  resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.5.tgz#67d66014b66a6a8aaa0c083c5fd58df4e4e97602"
+  integrity sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==
 
 mobx-react@^5.4.3:
   version "5.4.4"
@@ -840,9 +840,9 @@ node-fetch-h2@^2.3.0:
     http2-client "^1.2.5"
 
 node-fetch@^2.3.0:
-  version "2.6.0"
-  resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.6.0.tgz#e633456386d4aa55863f676a7ab0daa8fdecb0fd"
-  integrity sha512-8dG4H5ujfvFiqDmVu9fQ5bOHUC15JMjMY/Zumv26oOvvVJjM67KF8koCWIabKQ1GJIa9r2mMZscBq/TbdOcmNA==
+  version "2.6.1"
+  resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.6.1.tgz#045bd323631f76ed2e2b55573394416b639a0052"
+  integrity sha512-V4aYg89jEoVRxRb2fJdAg8FHvI7cEyYdVAh94HH0UIK8oJxUfkjlDQN9RbMx+bEjP7+ggMiFRprSti032Oipxw==
 
 node-readfiles@^0.2.0:
   version "0.2.0"
@@ -1026,9 +1026,9 @@ polished@^3.0.3:
     "@babel/runtime" "^7.4.5"
 
 prismjs@^1.15.0:
-  version "1.17.1"
-  resolved "https://registry.yarnpkg.com/prismjs/-/prismjs-1.17.1.tgz#e669fcbd4cdd873c35102881c33b14d0d68519be"
-  integrity sha512-PrEDJAFdUGbOP6xK/UsfkC5ghJsPJviKgnQOoxaDbBjwc8op68Quupwt1DeAFoG8GImPhiKXAvvsH7wDSLsu1Q==
+  version "1.21.0"
+  resolved "https://registry.yarnpkg.com/prismjs/-/prismjs-1.21.0.tgz#36c086ec36b45319ec4218ee164c110f9fc015a3"
+  integrity sha512-uGdSIu1nk3kej2iZsLyDoJ7e9bnPzIgY0naW/HdknGj61zScaprVEVGHrPoXqI+M9sP0NDnTK2jpkvmldpuqDw==
   optionalDependencies:
     clipboard "^2.0.0"