Skip to content

Repair API docs content with source-backed Orders metadata#3

Merged
roncodes merged 10 commits into
mainfrom
repair-source-backed-orders-docs
May 7, 2026
Merged

Repair API docs content with source-backed Orders metadata#3
roncodes merged 10 commits into
mainfrom
repair-source-backed-orders-docs

Conversation

@roncodes
Copy link
Copy Markdown
Member

@roncodes roncodes commented May 7, 2026

Summary

This repairs the previously merged broad generated content pass.

  • Reverts PR Complete API collection content for docs #2 (complete-api-collection-content) so the hallucinated params/examples/object files are removed from main.
  • Adds back a focused, source-backed Orders pass for Fleetbase API only.
  • Uses packages/fleetops/server/src/Http/Requests/CreateOrderRequest.php, UpdateOrderRequest.php, ScheduleOrderRequest.php, Http/Controllers/Api/v1/OrderController.php, and Http/Resources/v1/Order.php as the source of truth.

Source-backed Orders updates

  • Corrected create/update/query params for the actual FleetOps order contract.
  • Added params for schedule, start, update activity, and proof capture endpoints.
  • Added an Orders resource object file using the public Order resource shape, without a generic object property.
  • Replaced the worst Orders response examples with public-resource-shaped examples using driver_assigned, vehicle_assigned, tracking_number, payload, and lifecycle fields.
  • Tightened stale or generic Orders descriptions and path variable descriptions.

Verification

  • ruby -e 'require "yaml"; Dir["postman/collections/**/*.yaml"].each { |f| YAML.load_file(f) }; puts "collection yaml ok"'
  • node scripts/validate-collections.js
  • pnpm postman:lint
  • POSTMAN_COLLECTIONS_DIR=/Users/ron/Development/fleetbase/postman/postman/collections node scripts/generate-api-docs.mjs from ~/Development/fleetbase/fleetbase.io

Note: pnpm postman:lint passes repository validation but skips Postman CLI schema lint because the Postman CLI is not installed in this environment.

@roncodes roncodes merged commit 46fd85b into main May 7, 2026
1 check passed
@roncodes roncodes deleted the repair-source-backed-orders-docs branch May 7, 2026 09:02
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