Fix the API reference build after the Postman submodule bump - #97
Merged
Conversation
The Bump Postman Submodule dispatch moved vendor/postman to the merged
collection, which added 21 requests. The catalog was still the 220-request one
generated at 9a7d4d8, so generate-api-docs.mjs threw on the first request it
could not map:
No PHP SDK example is mapped for
fleetbase-api-drivers-create-an-operational-driver.
Regenerated from fleetbase/fleetbase-php at the matching Postman ref. The
catalog now covers all 241 requests, so both directions of the coverage check
pass: every request has an example, and no catalog entry goes unused.
The scenario requests among the 21 resolve to the method they actually
exercise rather than to one of their own, so `Create an Order with Empty
Relationships` documents createOrder and `Expand a Vehicle` documents
retrieveVehicle with its `with` parameter.
The four genuinely new fleet membership endpoints need fleetbase-php 1.2.0,
which is in review; this catalog is generated from that branch. Land the SDK
release first so the documented methods exist in a published version.
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.
Summary
Fixes the API-reference build, which currently fails on
main.The Bump Postman Submodule dispatch (run 34012387765) moved
vendor/postmanto the merged collection from fleetbase/postman#59, which added 21 requests.scripts/php-sdk-examples.generated.jsonwas still the 220-request catalog generated at9a7d4d8, sogenerate-api-docs.mjsthrew on the first request it could not map:Regenerated the catalog from
fleetbase/fleetbase-phpat the matching Postman ref, and bumped the submodule to9b59bef.What changed
Only two files — the generated
.mdxpages andapi-nav.generated.tsare build outputs and are not tracked.scripts/php-sdk-examples.generated.json— 220 → 241 examples,generated_from.refnow9b59befvendor/postman—9a7d4d8→9b59befBoth directions of the coverage check now pass: every request has an example, and no catalog entry is unused.
The scenario requests among the 21 map to the method they actually exercise rather than to a bespoke one, so
Create an Order with Empty RelationshipsdocumentscreateOrder, andExpand a VehicledocumentsretrieveVehiclewith itswithparameter.Validation
Ran the postinstall pair (
fumadocs-mdx && node scripts/generate-api-docs.mjs) exactly as CI does; it exits 0. Spot-checked the endpoint that broke the build —Create an Operational Driverrenders ondrivers.mdxwith its PHP sample — and confirmed the fleet membership endpoints render onfleets.mdx.Ordering
Depends on fleetbase/fleetbase-php#10, which adds the four fleet membership methods this catalog documents. That PR is the source of this file, so land it first — otherwise the reference documents methods that no published SDK version has.