docs: resolve issues #864, #865, #866 — OpenAPI spec, runbook, contra…#924
Merged
Merged
Conversation
…PI spec, runbook, contract doc comments Issue Xoulomon#864 — Backend API OpenAPI specification - Add backend/openapi.yaml (OpenAPI 3.0.3) covering all /api/* endpoints - Documents auth, user, health, stats, recommendations, search, analytics, contract events, export, backup, notifications, webhooks, and cache routes - Full request/response schemas for every endpoint derived from route handlers - Security schemes (bearerAuth JWT), reusable parameters, and shared responses - Covers both /api/v1 and /api/v2 versioned routes - Includes deprecation notes for legacy unversioned paths Issue Xoulomon#865 — Infrastructure runbook - Add docs/runbook.md with three core operational sections: 1. ECS task scaling (scale up/down, disable auto-scaling, CloudWatch metrics) 2. Database restore from S3 (API path, DR script, RDS point-in-time fallback, integrity verification) 3. On-call escalation checklist for contract pause scenarios (detection, immediate response, step-by-step checklist, unpause procedure, post-incident actions, escalation contacts) - Additional sections: common ops tasks, environment variable reference, infrastructure resource identifiers, related documentation links - All commands reference actual Terraform resource names from infra/modules/ Issue Xoulomon#866 — Inline Rust doc comments on contract modules - group.rs: expand/add /// comments on TokenConfig fields, GroupStatus as_u32/from_u32, all new Group fields (require_contribution_proof, allow_dynamic_contributions, grace_period_seconds, invitation_only, reward_pool, paused, penalty_enabled, penalty_amount, dispute_active, name, description, image_url, archived, payout_order), new_with_penalty, is_complete, deactivate, can_activate, total_pool_amount, validate, add_member, is_paused - contribution.rs: expand ContributionPage.has_more field doc - payout.rs: expand PayoutOrder enum variants (Sequential, Random, Bid), validate, belongs_to_group, amount_in_xlm with example - cargo doc --no-deps produces zero missing-documentation warnings Closes Xoulomon#864 Closes Xoulomon#865 Closes Xoulomon#866
|
@GoodnessJohn Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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
2 participants
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
Resolves three documentation issues in a single branch.
#864 — Backend API OpenAPI specification
backend/openapi.yaml(OpenAPI 3.0.3) covering every/api/*endpointroutes/v1.ts,routes/v2.ts,routes/auth.ts,routes/user.ts,routes/notifications.ts, androutes/webhooks.ts/api/v1and/api/v2versioned routes documented; legacy deprecation notedCloses #864
#865 — Infrastructure runbook
docs/runbook.mdwith three core operational sections:infra/modules/ecsandinfra/modules/rdsCloses #865
#866 — Inline Rust doc comments on contract modules
///comments onTokenConfigfields,GroupStatus::as_u32/from_u32, allGroupfields added since the original implementation, and methodsnew_with_penalty,is_complete,deactivate,can_activate,total_pool_amount,validate,add_member,is_pausedContributionPage.has_morefield doc with cursor guidancePayoutOrdervariant docs (Sequential,Random,Bid),validate,belongs_to_group,amount_in_xlm(with code example)cargo doc --no-depsproduces zero missing-documentation warningsCloses #866