You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The repository includes a Postman collection for testing the API endpoints. This creates
several friction points:
Vendor lock-in: Postman is a proprietary tool that requires account sign-in and a
separate desktop app (or browser extension) to use.
Redundant with Swagger: The API already exposes interactive documentation at /docs
(Swagger UI), which covers ad-hoc exploration without any additional tooling.
Not editor-native: The collection lives outside the development workflow. Developers
have to context-switch to Postman instead of staying in their editor.
Format opacity: The .json collection format is not human-readable at a glance and
is not diff-friendly in code review.
Proposed Solution
Replace postman_collections/ with a rest/players.rest file using the plain-text HTTP file format,
supported natively by:
VS Code via the REST Client extension (humao.rest-client)
IntelliJ IDEA / WebStorm via the built-in HTTP Client
The file is plain text, version-controlled, diff-friendly, and runs directly inside the
editor without leaving the development environment.
Suggested Approach
Remove postman_collections/
Add rest/players.rest covering all CRUD operations, with request bodies aligned with
test fixtures (natural key lookups where needed)
Add humao.rest-client to .vscode/extensions.json recommendations
postman_collections/ is removed from the repository
rest/players.rest covers: health check, POST, GET all, GET by UUID, GET by squad
number, PUT, DELETE (with two-step UUID resolution for runtime-generated IDs)
Request bodies and UUIDs in rest/players.rest are aligned with test fixtures
humao.rest-client is listed in .vscode/extensions.json
All exclusion lists (Black, Codecov, flake8) updated
README.md references rest/players.rest and the REST Client extension
All pre-commit checks pass (flake8, black --check, pytest, coverage ≥ 80%)
Problem
The repository includes a Postman collection for testing the API endpoints. This creates
several friction points:
separate desktop app (or browser extension) to use.
/docs(Swagger UI), which covers ad-hoc exploration without any additional tooling.
have to context-switch to Postman instead of staying in their editor.
.jsoncollection format is not human-readable at a glance andis not diff-friendly in code review.
Proposed Solution
Replace
postman_collections/with arest/players.restfile using the plain-textHTTP file format,
supported natively by:
humao.rest-client)The file is plain text, version-controlled, diff-friendly, and runs directly inside the
editor without leaving the development environment.
Suggested Approach
postman_collections/rest/players.restcovering all CRUD operations, with request bodies aligned withtest fixtures (natural key lookups where needed)
humao.rest-clientto.vscode/extensions.jsonrecommendationspostman_collections/, addrest/README.mdCHANGELOG.mdAcceptance Criteria
postman_collections/is removed from the repositoryrest/players.restcovers: health check, POST, GET all, GET by UUID, GET by squadnumber, PUT, DELETE (with two-step UUID resolution for runtime-generated IDs)
rest/players.restare aligned with test fixtureshumao.rest-clientis listed in.vscode/extensions.jsonREADME.mdreferencesrest/players.restand the REST Client extensionflake8,black --check,pytest, coverage ≥ 80%)References