[GitHubAE] Update to 1.1.4-4c4e1701d928399d4897fc32d297d17b from 1.1.4-a2da0f53e6e409f85678904ce5808926

WyriHaximus · web-flow · commit 140b3d897833 · 2023-09-28T16:43:41.000Z
Detected Schema changes:

├─┬Paths
│ └─┬/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies
│   └─┬POST
│     └─┬Requestbody
│       └─┬application/json
│         └─┬Schema
│           └──[M] $ref (58795:14)❌
├─┬user-created
│ └─┬POST
│   └─┬Extensions
│     └──[M] x-github (45394:9)
├──check-run-created
├─┬user-deleted
│ └─┬POST
│   └─┬Extensions
│     └──[M] x-github (45454:9)
└─┬Components
  └──[-] schemas (58795:7)❌

Date: 09/28/23 | Commit: New: etc/specs/GitHubAE/previous.spec.yaml, Original: etc/specs/GitHubAE/current.spec.yaml
Document Element | Total Changes | Breaking Changes
paths            | 1             | 1
webhooks         | 2             | 0
components       | 1             | 1
❌  2 Breaking changes out of 4
INFO: Modifications: 3
INFO: Removals: 1
INFO: Breaking Removals: 1
INFO: Breaking Modifications: 1

ERROR: breaking changes discovered
diff --git a/etc/openapi-client-generator.state b/etc/openapi-client-generator.state
@@ -1,5 +1,5 @@
 {
-    "specHash": "a2da0f53e6e409f85678904ce5808926",
+    "specHash": "4c4e1701d928399d4897fc32d297d17b",
     "generatedFiles": {
         "files": [
             {
@@ -4848,7 +4848,7 @@
             },
             {
                 "name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/EnterpriseAdmin.php",
-                "hash": "969ab4e55d891ff1ee9a9a69939a14b8"
+                "hash": "3763297449aa164a5bc3781df0bc393c"
             },
             {
                 "name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/Apps.php",
@@ -4892,11 +4892,11 @@
             },
             {
                 "name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/Orgs.php",
-                "hash": "9c8bfc530e90d40ea31d8d330a8b0cc6"
+                "hash": "060f8e5408cf25e4f8ed5553efe32ae7"
             },
             {
                 "name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/Actions.php",
-                "hash": "80d30cf4f4e29714fc71a81c030c14be"
+                "hash": "30727655dc7e384b9c978060c8dec978"
             },
             {
                 "name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/CodeScanning.php",
@@ -4916,7 +4916,7 @@
             },
             {
                 "name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/Repos.php",
-                "hash": "2d4beedd21db7d61f1c5f34103c98bee"
+                "hash": "0fe31eb63fd9a5c5e3398cd2f14483e2"
             },
             {
                 "name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/Reactions.php",
@@ -17264,15 +17264,15 @@
             },
             {
                 "name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Internal\/Operation\/Repos\/CreateDeploymentBranchPolicy.php",
-                "hash": "adce63e41c5e7b33375bf14fa18aed9b"
+                "hash": "5cb40f8defd983846180d294db459b81"
             },
             {
                 "name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Internal\/Operator\/Repos\/CreateDeploymentBranchPolicy.php",
                 "hash": "42733615fa1190260f356e515519d4f3"
             },
             {
                 "name": ".\/clients\/GitHubAE\/etc\/..\/\/tests\/\/Internal\/Operation\/Repos\/CreateDeploymentBranchPolicyTest.php",
-                "hash": "e5351388ec5cb32b623ea4e16fd6da6f"
+                "hash": "4957e6de4cc85f30b081e49ae5fe4a05"
             },
             {
                 "name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Internal\/Operation\/Repos\/GetDeploymentBranchPolicy.php",
@@ -23401,6 +23401,10 @@
             {
                 "name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Internal\/Hydrator\/Operation\/Repos\/Owner\/Repo\/Actions\/Runs\/RunId\/ForceCancel.php",
                 "hash": "214bd6b16c7504cf76529ed48693ccd3"
+            },
+            {
+                "name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Schema\/DeploymentBranchPolicyNamePatternWithType.php",
+                "hash": "0b3d0945d7c97e2f516829d303f42e99"
             }
         ]
     },
diff --git a/src/Internal/Operation/Repos/CreateDeploymentBranchPolicy.php b/src/Internal/Operation/Repos/CreateDeploymentBranchPolicy.php
@@ -40,7 +40,7 @@ public function __construct(private readonly SchemaValidator $requestSchemaValid
 
     public function createRequest(array $data): RequestInterface
     {
-        $this->requestSchemaValidator->validate($data, Reader::readFromJson(Schema\DeploymentBranchPolicyNamePattern::SCHEMA_JSON, \cebe\openapi\spec\Schema::class));
+        $this->requestSchemaValidator->validate($data, Reader::readFromJson(Schema\DeploymentBranchPolicyNamePatternWithType::SCHEMA_JSON, \cebe\openapi\spec\Schema::class));
 
         return new Request(self::METHOD, str_replace(['{owner}', '{repo}', '{environment_name}'], [$this->owner, $this->repo, $this->environmentName], self::PATH), ['Content-Type' => 'application/json'], json_encode($data));
     }
diff --git a/src/Schema/DeploymentBranchPolicyNamePatternWithType.php b/src/Schema/DeploymentBranchPolicyNamePatternWithType.php
@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ApiClients\Client\GitHubAE\Schema;
+
+final readonly class DeploymentBranchPolicyNamePatternWithType
+{
+    public const SCHEMA_JSON         = '{
+    "title": "Deployment branch policy name pattern",
+    "required": [
+        "name"
+    ],
+    "type": "object",
+    "properties": {
+        "name": {
+            "type": "string",
+            "description": "The name pattern that branches must match in order to deploy to the environment.\\n\\nWildcard characters will not match `\\/`. For example, to match branches that begin with `release\\/` and contain an additional single slash, use `release\\/*\\/*`.\\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https:\\/\\/ruby-doc.org\\/core-2.5.1\\/File.html#method-c-fnmatch).",
+            "examples": [
+                "release\\/*"
+            ]
+        }
+    }
+}';
+    public const SCHEMA_TITLE        = 'Deployment branch policy name pattern';
+    public const SCHEMA_DESCRIPTION  = '';
+    public const SCHEMA_EXAMPLE_DATA = '{
+    "name": "release\\/*"
+}';
+
+    /**
+     * name: The name pattern that branches must match in order to deploy to the environment.
+
+    Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*`.
+    For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).
+     */
+    public function __construct(public string $name)
+    {
+    }
+}
diff --git a/tests/Internal/Operation/Repos/CreateDeploymentBranchPolicyTest.php b/tests/Internal/Operation/Repos/CreateDeploymentBranchPolicyTest.php
@@ -29,15 +29,15 @@ public function call_httpCode_200_requestContentType_application_json_responseCo
         $browser = $this->prophesize(Browser::class);
         $browser->withBase(Argument::any())->willReturn($browser->reveal());
         $browser->withFollowRedirects(Argument::any())->willReturn($browser->reveal());
-        $browser->request('POST', '/repos/generated/generated/environments/generated/deployment-branch-policies', Argument::type('array'), json_encode(json_decode(Schema\DeploymentBranchPolicyNamePattern::SCHEMA_EXAMPLE_DATA, true)))->willReturn(resolve($response))->shouldBeCalled();
+        $browser->request('POST', '/repos/generated/generated/environments/generated/deployment-branch-policies', Argument::type('array'), json_encode(json_decode(Schema\DeploymentBranchPolicyNamePatternWithType::SCHEMA_EXAMPLE_DATA, true)))->willReturn(resolve($response))->shouldBeCalled();
         $client = new Client($auth->reveal(), $browser->reveal());
         $result = $client->call(Internal\Operation\Repos\CreateDeploymentBranchPolicy::OPERATION_MATCH, (static function (array $data): array {
             $data['owner']            = 'generated';
             $data['repo']             = 'generated';
             $data['environment_name'] = 'generated';
 
             return $data;
-        })(json_decode(Schema\DeploymentBranchPolicyNamePattern::SCHEMA_EXAMPLE_DATA, true)));
+        })(json_decode(Schema\DeploymentBranchPolicyNamePatternWithType::SCHEMA_EXAMPLE_DATA, true)));
     }
 
     /** @test */
