Skip to content

Commit

Permalink
docs fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
bshaffer committed Mar 5, 2021
1 parent 7dd320b commit 6a7fd11
Show file tree
Hide file tree
Showing 7 changed files with 43 additions and 58 deletions.
34 changes: 0 additions & 34 deletions autoload.php

This file was deleted.

21 changes: 13 additions & 8 deletions src/Auth/Credentials/ComputeCredentials.php
Original file line number Diff line number Diff line change
Expand Up @@ -117,14 +117,19 @@ class ComputeCredentials implements
private $jwtClient;

/**
* @param array $options
* @param array|string $options.scope the scope of the access request,
* expressed either as an array or as a space-delimited string.
* @param string $options.targetAudience The audience for the ID token.
* @param string $options.quotaProject Specifies a project to bill for access
* charges associated with the request.
* @param string $options.serviceAccountIdentity [optional] Specify a service
* account identity name to use instead of "default".
* @param array $options
* @param array|string $options.scope the scope of the access request,
* expressed either as an array or as a space-delimited string.
* @param string $options.targetAudience The audience for the ID token.
* @param string $options.quotaProject Specifies a project to bill for access
* charges associated with the request.
* @param string $options.serviceAccountIdentity [optional] Specify a service
* account identity name to use instead of "default".
* @param HttpClientInterface $options.httpClient
* @param JwtClientInterface $options.jwtClient
* @param CacheItemPoolInterface $options.cache
* @param string $options.cachePrefix
* @param int $options.cacheLifetime
*/
public function __construct(array $options = [])
{
Expand Down
22 changes: 13 additions & 9 deletions src/Auth/Credentials/ServiceAccountCredentials.php
Original file line number Diff line number Diff line change
Expand Up @@ -90,15 +90,19 @@ class ServiceAccountCredentials implements
/**
* Create a new ServiceAccountCredentials.
*
* @param array|string $jsonKey JSON credential file path or JSON
* credentials in associative array
* @param array $options
* @param array|string $options.scope the scope of the access request, expressed
* as an array or as a space-delimited string
* @param string $options.subject an email address account to impersonate, in
* situations when the service account has been delegated domain
* wide access
* @param string $options.targetAudience The audience for the ID token.
* @param array|string $jsonKey JSON credential file path or JSON
* credentials in associative array
* @param array $options
* @param array|string $options.scope the scope of the access request, expressed
* as an array or as a space-delimited string
* @param string $options.subject an email address account to impersonate, in
* situations when the service account has been delegated domain
* wide access
* @param string $options.targetAudience The audience for the ID token.
* @param HttpClientInterface $options.httpClient
* @param CacheItemPoolInterface $options.cache
* @param string $options.cachePrefix
* @param int $options.cacheLifetime
*/
public function __construct($jsonKey, array $options = [])
{
Expand Down
10 changes: 8 additions & 2 deletions src/Auth/Credentials/ServiceAccountJwtAccessCredentials.php
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,14 @@ class ServiceAccountJwtAccessCredentials implements
/**
* Create a new ServiceAccountJwtAccessCredentials.
*
* @param array|string $jsonKey JSON credential file path or JSON credentials
* as an associative array
* @param array|string $jsonKey JSON credential file path or JSON credentials
* as an associative array
* @param array $options
* @param string $options.audience
* @param HttpClientInterface $options.httpClient
* @param CacheItemPoolInterface $options.cache
* @param string $options.cachePrefix
* @param int $options.cacheLifetime
*/
public function __construct($jsonKey, array $options = [])
{
Expand Down
11 changes: 8 additions & 3 deletions src/Auth/Credentials/UserRefreshCredentials.php
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,14 @@ class UserRefreshCredentials implements CredentialsInterface
/**
* Create a new UserRefreshCredentials.
*
* @param array $jsonKey JSON credential as an associative array
* @param array|string $scope the scope of the access request, expressed
* either as an Array or as a space-delimited String
* @param array $jsonKey JSON credential as an associative array
* @param array $options
* @param array $options.scope the scope of the access request, expressed
* either as an Array or as a space-delimited String
* @param HttpClientInterface $options.httpClient
* @param CacheItemPoolInterface $options.cache
* @param string $options.cachePrefix
* @param int $options.cacheLifetime
*/
public function __construct($jsonKey, array $options = [])
{
Expand Down
1 change: 0 additions & 1 deletion src/Auth/GoogleAuth.php
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,6 @@ class GoogleAuth
* provided if you have one already available for use.
* @param int $options.cacheLifetime
* @param string $options.cachePrefix
* }
*/
public function __construct(array $options = [])
{
Expand Down
2 changes: 1 addition & 1 deletion tests/Auth/Credentials/CredentialsTraitTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,7 @@ private function fetchAuthTokenNoCache(): array
return $this->token;
}

private function getCacheKey()
private function getCacheKey(): string
{
return $this->key;
}
Expand Down

0 comments on commit 6a7fd11

Please sign in to comment.