PythonBulawayo/ChitChat

Add API Endpoint Documentation

Open

#23 opened on Jan 25, 2024

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)TypeScript (24 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (25 stars)
PR merge metrics
 (PR metrics pending)

Description

The API is currently undocumented. Add documentation to make it easy to build against the API. We should consider using a tool like Swagger to document our endpoints.

Contributor guide

Research direction
Explore the codebase to identify all API endpoints, then choose a documentation tool like Swagger to document each endpoint with methods, parameters, and response examples.
Tech stack
typescript
Domain
apidocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75