Skip to content

fix: include api_version on client class docs #795

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bshaffer merged 1 commit into from
Dec 10, 2025
Merged

fix: include api_version on client class docs #795

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/Generation/GapicClientV2Generator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,11 @@ private function generateClass(): PhpClass
'Service Description: ' . ($this->serviceDetails->docLines->firstOrNull() ?? '')
)
),
!is_null($this->serviceDetails->apiVersion)
? PhpDoc::text(
'This client uses ' . $this->serviceDetails->shortName . ' version ' . $this->serviceDetails->apiVersion . '.'
)
: null,
PhpDoc::preFormattedText(
Vector::new([
'This class provides the ability to make remote calls to the backing service through method',
Expand Down
2 changes: 2 additions & 0 deletions tests/Unit/ProtoTests/Basic/out/src/Client/BasicClient.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@
/**
* Service Description: This is a basic service.
*
* This client uses Basic version v1_20240418.
*
* This class provides the ability to make remote calls to the backing service through method
* calls that map to API methods.
*
Expand Down