Skip to content

Commit 93fa386

Browse files
committed
docs: Update README to enhance method and property documentation
Refactor method and property descriptions in the README to use tables for better clarity and organization. This change improves the overall readability and structure of the API documentation.
1 parent 2199df3 commit 93fa386

1 file changed

Lines changed: 30 additions & 22 deletions

File tree

README.md

Lines changed: 30 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -185,43 +185,51 @@ foreach ($page->containers as $containerId => $container) {
185185

186186
The main client for interacting with the dotCMS API.
187187

188-
- `__construct(Config $config)`: Create a new client instance
189-
- `getPage(PageRequest $request)`: Fetch a page synchronously
190-
- `getPageAsync(PageRequest $request)`: Fetch a page asynchronously
191-
- `createPageRequest(string $pagePath, string $format = 'json')`: Create a new page request
188+
| Method | Description | Parameters |
189+
|--------|-------------|------------|
190+
| `__construct` | Create a new client instance | `Config $config` |
191+
| `getPage` | Fetch a page synchronously | `PageRequest $request` |
192+
| `getPageAsync` | Fetch a page asynchronously | `PageRequest $request` |
193+
| `createPageRequest` | Create a new page request | `string $pagePath, string $format = 'json'` |
192194

193195
### PageRequest
194196

195197
Represents a request to the dotCMS Page API.
196198

197-
- `__construct(string $pagePath, string $format = 'json')`: Create a new page request
198-
- `withLanguageId(int $languageId)`: Set the language ID for the request
199-
- `withMode(string $mode)`: Set the mode (LIVE, WORKING, EDIT_MODE)
200-
- `withDepth(int $depth)`: Set the depth of the content to retrieve (0-3)
201-
- `withPersonaId(string $personaId)`: Set the persona ID for personalization
202-
- `withHostId(string $hostId)`: Set the host ID (Site ID)
203-
- `withFireRules(bool $fireRules)`: Set whether to fire rules
204-
- `buildPath()`: **(Internal)** Build the API path for the request
205-
- `buildQueryParams()`: **(Internal)** Build the query parameters for the request
199+
| Method | Description | Parameters |
200+
|--------|-------------|------------|
201+
| `__construct` | Create a new page request | `string $pagePath, string $format = 'json'` |
202+
| `withLanguageId` | Set the language ID for the request | `int $languageId` |
203+
| `withMode` | Set the mode (LIVE, WORKING, EDIT_MODE) | `string $mode` |
204+
| `withDepth` | Set the depth of the content to retrieve (0-3) | `int $depth` |
205+
| `withPersonaId` | Set the persona ID for personalization | `string $personaId` |
206+
| `withHostId` | Set the host ID (Site ID) | `string $hostId` |
207+
| `withFireRules` | Set whether to fire rules | `bool $fireRules` |
208+
| `buildPath` | **(Internal)** Build the API path for the request | None |
209+
| `buildQueryParams` | **(Internal)** Build the query parameters for the request | None |
206210

207211
### PageAsset
208212

209213
Represents a complete page asset from dotCMS.
210214

211-
- `page`: The Page object
212-
- `site`: The Site object
213-
- `template`: The Template object
214-
- `layout`: The Layout object
215-
- `containers`: Array of Container objects
215+
| Property | Type | Description |
216+
|----------|------|-------------|
217+
| `page` | Page | The Page object |
218+
| `site` | Site | The Site object |
219+
| `template` | Template | The Template object |
220+
| `layout` | Layout | The Layout object |
221+
| `containers` | Array | Array of Container objects |
216222

217223
## Error Handling
218224

219225
The SDK provides several exception classes for error handling:
220226

221-
- `DotCMSException`: Base exception class for all SDK exceptions
222-
- `ConfigException`: Thrown when there's an issue with the configuration
223-
- `HttpException`: Thrown when there's an HTTP error
224-
- `ResponseException`: Thrown when there's an issue with the response
227+
| Exception | Description |
228+
|-----------|-------------|
229+
| `DotCMSException` | Base exception class for all SDK exceptions |
230+
| `ConfigException` | Thrown when there's an issue with the configuration |
231+
| `HttpException` | Thrown when there's an HTTP error |
232+
| `ResponseException` | Thrown when there's an issue with the response |
225233

226234
Example error handling:
227235

0 commit comments

Comments
 (0)