@@ -49,9 +49,9 @@ public function operations_httpCode_200_requestContentType_application_json_resp
         $browser = $this->prophesize(Browser::class);
         $browser->withBase(Argument::any())->willReturn($browser->reveal());
         $browser->withFollowRedirects(Argument::any())->willReturn($browser->reveal());
-        $browser->request('POST', '/repos/generated/generated/environments/generated/deployment-branch-policies', Argument::type('array'), json_encode(json_decode(Schema\DeploymentBranchPolicyNamePattern::SCHEMA_EXAMPLE_DATA, true)))->willReturn(resolve($response))->shouldBeCalled();
+        $browser->request('POST', '/repos/generated/generated/environments/generated/deployment-branch-policies', Argument::type('array'), json_encode(json_decode(Schema\DeploymentBranchPolicyNamePatternWithType::SCHEMA_EXAMPLE_DATA, true)))->willReturn(resolve($response))->shouldBeCalled();
         $client = new Client($auth->reveal(), $browser->reveal());
-        $result = $client->operations()->repos()->createDeploymentBranchPolicy('generated', 'generated', 'generated', json_decode(Schema\DeploymentBranchPolicyNamePattern::SCHEMA_EXAMPLE_DATA, true));
+        $result = $client->operations()->repos()->createDeploymentBranchPolicy('generated', 'generated', 'generated', json_decode(Schema\DeploymentBranchPolicyNamePatternWithType::SCHEMA_EXAMPLE_DATA, true));
     }
 
     /** @test */
