From 57a029b042406b108918e08e3b12f736ad9d11ed Mon Sep 17 00:00:00 2001 From: Brent Shaffer Date: Wed, 6 Nov 2024 13:32:50 -0800 Subject: [PATCH] feat(docs): generate reference docs for GAX (#7797) --- .kokoro/docs/publish.sh | 41 ++++++------ dev/src/Command/DocFxCommand.php | 14 ++--- dev/src/Component.php | 42 ++++++++----- dev/src/DocFx/Node/XrefTrait.php | 12 ---- dev/tests/Unit/Command/DocFxCommandTest.php | 2 +- .../V1.Client.SecretManagerServiceClient.yml | 60 +++++++++--------- .../docfx/Vision/V1.AnnotateFileResponse.yml | 6 +- .../docfx/Vision/V1.AnnotateImageResponse.yml | 6 +- .../Vision/V1.Client.ImageAnnotatorClient.yml | 24 +++---- .../Vision/V1.Client.ProductSearchClient.yml | 62 +++++++++---------- .../fixtures/docfx/Vision/V1.ColorInfo.yml | 6 +- .../docfx/Vision/V1.ImageAnnotatorClient.yml | 50 +++++++-------- .../Vision/V1.ImportProductSetsResponse.yml | 4 +- .../fixtures/docfx/Vision/V1.LatLongRect.yml | 12 ++-- .../fixtures/docfx/Vision/V1.LocationInfo.yml | 6 +- .../docfx/Vision/V1.ProductSearchClient.yml | 62 +++++++++---------- .../fixtures/docfx/Vision/V1.ProductSet.yml | 6 +- dev/tests/fixtures/docfx/Vision/docs.metadata | 1 + 18 files changed, 204 insertions(+), 212 deletions(-) diff --git a/.kokoro/docs/publish.sh b/.kokoro/docs/publish.sh index 11f60baadc0c..0c0073578330 100755 --- a/.kokoro/docs/publish.sh +++ b/.kokoro/docs/publish.sh @@ -17,39 +17,38 @@ PROJECT_DIR=$(dirname $(dirname $SCRIPT_DIR)) if [ ! -d 'dev/vendor/' ]; then composer install -d $PROJECT_DIR/dev fi - +STAGING_FLAG=""; if [ "$STAGING_BUCKET" != "" ]; then echo "Using staging bucket ${STAGING_BUCKET}..." + STAGING_FLAG="--staging-bucket $STAGING_BUCKET" fi -VERBOSITY=""; +VERBOSITY_FLAG=""; if [ "$GCLOUD_DEBUG" = "1" ]; then echo "Setting verbosity to VERBOSE..."; - VERBOSITY=" -v"; + VERBOSITY_FLAG=" -v"; fi - find $PROJECT_DIR/* -mindepth 1 -maxdepth 1 -name 'composer.json' -not -path '*vendor/*' -regex "$PROJECT_DIR/[A-Z].*" -exec dirname {} \; | while read DIR do COMPONENT=$(basename $DIR) VERSION=$(cat $DIR/VERSION) - if [ "$STAGING_BUCKET" != "" ]; then - $PROJECT_DIR/dev/google-cloud docfx \ - --component $COMPONENT \ - --out $DIR/out \ - --metadata-version $VERSION \ - --staging-bucket $STAGING_BUCKET \ - --with-cache \ - $VERBOSITY - else - # dry run - $PROJECT_DIR/dev/google-cloud docfx \ - --component $COMPONENT \ - --out $DIR/out \ - --metadata-version $VERSION \ - --with-cache \ - $VERBOSITY - fi + $PROJECT_DIR/dev/google-cloud docfx \ + --component $COMPONENT \ + --out $DIR/out \ + --metadata-version $VERSION \ + --with-cache \ + $STAGING_FLAG \ + $VERBOSITY_FLAG done +# Add GAX repo +GAX_DIR=$PROJECT_DIR/dev/vendor/google/gax +$PROJECT_DIR/dev/google-cloud docfx \ + --path $GAX_DIR \ + --out gax-out \ + --metadata-version $(cat $GAX_DIR/VERSION) \ + $STAGING_FLAG \ + $VERBOSITY_FLAG + # If this run after a release, store the released artifacts. if [ "$KOKORO_GITHUB_COMMIT" != "" ]; then # Move to the project directory diff --git a/dev/src/Command/DocFxCommand.php b/dev/src/Command/DocFxCommand.php index bf3c18c87955..348621f6b39c 100644 --- a/dev/src/Command/DocFxCommand.php +++ b/dev/src/Command/DocFxCommand.php @@ -55,16 +55,11 @@ protected function configure() $this->setName('docfx') ->setDescription('Generate DocFX yaml from a phpdoc strucutre.xml') ->addOption('xml', '', InputOption::VALUE_REQUIRED, 'Path to phpdoc structure.xml') - ->addOption('component', 'c', InputOption::VALUE_REQUIRED, 'Generate docs only for a single component.', '') + ->addOption('component', 'c', InputOption::VALUE_REQUIRED, 'Generate docs for a specific component.', '') ->addOption('out', '', InputOption::VALUE_REQUIRED, 'Path where to store the generated output.', 'out') ->addOption('metadata-version', '', InputOption::VALUE_REQUIRED, 'version to write to docs.metadata using docuploader') ->addOption('staging-bucket', '', InputOption::VALUE_REQUIRED, 'Upload to the specified staging bucket using docuploader.') - ->addOption( - 'component-path', - '', - InputOption::VALUE_OPTIONAL, - 'Specify the path of the desired component. Please note, this option is only intended for testing purposes.' - ) + ->addOption('path', '', InputOption::VALUE_OPTIONAL, 'Specify the path to the composer package to generate.') ->addOption('--with-cache', '', InputOption::VALUE_NONE, 'Cache expensive proto namespace lookups to a file') ; } @@ -75,8 +70,9 @@ protected function execute(InputInterface $input, OutputInterface $output) throw new RuntimeException('This command must be run on PHP 8.0 or above'); } - $componentName = rtrim($input->getOption('component'), '/') ?: basename(getcwd()); - $component = new Component($componentName, $input->getOption('component-path')); + $componentPath = $input->getOption('path'); + $componentName = rtrim($input->getOption('component'), '/') ?: basename($componentPath ?: getcwd()); + $component = new Component($componentName, $componentPath); $output->writeln(sprintf('Generating documentation for %s', $componentName)); $xml = $input->getOption('xml'); $outDir = $input->getOption('out'); diff --git a/dev/src/Component.php b/dev/src/Component.php index aa04008d7c04..734193da319c 100644 --- a/dev/src/Component.php +++ b/dev/src/Component.php @@ -170,9 +170,6 @@ private function validateComponentFiles(): void if (empty($composerJson['name'])) { throw new RuntimeException('composer.json does not contain "name"'); } - if (empty($composerJson['extra']['component']['target'])) { - throw new RuntimeException('composer does not contain extra.component.target'); - } if (empty($composerJson['description'])) { throw new RuntimeException('composer.json does not contain "description"'); } @@ -181,22 +178,32 @@ private function validateComponentFiles(): void } $this->packageName = $composerJson['name']; - $repoName = $composerJson['extra']['component']['target']; - $this->repoName = preg_replace('/\.git$/', '', $repoName); // Strip trailing ".git" $this->description = $composerJson['description']; - $repoMetadataPath = self::ROOT_DIR . '/.repo-metadata-full.json'; - $repoMetadataFullJson = json_decode(file_get_contents($repoMetadataPath), true); - if (!$repoMetadataFullJson) { - throw new RuntimeException('Invalid .repo-metadata-full.json'); + if (!$repoName = $composerJson['extra']['component']['target'] ?? null) { + if (!str_starts_with($composerJson['homepage'], 'https://github.com/')) { + throw new RuntimeException( + 'composer does not contain extra.component.target, and homepage is not a github URL' + ); + } + $repoName = str_replace('https://github.com', '', $composerJson['homepage']); } - if (!isset($repoMetadataFullJson[$this->name])) { + $this->repoName = preg_replace('/\.git$/', '', $repoName); // Strip trailing ".git" + + $repoMetadataFullPath = self::ROOT_DIR . '/.repo-metadata-full.json'; + $repoMetadataFullJson = json_decode(file_get_contents($repoMetadataFullPath), true); + if (isset($repoMetadataFullJson[$this->name])) { + $repoMetadataJson = $repoMetadataFullJson[$this->name]; + } elseif (file_exists($repoMetadataPath = $this->path . '/.repo-metadata.json')) { + $repoMetadataJson = json_decode(file_get_contents($repoMetadataPath), true); + } else { throw new RuntimeException(sprintf( - 'repo metadata for component "%s" not found in .repo-metadata-full.json', - $this->name + 'repo metadata not found for component "%s" and no .repo-metadata.json file found in %s', + $this->name, + $repoMetadataPath )); } - $repoMetadataJson = $repoMetadataFullJson[$this->name]; + if (empty($repoMetadataJson['release_level'])) { throw new RuntimeException(sprintf( 'repo metadata does not contain "release_level" for component "%s"', @@ -234,10 +241,11 @@ private function validateComponentFiles(): void $this->componentDependencies[] = new Component($componentName); } } - if (isset($composerJson['require']['google/gax']) - && !isset($composerJson['require']['google/common-protos']) - ) { - $this->componentDependencies[] = new Component('CommonProtos'); + if (isset($composerJson['require']['google/gax'])) { + $this->componentDependencies[] = new Component('gax', self::ROOT_DIR . '/dev/vendor/google/gax'); + if (!isset($composerJson['require']['google/common-protos'])) { + $this->componentDependencies[] = new Component('CommonProtos'); + } } } diff --git a/dev/src/DocFx/Node/XrefTrait.php b/dev/src/DocFx/Node/XrefTrait.php index f977c783a950..fb7bdf4933c9 100644 --- a/dev/src/DocFx/Node/XrefTrait.php +++ b/dev/src/DocFx/Node/XrefTrait.php @@ -170,24 +170,12 @@ private function replaceUidWithLink(string $uid, string $name = null): string // Check for external package namespaces switch (true) { - case str_starts_with($uid, '\Google\ApiCore\\'): - $extLinkRoot = 'https://googleapis.github.io/gax-php#'; - break; case str_starts_with($uid, '\Google\Auth\\'): $extLinkRoot = 'https://googleapis.github.io/google-auth-library-php/main/'; break; case str_starts_with($uid, '\Google\Protobuf\\'): $extLinkRoot = 'https://protobuf.dev/reference/php/api-docs/'; break; - case str_starts_with($uid, '\Google\Api\\'): - case str_starts_with($uid, '\Google\Cloud\Iam\V1\\'): - case str_starts_with($uid, '\Google\Cloud\Location\\'): - case str_starts_with($uid, '\Google\Cloud\Logging\Type\\'): - case str_starts_with($uid, '\Google\Iam\\'): - case str_starts_with($uid, '\Google\Rpc\\'): - case str_starts_with($uid, '\Google\Type\\'): - $extLinkRoot = 'https://googleapis.github.io/common-protos-php#'; - break; case 0 === strpos($uid, '\GuzzleHttp\Promise\PromiseInterface'): $extLinkRoot = 'https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-GuzzleHttp.Promise.Promise.html'; break; diff --git a/dev/tests/Unit/Command/DocFxCommandTest.php b/dev/tests/Unit/Command/DocFxCommandTest.php index bccd5057d735..8ecb56e004c8 100644 --- a/dev/tests/Unit/Command/DocFxCommandTest.php +++ b/dev/tests/Unit/Command/DocFxCommandTest.php @@ -141,7 +141,7 @@ public function provideDocFxFiles() '--xml' => self::$fixturesDir . '/phpdoc/structure.xml', '--out' => self::$tmpDir = sys_get_temp_dir() . '/' . rand(), '--metadata-version' => '1.0.0', - '--component-path' => self::$fixturesDir . '/component/Vision', + '--path' => self::$fixturesDir . '/component/Vision', '--with-cache' => true, ]); diff --git a/dev/tests/fixtures/docfx/NewClient/V1.Client.SecretManagerServiceClient.yml b/dev/tests/fixtures/docfx/NewClient/V1.Client.SecretManagerServiceClient.yml index 2d1c121e642c..e188faded5e4 100644 --- a/dev/tests/fixtures/docfx/NewClient/V1.Client.SecretManagerServiceClient.yml +++ b/dev/tests/fixtures/docfx/NewClient/V1.Client.SecretManagerServiceClient.yml @@ -88,11 +88,11 @@ items: - id: '↳ credentials' var_type: string|array|FetchAuthTokenInterface|CredentialsWrapper - description: 'The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. *Advanced usage*: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.' + description: 'The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. *Advanced usage*: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.' - id: '↳ credentialsConfig' var_type: array - description: 'Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .' + description: 'Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .' - id: '↳ disableRetries' var_type: bool @@ -104,11 +104,11 @@ items: - id: '↳ transport' var_type: string|TransportInterface - description: 'The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. *Advanced usage*: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.' + description: 'The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. *Advanced usage*: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.' - id: '↳ transportConfig' var_type: array - description: 'Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ ''grpc'' => [...], ''rest'' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.' + description: 'Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ ''grpc'' => [...], ''rest'' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.' - id: '↳ clientCertSource' var_type: callable @@ -142,7 +142,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\SecretManager\V1\AccessSecretVersionResponse' @@ -173,7 +173,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\SecretManager\V1\SecretVersion' @@ -202,7 +202,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\SecretManager\V1\Secret' @@ -231,7 +231,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::destroySecretVersion()' name: destroySecretVersion @@ -262,7 +262,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\SecretManager\V1\SecretVersion' @@ -295,7 +295,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\SecretManager\V1\SecretVersion' @@ -328,7 +328,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\SecretManager\V1\SecretVersion' @@ -350,7 +350,7 @@ items: parameters: - id: request - var_type: 'Google\Cloud\Iam\V1\GetIamPolicyRequest' + var_type: 'Google\Cloud\Iam\V1\GetIamPolicyRequest' description: 'A request to house fields associated with the call.' - id: callOptions @@ -359,10 +359,10 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - - var_type: 'Google\Cloud\Iam\V1\Policy' + var_type: 'Google\Cloud\Iam\V1\Policy' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::getSecret()' name: getSecret @@ -388,7 +388,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\SecretManager\V1\Secret' @@ -421,7 +421,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\SecretManager\V1\SecretVersion' @@ -452,10 +452,10 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - - var_type: 'Google\ApiCore\PagedListResponse' + var_type: 'Google\ApiCore\PagedListResponse' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::listSecrets()' name: listSecrets @@ -481,10 +481,10 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - - var_type: 'Google\ApiCore\PagedListResponse' + var_type: 'Google\ApiCore\PagedListResponse' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::setIamPolicy()' name: setIamPolicy @@ -505,7 +505,7 @@ items: parameters: - id: request - var_type: 'Google\Cloud\Iam\V1\SetIamPolicyRequest' + var_type: 'Google\Cloud\Iam\V1\SetIamPolicyRequest' description: 'A request to house fields associated with the call.' - id: callOptions @@ -514,10 +514,10 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - - var_type: 'Google\Cloud\Iam\V1\Policy' + var_type: 'Google\Cloud\Iam\V1\Policy' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::testIamPermissions()' name: testIamPermissions @@ -542,7 +542,7 @@ items: parameters: - id: request - var_type: 'Google\Cloud\Iam\V1\TestIamPermissionsRequest' + var_type: 'Google\Cloud\Iam\V1\TestIamPermissionsRequest' description: 'A request to house fields associated with the call.' - id: callOptions @@ -551,10 +551,10 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - - var_type: 'Google\Cloud\Iam\V1\TestIamPermissionsResponse' + var_type: 'Google\Cloud\Iam\V1\TestIamPermissionsResponse' - uid: '\Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient::updateSecret()' name: updateSecret @@ -580,7 +580,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\SecretManager\V1\Secret' @@ -743,7 +743,7 @@ items: parameters: - id: request - var_type: 'Google\Cloud\Iam\V1\GetIamPolicyRequest' + var_type: 'Google\Cloud\Iam\V1\GetIamPolicyRequest' description: '' - id: 'optionalArgs = []' @@ -848,7 +848,7 @@ items: parameters: - id: request - var_type: 'Google\Cloud\Iam\V1\SetIamPolicyRequest' + var_type: 'Google\Cloud\Iam\V1\SetIamPolicyRequest' description: '' - id: 'optionalArgs = []' @@ -869,7 +869,7 @@ items: parameters: - id: request - var_type: 'Google\Cloud\Iam\V1\TestIamPermissionsRequest' + var_type: 'Google\Cloud\Iam\V1\TestIamPermissionsRequest' description: '' - id: 'optionalArgs = []' diff --git a/dev/tests/fixtures/docfx/Vision/V1.AnnotateFileResponse.yml b/dev/tests/fixtures/docfx/Vision/V1.AnnotateFileResponse.yml index efe4eed6e025..7b41026bac07 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.AnnotateFileResponse.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.AnnotateFileResponse.yml @@ -57,7 +57,7 @@ items: description: 'This field gives the total number of pages in the file.' - id: '↳ error' - var_type: 'Google\Rpc\Status' + var_type: 'Google\Rpc\Status' description: 'If set, represents the error message for the failed request. The `responses` field will not be set in this case.' - uid: '\Google\Cloud\Vision\V1\AnnotateFileResponse::getInputConfig()' @@ -186,7 +186,7 @@ items: syntax: returns: - - var_type: 'Google\Rpc\Status|null' + var_type: 'Google\Rpc\Status|null' - uid: '\Google\Cloud\Vision\V1\AnnotateFileResponse::hasError()' name: hasError @@ -218,7 +218,7 @@ items: parameters: - id: var - var_type: 'Google\Rpc\Status' + var_type: 'Google\Rpc\Status' description: '' returns: - diff --git a/dev/tests/fixtures/docfx/Vision/V1.AnnotateImageResponse.yml b/dev/tests/fixtures/docfx/Vision/V1.AnnotateImageResponse.yml index 44c117f17b8c..e7e8a6ffd209 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.AnnotateImageResponse.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.AnnotateImageResponse.yml @@ -124,7 +124,7 @@ items: description: 'If present, product search has completed successfully.' - id: '↳ error' - var_type: 'Google\Rpc\Status' + var_type: 'Google\Rpc\Status' description: 'If set, represents the error message for the operation. Note that filled-in image annotations are guaranteed to be correct, even when `error` is set.' - id: '↳ context' @@ -630,7 +630,7 @@ items: syntax: returns: - - var_type: 'Google\Rpc\Status|null' + var_type: 'Google\Rpc\Status|null' - uid: '\Google\Cloud\Vision\V1\AnnotateImageResponse::hasError()' name: hasError @@ -664,7 +664,7 @@ items: parameters: - id: var - var_type: 'Google\Rpc\Status' + var_type: 'Google\Rpc\Status' description: '' returns: - diff --git a/dev/tests/fixtures/docfx/Vision/V1.Client.ImageAnnotatorClient.yml b/dev/tests/fixtures/docfx/Vision/V1.Client.ImageAnnotatorClient.yml index 194ad2a2e434..5761cda21338 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.Client.ImageAnnotatorClient.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.Client.ImageAnnotatorClient.yml @@ -60,11 +60,11 @@ items: - id: '↳ credentials' var_type: string|array|FetchAuthTokenInterface|CredentialsWrapper - description: 'The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. *Advanced usage*: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.' + description: 'The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. *Advanced usage*: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.' - id: '↳ credentialsConfig' var_type: array - description: 'Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .' + description: 'Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .' - id: '↳ disableRetries' var_type: bool @@ -76,11 +76,11 @@ items: - id: '↳ transport' var_type: string|TransportInterface - description: 'The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. *Advanced usage*: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.' + description: 'The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. *Advanced usage*: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.' - id: '↳ transportConfig' var_type: array - description: 'Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ ''grpc'' => [...], ''rest'' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.' + description: 'Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ ''grpc'' => [...], ''rest'' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.' - id: '↳ clientCertSource' var_type: callable @@ -117,10 +117,10 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - - var_type: 'Google\ApiCore\OperationResponse' + var_type: 'Google\ApiCore\OperationResponse' - uid: '\Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::asyncBatchAnnotateImages()' name: asyncBatchAnnotateImages @@ -155,10 +155,10 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - - var_type: 'Google\ApiCore\OperationResponse' + var_type: 'Google\ApiCore\OperationResponse' - uid: '\Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::batchAnnotateFiles()' name: batchAnnotateFiles @@ -191,7 +191,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\Vision\V1\BatchAnnotateFilesResponse' @@ -220,7 +220,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\Vision\V1\BatchAnnotateImagesResponse' @@ -320,7 +320,7 @@ items: syntax: returns: - - var_type: 'Google\ApiCore\LongRunning\OperationsClient' + var_type: 'Google\ApiCore\LongRunning\OperationsClient' - uid: '\Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::resumeOperation()' name: resumeOperation @@ -346,7 +346,7 @@ items: description: 'The name of the method used to start the operation' returns: - - var_type: 'Google\ApiCore\OperationResponse' + var_type: 'Google\ApiCore\OperationResponse' - uid: '\Google\Cloud\Vision\V1\Client\ImageAnnotatorClient::productSetName()' name: 'static::productSetName' diff --git a/dev/tests/fixtures/docfx/Vision/V1.Client.ProductSearchClient.yml b/dev/tests/fixtures/docfx/Vision/V1.Client.ProductSearchClient.yml index 4c6a63cd900b..24301054c2f2 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.Client.ProductSearchClient.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.Client.ProductSearchClient.yml @@ -104,11 +104,11 @@ items: - id: '↳ credentials' var_type: string|array|FetchAuthTokenInterface|CredentialsWrapper - description: 'The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. *Advanced usage*: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.' + description: 'The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. *Advanced usage*: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.' - id: '↳ credentialsConfig' var_type: array - description: 'Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .' + description: 'Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .' - id: '↳ disableRetries' var_type: bool @@ -120,11 +120,11 @@ items: - id: '↳ transport' var_type: string|TransportInterface - description: 'The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. *Advanced usage*: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.' + description: 'The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. *Advanced usage*: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.' - id: '↳ transportConfig' var_type: array - description: 'Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ ''grpc'' => [...], ''rest'' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.' + description: 'Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ ''grpc'' => [...], ''rest'' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.' - id: '↳ clientCertSource' var_type: callable @@ -161,7 +161,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::createProduct()' name: createProduct @@ -194,7 +194,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\Vision\V1\Product' @@ -228,7 +228,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\Vision\V1\ProductSet' @@ -275,7 +275,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\Vision\V1\ReferenceImage' @@ -308,7 +308,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::deleteProductSet()' name: deleteProductSet @@ -337,7 +337,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::deleteReferenceImage()' name: deleteReferenceImage @@ -369,7 +369,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::getProduct()' name: getProduct @@ -399,7 +399,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\Vision\V1\Product' @@ -432,7 +432,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\Vision\V1\ProductSet' @@ -465,7 +465,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\Vision\V1\ReferenceImage' @@ -504,10 +504,10 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - - var_type: 'Google\ApiCore\OperationResponse' + var_type: 'Google\ApiCore\OperationResponse' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::listProductSets()' name: listProductSets @@ -538,10 +538,10 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - - var_type: 'Google\ApiCore\PagedListResponse' + var_type: 'Google\ApiCore\PagedListResponse' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::listProducts()' name: listProducts @@ -571,10 +571,10 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - - var_type: 'Google\ApiCore\PagedListResponse' + var_type: 'Google\ApiCore\PagedListResponse' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::listProductsInProductSet()' name: listProductsInProductSet @@ -607,10 +607,10 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - - var_type: 'Google\ApiCore\PagedListResponse' + var_type: 'Google\ApiCore\PagedListResponse' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::listReferenceImages()' name: listReferenceImages @@ -642,10 +642,10 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - - var_type: 'Google\ApiCore\PagedListResponse' + var_type: 'Google\ApiCore\PagedListResponse' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::purgeProducts()' name: purgeProducts @@ -694,10 +694,10 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - - var_type: 'Google\ApiCore\OperationResponse' + var_type: 'Google\ApiCore\OperationResponse' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::removeProductFromProductSet()' name: removeProductFromProductSet @@ -724,7 +724,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::updateProduct()' name: updateProduct @@ -765,7 +765,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\Vision\V1\Product' @@ -802,7 +802,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\Vision\V1\ProductSet' @@ -1217,7 +1217,7 @@ items: syntax: returns: - - var_type: 'Google\ApiCore\LongRunning\OperationsClient' + var_type: 'Google\ApiCore\LongRunning\OperationsClient' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::resumeOperation()' name: resumeOperation @@ -1243,7 +1243,7 @@ items: description: 'The name of the method used to start the operation' returns: - - var_type: 'Google\ApiCore\OperationResponse' + var_type: 'Google\ApiCore\OperationResponse' - uid: '\Google\Cloud\Vision\V1\Client\ProductSearchClient::locationName()' name: 'static::locationName' diff --git a/dev/tests/fixtures/docfx/Vision/V1.ColorInfo.yml b/dev/tests/fixtures/docfx/Vision/V1.ColorInfo.yml index 2dd430751159..d6a1eb7ef2d0 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.ColorInfo.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.ColorInfo.yml @@ -41,7 +41,7 @@ items: description: 'Optional. Data for populating the Message object.' - id: '↳ color' - var_type: 'Google\Type\Color' + var_type: 'Google\Type\Color' description: 'RGB components of the color.' - id: '↳ score' @@ -63,7 +63,7 @@ items: syntax: returns: - - var_type: 'Google\Type\Color|null' + var_type: 'Google\Type\Color|null' - uid: '\Google\Cloud\Vision\V1\ColorInfo::hasColor()' name: hasColor @@ -93,7 +93,7 @@ items: parameters: - id: var - var_type: 'Google\Type\Color' + var_type: 'Google\Type\Color' description: '' returns: - diff --git a/dev/tests/fixtures/docfx/Vision/V1.ImageAnnotatorClient.yml b/dev/tests/fixtures/docfx/Vision/V1.ImageAnnotatorClient.yml index 3a635515285c..5a7f06400099 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.ImageAnnotatorClient.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.ImageAnnotatorClient.yml @@ -169,7 +169,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\Vision\V1\AnnotateImageResponse' @@ -206,7 +206,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\Vision\V1\AnnotateImageResponse' @@ -243,7 +243,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\Vision\V1\AnnotateImageResponse' @@ -280,7 +280,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\Vision\V1\AnnotateImageResponse' @@ -317,7 +317,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\Vision\V1\AnnotateImageResponse' @@ -354,7 +354,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\Vision\V1\AnnotateImageResponse' @@ -391,7 +391,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\Vision\V1\AnnotateImageResponse' @@ -428,7 +428,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\Vision\V1\AnnotateImageResponse' @@ -465,7 +465,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\Vision\V1\AnnotateImageResponse' @@ -502,7 +502,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\Vision\V1\AnnotateImageResponse' @@ -539,7 +539,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\Vision\V1\AnnotateImageResponse' @@ -576,7 +576,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\Vision\V1\AnnotateImageResponse' @@ -629,7 +629,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\Vision\V1\AnnotateImageResponse' @@ -655,11 +655,11 @@ items: - id: '↳ credentials' var_type: string|array|FetchAuthTokenInterface|CredentialsWrapper - description: 'The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. *Advanced usage*: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.' + description: 'The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. *Advanced usage*: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.' - id: '↳ credentialsConfig' var_type: array - description: 'Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .' + description: 'Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .' - id: '↳ disableRetries' var_type: bool @@ -671,11 +671,11 @@ items: - id: '↳ transport' var_type: string|TransportInterface - description: 'The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. *Advanced usage*: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.' + description: 'The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. *Advanced usage*: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.' - id: '↳ transportConfig' var_type: array - description: 'Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ ''grpc'' => [...], ''rest'' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.' + description: 'Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ ''grpc'' => [...], ''rest'' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.' - id: '↳ clientCertSource' var_type: callable @@ -759,10 +759,10 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - - var_type: 'Google\ApiCore\OperationResponse' + var_type: 'Google\ApiCore\OperationResponse' - uid: '\Google\Cloud\Vision\V1\ImageAnnotatorClient::asyncBatchAnnotateImages()' name: asyncBatchAnnotateImages @@ -850,10 +850,10 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - - var_type: 'Google\ApiCore\OperationResponse' + var_type: 'Google\ApiCore\OperationResponse' - uid: '\Google\Cloud\Vision\V1\ImageAnnotatorClient::batchAnnotateFiles()' name: batchAnnotateFiles @@ -924,7 +924,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\Vision\V1\BatchAnnotateFilesResponse' @@ -989,7 +989,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\Vision\V1\BatchAnnotateImagesResponse' @@ -1005,7 +1005,7 @@ items: syntax: returns: - - var_type: 'Google\ApiCore\LongRunning\OperationsClient' + var_type: 'Google\ApiCore\LongRunning\OperationsClient' - uid: '\Google\Cloud\Vision\V1\ImageAnnotatorClient::resumeOperation()' name: resumeOperation @@ -1031,7 +1031,7 @@ items: description: 'The name of the method used to start the operation' returns: - - var_type: 'Google\ApiCore\OperationResponse' + var_type: 'Google\ApiCore\OperationResponse' - uid: '\Google\Cloud\Vision\V1\ImageAnnotatorClient::productSetName()' name: 'static::productSetName' diff --git a/dev/tests/fixtures/docfx/Vision/V1.ImportProductSetsResponse.yml b/dev/tests/fixtures/docfx/Vision/V1.ImportProductSetsResponse.yml index 1141734cfb2b..00eb0cf33d7a 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.ImportProductSetsResponse.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.ImportProductSetsResponse.yml @@ -44,7 +44,7 @@ items: description: 'The list of reference_images that are imported successfully.' - id: '↳ statuses' - var_type: 'array<Google\Rpc\Status>' + var_type: 'array<Google\Rpc\Status>' description: 'The rpc status for each ImportProductSet request, including both successes and errors. The number of statuses here matches the number of lines in the csv file, and statuses[i] stores the success or failure status of processing the i-th line of the csv, starting from line 0.' - uid: '\Google\Cloud\Vision\V1\ImportProductSetsResponse::getReferenceImages()' @@ -115,7 +115,7 @@ items: parameters: - id: var - var_type: 'array<Google\Rpc\Status>' + var_type: 'array<Google\Rpc\Status>' description: '' returns: - diff --git a/dev/tests/fixtures/docfx/Vision/V1.LatLongRect.yml b/dev/tests/fixtures/docfx/Vision/V1.LatLongRect.yml index 27da7addac42..9c24fbf7307d 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.LatLongRect.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.LatLongRect.yml @@ -40,11 +40,11 @@ items: description: 'Optional. Data for populating the Message object.' - id: '↳ min_lat_lng' - var_type: 'Google\Type\LatLng' + var_type: 'Google\Type\LatLng' description: 'Min lat/long pair.' - id: '↳ max_lat_lng' - var_type: 'Google\Type\LatLng' + var_type: 'Google\Type\LatLng' description: 'Max lat/long pair.' - uid: '\Google\Cloud\Vision\V1\LatLongRect::getMinLatLng()' @@ -58,7 +58,7 @@ items: syntax: returns: - - var_type: 'Google\Type\LatLng|null' + var_type: 'Google\Type\LatLng|null' - uid: '\Google\Cloud\Vision\V1\LatLongRect::hasMinLatLng()' name: hasMinLatLng @@ -88,7 +88,7 @@ items: parameters: - id: var - var_type: 'Google\Type\LatLng' + var_type: 'Google\Type\LatLng' description: '' returns: - @@ -105,7 +105,7 @@ items: syntax: returns: - - var_type: 'Google\Type\LatLng|null' + var_type: 'Google\Type\LatLng|null' - uid: '\Google\Cloud\Vision\V1\LatLongRect::hasMaxLatLng()' name: hasMaxLatLng @@ -135,7 +135,7 @@ items: parameters: - id: var - var_type: 'Google\Type\LatLng' + var_type: 'Google\Type\LatLng' description: '' returns: - diff --git a/dev/tests/fixtures/docfx/Vision/V1.LocationInfo.yml b/dev/tests/fixtures/docfx/Vision/V1.LocationInfo.yml index 8233c5c5120b..2efb8be4114a 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.LocationInfo.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.LocationInfo.yml @@ -36,7 +36,7 @@ items: description: 'Optional. Data for populating the Message object.' - id: '↳ lat_lng' - var_type: 'Google\Type\LatLng' + var_type: 'Google\Type\LatLng' description: 'lat/long location coordinates.' - uid: '\Google\Cloud\Vision\V1\LocationInfo::getLatLng()' @@ -50,7 +50,7 @@ items: syntax: returns: - - var_type: 'Google\Type\LatLng|null' + var_type: 'Google\Type\LatLng|null' - uid: '\Google\Cloud\Vision\V1\LocationInfo::hasLatLng()' name: hasLatLng @@ -80,7 +80,7 @@ items: parameters: - id: var - var_type: 'Google\Type\LatLng' + var_type: 'Google\Type\LatLng' description: '' returns: - diff --git a/dev/tests/fixtures/docfx/Vision/V1.ProductSearchClient.yml b/dev/tests/fixtures/docfx/Vision/V1.ProductSearchClient.yml index 12d2a03cb3d3..d20baa7dab5d 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.ProductSearchClient.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.ProductSearchClient.yml @@ -99,11 +99,11 @@ items: - id: '↳ credentials' var_type: string|array|FetchAuthTokenInterface|CredentialsWrapper - description: 'The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. *Advanced usage*: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.' + description: 'The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. *Advanced usage*: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.' - id: '↳ credentialsConfig' var_type: array - description: 'Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .' + description: 'Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .' - id: '↳ disableRetries' var_type: bool @@ -115,11 +115,11 @@ items: - id: '↳ transport' var_type: string|TransportInterface - description: 'The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. *Advanced usage*: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.' + description: 'The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. *Advanced usage*: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.' - id: '↳ transportConfig' var_type: array - description: 'Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ ''grpc'' => [...], ''rest'' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.' + description: 'Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ ''grpc'' => [...], ''rest'' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.' - id: '↳ clientCertSource' var_type: callable @@ -216,7 +216,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::createProduct()' name: createProduct @@ -308,7 +308,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\Vision\V1\Product' @@ -399,7 +399,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\Vision\V1\ProductSet' @@ -512,7 +512,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\Vision\V1\ReferenceImage' @@ -591,7 +591,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::deleteProductSet()' name: deleteProductSet @@ -666,7 +666,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::deleteReferenceImage()' name: deleteReferenceImage @@ -749,7 +749,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::getProduct()' name: getProduct @@ -827,7 +827,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\Vision\V1\Product' @@ -908,7 +908,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\Vision\V1\ProductSet' @@ -994,7 +994,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\Vision\V1\ReferenceImage' @@ -1099,10 +1099,10 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - - var_type: 'Google\ApiCore\OperationResponse' + var_type: 'Google\ApiCore\OperationResponse' - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::listProductSets()' name: listProductSets @@ -1192,10 +1192,10 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - - var_type: 'Google\ApiCore\PagedListResponse' + var_type: 'Google\ApiCore\PagedListResponse' - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::listProducts()' name: listProducts @@ -1286,10 +1286,10 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - - var_type: 'Google\ApiCore\PagedListResponse' + var_type: 'Google\ApiCore\PagedListResponse' - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::listProductsInProductSet()' name: listProductsInProductSet @@ -1382,10 +1382,10 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - - var_type: 'Google\ApiCore\PagedListResponse' + var_type: 'Google\ApiCore\PagedListResponse' - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::listReferenceImages()' name: listReferenceImages @@ -1478,10 +1478,10 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - - var_type: 'Google\ApiCore\PagedListResponse' + var_type: 'Google\ApiCore\PagedListResponse' - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::purgeProducts()' name: purgeProducts @@ -1597,10 +1597,10 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - - var_type: 'Google\ApiCore\OperationResponse' + var_type: 'Google\ApiCore\OperationResponse' - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::removeProductFromProductSet()' name: removeProductFromProductSet @@ -1688,7 +1688,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::updateProduct()' name: updateProduct @@ -1766,7 +1766,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\Vision\V1\Product' @@ -1838,7 +1838,7 @@ items: - id: '↳ retrySettings' var_type: RetrySettings|array - description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' + description: 'Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.' returns: - var_type: 'Google\Cloud\Vision\V1\ProductSet' @@ -1854,7 +1854,7 @@ items: syntax: returns: - - var_type: 'Google\ApiCore\LongRunning\OperationsClient' + var_type: 'Google\ApiCore\LongRunning\OperationsClient' - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::resumeOperation()' name: resumeOperation @@ -1880,7 +1880,7 @@ items: description: 'The name of the method used to start the operation' returns: - - var_type: 'Google\ApiCore\OperationResponse' + var_type: 'Google\ApiCore\OperationResponse' - uid: '\Google\Cloud\Vision\V1\ProductSearchClient::locationName()' name: 'static::locationName' diff --git a/dev/tests/fixtures/docfx/Vision/V1.ProductSet.yml b/dev/tests/fixtures/docfx/Vision/V1.ProductSet.yml index 1de1dc3c31c4..93ea90377e32 100644 --- a/dev/tests/fixtures/docfx/Vision/V1.ProductSet.yml +++ b/dev/tests/fixtures/docfx/Vision/V1.ProductSet.yml @@ -58,7 +58,7 @@ items: description: 'Output only. The time at which this ProductSet was last indexed. Query results will reflect all updates before this time. If this ProductSet has never been indexed, this timestamp is the default value "1970-01-01T00:00:00Z". This field is ignored when creating a ProductSet.' - id: '↳ index_error' - var_type: 'Google\Rpc\Status' + var_type: 'Google\Rpc\Status' description: 'Output only. If there was an error with indexing the product set, the field is populated. This field is ignored when creating a ProductSet.' - uid: '\Google\Cloud\Vision\V1\ProductSet::getName()' @@ -211,7 +211,7 @@ items: syntax: returns: - - var_type: 'Google\Rpc\Status|null' + var_type: 'Google\Rpc\Status|null' - uid: '\Google\Cloud\Vision\V1\ProductSet::hasIndexError()' name: hasIndexError @@ -245,7 +245,7 @@ items: parameters: - id: var - var_type: 'Google\Rpc\Status' + var_type: 'Google\Rpc\Status' description: '' returns: - diff --git a/dev/tests/fixtures/docfx/Vision/docs.metadata b/dev/tests/fixtures/docfx/Vision/docs.metadata index db5afd540963..7ed906854baf 100644 --- a/dev/tests/fixtures/docfx/Vision/docs.metadata +++ b/dev/tests/fixtures/docfx/Vision/docs.metadata @@ -9,4 +9,5 @@ distribution_name: "google/cloud-vision" github_repository: "googleapis/google-cloud-php-vision" issue_tracker: "https://github.com/googleapis/google-cloud-php-vision/issues" xrefs: "devsite://php/cloud-core" +xrefs: "devsite://php/gax" xrefs: "devsite://php/common-protos"