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
Remove the stale, hand-maintained API reference from README.md and replace it with a properly maintained, published Postman collection + auto-generated docs.
Background
README.md currently contains a large "Detailed API Documentation" section (queries, mutations, request/response examples) that is manually written and drifts out of sync with the actual GraphQL schema. This should be replaced with a Postman collection that is the source of truth, with docs auto-generated from it and published via Postman's built-in Publish feature.
Tasks
Remove the stale "Detailed API Documentation" section from README.md (Authentication, Tournament Management, Participant Management, Bracket Management, Queries subsections and their request/response examples)
Build a new Postman collection from scratch covering all current queries and mutations:
Summary
Remove the stale, hand-maintained API reference from
README.mdand replace it with a properly maintained, published Postman collection + auto-generated docs.Background
README.mdcurrently contains a large "Detailed API Documentation" section (queries, mutations, request/response examples) that is manually written and drifts out of sync with the actual GraphQL schema. This should be replaced with a Postman collection that is the source of truth, with docs auto-generated from it and published via Postman's built-in Publish feature.Tasks
README.md(Authentication, Tournament Management, Participant Management, Bracket Management, Queries subsections and their request/response examples)registerUser,loginUser,me, refresh token / logout mutationscreateTournament,updateTournament,deleteTournament,tournaments,tournamentByIdaddParticipant,joinTournamentgenerateBracket,play,updateRound,matchesForRoundloginUser, and which requests require authREADME.mdto link to the published Postman documentation in place of the removed sectionAcceptance Criteria
README.mdno longer contains inline hand-written API request/response examplesREADME.mdlinks to the published Postman docs