@@ -63,15 +63,15 @@ public function call_httpCode_404_requestContentType_application_json_empty(): v
         $browser = $this->prophesize(Browser::class);
         $browser->withBase(Argument::any())->willReturn($browser->reveal());
         $browser->withFollowRedirects(Argument::any())->willReturn($browser->reveal());
-        $browser->request('POST', '/repos/generated/generated/environments/generated/deployment-branch-policies', Argument::type('array'), json_encode(json_decode(Schema\DeploymentBranchPolicyNamePattern::SCHEMA_EXAMPLE_DATA, true)))->willReturn(resolve($response))->shouldBeCalled();
+        $browser->request('POST', '/repos/generated/generated/environments/generated/deployment-branch-policies', Argument::type('array'), json_encode(json_decode(Schema\DeploymentBranchPolicyNamePatternWithType::SCHEMA_EXAMPLE_DATA, true)))->willReturn(resolve($response))->shouldBeCalled();
         $client = new Client($auth->reveal(), $browser->reveal());
         $result = $client->call(Internal\Operation\Repos\CreateDeploymentBranchPolicy::OPERATION_MATCH, (static function (array $data): array {
             $data['owner']            = 'generated';
             $data['repo']             = 'generated';
             $data['environment_name'] = 'generated';
 
             return $data;
-        })(json_decode(Schema\DeploymentBranchPolicyNamePattern::SCHEMA_EXAMPLE_DATA, true)));
+        })(json_decode(Schema\DeploymentBranchPolicyNamePatternWithType::SCHEMA_EXAMPLE_DATA, true)));
     }
 
     /** @test */
@@ -83,9 +83,9 @@ public function operations_httpCode_404_requestContentType_application_json_empt
         $browser = $this->prophesize(Browser::class);
         $browser->withBase(Argument::any())->willReturn($browser->reveal());
         $browser->withFollowRedirects(Argument::any())->willReturn($browser->reveal());
-        $browser->request('POST', '/repos/generated/generated/environments/generated/deployment-branch-policies', Argument::type('array'), json_encode(json_decode(Schema\DeploymentBranchPolicyNamePattern::SCHEMA_EXAMPLE_DATA, true)))->willReturn(resolve($response))->shouldBeCalled();
+        $browser->request('POST', '/repos/generated/generated/environments/generated/deployment-branch-policies', Argument::type('array'), json_encode(json_decode(Schema\DeploymentBranchPolicyNamePatternWithType::SCHEMA_EXAMPLE_DATA, true)))->willReturn(resolve($response))->shouldBeCalled();
         $client = new Client($auth->reveal(), $browser->reveal());
-        $result = $client->operations()->repos()->createDeploymentBranchPolicy('generated', 'generated', 'generated', json_decode(Schema\DeploymentBranchPolicyNamePattern::SCHEMA_EXAMPLE_DATA, true));
+        $result = $client->operations()->repos()->createDeploymentBranchPolicy('generated', 'generated', 'generated', json_decode(Schema\DeploymentBranchPolicyNamePatternWithType::SCHEMA_EXAMPLE_DATA, true));
         self::assertArrayHasKey('code', $result);
         self::assertSame(404, $result['code']);
     }
@@ -99,15 +99,15 @@ public function call_httpCode_303_requestContentType_application_json_empty(): v
         $browser = $this->prophesize(Browser::class);
         $browser->withBase(Argument::any())->willReturn($browser->reveal());
         $browser->withFollowRedirects(Argument::any())->willReturn($browser->reveal());
-        $browser->request('POST', '/repos/generated/generated/environments/generated/deployment-branch-policies', Argument::type('array'), json_encode(json_decode(Schema\DeploymentBranchPolicyNamePattern::SCHEMA_EXAMPLE_DATA, true)))->willReturn(resolve($response))->shouldBeCalled();
+        $browser->request('POST', '/repos/generated/generated/environments/generated/deployment-branch-policies', Argument::type('array'), json_encode(json_decode(Schema\DeploymentBranchPolicyNamePatternWithType::SCHEMA_EXAMPLE_DATA, true)))->willReturn(resolve($response))->shouldBeCalled();
         $client = new Client($auth->reveal(), $browser->reveal());
         $result = $client->call(Internal\Operation\Repos\CreateDeploymentBranchPolicy::OPERATION_MATCH, (static function (array $data): array {
             $data['owner']            = 'generated';
             $data['repo']             = 'generated';
             $data['environment_name'] = 'generated';
 
             return $data;
-        })(json_decode(Schema\DeploymentBranchPolicyNamePattern::SCHEMA_EXAMPLE_DATA, true)));
+        })(json_decode(Schema\DeploymentBranchPolicyNamePatternWithType::SCHEMA_EXAMPLE_DATA, true)));
     }
 
     /** @test */
@@ -119,9 +119,9 @@ public function operations_httpCode_303_requestContentType_application_json_empt
         $browser = $this->prophesize(Browser::class);
         $browser->withBase(Argument::any())->willReturn($browser->reveal());
         $browser->withFollowRedirects(Argument::any())->willReturn($browser->reveal());
-        $browser->request('POST', '/repos/generated/generated/environments/generated/deployment-branch-policies', Argument::type('array'), json_encode(json_decode(Schema\DeploymentBranchPolicyNamePattern::SCHEMA_EXAMPLE_DATA, true)))->willReturn(resolve($response))->shouldBeCalled();
+        $browser->request('POST', '/repos/generated/generated/environments/generated/deployment-branch-policies', Argument::type('array'), json_encode(json_decode(Schema\DeploymentBranchPolicyNamePatternWithType::SCHEMA_EXAMPLE_DATA, true)))->willReturn(resolve($response))->shouldBeCalled();
         $client = new Client($auth->reveal(), $browser->reveal());
-        $result = $client->operations()->repos()->createDeploymentBranchPolicy('generated', 'generated', 'generated', json_decode(Schema\DeploymentBranchPolicyNamePattern::SCHEMA_EXAMPLE_DATA, true));
+        $result = $client->operations()->repos()->createDeploymentBranchPolicy('generated', 'generated', 'generated', json_decode(Schema\DeploymentBranchPolicyNamePatternWithType::SCHEMA_EXAMPLE_DATA, true));
         self::assertArrayHasKey('code', $result);
         self::assertSame(303, $result['code']);
     }

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "specHash": "a2da0f53e6e409f85678904ce5808926",`
	`2`	`+ "specHash": "4c4e1701d928399d4897fc32d297d17b",`
`3`	`3`	`"generatedFiles": {`
`4`	`4`	`"files": [`
`5`	`5`	`{`
`@@ -4848,7 +4848,7 @@`
`4848`	`4848`	`},`
`4849`	`4849`	`{`
`4850`	`4850`	`"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/EnterpriseAdmin.php",`
`4851`		`- "hash": "969ab4e55d891ff1ee9a9a69939a14b8"`
	`4851`	`+ "hash": "3763297449aa164a5bc3781df0bc393c"`
`4852`	`4852`	`},`
`4853`	`4853`	`{`
`4854`	`4854`	`"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/Apps.php",`
`@@ -4892,11 +4892,11 @@`
`4892`	`4892`	`},`
`4893`	`4893`	`{`
`4894`	`4894`	`"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/Orgs.php",`
`4895`		`- "hash": "9c8bfc530e90d40ea31d8d330a8b0cc6"`
	`4895`	`+ "hash": "060f8e5408cf25e4f8ed5553efe32ae7"`
`4896`	`4896`	`},`
`4897`	`4897`	`{`
`4898`	`4898`	`"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/Actions.php",`
`4899`		`- "hash": "80d30cf4f4e29714fc71a81c030c14be"`
	`4899`	`+ "hash": "30727655dc7e384b9c978060c8dec978"`
`4900`	`4900`	`},`
`4901`	`4901`	`{`
`4902`	`4902`	`"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/CodeScanning.php",`
`@@ -4916,7 +4916,7 @@`
`4916`	`4916`	`},`
`4917`	`4917`	`{`
`4918`	`4918`	`"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/Repos.php",`
`4919`		`- "hash": "2d4beedd21db7d61f1c5f34103c98bee"`
	`4919`	`+ "hash": "0fe31eb63fd9a5c5e3398cd2f14483e2"`
`4920`	`4920`	`},`
`4921`	`4921`	`{`
`4922`	`4922`	`"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/Reactions.php",`
`@@ -17264,15 +17264,15 @@`
`17264`	`17264`	`},`
`17265`	`17265`	`{`
`17266`	`17266`	`"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Internal\/Operation\/Repos\/CreateDeploymentBranchPolicy.php",`
`17267`		`- "hash": "adce63e41c5e7b33375bf14fa18aed9b"`
	`17267`	`+ "hash": "5cb40f8defd983846180d294db459b81"`
`17268`	`17268`	`},`
`17269`	`17269`	`{`
`17270`	`17270`	`"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Internal\/Operator\/Repos\/CreateDeploymentBranchPolicy.php",`
`17271`	`17271`	`"hash": "42733615fa1190260f356e515519d4f3"`
`17272`	`17272`	`},`
`17273`	`17273`	`{`
`17274`	`17274`	`"name": ".\/clients\/GitHubAE\/etc\/..\/\/tests\/\/Internal\/Operation\/Repos\/CreateDeploymentBranchPolicyTest.php",`
`17275`		`- "hash": "e5351388ec5cb32b623ea4e16fd6da6f"`
	`17275`	`+ "hash": "4957e6de4cc85f30b081e49ae5fe4a05"`
`17276`	`17276`	`},`
`17277`	`17277`	`{`
`17278`	`17278`	`"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Internal\/Operation\/Repos\/GetDeploymentBranchPolicy.php",`
`@@ -23401,6 +23401,10 @@`
`23401`	`23401`	`{`
`23402`	`23402`	`"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Internal\/Hydrator\/Operation\/Repos\/Owner\/Repo\/Actions\/Runs\/RunId\/ForceCancel.php",`
`23403`	`23403`	`"hash": "214bd6b16c7504cf76529ed48693ccd3"`
	`23404`	`+ },`
	`23405`	`+ {`
	`23406`	`+ "name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Schema\/DeploymentBranchPolicyNamePatternWithType.php",`
	`23407`	`+ "hash": "0b3d0945d7c97e2f516829d303f42e99"`
`23404`	`23408`	`}`
`23405`	`23409`	`]`
`23406`	`23410`	`},`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ public function __construct(private readonly SchemaValidator $requestSchemaValid`
`40`	`40`
`41`	`41`	`public function createRequest(array $data): RequestInterface`
`42`	`42`	`{`
`43`		`- $this->requestSchemaValidator->validate($data, Reader::readFromJson(Schema\DeploymentBranchPolicyNamePattern::SCHEMA_JSON, \cebe\openapi\spec\Schema::class));`
	`43`	`+ $this->requestSchemaValidator->validate($data, Reader::readFromJson(Schema\DeploymentBranchPolicyNamePatternWithType::SCHEMA_JSON, \cebe\openapi\spec\Schema::class));`
`44`	`44`
`45`	`45`	`return new Request(self::METHOD, str_replace(['{owner}', '{repo}', '{environment_name}'], [$this->owner, $this->repo, $this->environmentName], self::PATH), ['Content-Type' => 'application/json'], json_encode($data));`
`46`	`46`	`}`