feat(docs): pre-built Postman collection generated from /openapi.json#59
Merged
Conversation
setup/TimeTrackerAPI.postman_collection.json — 47 endpoints across
16 entity folders, generated via openapi-to-postmanv2 from the
single source of truth in app/config/openapi.js. README adds a
short pointer + the one-liner to regenerate after API changes.
Why generate, not hand-write:
- app/config/openapi.js is the spec we already maintain
(PR #50 conventions kept it in sync with router additions).
Hand-writing a separate Postman collection would create a
second source of truth that immediately drifts.
- openapi-to-postmanv2 is the canonical generator and produces
a v2.1 collection that imports cleanly into Postman / Bruno /
Insomnia.
The 1MB collection size is example-payload bloat from the
generator — unavoidable without templating support that Postman
v2.1 doesn't fully expose. Worth the cost for "import → click →
authenticated request" out-of-the-box ergonomics.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
CryptoJones
added a commit
that referenced
this pull request
May 18, 2026
Continues the docs-sync pattern from #44 and #53. CHANGELOG [Unreleased] now reflects: Added: - Sequelize associations (#54) - Integration test harness (#55) - Postman collection (#59) - TLS reverse-proxy compose (#60) - docker-compose.override.yml committed (#56) Fixed: - setup/TimeTracker.sql idempotency (#57) — removes the \`docker compose down -v\` workaround Docs: - Integration bring-up flow (#56, #58) - README sections for Testing and Behind TLS Co-authored-by: Aaron K. Clark <akclark@thenetwerk.net> Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
Adds
setup/TimeTrackerAPI.postman_collection.json— 47 endpoints in 16 entity folders, generated fromapp/config/openapi.jsviaopenapi-to-postmanv2. Single source of truth stays OpenAPI; this is just a derived artifact for the Postman/Bruno/Insomnia crowd.README gets the import-it pointer + the regenerate one-liner so future API changes can refresh the collection in one command.
Test plan
jqconfirms valid v2.1 collection withinfo.name = "TimeTrackerAPI"healthz+v1), 16 entity subfolders under v1Proudly Made in Nebraska. Go Big Red! 🌽 https://xkcd.com/2347/