Skip to content

Use official PHP SDK examples across the API reference - #95

Merged
roncodes merged 3 commits into
mainfrom
feature/php-sdk-api-examples
Sep 3, 2026
Merged

Use official PHP SDK examples across the API reference#95
roncodes merged 3 commits into
mainfrom
feature/php-sdk-api-examples

Conversation

@roncodes

@roncodes roncodes commented Sep 3, 2026

Copy link
Copy Markdown
Member

Summary

  • vendor the machine-readable 220-request PHP example catalog generated by fleetbase/fleetbase-php
  • key examples by the same stable Fleetbase and Core Postman request IDs
  • keep concise service calls for canonical CRUD endpoints
  • use the exact generated PHP SDK method for every custom endpoint
  • render positional URL identifiers and direct body/query/multipart arrays without exposing internal SDK envelopes
  • fail API-doc generation when any catalog request is missing or stale

Examples

Canonical CRUD remains concise:

$fleetbase->places->create($attributes);

Custom actions use the contract-named SDK method and declared variables:

$orderId = 'order_id-fixture';
$fleetbase->orders->dispatchOrder($orderId);

$fleetbase->drivers->changeDriverPassword($driverId, $passwordData);

Compatibility envelopes such as ['id' => ..., 'body' => ...] remain documented in the SDK migration guide but are not presented as the primary API-reference form.

Verification

  • catalog contains all 220 stable request IDs
  • SDK-side generator and executable-example tests consume all 220 entries
  • website SDK emitter tests: four passing, including positional dispatch and direct driver-password data
  • canonical CRUD remains mapped to concise resource methods
  • custom Fleetbase and Core API endpoints retain first-class SDK calls instead of raw Guzzle fallbacks
  • Vercel preview and preview-comments checks pass on website SHA 677cfb5ab8344c39ffee9e0971ea5110be159352
  • coordinated SDK SHA 3e7e608dd4dd25fd76c71cf78d530effcd7921b0 passes its complete PHP/consumer/security/coverage/mutation matrix and the disposable contract recorded all 220 expected SDK request IDs

The website checkout used for this update intentionally remains isolated from the maintainer's normal checkout.

Coordinated SDK release PR: fleetbase/fleetbase-php#9

@vercel

vercel Bot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
fleetbase-io Ready Ready Preview Sep 3, 2026 8:01am UTC

Request Review

@roncodes
roncodes merged commit c262141 into main Sep 3, 2026
2 checks passed
@roncodes
roncodes deleted the feature/php-sdk-api-examples branch September 3, 2026 08:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant