Skip to content

Commit 6ac7a07

Browse files
committed
docs: Mark buildPath and buildQueryParams as internal in README and PageRequest
Update documentation to indicate that buildPath and buildQueryParams methods are for internal use only. This change clarifies their intended usage within the SDK.
1 parent 93bea12 commit 6ac7a07

2 files changed

Lines changed: 4 additions & 2 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -201,8 +201,8 @@ Represents a request to the dotCMS Page API.
201201
- `withPersonaId(string $personaId)`: Set the persona ID for personalization
202202
- `withHostId(string $hostId)`: Set the host ID (Site ID)
203203
- `withFireRules(bool $fireRules)`: Set whether to fire rules
204-
- `buildPath()`: Build the API path for the request
205-
- `buildQueryParams()`: Build the query parameters for the request
204+
- `buildPath()`: **(Internal)** Build the API path for the request
205+
- `buildQueryParams()`: **(Internal)** Build the query parameters for the request
206206

207207
### PageAsset
208208

src/Request/PageRequest.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -387,6 +387,7 @@ public function withDepth(int $depth): self
387387
/**
388388
* Build the request URL path.
389389
*
390+
* @internal This method is meant for internal use by the SDK
390391
* @return string The request URL path
391392
*/
392393
public function buildPath(): string
@@ -397,6 +398,7 @@ public function buildPath(): string
397398
/**
398399
* Build the query parameters.
399400
*
401+
* @internal This method is meant for internal use by the SDK
400402
* @return array<string, string|int>
401403
*/
402404
public function buildQueryParams(): array

0 commit comments

Comments
 (0)