Fix Postman bumps and document the Trailers PHP SDK - #98
Merged
Merged
Conversation
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem and fix
The Postman bump workflow failed during dependency installation because postinstall generates API documentation against an older PHP SDK catalog:
No PHP SDK example is mapped for fleetbase-api-equipment-attach-equipment.Update Postman to
7fe06b7c5e415a9aa292869e9037910896b049adand vendor the matching 264-request catalog from SDK 1.3.0 PR #11. The API reference now renders all Trailers and Equipment attachment examples with the correct SDK services and positional/direct-data arguments.Future submodule bumps check out the PHP SDK's reviewed main branch, validate the exact Postman request-ID set, and synchronize its catalog before postinstall. Invalid, incomplete, or stale catalogs fail with an actionable error before replacing the checked-in file. A daily retry allows updates waiting for SDK support to recover after that SDK change merges. Concurrent runs are serialized, and automated PRs stage only the submodule and generated catalog.
A new PR workflow checks catalog completeness, tests the emitters and synchronizer, and regenerates the docs. The full 264-request coverage check remains enforced.
Validation
node scripts/sync-php-sdk-examples.mjs: 264/264 request IDs.node --test scripts/sdk-emitters.test.mjs scripts/sync-php-sdk-examples.test.mjs: seven tests pass, including correct service ownership for trailer/device/equipment actions and preservation of the existing file when an incomplete candidate is supplied.pnpm install --frozen-lockfile: passes, including postinstall and complete API documentation generation. The previously failing step now succeeds with the new submodule and catalog.pnpm build: compiles successfully; local page-data generation stops because the isolated checkout lacks the blog'sGHOST_API_URL.19d87420e6a9fad072ebaa4ee4551d312b4b1a6b, including complete catalog validation, frozen dependency installation/postinstall, tests and regeneration.86be1e719e6d5c0bd8b8f266200f2de2da26fac2passes all SDK CI and the disposable Fleetbase contract: 264/264 expected SDK request IDs, zero failed Postman requests, 100% line/branch coverage and 88.18% mutation score.Merge the SDK release PR first so the bump workflow can obtain the matching catalog from SDK main. Then merge this website PR and rerun Bump Postman Submodule, or allow the scheduled retry.