diff --git a/clients/GitHub/etc/openapi-client-generator.state b/clients/GitHub/etc/openapi-client-generator.state index 3c8fedccd87..0f6e8be498f 100644 --- a/clients/GitHub/etc/openapi-client-generator.state +++ b/clients/GitHub/etc/openapi-client-generator.state @@ -1,5 +1,5 @@ { - "specHash": "c1edbd9927fe103e94027b18d46aa0e4", + "specHash": "9458c0477f3e10e00654df3219f3506a", "generatedFiles": { "files": [ { @@ -524,7 +524,7 @@ }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/RepositoryRulesetBypassActor.php", - "hash": "83705a685ea73d3e8f172764ffba2711" + "hash": "b36a042186b8a9bed422fe3c96c80f85" }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/RepositoryRulesetConditions.php", @@ -536,7 +536,7 @@ }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/OrgRulesetConditions.php", - "hash": "f8cf1bce3aba11fe9c65a27706cbb1d2" + "hash": "4c3980c5c065c337034572543f20471e" }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/RepositoryRuleCreation.php", @@ -604,7 +604,7 @@ }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/RepositoryRuleset.php", - "hash": "7dc0b80dc766b24c64d6353f9288bca2" + "hash": "8e1c29ff35771f7f17d22547af662cd5" }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/ActionsBillingUsage.php", @@ -1952,7 +1952,7 @@ }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/WebhookMergeGroupChecksRequested.php", - "hash": "f4c113fde697c03f299a9442c35ea550" + "hash": "53b29d2313af46cc20a2a32a1b0fb98a" }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/WebhookMetaDeleted.php", @@ -4628,11 +4628,11 @@ }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/Repos\/CreateOrgRuleset\/Request\/ApplicationJson.php", - "hash": "b0280f1996c06ebef0b59444546bdf93" + "hash": "524ca93d133aca32bba1b90d3bbed201" }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/Repos\/UpdateOrgRuleset\/Request\/ApplicationJson.php", - "hash": "9edc8dc810d292fb2055f23e871ef364" + "hash": "867f2d550a888bc7d8b48c12f4ba6791" }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/Teams\/Create\/Request\/ApplicationJson.php", @@ -4816,11 +4816,11 @@ }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/Repos\/UpdateBranchProtection\/Request\/ApplicationJson.php", - "hash": "79a8bd033e6efc1bdb057255ed4ca12e" + "hash": "548c6ea161f22f6663488601a6cb8ad4" }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/Repos\/UpdateBranchProtection\/Request\/ApplicationJson\/RequiredStatusChecks.php", - "hash": "0b960af2cf83982fe947c076d21d2eb5" + "hash": "ad27608b8037c9c0b89e0ed2aa40d5c8" }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/Repos\/UpdateBranchProtection\/Request\/ApplicationJson\/RequiredStatusChecks\/Checks.php", @@ -4848,7 +4848,7 @@ }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/Repos\/UpdateStatusCheckProtection\/Request\/ApplicationJson.php", - "hash": "05ea91d86ab2a2751f170e9b909510b8" + "hash": "ccfba20b0fe2afd9757237d66b5d6ab8" }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/Repos\/SetStatusCheckContexts\/Request\/ApplicationJson.php", @@ -5336,11 +5336,11 @@ }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/Repos\/CreateRepoRuleset\/Request\/ApplicationJson.php", - "hash": "79f4c16806156c36377e7a95df81f8ec" + "hash": "272bb8ffe70c702cdc4530b7c27143a9" }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/Repos\/UpdateRepoRuleset\/Request\/ApplicationJson.php", - "hash": "200b734577fe064c81af8da3f7494686" + "hash": "672be99a3aa2ca2ed1bb907a94e80996" }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/SecretScanning\/UpdateAlert\/Request\/ApplicationJson.php", @@ -5612,7 +5612,7 @@ }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Operation\/Repos.php", - "hash": "af3d3a3094434c46deb56bfd146053fc" + "hash": "8eab2a2b859f451a75eb6c348f394590" }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Operation\/Billing.php", @@ -5648,7 +5648,7 @@ }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Operation\/SecurityAdvisories.php", - "hash": "67428559cb53db9befa41253dc5d7da6" + "hash": "8c4aac090d10f4cd445e57d74d3351e4" }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Operation\/Search.php", @@ -11616,11 +11616,11 @@ }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/MergeGroup.php", - "hash": "b7294a44fb4d3e6ed28c6e097853eafe" + "hash": "8c5245d4fac04995610327a0142b9fdd" }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/WebhookMergeGroupDestroyed.php", - "hash": "ffd736270c6f9230b540e550c093bf40" + "hash": "03c8a668adf4710ed84c81f37540e4e4" }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/ApiOverview\/Domains.php", @@ -11800,15 +11800,15 @@ }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/WebhookRepositoryRulesetCreated.php", - "hash": "4c877288af50a7b7334cb1bc2fd52324" + "hash": "1e67457d601830a99b9df3f28ba56dff" }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/WebhookRepositoryRulesetDeleted.php", - "hash": "0dc395659ee136b10835c9fba64a5f11" + "hash": "fd7a4a3b361d64cc6351572d60d5d500" }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/WebhookRepositoryRulesetEdited.php", - "hash": "6dd804426a30e9e4498933adb821994b" + "hash": "ce991a6d07a851f3e27ef12ce1041c11" }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/WebhookDeploymentReviewApproved\/WorkflowRun\/Actor.php", @@ -24468,7 +24468,7 @@ }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Internal\/Router\/Get\/Repos.php", - "hash": "15b6c3b26b0222befe543a77d1d425dc" + "hash": "c3328f2b37c3796dfd1088b9f8a5ddb8" }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Internal\/Router\/Get\/Users.php", @@ -24744,7 +24744,7 @@ }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Internal\/Router\/List\/Repos.php", - "hash": "58feacbb3f5aceff6543f0db3e7d382f" + "hash": "20a949e9cfde5e3968b84f23bb387069" }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Internal\/Router\/List\/Activity.php", @@ -24960,11 +24960,11 @@ }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Internal\/Router\/Get\/Five.php", - "hash": "0846a936eb0a3e31a24ddb21a9bf9124" + "hash": "19ab8e8f42240bc9379eedc1af59716d" }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Internal\/Router\/Get\/Six.php", - "hash": "b2a28a4c2a159a5554c4694f89317cfd" + "hash": "7dbbcb60acf73b6e3bc73f443b40742d" }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Internal\/Router\/Get\/Seven.php", @@ -25064,11 +25064,11 @@ }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Internal\/Router\/List\/Five.php", - "hash": "847f3fb360c2b185cfe50d6fb2ad225b" + "hash": "24a252dc0f60a98121c41db92b4fc10d" }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Internal\/Router\/List\/Six.php", - "hash": "308c392e37c1750ea31302f83f39951f" + "hash": "854592a792479803f65817b8fb8dc4b8" }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Internal\/Router\/List\/Seven.php", @@ -27388,11 +27388,11 @@ }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Internal\/Operation\/Repos\/GetOrgRuleSuites.php", - "hash": "d3aed4ef214de6361c8ca0b45e7f70aa" + "hash": "5d875655de5246b4c6b45aee06c86aaa" }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Internal\/Operator\/Repos\/GetOrgRuleSuites.php", - "hash": "9525ac84738b11696decbfe37eadffa5" + "hash": "1e1db1d8112a4846d4d245a5400d3ad7" }, { "name": ".\/clients\/GitHub\/etc\/..\/\/tests\/\/Internal\/Operation\/Repos\/GetOrgRuleSuitesTest.php", @@ -27400,11 +27400,11 @@ }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Internal\/Operation\/Repos\/GetOrgRuleSuitesListing.php", - "hash": "eedf6f843ca19d71731c856445c3aa63" + "hash": "b7b2cee6ead0582fbadcabf628b48add" }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Internal\/Operator\/Repos\/GetOrgRuleSuitesListing.php", - "hash": "0af44c3d5f2d0c8da34894110150e69e" + "hash": "18d8b71770f211fa73139a753cad9cea" }, { "name": ".\/clients\/GitHub\/etc\/..\/\/tests\/\/Internal\/Operation\/Repos\/GetOrgRuleSuitesListingTest.php", @@ -27424,11 +27424,11 @@ }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Internal\/Operation\/Repos\/GetRepoRuleSuites.php", - "hash": "302f93fba8499e154a149399cf64ba38" + "hash": "f8953eadc49844b251876a884a6d0017" }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Internal\/Operator\/Repos\/GetRepoRuleSuites.php", - "hash": "3f26606fb72cd82ac11173f00d4f0bb9" + "hash": "44c35ce9b778591b251392daac746775" }, { "name": ".\/clients\/GitHub\/etc\/..\/\/tests\/\/Internal\/Operation\/Repos\/GetRepoRuleSuitesTest.php", @@ -27436,11 +27436,11 @@ }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Internal\/Operation\/Repos\/GetRepoRuleSuitesListing.php", - "hash": "8dcd35b357baa2578eb8b5138dc4141c" + "hash": "d85287206b261fafeefbfc2d1ba4bd01" }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Internal\/Operator\/Repos\/GetRepoRuleSuitesListing.php", - "hash": "2c55b972d1a7c6537d1ab0cfe1b9db49" + "hash": "7df9ac5ef34dd39c376cb51361c1997d" }, { "name": ".\/clients\/GitHub\/etc\/..\/\/tests\/\/Internal\/Operation\/Repos\/GetRepoRuleSuitesListingTest.php", @@ -27776,11 +27776,11 @@ }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/PHPStan\/ClientCallReturnTypes.php", - "hash": "b279bfe420072ca3881b316b41cde25a" + "hash": "01ddd6d5ae952444656c965dbe948a6a" }, { "name": ".\/clients\/GitHub\/etc\/..\/\/tests\/\/Types\/ClientCallReturnTypes.php", - "hash": "a3cd037b10acacb7fbfa8165f0c08dac" + "hash": "55379bd052b05312b4189058c164ea6d" }, { "name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/..\/etc\/phpstan-extension.neon", diff --git a/clients/GitHub/src/Internal/Operation/Repos/GetOrgRuleSuites.php b/clients/GitHub/src/Internal/Operation/Repos/GetOrgRuleSuites.php index 220bfc4dc7f..4905dc4be8c 100644 --- a/clients/GitHub/src/Internal/Operation/Repos/GetOrgRuleSuites.php +++ b/clients/GitHub/src/Internal/Operation/Repos/GetOrgRuleSuites.php @@ -27,8 +27,7 @@ final class GetOrgRuleSuites public const OPERATION_MATCH = 'GET /orgs/{org}/rulesets/rule-suites'; /**The organization name. The name is not case sensitive. **/ private string $org; - /**The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. - **/ + /**The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. **/ private string $ref; /**The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. **/ private int $repositoryName; diff --git a/clients/GitHub/src/Internal/Operation/Repos/GetOrgRuleSuitesListing.php b/clients/GitHub/src/Internal/Operation/Repos/GetOrgRuleSuitesListing.php index 0a7bbd76853..ea26cc4aa84 100644 --- a/clients/GitHub/src/Internal/Operation/Repos/GetOrgRuleSuitesListing.php +++ b/clients/GitHub/src/Internal/Operation/Repos/GetOrgRuleSuitesListing.php @@ -27,8 +27,7 @@ final class GetOrgRuleSuitesListing public const OPERATION_MATCH = 'LIST /orgs/{org}/rulesets/rule-suites'; /**The organization name. The name is not case sensitive. **/ private string $org; - /**The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. - **/ + /**The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. **/ private string $ref; /**The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. **/ private int $repositoryName; diff --git a/clients/GitHub/src/Internal/Operation/Repos/GetRepoRuleSuites.php b/clients/GitHub/src/Internal/Operation/Repos/GetRepoRuleSuites.php index d455d15cb5d..2e091942432 100644 --- a/clients/GitHub/src/Internal/Operation/Repos/GetRepoRuleSuites.php +++ b/clients/GitHub/src/Internal/Operation/Repos/GetRepoRuleSuites.php @@ -29,8 +29,7 @@ final class GetRepoRuleSuites private string $owner; /**The name of the repository without the `.git` extension. The name is not case sensitive. **/ private string $repo; - /**The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. - **/ + /**The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. **/ private string $ref; /**The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. **/ private string $actorName; diff --git a/clients/GitHub/src/Internal/Operation/Repos/GetRepoRuleSuitesListing.php b/clients/GitHub/src/Internal/Operation/Repos/GetRepoRuleSuitesListing.php index 20b7beb85fa..80f11396994 100644 --- a/clients/GitHub/src/Internal/Operation/Repos/GetRepoRuleSuitesListing.php +++ b/clients/GitHub/src/Internal/Operation/Repos/GetRepoRuleSuitesListing.php @@ -29,8 +29,7 @@ final class GetRepoRuleSuitesListing private string $owner; /**The name of the repository without the `.git` extension. The name is not case sensitive. **/ private string $repo; - /**The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. - **/ + /**The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. **/ private string $ref; /**The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. **/ private string $actorName; diff --git a/clients/GitHub/src/Internal/Operator/Repos/GetOrgRuleSuites.php b/clients/GitHub/src/Internal/Operator/Repos/GetOrgRuleSuites.php index a19ed0f9713..2d3cac59075 100644 --- a/clients/GitHub/src/Internal/Operator/Repos/GetOrgRuleSuites.php +++ b/clients/GitHub/src/Internal/Operator/Repos/GetOrgRuleSuites.php @@ -24,7 +24,7 @@ public function __construct(private Browser $browser, private AuthenticationInte { } - /** @return Observable */ + /** @return iterable */ public function call(string $org, string $ref, int $repositoryName, string $actorName, string $timePeriod = 'day', string $ruleSuiteResult = 'all', int $perPage = 30, int $page = 1): iterable { $operation = new \ApiClients\Client\GitHub\Internal\Operation\Repos\GetOrgRuleSuites($this->responseSchemaValidator, $this->hydrator, $org, $ref, $repositoryName, $actorName, $timePeriod, $ruleSuiteResult, $perPage, $page); diff --git a/clients/GitHub/src/Internal/Operator/Repos/GetOrgRuleSuitesListing.php b/clients/GitHub/src/Internal/Operator/Repos/GetOrgRuleSuitesListing.php index e01b5c22d38..f0a46447fcf 100644 --- a/clients/GitHub/src/Internal/Operator/Repos/GetOrgRuleSuitesListing.php +++ b/clients/GitHub/src/Internal/Operator/Repos/GetOrgRuleSuitesListing.php @@ -24,7 +24,7 @@ public function __construct(private Browser $browser, private AuthenticationInte { } - /** @return Observable */ + /** @return iterable */ public function call(string $org, string $ref, int $repositoryName, string $actorName, string $timePeriod = 'day', string $ruleSuiteResult = 'all', int $perPage = 30, int $page = 1): iterable { $operation = new \ApiClients\Client\GitHub\Internal\Operation\Repos\GetOrgRuleSuitesListing($this->responseSchemaValidator, $this->hydrator, $org, $ref, $repositoryName, $actorName, $timePeriod, $ruleSuiteResult, $perPage, $page); diff --git a/clients/GitHub/src/Internal/Operator/Repos/GetRepoRuleSuites.php b/clients/GitHub/src/Internal/Operator/Repos/GetRepoRuleSuites.php index 771783c9c1a..3bb5e1e1a05 100644 --- a/clients/GitHub/src/Internal/Operator/Repos/GetRepoRuleSuites.php +++ b/clients/GitHub/src/Internal/Operator/Repos/GetRepoRuleSuites.php @@ -24,7 +24,7 @@ public function __construct(private Browser $browser, private AuthenticationInte { } - /** @return Observable */ + /** @return iterable */ public function call(string $owner, string $repo, string $ref, string $actorName, string $timePeriod = 'day', string $ruleSuiteResult = 'all', int $perPage = 30, int $page = 1): iterable { $operation = new \ApiClients\Client\GitHub\Internal\Operation\Repos\GetRepoRuleSuites($this->responseSchemaValidator, $this->hydrator, $owner, $repo, $ref, $actorName, $timePeriod, $ruleSuiteResult, $perPage, $page); diff --git a/clients/GitHub/src/Internal/Operator/Repos/GetRepoRuleSuitesListing.php b/clients/GitHub/src/Internal/Operator/Repos/GetRepoRuleSuitesListing.php index ec39e4c4bdb..d2f865738e2 100644 --- a/clients/GitHub/src/Internal/Operator/Repos/GetRepoRuleSuitesListing.php +++ b/clients/GitHub/src/Internal/Operator/Repos/GetRepoRuleSuitesListing.php @@ -24,7 +24,7 @@ public function __construct(private Browser $browser, private AuthenticationInte { } - /** @return Observable */ + /** @return iterable */ public function call(string $owner, string $repo, string $ref, string $actorName, string $timePeriod = 'day', string $ruleSuiteResult = 'all', int $perPage = 30, int $page = 1): iterable { $operation = new \ApiClients\Client\GitHub\Internal\Operation\Repos\GetRepoRuleSuitesListing($this->responseSchemaValidator, $this->hydrator, $owner, $repo, $ref, $actorName, $timePeriod, $ruleSuiteResult, $perPage, $page); diff --git a/clients/GitHub/src/Internal/Router/Get/Five.php b/clients/GitHub/src/Internal/Router/Get/Five.php index eb8ff68cb4f..dece2d8ff5c 100644 --- a/clients/GitHub/src/Internal/Router/Get/Five.php +++ b/clients/GitHub/src/Internal/Router/Get/Five.php @@ -51,7 +51,7 @@ public function __construct(private Routers $routers) { } - /** @return |Observable|Observable|WithoutBody|Observable|Observable|Observable|Schema\BasicError|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable */ + /** @return |Observable|Observable|WithoutBody|Observable|Observable|Observable|Schema\BasicError|Observable|Observable|Observable|Observable|Observable|iterable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable */ public function call(string $call, array $params, array $pathChunks): HookDelivery|iterable|WithoutBody|GistComment|MarketplacePurchase|BasicError|ThreadSubscription|ActionsOrganizationPermissions|Ok|\ApiClients\Client\GitHub\Schema\Operations\Actions\ListOrgSecrets\Response\ApplicationJson\Ok|\ApiClients\Client\GitHub\Schema\Operations\Actions\ListOrgVariables\Response\ApplicationJson\Ok|\ApiClients\Client\GitHub\Schema\Operations\Orgs\ListAttestations\Response\ApplicationJson\Ok|\ApiClients\Client\GitHub\Schema\Operations\Codespaces\ListOrgSecrets\Response\ApplicationJson\Ok|CopilotOrganizationDetails|\ApiClients\Client\GitHub\Schema\Operations\Dependabot\ListOrgSecrets\Response\ApplicationJson\Ok|OrgHook|OrgMembership|Migration|OrganizationRole|RepositoryRuleset|TeamFull|ProjectCard|CheckAutomatedSecurityFixes|CodeSecurityConfigurationForRepository|Json|\ApiClients\Client\GitHub\Schema\Operations\Repos\GetAllEnvironments\Response\ApplicationJson\Ok|Import|Installation|InteractionLimitResponse|One|Language|LicenseContent|Page|\ApiClients\Client\GitHub\Schema\Operations\Repos\CheckPrivateVulnerabilityReporting\Response\ApplicationJson\Ok|ContentFile|SimpleUser|Stargazer|RepositorySubscription|Topic|TeamDiscussion|TeamMembership|TeamProject|CodespacesUserPublicKey|CodespacesSecret|\ApiClients\Client\GitHub\Schema\Operations\Codespaces\CodespaceMachinesForAuthenticatedUser\Response\ApplicationJson\Ok\Application\Json|\ApiClients\Client\GitHub\Schema\Operations\Apps\ListInstallationReposForAuthenticatedUser\Response\ApplicationJson\Ok|Package|\ApiClients\Client\GitHub\Schema\Operations\Users\ListAttestations\Response\ApplicationJson\Ok|EmptyObject { if ($pathChunks[0] === '') { diff --git a/clients/GitHub/src/Internal/Router/Get/Repos.php b/clients/GitHub/src/Internal/Router/Get/Repos.php index df938421704..c09f0eb80c3 100644 --- a/clients/GitHub/src/Internal/Router/Get/Repos.php +++ b/clients/GitHub/src/Internal/Router/Get/Repos.php @@ -303,7 +303,7 @@ public function listForUser(array $params): iterable return $operator->call($arguments['username'], $arguments['direction'], $arguments['type'], $arguments['sort'], $arguments['per_page'], $arguments['page']); } - /** @return Observable */ + /** @return iterable */ public function getOrgRuleSuites(array $params): iterable { $arguments = []; @@ -1824,7 +1824,7 @@ public function getRelease(array $params): Release|WithoutBody return $operator->call($arguments['owner'], $arguments['repo'], $arguments['release_id']); } - /** @return Observable */ + /** @return iterable */ public function getRepoRuleSuites(array $params): iterable { $arguments = []; diff --git a/clients/GitHub/src/Internal/Router/Get/Six.php b/clients/GitHub/src/Internal/Router/Get/Six.php index e60a802fe22..ceaec190d8c 100644 --- a/clients/GitHub/src/Internal/Router/Get/Six.php +++ b/clients/GitHub/src/Internal/Router/Get/Six.php @@ -74,7 +74,7 @@ public function __construct(private Routers $routers) { } - /** @return |Observable|Observable|Observable|WithoutBody|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Schema\Operations\Repos\GetCodeFrequencyStats\Response\ApplicationJson\Accepted\Application\Json|Observable|Schema\Operations\Repos\GetCommitActivityStats\Response\ApplicationJson\Accepted\Application\Json|Observable|Schema\Operations\Repos\GetContributorsStats\Response\ApplicationJson\Accepted\Application\Json|Observable|Observable|Observable|Observable|Observable */ + /** @return |Observable|Observable|Observable|WithoutBody|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|iterable|Observable|Observable|Schema\Operations\Repos\GetCodeFrequencyStats\Response\ApplicationJson\Accepted\Application\Json|Observable|Schema\Operations\Repos\GetCommitActivityStats\Response\ApplicationJson\Accepted\Application\Json|Observable|Schema\Operations\Repos\GetContributorsStats\Response\ApplicationJson\Accepted\Application\Json|Observable|Observable|Observable|Observable|Observable */ public function call(string $call, array $params, array $pathChunks): Ok|iterable|ActionsCacheUsageOrgEnterprise|\ApiClients\Client\GitHub\Schema\Operations\Actions\GetActionsCacheUsageByRepoForOrg\Response\ApplicationJson\Ok|\ApiClients\Client\GitHub\Schema\Operations\Actions\ListSelectedRepositoriesEnabledGithubActionsOrganization\Response\ApplicationJson\Ok|SelectedActions|ActionsGetDefaultWorkflowPermissions|Runner|ActionsPublicKey|OrganizationActionsSecret|OrganizationActionsVariable|WithoutBody|CodeSecurityConfiguration|CodespacesPublicKey|CodespacesOrgSecret|\ApiClients\Client\GitHub\Schema\Operations\Copilot\ListCopilotSeats\Response\ApplicationJson\Ok|DependabotPublicKey|OrganizationDependabotSecret|WebhookConfig|Json|CopilotSeatDetails|Package|CustomProperty|RuleSuite|ActionsBillingUsage|PackagesBillingUsage|CombinedBillingUsage|ProjectCollaboratorPermission|\ApiClients\Client\GitHub\Schema\Operations\Actions\ListArtifactsForRepo\Response\ApplicationJson\Ok|ActionsCacheList|\ApiClients\Client\GitHub\Schema\Operations\Actions\ListRepoOrganizationSecrets\Response\ApplicationJson\Ok|\ApiClients\Client\GitHub\Schema\Operations\Actions\ListRepoOrganizationVariables\Response\ApplicationJson\Ok|ActionsRepositoryPermissions|\ApiClients\Client\GitHub\Schema\Operations\Actions\ListSelfHostedRunnersForRepo\Response\ApplicationJson\Ok\Application\Json|\ApiClients\Client\GitHub\Schema\Operations\Actions\ListWorkflowRunsForRepo\Response\ApplicationJson\Ok|\ApiClients\Client\GitHub\Schema\Operations\Actions\ListRepoSecrets\Response\ApplicationJson\Ok\Application\Json|\ApiClients\Client\GitHub\Schema\Operations\Actions\ListRepoVariables\Response\ApplicationJson\Ok\Application\Json|\ApiClients\Client\GitHub\Schema\Operations\Actions\ListRepoWorkflows\Response\ApplicationJson\Ok|\ApiClients\Client\GitHub\Schema\Operations\Repos\ListAttestations\Response\ApplicationJson\Ok\Application\Json|Autolink|BranchWithProtection|BasicError|CheckRun|CheckSuite|CodeScanningDefaultSetup|CodeownersErrors|\ApiClients\Client\GitHub\Schema\Operations\Codespaces\ListDevcontainersInRepositoryForAuthenticatedUser\Response\ApplicationJson\Ok|\ApiClients\Client\GitHub\Schema\Operations\Codespaces\RepoMachinesForAuthenticatedUser\Response\ApplicationJson\Ok|\ApiClients\Client\GitHub\Schema\Operations\Codespaces\PreFlightWithRepoForAuthenticatedUser\Response\ApplicationJson\Ok|CodespacesPermissionsCheckForDevcontainer|\ApiClients\Client\GitHub\Schema\Operations\Codespaces\ListRepoSecrets\Response\ApplicationJson\Ok|CommitComment|Commit|CommunityProfile|CommitComparison|ContentDirectory|ContentFile|ContentSymlink|ContentSubmodule|\ApiClients\Client\GitHub\Schema\Operations\Dependabot\ListRepoSecrets\Response\ApplicationJson\Ok|DependencyGraphSpdxSbom|Deployment|Environment|Hook|Issue|DeployKey|Label|Milestone|PagesHealthCheck|EmptyObject|PullRequest|Release|RepositoryRuleset|RepositoryAdvisory|\ApiClients\Client\GitHub\Schema\Operations\Repos\GetCodeFrequencyStats\Response\ApplicationJson\Accepted\Application\Json|\ApiClients\Client\GitHub\Schema\Operations\Repos\GetCommitActivityStats\Response\ApplicationJson\Accepted\Application\Json|\ApiClients\Client\GitHub\Schema\Operations\Repos\GetContributorsStats\Response\ApplicationJson\Accepted\Application\Json|ParticipationStats|CloneTraffic|ViewTraffic|TeamRepository|\ApiClients\Client\GitHub\Schema\Operations\Codespaces\ListRepositoriesForSecretForAuthenticatedUser\Response\ApplicationJson\Ok\Application\Json|CodespaceExportDetails { if ($pathChunks[0] === '') { diff --git a/clients/GitHub/src/Internal/Router/List/Five.php b/clients/GitHub/src/Internal/Router/List/Five.php index 54dd93858a9..aa53259072c 100644 --- a/clients/GitHub/src/Internal/Router/List/Five.php +++ b/clients/GitHub/src/Internal/Router/List/Five.php @@ -16,7 +16,7 @@ public function __construct(private Routers $routers) { } - /** @return Observable|Observable|Observable|Schema\BasicError|WithoutBody|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable */ + /** @return Observable|Observable|Observable|Schema\BasicError|WithoutBody|Observable|Observable|iterable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable */ public function call(string $call, array $params, array $pathChunks): iterable|BasicError|WithoutBody { if ($pathChunks[0] === '') { diff --git a/clients/GitHub/src/Internal/Router/List/Repos.php b/clients/GitHub/src/Internal/Router/List/Repos.php index 01e0d9c68f5..d7ede961aa9 100644 --- a/clients/GitHub/src/Internal/Router/List/Repos.php +++ b/clients/GitHub/src/Internal/Router/List/Repos.php @@ -253,7 +253,7 @@ public function listForUserListing(array $params): iterable } while (count($items) > 0); } - /** @return Observable */ + /** @return iterable */ public function getOrgRuleSuitesListing(array $params): iterable { $arguments = []; @@ -1267,7 +1267,7 @@ public function listPagesBuildsListing(array $params): iterable } while (count($items) > 0); } - /** @return Observable */ + /** @return iterable */ public function getRepoRuleSuitesListing(array $params): iterable { $arguments = []; diff --git a/clients/GitHub/src/Internal/Router/List/Six.php b/clients/GitHub/src/Internal/Router/List/Six.php index e2afcb66c84..c6a014790a7 100644 --- a/clients/GitHub/src/Internal/Router/List/Six.php +++ b/clients/GitHub/src/Internal/Router/List/Six.php @@ -15,7 +15,7 @@ public function __construct(private Routers $routers) { } - /** @return Observable|Observable|Observable|Observable|WithoutBody|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable */ + /** @return Observable|Observable|Observable|Observable|WithoutBody|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|Observable|iterable|Observable|Observable|Observable|Observable|Observable */ public function call(string $call, array $params, array $pathChunks): iterable|WithoutBody { if ($pathChunks[0] === '') { diff --git a/clients/GitHub/src/Operation/Repos.php b/clients/GitHub/src/Operation/Repos.php index 26fa3f0f357..c09189e0839 100644 --- a/clients/GitHub/src/Operation/Repos.php +++ b/clients/GitHub/src/Operation/Repos.php @@ -107,13 +107,13 @@ public function createOrgRuleset(string $org, array $params): RepositoryRuleset return $this->operators->repos👷CreateOrgRuleset()->call($org, $params); } - /** @return Observable */ + /** @return iterable */ public function getOrgRuleSuites(string $org, string $ref, int $repositoryName, string $actorName, string $timePeriod, string $ruleSuiteResult, int $perPage, int $page): iterable { return $this->operators->repos👷GetOrgRuleSuites()->call($org, $ref, $repositoryName, $actorName, $timePeriod, $ruleSuiteResult, $perPage, $page); } - /** @return Observable */ + /** @return iterable */ public function getOrgRuleSuitesListing(string $org, string $ref, int $repositoryName, string $actorName, string $timePeriod, string $ruleSuiteResult, int $perPage, int $page): iterable { return $this->operators->repos👷GetOrgRuleSuitesListing()->call($org, $ref, $repositoryName, $actorName, $timePeriod, $ruleSuiteResult, $perPage, $page); @@ -1181,13 +1181,13 @@ public function createRepoRuleset(string $owner, string $repo, array $params): R return $this->operators->repos👷CreateRepoRuleset()->call($owner, $repo, $params); } - /** @return Observable */ + /** @return iterable */ public function getRepoRuleSuites(string $owner, string $repo, string $ref, string $actorName, string $timePeriod, string $ruleSuiteResult, int $perPage, int $page): iterable { return $this->operators->repos👷GetRepoRuleSuites()->call($owner, $repo, $ref, $actorName, $timePeriod, $ruleSuiteResult, $perPage, $page); } - /** @return Observable */ + /** @return iterable */ public function getRepoRuleSuitesListing(string $owner, string $repo, string $ref, string $actorName, string $timePeriod, string $ruleSuiteResult, int $perPage, int $page): iterable { return $this->operators->repos👷GetRepoRuleSuitesListing()->call($owner, $repo, $ref, $actorName, $timePeriod, $ruleSuiteResult, $perPage, $page); diff --git a/clients/GitHub/src/PHPStan/ClientCallReturnTypes.php b/clients/GitHub/src/PHPStan/ClientCallReturnTypes.php index 87997385669..a2317a169f8 100644 --- a/clients/GitHub/src/PHPStan/ClientCallReturnTypes.php +++ b/clients/GitHub/src/PHPStan/ClientCallReturnTypes.php @@ -1300,11 +1300,11 @@ public function getTypeFromMethodCall(MethodReflection $methodReflection, Method } if ($call === 'GET /orgs/{org}/rulesets/rule-suites') { - return $this->typeResolver->resolve('Observable'); + return $this->typeResolver->resolve('iterable'); } if ($call === 'LIST /orgs/{org}/rulesets/rule-suites') { - return $this->typeResolver->resolve('Observable'); + return $this->typeResolver->resolve('iterable'); } if ($call === 'GET /orgs/{org}/rulesets/rule-suites/{rule_suite_id}') { @@ -3452,11 +3452,11 @@ public function getTypeFromMethodCall(MethodReflection $methodReflection, Method } if ($call === 'GET /repos/{owner}/{repo}/rulesets/rule-suites') { - return $this->typeResolver->resolve('Observable'); + return $this->typeResolver->resolve('iterable'); } if ($call === 'LIST /repos/{owner}/{repo}/rulesets/rule-suites') { - return $this->typeResolver->resolve('Observable'); + return $this->typeResolver->resolve('iterable'); } if ($call === 'GET /repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}') { diff --git a/clients/GitHub/src/Schema/MergeGroup.php b/clients/GitHub/src/Schema/MergeGroup.php index 2229eac44ac..b3ba089b3e3 100644 --- a/clients/GitHub/src/Schema/MergeGroup.php +++ b/clients/GitHub/src/Schema/MergeGroup.php @@ -134,11 +134,10 @@ "description": "A commit." } }, - "description": "A group of pull requests that the merge queue has grouped together to be merged.\\n" + "description": "A group of pull requests that the merge queue has grouped together to be merged." }'; public const SCHEMA_TITLE = 'Merge Group'; - public const SCHEMA_DESCRIPTION = 'A group of pull requests that the merge queue has grouped together to be merged. -'; + public const SCHEMA_DESCRIPTION = 'A group of pull requests that the merge queue has grouped together to be merged.'; public const SCHEMA_EXAMPLE_DATA = '{ "head_sha": "generated", "head_ref": "generated", diff --git a/clients/GitHub/src/Schema/OrgRulesetConditions.php b/clients/GitHub/src/Schema/OrgRulesetConditions.php index 3dabf216782..2413bf4f6b6 100644 --- a/clients/GitHub/src/Schema/OrgRulesetConditions.php +++ b/clients/GitHub/src/Schema/OrgRulesetConditions.php @@ -248,11 +248,10 @@ "description": "Conditions to target repositories by property and refs by name" } ], - "description": "Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties.\\n" + "description": "Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties." }'; public const SCHEMA_TITLE = 'Organization ruleset conditions'; - public const SCHEMA_DESCRIPTION = 'Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. -'; + public const SCHEMA_DESCRIPTION = 'Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties.'; public const SCHEMA_EXAMPLE_DATA = '[]'; public function __construct() diff --git a/clients/GitHub/src/Schema/Repos/CreateOrgRuleset/Request/ApplicationJson.php b/clients/GitHub/src/Schema/Repos/CreateOrgRuleset/Request/ApplicationJson.php index b9fd0b73df9..1b7c15cdfeb 100644 --- a/clients/GitHub/src/Schema/Repos/CreateOrgRuleset/Request/ApplicationJson.php +++ b/clients/GitHub/src/Schema/Repos/CreateOrgRuleset/Request/ApplicationJson.php @@ -55,7 +55,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories.\\n" + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." }, "actor_type": { "enum": [ @@ -66,7 +66,7 @@ "DeployKey" ], "type": "string", - "description": "The type of actor that can bypass a ruleset.\\n" + "description": "The type of actor that can bypass a ruleset." }, "bypass_mode": { "enum": [ @@ -74,7 +74,7 @@ "pull_request" ], "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type.\\n" + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type." } }, "description": "An actor that can bypass rules in a ruleset" @@ -323,7 +323,7 @@ "description": "Conditions to target repositories by property and refs by name" } ], - "description": "Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties.\\n" + "description": "Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties." }, "rules": { "type": "array", @@ -1174,7 +1174,6 @@ * enforcement: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise). * bypassActors: The actors that can bypass the rules in this ruleset * conditions: Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. - * rules: An array of rules within the ruleset. */ public function __construct(public string $name, public string|null $target, public string $enforcement, #[MapFrom('bypass_actors')] diff --git a/clients/GitHub/src/Schema/Repos/CreateRepoRuleset/Request/ApplicationJson.php b/clients/GitHub/src/Schema/Repos/CreateRepoRuleset/Request/ApplicationJson.php index acd8bde4131..77908fecbb7 100644 --- a/clients/GitHub/src/Schema/Repos/CreateRepoRuleset/Request/ApplicationJson.php +++ b/clients/GitHub/src/Schema/Repos/CreateRepoRuleset/Request/ApplicationJson.php @@ -54,7 +54,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories.\\n" + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." }, "actor_type": { "enum": [ @@ -65,7 +65,7 @@ "DeployKey" ], "type": "string", - "description": "The type of actor that can bypass a ruleset.\\n" + "description": "The type of actor that can bypass a ruleset." }, "bypass_mode": { "enum": [ @@ -73,7 +73,7 @@ "pull_request" ], "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type.\\n" + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type." } }, "description": "An actor that can bypass rules in a ruleset" diff --git a/clients/GitHub/src/Schema/Repos/UpdateBranchProtection/Request/ApplicationJson.php b/clients/GitHub/src/Schema/Repos/UpdateBranchProtection/Request/ApplicationJson.php index 661710f3f5b..1454e8bd51b 100644 --- a/clients/GitHub/src/Schema/Repos/UpdateBranchProtection/Request/ApplicationJson.php +++ b/clients/GitHub/src/Schema/Repos/UpdateBranchProtection/Request/ApplicationJson.php @@ -37,7 +37,7 @@ "items": { "type": "string" }, - "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\\n", + "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "deprecated": true }, "checks": { diff --git a/clients/GitHub/src/Schema/Repos/UpdateBranchProtection/Request/ApplicationJson/RequiredStatusChecks.php b/clients/GitHub/src/Schema/Repos/UpdateBranchProtection/Request/ApplicationJson/RequiredStatusChecks.php index 014d2f9ffd0..c74f8798a04 100644 --- a/clients/GitHub/src/Schema/Repos/UpdateBranchProtection/Request/ApplicationJson/RequiredStatusChecks.php +++ b/clients/GitHub/src/Schema/Repos/UpdateBranchProtection/Request/ApplicationJson/RequiredStatusChecks.php @@ -25,7 +25,7 @@ "items": { "type": "string" }, - "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\\n", + "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "deprecated": true }, "checks": { diff --git a/clients/GitHub/src/Schema/Repos/UpdateOrgRuleset/Request/ApplicationJson.php b/clients/GitHub/src/Schema/Repos/UpdateOrgRuleset/Request/ApplicationJson.php index 015707e7235..3e6d523317c 100644 --- a/clients/GitHub/src/Schema/Repos/UpdateOrgRuleset/Request/ApplicationJson.php +++ b/clients/GitHub/src/Schema/Repos/UpdateOrgRuleset/Request/ApplicationJson.php @@ -50,7 +50,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories.\\n" + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." }, "actor_type": { "enum": [ @@ -61,7 +61,7 @@ "DeployKey" ], "type": "string", - "description": "The type of actor that can bypass a ruleset.\\n" + "description": "The type of actor that can bypass a ruleset." }, "bypass_mode": { "enum": [ @@ -69,7 +69,7 @@ "pull_request" ], "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type.\\n" + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type." } }, "description": "An actor that can bypass rules in a ruleset" @@ -318,7 +318,7 @@ "description": "Conditions to target repositories by property and refs by name" } ], - "description": "Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties.\\n" + "description": "Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties." }, "rules": { "type": "array", @@ -1169,7 +1169,6 @@ * enforcement: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise). * bypassActors: The actors that can bypass the rules in this ruleset * conditions: Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. - * rules: An array of rules within the ruleset. */ public function __construct(public string|null $name, public string|null $target, public string|null $enforcement, #[MapFrom('bypass_actors')] diff --git a/clients/GitHub/src/Schema/Repos/UpdateRepoRuleset/Request/ApplicationJson.php b/clients/GitHub/src/Schema/Repos/UpdateRepoRuleset/Request/ApplicationJson.php index 16858dba04d..685c27a6119 100644 --- a/clients/GitHub/src/Schema/Repos/UpdateRepoRuleset/Request/ApplicationJson.php +++ b/clients/GitHub/src/Schema/Repos/UpdateRepoRuleset/Request/ApplicationJson.php @@ -49,7 +49,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories.\\n" + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." }, "actor_type": { "enum": [ @@ -60,7 +60,7 @@ "DeployKey" ], "type": "string", - "description": "The type of actor that can bypass a ruleset.\\n" + "description": "The type of actor that can bypass a ruleset." }, "bypass_mode": { "enum": [ @@ -68,7 +68,7 @@ "pull_request" ], "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type.\\n" + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type." } }, "description": "An actor that can bypass rules in a ruleset" diff --git a/clients/GitHub/src/Schema/Repos/UpdateStatusCheckProtection/Request/ApplicationJson.php b/clients/GitHub/src/Schema/Repos/UpdateStatusCheckProtection/Request/ApplicationJson.php index 48a28e123ba..62d47a8809a 100644 --- a/clients/GitHub/src/Schema/Repos/UpdateStatusCheckProtection/Request/ApplicationJson.php +++ b/clients/GitHub/src/Schema/Repos/UpdateStatusCheckProtection/Request/ApplicationJson.php @@ -18,7 +18,7 @@ "items": { "type": "string" }, - "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\\n", + "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.", "deprecated": true }, "checks": { diff --git a/clients/GitHub/src/Schema/RepositoryRuleset.php b/clients/GitHub/src/Schema/RepositoryRuleset.php index 0b60ceda091..705d378d7f1 100644 --- a/clients/GitHub/src/Schema/RepositoryRuleset.php +++ b/clients/GitHub/src/Schema/RepositoryRuleset.php @@ -73,7 +73,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories.\\n" + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." }, "actor_type": { "enum": [ @@ -84,7 +84,7 @@ "DeployKey" ], "type": "string", - "description": "The type of actor that can bypass a ruleset.\\n" + "description": "The type of actor that can bypass a ruleset." }, "bypass_mode": { "enum": [ @@ -92,7 +92,7 @@ "pull_request" ], "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type.\\n" + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type." } }, "description": "An actor that can bypass rules in a ruleset" @@ -408,7 +408,7 @@ "description": "Conditions to target repositories by property and refs by name" } ], - "description": "Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties.\\n" + "description": "Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties." } ] }, diff --git a/clients/GitHub/src/Schema/RepositoryRulesetBypassActor.php b/clients/GitHub/src/Schema/RepositoryRulesetBypassActor.php index 96178493151..64260bcdcf0 100644 --- a/clients/GitHub/src/Schema/RepositoryRulesetBypassActor.php +++ b/clients/GitHub/src/Schema/RepositoryRulesetBypassActor.php @@ -21,7 +21,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories.\\n" + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." }, "actor_type": { "enum": [ @@ -32,7 +32,7 @@ "DeployKey" ], "type": "string", - "description": "The type of actor that can bypass a ruleset.\\n" + "description": "The type of actor that can bypass a ruleset." }, "bypass_mode": { "enum": [ @@ -40,7 +40,7 @@ "pull_request" ], "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type.\\n" + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type." } }, "description": "An actor that can bypass rules in a ruleset" diff --git a/clients/GitHub/src/Schema/WebhookMergeGroupChecksRequested.php b/clients/GitHub/src/Schema/WebhookMergeGroupChecksRequested.php index 48fc2d5cd78..0ac735053ac 100644 --- a/clients/GitHub/src/Schema/WebhookMergeGroupChecksRequested.php +++ b/clients/GitHub/src/Schema/WebhookMergeGroupChecksRequested.php @@ -172,7 +172,7 @@ "description": "A commit." } }, - "description": "A group of pull requests that the merge queue has grouped together to be merged.\\n" + "description": "A group of pull requests that the merge queue has grouped together to be merged." }, "organization": { "title": "Organization Simple", @@ -2263,7 +2263,6 @@ for and sent to a GitHub App. For more information, see "[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)." * mergeGroup: A group of pull requests that the merge queue has grouped together to be merged. - * organization: A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization. * repository: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property diff --git a/clients/GitHub/src/Schema/WebhookMergeGroupDestroyed.php b/clients/GitHub/src/Schema/WebhookMergeGroupDestroyed.php index 0b618d669ad..5d0181b84a5 100644 --- a/clients/GitHub/src/Schema/WebhookMergeGroupDestroyed.php +++ b/clients/GitHub/src/Schema/WebhookMergeGroupDestroyed.php @@ -181,7 +181,7 @@ "description": "A commit." } }, - "description": "A group of pull requests that the merge queue has grouped together to be merged.\\n" + "description": "A group of pull requests that the merge queue has grouped together to be merged." }, "organization": { "title": "Organization Simple", @@ -2274,7 +2274,6 @@ for and sent to a GitHub App. For more information, see "[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)." * mergeGroup: A group of pull requests that the merge queue has grouped together to be merged. - * organization: A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization. * repository: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property diff --git a/clients/GitHub/src/Schema/WebhookRepositoryRulesetCreated.php b/clients/GitHub/src/Schema/WebhookRepositoryRulesetCreated.php index c308f933a2f..308292ccf76 100644 --- a/clients/GitHub/src/Schema/WebhookRepositoryRulesetCreated.php +++ b/clients/GitHub/src/Schema/WebhookRepositoryRulesetCreated.php @@ -1778,7 +1778,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories.\\n" + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." }, "actor_type": { "enum": [ @@ -1789,7 +1789,7 @@ "DeployKey" ], "type": "string", - "description": "The type of actor that can bypass a ruleset.\\n" + "description": "The type of actor that can bypass a ruleset." }, "bypass_mode": { "enum": [ @@ -1797,7 +1797,7 @@ "pull_request" ], "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type.\\n" + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type." } }, "description": "An actor that can bypass rules in a ruleset" @@ -2113,7 +2113,7 @@ "description": "Conditions to target repositories by property and refs by name" } ], - "description": "Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties.\\n" + "description": "Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties." } ] }, diff --git a/clients/GitHub/src/Schema/WebhookRepositoryRulesetDeleted.php b/clients/GitHub/src/Schema/WebhookRepositoryRulesetDeleted.php index 364dc655374..4509c18e43a 100644 --- a/clients/GitHub/src/Schema/WebhookRepositoryRulesetDeleted.php +++ b/clients/GitHub/src/Schema/WebhookRepositoryRulesetDeleted.php @@ -1778,7 +1778,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories.\\n" + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." }, "actor_type": { "enum": [ @@ -1789,7 +1789,7 @@ "DeployKey" ], "type": "string", - "description": "The type of actor that can bypass a ruleset.\\n" + "description": "The type of actor that can bypass a ruleset." }, "bypass_mode": { "enum": [ @@ -1797,7 +1797,7 @@ "pull_request" ], "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type.\\n" + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type." } }, "description": "An actor that can bypass rules in a ruleset" @@ -2113,7 +2113,7 @@ "description": "Conditions to target repositories by property and refs by name" } ], - "description": "Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties.\\n" + "description": "Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties." } ] }, diff --git a/clients/GitHub/src/Schema/WebhookRepositoryRulesetEdited.php b/clients/GitHub/src/Schema/WebhookRepositoryRulesetEdited.php index a8c6416dd97..e44a0921c4d 100644 --- a/clients/GitHub/src/Schema/WebhookRepositoryRulesetEdited.php +++ b/clients/GitHub/src/Schema/WebhookRepositoryRulesetEdited.php @@ -1778,7 +1778,7 @@ "integer", "null" ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories.\\n" + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories." }, "actor_type": { "enum": [ @@ -1789,7 +1789,7 @@ "DeployKey" ], "type": "string", - "description": "The type of actor that can bypass a ruleset.\\n" + "description": "The type of actor that can bypass a ruleset." }, "bypass_mode": { "enum": [ @@ -1797,7 +1797,7 @@ "pull_request" ], "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type.\\n" + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type." } }, "description": "An actor that can bypass rules in a ruleset" @@ -2113,7 +2113,7 @@ "description": "Conditions to target repositories by property and refs by name" } ], - "description": "Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties.\\n" + "description": "Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties." } ] }, diff --git a/clients/GitHub/tests/Types/ClientCallReturnTypes.php b/clients/GitHub/tests/Types/ClientCallReturnTypes.php index 7d6cb950726..8d02282a940 100644 --- a/clients/GitHub/tests/Types/ClientCallReturnTypes.php +++ b/clients/GitHub/tests/Types/ClientCallReturnTypes.php @@ -331,8 +331,8 @@ function authHeader(): string assertType('Observable', $client->call('GET /orgs/{org}/rulesets')); assertType('Observable', $client->call('LIST /orgs/{org}/rulesets')); assertType('', $client->call('POST /orgs/{org}/rulesets')); -assertType('Observable', $client->call('GET /orgs/{org}/rulesets/rule-suites')); -assertType('Observable', $client->call('LIST /orgs/{org}/rulesets/rule-suites')); +assertType('iterable', $client->call('GET /orgs/{org}/rulesets/rule-suites')); +assertType('iterable', $client->call('LIST /orgs/{org}/rulesets/rule-suites')); assertType('', $client->call('GET /orgs/{org}/rulesets/rule-suites/{rule_suite_id}')); assertType('', $client->call('GET /orgs/{org}/rulesets/{ruleset_id}')); assertType('', $client->call('PUT /orgs/{org}/rulesets/{ruleset_id}')); @@ -869,8 +869,8 @@ function authHeader(): string assertType('Observable', $client->call('GET /repos/{owner}/{repo}/rulesets')); assertType('Observable', $client->call('LIST /repos/{owner}/{repo}/rulesets')); assertType('', $client->call('POST /repos/{owner}/{repo}/rulesets')); -assertType('Observable', $client->call('GET /repos/{owner}/{repo}/rulesets/rule-suites')); -assertType('Observable', $client->call('LIST /repos/{owner}/{repo}/rulesets/rule-suites')); +assertType('iterable', $client->call('GET /repos/{owner}/{repo}/rulesets/rule-suites')); +assertType('iterable', $client->call('LIST /repos/{owner}/{repo}/rulesets/rule-suites')); assertType('', $client->call('GET /repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}')); assertType('', $client->call('GET /repos/{owner}/{repo}/rulesets/{ruleset_id}')); assertType('', $client->call('PUT /repos/{owner}/{repo}/rulesets/{ruleset_id}')); diff --git a/etc/specs/GitHub/current.spec.yaml b/etc/specs/GitHub/current.spec.yaml index bf13d00559e..62f8e99fa99 100644 --- a/etc/specs/GitHub/current.spec.yaml +++ b/etc/specs/GitHub/current.spec.yaml @@ -20022,7 +20022,7 @@ paths: have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained - control.\n" + control." items: type: string checks: @@ -20733,7 +20733,7 @@ paths: in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` - instead of `contexts` for more fine-grained control.\n" + instead of `contexts` for more fine-grained control." items: type: string checks: @@ -73886,12 +73886,10 @@ components: type: - integer - 'null' - description: 'The ID of the actor that can bypass a ruleset. If `actor_type` + description: The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. - - ' actor_type: type: string enum: @@ -73900,16 +73898,12 @@ components: - RepositoryRole - Team - DeployKey - description: 'The type of actor that can bypass a ruleset. - - ' + description: The type of actor that can bypass a ruleset. bypass_mode: type: string - description: 'When the specified actor can bypass the ruleset. `pull_request` + description: When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. - - ' enum: - always - pull_request @@ -74024,11 +74018,9 @@ components: org-ruleset-conditions: title: Organization ruleset conditions type: object - description: 'Conditions for an organization ruleset. The conditions object - should contain both `repository_name` and `ref_name` properties or both `repository_id` + description: Conditions for an organization ruleset. The conditions object should + contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. - - ' oneOf: - type: object title: repository_name_and_ref_name @@ -95585,10 +95577,8 @@ components: merge-group: type: object title: Merge Group - description: 'A group of pull requests that the merge queue has grouped together + description: A group of pull requests that the merge queue has grouped together to be merged. - - ' properties: head_sha: description: The SHA of the merge group. @@ -223722,12 +223712,10 @@ components: type: string ref-in-query: name: ref - description: 'The name of the ref. Cannot contain wildcard characters. Optionally + description: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. - - ' in: query schema: type: string