Skip to content

fix: keep Postman API docs independent of SDK coverage - #99

Merged
roncodes merged 1 commit into
mainfrom
feature/inspections-postman-docs
Sep 14, 2026
Merged

fix: keep Postman API docs independent of SDK coverage#99
roncodes merged 1 commit into
mainfrom
feature/inspections-postman-docs

Conversation

@roncodes

Copy link
Copy Markdown
Member

Summary

Fix the failed inspection Postman bump without requiring PHP or any other SDK to catch up before API documentation can update.

  • Update vendor/postman to d6a7cc5, including inspections and the submission JSON-body fix.
  • Restore the no-change guard, skip dependency installation/generation/PR creation when Postman is current, and remove the PHP checkout and SDK-driven daily schedule from Bump Postman Submodule.
  • Accept incomplete or stale SDK catalogs while still rejecting malformed supplied examples. Missing PHP examples omit that sample rather than failing API generation or inventing SDK methods.
  • Unknown JavaScript SDK resources use raw fetch examples instead of guessing stores. Other languages and the HTTP reference remain available.
  • Add regression tests for independent coverage, malformed catalogs, unknown SDK resources, and the no-change workflow guards.

Validation

  • 10 emitter/catalog/workflow regression tests pass locally.
  • Locked dependency installation and complete API generation pass with the existing 264-example published PHP catalog and the new 270-request Postman collection. The six inspection endpoints render without PHP samples: the exact previously failing mismatch is no longer fatal.
  • actionlint and git diff checks pass.
  • Production build and hosted PR checks are being verified before handoff.

Release independence

This PR intentionally retains the current published PHP catalog. It can merge independently of fleetbase/fleetbase-php#15. After SDK 1.4.0 is published, synchronize its generated catalog in a separate reviewed update to enable inspection PHP samples. No unreleased SDK support is claimed here.

The docs source remains Postman; SDK examples are optional per language, not a release gate for the API reference.

Fixes: https://github.com/fleetbase/fleetbase.io/actions/runs/34685799767/job/103532458886
Related: fleetbase/postman#60, fleetbase/postman#61, fleetbase/fleetbase-php#15.

No merge or publication has been performed.

@vercel

vercel Bot commented Sep 12, 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 12, 2026 12:35pm UTC

Request Review

@roncodes

Copy link
Copy Markdown
Member Author

Verification on fc65029:

  • API documentation CI passed: https://github.com/fleetbase/fleetbase.io/actions/runs/34693985036
  • Vercel production preview build passed: https://vercel.com/fleetbase/fleetbase-io/C5jB4dQKjVLazBU353ougLYheaRK
  • All 10 emitter/catalog/workflow regression tests and 12 existing application tests passed locally.
  • Complete API generation succeeded with Postman d6a7cc5 and the unchanged published 264-example PHP catalog. All six inspection endpoints render, with missing PHP samples omitted; no guessed JavaScript inspection store is emitted.
  • The local production build compiled successfully but stopped at the unrelated missing GHOST_API_URL configuration; the configured hosted build above passed in full.

This PR is independent of the pending PHP SDK release PR fleetbase/fleetbase-php#15. No SDK checkout or completeness requirement remains in the Postman bump.

@roncodes
roncodes merged commit 70e7ce1 into main Sep 14, 2026
3 checks passed
@roncodes
roncodes deleted the feature/inspections-postman-docs branch September 14, 2026 06:03
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